blob: 529a228ec88f118f412fe22c70bde5d9eaf3c741 [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:" \
141 "\n addbr BRIDGE Create BRIDGE" \
142 "\n delbr BRIDGE Delete BRIDGE" \
143 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
144 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
145 USE_FEATURE_BRCTL_FANCY( \
146 "\n setageing BRIDGE TIME Set ageing time" \
147 "\n setfd BRIDGE TIME Set bridge forward delay" \
148 "\n sethello BRIDGE TIME Set hello time" \
149 "\n setmaxage BRIDGE TIME Set max message age" \
150 "\n setpathcost BRIDGE COST Set path cost" \
151 "\n setportprio BRIDGE PRIO Set port priority" \
152 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
153 "\n stp BRIDGE [1|0] STP on/off" \
154 )
Glenn L McGrath24e28332001-10-05 03:48:57 +0000155#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000156 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000157#define bunzip2_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000158 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
159 "\nOptions:" \
160 "\n -c Write to standard output" \
161 "\n -f Force" \
Glenn L McGrath24e28332001-10-05 03:48:57 +0000162
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000163#define bzip2_trivial_usage \
164 "[OPTION]... [FILE]..."
165#define bzip2_full_usage \
166 "Compress FILE(s) with bzip2 algorithm.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000167 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n" \
168 "\nOptions:" \
169 "\n -c Write to standard output" \
170 "\n -d Decompress" \
171 "\n -f Force" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000172 "\n -1..-9 Compression level" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000173
Rob Landley6130b9b2006-01-23 21:10:38 +0000174#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000175 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000176
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000177#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000178 "FILE"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000179#define bzcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000180 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000181
Rob Landleyc1d69902006-01-20 18:28:50 +0000182#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000183 "[OPTION]... [FILE]"
Rob Landleyc1d69902006-01-20 18:28:50 +0000184#define unlzma_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000185 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
186 "\nOptions:" \
187 "\n -c Write to standard output" \
188 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000189
190#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000191 "FILE"
Rob Landleyc1d69902006-01-20 18:28:50 +0000192#define lzmacat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000193 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000194
Eric Andersenc98c0622001-12-06 15:16:43 +0000195#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000196 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000197#define cal_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000198 "Display a calendar\n" \
199 "\nOptions:" \
200 "\n -j Use julian dates" \
201 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000202
Eric Andersen7e9276b2001-02-22 01:15:47 +0000203#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000204 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000205#define cat_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000206 "Concatenate FILE(s) and print them to stdout\n" \
207 "\nOptions:" \
208 "\n -u Use unbuffered i/o (ignored)" \
209
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000210#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000211 "$ cat /proc/uptime\n" \
212 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000213
Rob Landley8abbee42006-05-31 19:36:04 +0000214#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000215 "[-etv] [FILE]..."
Rob Landley8abbee42006-05-31 19:36:04 +0000216#define catv_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000217 "Display nonprinting characters as ^x or M-x\n" \
218 "\nOptions:" \
219 "\n -e End each line with $" \
220 "\n -t Show tabs as ^I" \
221 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000222
223#define chat_trivial_usage \
224 "EXPECT [SEND [EXPECT [SEND...]]]"
225#define chat_full_usage \
226 "Useful for interacting with a modem connected to stdin/stdout.\n" \
227 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
228 "each pair is a pair of arguments. Example:\n" \
229 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
230
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000231#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000232 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000233#define chattr_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000234 "Change file attributes on an ext2 fs\n" \
235 "\nModifiers:" \
236 "\n - Remove attributes" \
237 "\n + Add attributes" \
238 "\n = Set attributes" \
239 "\nAttributes:" \
240 "\n A Don't track atime" \
241 "\n a Append mode only" \
242 "\n c Enable compress" \
243 "\n D Write dir contents synchronously" \
244 "\n d Do not backup with dump" \
245 "\n i Cannot be modified (immutable)" \
246 "\n j Write all data to journal first" \
247 "\n s Zero disk storage when deleted" \
248 "\n S Write file contents synchronously" \
249 "\n t Disable tail-merging of partial blocks with other files" \
250 "\n u Allow file to be undeleted" \
251 "\nOptions:" \
252 "\n -R Recursively list subdirectories" \
253 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000254
Denis Vlasenko49622d72007-03-10 16:58:49 +0000255#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000256 "[OPTIONS] CONTEXT FILE..." \
257 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
258 USE_FEATURE_CHCON_LONG_OPTIONS( \
259 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
260 )
Denis Vlasenko49622d72007-03-10 16:58:49 +0000261#define chcon_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000262 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000263 USE_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000264 "\n -v,--verbose Verbose" \
265 "\n -c,--changes Report changes made" \
266 "\n -h,--no-dereference Affect symlinks instead of their targets" \
267 "\n -f,--silent,--quiet Suppress most error messages" \
268 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
269 "\n -u,--user=USER Set user/role/type/range in the target" \
270 "\n -r,--role=ROLE security context" \
271 "\n -t,--type=TYPE" \
272 "\n -l,--range=RANGE" \
273 "\n -R,--recursive Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000274 ) \
275 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000276 "\n -v Verbose" \
277 "\n -c Report changes made" \
278 "\n -h Affect symlinks instead of their targets" \
279 "\n -f Suppress most error messages" \
280 "\n -u USER Set user/role/type/range in the target security context" \
281 "\n -r ROLE" \
282 "\n -t TYPE" \
283 "\n -l RNG" \
284 "\n -R Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000285 )
286
Eric Andersen7e9276b2001-02-22 01:15:47 +0000287#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000288 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000289#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000290 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000291 "symbols +-= and one or more of the letters rwxst\n" \
292 "\nOptions:" \
293 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000294 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000295 "\n -c List changed files" \
296 "\n -v List all files" \
297 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000298 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000299#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000300 "$ ls -l /tmp/foo\n" \
301 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
302 "$ chmod u+x /tmp/foo\n" \
303 "$ ls -l /tmp/foo\n" \
304 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
305 "$ chmod 444 /tmp/foo\n" \
306 "$ ls -l /tmp/foo\n" \
307 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000308
Denis Vlasenko081ef792007-03-17 16:38:21 +0000309#define chgrp_trivial_usage \
310 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
311#define chgrp_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000312 "Change the group membership of each FILE to GROUP\n" \
313 "\nOptions:" \
314 "\n -R Recurse directories" \
315 "\n -h Affect symlinks instead of symlink targets" \
316 "\n -L Traverse all symlinks to directories" \
317 "\n -H Traverse symlinks on command line only" \
318 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000319 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000320 "\n -c List changed files" \
321 "\n -v Verbose" \
322 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000323 )
324#define chgrp_example_usage \
325 "$ ls -l /tmp/foo\n" \
326 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
327 "$ chgrp root /tmp/foo\n" \
328 "$ ls -l /tmp/foo\n" \
329 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
330
Eric Andersen7e9276b2001-02-22 01:15:47 +0000331#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000332 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000333#define chown_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000334 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
335 "\nOptions:" \
336 "\n -R Recurse directories" \
337 "\n -h Affect symlinks instead of symlink targets" \
338 "\n -L Traverse all symlinks to directories" \
339 "\n -H Traverse symlinks on command line only" \
340 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000341 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000342 "\n -c List changed files" \
343 "\n -v List all files" \
344 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000345 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000346#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000347 "$ ls -l /tmp/foo\n" \
348 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
349 "$ chown root /tmp/foo\n" \
350 "$ ls -l /tmp/foo\n" \
351 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
352 "$ chown root.root /tmp/foo\n" \
353 "ls -l /tmp/foo\n" \
354 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000355
Denis Vlasenkofe544582006-10-03 15:57:40 +0000356#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000357 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
358 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
359 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000360#define chpst_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000361 "Change the process state and run specified program\n" \
362 "\nOptions:" \
363 "\n -u USER[:GRP] Set uid and gid" \
364 "\n -U USER[:GRP] Set $UID and $GID in environment" \
365 "\n -e DIR Set environment variables as specified by files" \
366 "\n in DIR: file=1st_line_of_file" \
367 "\n -/ DIR Chroot to DIR" \
368 "\n -n INC Add INC to nice value" \
369 "\n -m BYTES Limit data segment, stack segment, locked physical pages," \
370 "\n and total of all segment per process to BYTES each" \
371 "\n -d BYTES Limit data segment" \
372 "\n -o N Limit the number of open file descriptors per process to N" \
373 "\n -p N Limit number of processes per uid to N" \
374 "\n -f BYTES Limit output file size to BYTES" \
375 "\n -c BYTES Limit core file size to BYTES" \
376 "\n -v Verbose" \
377 "\n -P Run prog in a new process group" \
378 "\n -0 Close standard input" \
379 "\n -1 Close standard output" \
380 "\n -2 Close standard error" \
381
Denis Vlasenkofe544582006-10-03 15:57:40 +0000382#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000383 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000384#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000385 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
386 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000387#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000388 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000389#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000390 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000391#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000392 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000393#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000394 "Set various environment variables as specified by files\n" \
395 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000396#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000397 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
398 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
399 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000400#define softlimit_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000401 "Set soft resource limits, then run prog\n" \
402 "\nOptions:" \
403 "\n -m n Same as -d n -s n -l n -a n" \
404 "\n -d n Limit the data segment per process to n bytes" \
405 "\n -s n Limit the stack segment per process to n bytes" \
406 "\n -l n Limit the locked physical pages per process to n bytes" \
407 "\n -a n Limit the total of all segments per process to n bytes" \
408 "\n -o n Limit the number of open file descriptors per process to n" \
409 "\n -p n Limit the number of processes per uid to n" \
410 "\nOptions controlling file sizes:" \
411 "\n -f n Limit output file sizes to n bytes" \
412 "\n -c n Limit core file sizes to n bytes" \
413 "\nEfficiency opts:" \
414 "\n -r n Limit the resident set size to n bytes. This limit is not" \
415 "\n enforced unless physical memory is full" \
416 "\n -t n Limit the CPU time to n seconds. This limit is not enforced" \
417 "\n except that the process receives a SIGXCPU signal after n seconds" \
418 "\n" \
419 "\nSome options may have no effect on some operating systems" \
420 "\nn may be =, indicating that soft limit should be set equal to hard limit" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000421
Eric Andersen7e9276b2001-02-22 01:15:47 +0000422#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000423 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000424#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000425 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000426#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000427 "$ ls -l /bin/ls\n" \
428 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
429 "# mount /dev/hdc1 /mnt -t minix\n" \
430 "# chroot /mnt\n" \
431 "# ls -l /bin/ls\n" \
432 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000433
Eric Andersen7e9276b2001-02-22 01:15:47 +0000434#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000435 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000436#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000437 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000438
Rob Landley856489b2006-04-18 20:57:28 +0000439#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000440 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000441#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000442 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000443
Eric Andersen7e9276b2001-02-22 01:15:47 +0000444#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000445 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000446#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000447 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000448
Eric Andersen7e9276b2001-02-22 01:15:47 +0000449#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000450 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000451#define cmp_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000452 "Compares FILE1 vs stdin if FILE2 is not specified\n" \
453 "\nOptions:" \
454 "\n -l Write the byte numbers (decimal) and values (octal)" \
455 "\n for all differing bytes" \
456 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000457
Rob Landley2acfd7b2005-05-11 23:12:49 +0000458#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000459 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000460#define comm_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000461 "Compare FILE1 to FILE2, or to stdin if - is specified\n" \
462 "\nOptions:" \
463 "\n -1 Suppress lines unique to FILE1" \
464 "\n -2 Suppress lines unique to FILE2" \
465 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000466
Paul Fox79c142d2005-08-01 16:04:40 +0000467#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000468 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000469#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000470 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000471
Rob Landley69674942006-09-11 00:34:01 +0000472#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000473 "[FILE]...\n" \
474 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000475#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000476 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000477
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000478#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000479 "[OPTION]... [prio] [pid | command [arg]...]"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000480#define chrt_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000481 "Manipulate real-time attributes of a process\n" \
482 "\nOptions:" \
483 "\n -p Operate on pid" \
484 "\n -r Set scheduling policy to SCHED_RR" \
485 "\n -f Set scheduling policy to SCHED_FIFO" \
486 "\n -o Set scheduling policy to SCHED_OTHER" \
487 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000488
489#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000490 "$ chrt -r 4 sleep 900; x=$!\n" \
491 "$ chrt -f -p 3 $x\n" \
492 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000493
Eric Andersen7e9276b2001-02-22 01:15:47 +0000494#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000495 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000496#define cp_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000497 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
498 "\nOptions:" \
499 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000500 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000501 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000502 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000503 "\n -d,-P Preserve links" \
504 "\n -H,-L Dereference all symlinks (default)" \
505 "\n -p Preserve file attributes if possible" \
506 "\n -f Force overwrite" \
507 "\n -i Prompt before overwrite" \
508 "\n -R,-r Recurse directories" \
509 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000510
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000511#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000512 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000513#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000514 "Extract or list files from a cpio archive\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000515 "Main operation mode:" \
516 "\n d Make leading directories" \
517 "\n i Extract" \
518 "\n m Preserve mtime" \
519 "\n t List" \
520 "\n v Verbose" \
521 "\n u Unconditional overwrite" \
522 "\n F Input from file" \
Tim Riker7b253f82003-12-28 05:02:40 +0000523
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000524#define crond_trivial_usage \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000525 "-fbS -l N " USE_DEBUG_CROND_OPTION("-d N ") "-L LOGFILE -c DIR"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000526#define crond_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000527 " -f Foreground" \
528 "\n -b Background (default)" \
529 "\n -S Log to syslog (default)" \
530 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000531 USE_DEBUG_CROND_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000532 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000533 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000534 "\n -L Log to file" \
535 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000536
537#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000538 "[-c DIR] [-u USER] [-ler]|[FILE]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000539#define crontab_full_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000540 " -c Crontab directory" \
541 "\n -u User" \
542 "\n -l List crontab" \
543 "\n -e Edit crontab" \
544 "\n -r Delete crontab" \
545 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000546
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000547#define cryptpw_trivial_usage \
548 "[-a des|md5] [string]"
549#define cryptpw_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000550 "Output crypted string.\n" \
551 "If string isn't supplied on cmdline, read it from stdin.\n" \
552 "\nOptions:" \
553 "\n -a Algorithm to use (default: md5)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000554
Eric Andersen7e9276b2001-02-22 01:15:47 +0000555#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000556 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000557#define cut_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000558 "Print selected fields from each input FILE to standard output\n" \
559 "\nOptions:" \
560 "\n -b LIST Output only bytes from LIST" \
561 "\n -c LIST Output only characters from LIST" \
562 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
563 "\n -s Output only the lines containing delimiter" \
564 "\n -f N Print only these fields" \
565 "\n -n Ignored" \
566
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000567#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000568 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
569 "Hello\n" \
570 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
571 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000572
Eric Andersen7e9276b2001-02-22 01:15:47 +0000573#define date_trivial_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000574 "[OPTION]... [+FMT] [TIME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000575#define date_full_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000576 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000577 "\nOptions:" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000578 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000579 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000580 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000581 "\n -I[SPEC] Output ISO-8601 compliant date string" \
582 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000583 "\n 'hours', 'minutes', or 'seconds' for date and" \
584 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000585 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000586 "\n -d TIME Display TIME, not 'now'" \
587 "\n -r FILE Display last modification time of FILE" \
588 "\n [-s] TIME Set time to TIME" \
589 USE_FEATURE_DATE_ISOFMT( \
590 "\n -D FMT Use FMT for str->date conversion" \
591 ) \
592 "\n" \
593 "\nRecognized formats for TIME:" \
594 "\n [hh:]mm:ss" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000595 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000596 "\n MMDDhhmm[[YY]YY][.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000597
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000598#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000599 "$ date\n" \
600 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000601
Eric Andersen7e9276b2001-02-22 01:15:47 +0000602#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000603 "expression..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000604#define dc_full_usage \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000605 "Tiny RPN calculator. Operations:\n" \
606 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
607 "p - print top of the stack (without altering the stack),\n" \
608 "f - print entire stack, o - pop the value and set output radix\n" \
609 "(value must be 10 or 16).\n" \
610 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000611
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000612#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000613 "$ dc 2 2 + p\n" \
614 "4\n" \
615 "$ dc 8 8 \\* 2 2 + / p\n" \
616 "16\n" \
617 "$ dc 0 1 and p\n" \
618 "0\n" \
619 "$ dc 0 1 or p\n" \
620 "1\n" \
621 "$ echo 72 9 div 8 mul p | dc\n" \
622 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000623
Eric Andersen7e9276b2001-02-22 01:15:47 +0000624#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000625 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000626 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000627#define dd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000628 "Copy a file with converting and formatting\n" \
629 "\nOptions:" \
630 "\n if=FILE Read from FILE instead of stdin" \
631 "\n of=FILE Write to FILE instead of stdout" \
632 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000633 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000634 "\n ibs=N Read N bytes at a time") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000635 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000636 "\n obs=N Write N bytes at a time") \
637 "\n count=N Copy only N input blocks" \
638 "\n skip=N Skip N input blocks" \
639 "\n seek=N Skip N output blocks" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000640 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000641 "\n conv=notrunc Don't truncate output file" \
642 "\n conv=noerror Continue after read errors" \
643 "\n conv=sync Pad blocks with zeros") \
644 "\n" \
645 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
646 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
647
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000648#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000649 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
650 "4+0 records in\n" \
651 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000652
Eric Andersen7e9276b2001-02-22 01:15:47 +0000653#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000654 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000655#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000656 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000657
Eric Andersenf349e972001-08-21 16:18:59 +0000658#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000659 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000660#define delgroup_full_usage \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000661 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000662 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000663
664#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000665 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000666#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000667 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000668
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000669#define devfsd_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000670 "mntpnt [-v]" USE_DEVFSD_FG_NP("[-fg][-np]")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000671#define devfsd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000672 "Manage devfs permissions and old device name symlinks\n" \
673 "\nOptions:" \
674 "\n mntpnt The mount point where devfs is mounted" \
675 "\n -v Print the protocol version numbers for devfsd" \
676 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000677 USE_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000678 "\n -fg Run in foreground" \
679 "\n -np Exit after parsing the configuration file" \
680 "\n and processing synthetic REGISTER events," \
681 "\n do not poll for events" \
682 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000683
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000684/* -k is accepted but ignored for !HUMAN_READABLE,
685 * but we won't mention this (unimportant) */
686#if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
687#define DF_HAS_OPTIONS(x) x
688#else
689#define DF_HAS_OPTIONS(x)
690#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000691#define df_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000692 DF_HAS_OPTIONS("[-") \
693 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
694 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000695#define df_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000696 "Print filesystem usage statistics\n" \
697 DF_HAS_OPTIONS("\nOptions:") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000698 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000699 "\n -h Human readable (e.g. 1K 243M 2G)" \
700 "\n -m 1024*1024 blocks" \
701 "\n -k 1024 blocks" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000702 ) \
703 USE_FEATURE_DF_INODE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000704 "\n -i Inodes" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000705 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000706#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000707 "$ df\n" \
708 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
709 "/dev/sda3 8690864 8553540 137324 98% /\n" \
710 "/dev/sda1 64216 36364 27852 57% /boot\n" \
711 "$ df /dev/sda3\n" \
712 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
713 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000714
Denis Vlasenko736230e2006-11-20 19:40:36 +0000715#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000716 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000717#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000718 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000719
720#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000721 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000722#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000723 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000724
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000725#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000726 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000727#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000728 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000729 "This implementation supports unified diffs only.\n" \
730 "\nOptions:" \
731 "\n -a Treat all files as text" \
732 "\n -b Ignore changes in the amount of whitespace" \
733 "\n -d Try hard to find a smaller set of changes" \
734 "\n -i Ignore case differences" \
735 "\n -L Use LABEL instead of the filename in the unified header" \
736 "\n -N Treat absent files as empty" \
737 "\n -q Output only whether files differ" \
738 "\n -r Recursively compare subdirectories" \
739 "\n -S Start with FILE when comparing directories" \
740 "\n -T Make tabs line up by prefixing a tab when necessary" \
741 "\n -s Report when two files are the same" \
742 "\n -t Expand tabs to spaces in output" \
743 "\n -U Output LINES lines of context" \
744 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000745
Eric Andersen7e9276b2001-02-22 01:15:47 +0000746#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000747 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000748#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000749 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000750#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000751 "$ dirname /tmp/foo\n" \
752 "/tmp\n" \
753 "$ dirname /tmp/foo/\n" \
754 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000755
Eric Andersen7e9276b2001-02-22 01:15:47 +0000756#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000757 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000758#define dmesg_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000759 "Print or control the kernel ring buffer\n" \
760 "\nOptions:" \
761 "\n -c Clear ring buffer after printing" \
762 "\n -n LEVEL Set console logging level" \
763 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000764
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000765#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000766 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000767#define dnsd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000768 "Small static DNS server daemon\n" \
769 "\nOptions:" \
770 "\n -c Config filename" \
771 "\n -t TTL in seconds" \
772 "\n -p Listening port" \
773 "\n -i Listening ip (default all)" \
774 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000775
Eric Andersen7e9276b2001-02-22 01:15:47 +0000776#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000777 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000778#define dos2unix_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000779 "Convert FILE from dos to unix format.\n" \
780 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000781 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000782 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000783 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000784
Eric Andersen7e9276b2001-02-22 01:15:47 +0000785#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000786 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000787#define dpkg_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000788 "Install, remove and manage Debian packages\n" \
789 "\nOptions:" \
790 "\n -i Install the package" \
791 "\n -l List of installed packages" \
792 "\n -C Configure an unpackaged package" \
793 "\n -F depends Ignore dependency problems" \
794 "\n -P Purge all files of a package" \
795 "\n -r Remove all but the configuration files for a package" \
796 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000797
Eric Andersen7e9276b2001-02-22 01:15:47 +0000798#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000799 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000800#define dpkg_deb_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000801 "Perform actions on Debian packages (.debs)\n" \
802 "\nOptions:" \
803 "\n -c List contents of filesystem tree" \
804 "\n -e Extract control files to [argument] directory" \
805 "\n -f Display control field name starting with [argument]" \
806 "\n -x Extract packages filesystem tree to directory" \
807 "\n -X Verbose extract" \
808
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000809#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000810 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000811
Eric Andersen7e9276b2001-02-22 01:15:47 +0000812#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000813 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000814#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000815 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000816 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000817 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
818 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000819 " bytes.\n" \
820 "\nOptions:" \
821 "\n -a Show file sizes too" \
822 "\n -H Follow symlinks on command line" \
823 "\n -L Follow all symlinks" \
824 "\n -d N Limit output to directories (and files with -a) of depth < N" \
825 "\n -c Show grand total" \
826 "\n -l Count sizes many times if hard linked" \
827 "\n -s Display only a total for each argument" \
828 "\n -x Skip directories on different filesystems" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000829 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000830 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
831 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000832 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000833 "\n -k Sizes in kilobytes" \
834 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
835
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000836#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000837 "$ du\n" \
838 "16 ./CVS\n" \
839 "12 ./kernel-patches/CVS\n" \
840 "80 ./kernel-patches\n" \
841 "12 ./tests/CVS\n" \
842 "36 ./tests\n" \
843 "12 ./scripts/CVS\n" \
844 "16 ./scripts\n" \
845 "12 ./docs/CVS\n" \
846 "104 ./docs\n" \
847 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000848
Eric Andersen7e9276b2001-02-22 01:15:47 +0000849#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000850 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000851#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000852 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000853#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000854 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000855
Russ Dill61fb4892002-10-14 21:41:28 +0000856#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000857 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000858#define dumpleases_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000859 "Display DHCP leases granted by udhcpd\n" \
860 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000861 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000862 "\n -f,--file=FILE Leases file to load" \
863 "\n -r,--remaining Interpret lease times as time remaining" \
864 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000865 ) \
866 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000867 "\n -f FILE Leases file to load" \
868 "\n -r Interpret lease times as time remaining" \
869 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000870 )
Russ Dill61fb4892002-10-14 21:41:28 +0000871
Mike Frysinger51a43b42005-09-24 07:11:16 +0000872#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000873 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
874 "[-I inode_buffer_blocks] [-P process_inode_size] " \
875 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
876 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000877#define e2fsck_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000878 "Check ext2/ext3 file system\n" \
879 "\nOptions:" \
880 "\n -p Automatic repair (no questions)" \
881 "\n -n Make no changes to the filesystem" \
882 "\n -y Assume 'yes' to all questions" \
883 "\n -c Check for bad blocks and add them to the badblock list" \
884 "\n -f Force checking even if filesystem is marked clean" \
885 "\n -v Verbose" \
886 "\n -b superblock Use alternative superblock" \
887 "\n -B blocksize Force blocksize when looking for superblock" \
888 "\n -j journal Set location of the external journal" \
889 "\n -l file Add to badblocks list" \
890 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000891
Eric Andersen7e9276b2001-02-22 01:15:47 +0000892#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000893 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000894#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000895 "Print the specified ARGs to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000896 USE_FEATURE_FANCY_ECHO( "\n" \
897 "\nOptions:" \
898 "\n -n Suppress trailing newline" \
899 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
900 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000901 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000902#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000903 "$ echo \"Erik is cool\"\n" \
904 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000905 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000906 "Erik\n" \
907 "is\n" \
908 "cool\n" \
909 "$ echo \"Erik\\nis\\ncool\"\n" \
910 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000911
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000912#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000913 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000914#define eject_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000915 "Eject specified DEVICE (or default /dev/cdrom)\n" \
916 "\nOptions:" \
917 USE_FEATURE_EJECT_SCSI( \
918 "\n -s SCSI device" \
919 ) \
920 "\n -t Close tray" \
921 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000922
Rob Landley3b890392006-05-04 20:56:43 +0000923#define ed_trivial_usage ""
924#define ed_full_usage ""
925
Eric Andersen84e229c2001-03-29 22:48:33 +0000926#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000927 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000928#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000929 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000930 "up the specified environment\n" \
931 "\nOptions:" \
932 "\n -, -i Start with an empty environment" \
933 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +0000934
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000935#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000936 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000937#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000938 "Send a magic packet to wake up sleeping machines.\n" \
939 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000940 "a hostname with a known 'ethers' entry.\n" \
941 "\nOptions:" \
942 "\n -b Send wake-up packet to the broadcast address" \
943 "\n -i iface Interface to use (default eth0)" \
944 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000945
Denis Vlasenko3952f202007-08-13 14:10:24 +0000946#define expand_trivial_usage \
947 "[-i] [-t NUM] [FILE|-]"
948#define expand_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000949 "Convert tabs to spaces, writing to standard output.\n" \
950 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000951 USE_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000952 "\n -i,--initial Do not convert tabs after non blanks" \
953 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000954 ) \
955 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000956 "\n -i Do not convert tabs after non blanks" \
957 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000958 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000959
Eric Andersen7e9276b2001-02-22 01:15:47 +0000960#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000961 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000962#define expr_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000963 "Print the value of EXPRESSION to standard output.\n" \
964 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000965 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000966 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
967 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
968 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
969 " ARG1 <= ARG2\n" \
970 " ARG1 = ARG2\n" \
971 " ARG1 != ARG2\n" \
972 " ARG1 >= ARG2\n" \
973 " ARG1 > ARG2\n" \
974 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
975 " ARG1 - ARG2\n" \
976 " ARG1 * ARG2\n" \
977 " ARG1 / ARG2\n" \
978 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000979 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
980 " match STRING REGEXP Same as STRING : REGEXP\n" \
981 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
982 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
983 " length STRING Length of STRING\n" \
984 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000985 " it is a keyword like 'match' or an\n" \
986 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000987 " (EXPRESSION) Value of EXPRESSION\n" \
988 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000989 "Beware that many operators need to be escaped or quoted for shells.\n" \
990 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000991 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000992 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
993 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000994
Mike Frysingerfa69f112005-04-17 07:24:19 +0000995#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000996 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000997#define fakeidentd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000998 "Provide fake ident (auth) service\n" \
999 "\nOptions:" \
1000 "\n -f Run in foreground" \
1001 "\n -i Inetd mode" \
1002 "\n -w Inetd 'wait' mode" \
1003 "\n -b ADDR Bind to specified address" \
1004 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001005
Eric Andersen7e9276b2001-02-22 01:15:47 +00001006#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001007 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001008#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001009 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001010
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001011#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001012 "$ false\n" \
1013 "$ echo $?\n" \
1014 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001015
1016#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001017 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001018#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001019 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001020
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001021#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001022 "$ fbset\n" \
1023 "mode \"1024x768-76\"\n" \
1024 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1025 " geometry 1024 768 1024 768 16\n" \
1026 " timings 12714 128 32 16 4 128 4\n" \
1027 " accel false\n" \
1028 " rgba 5/11,6/5,5/0,0/0\n" \
1029 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001030
Eric Andersen7e9276b2001-02-22 01:15:47 +00001031#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001032 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001033#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001034 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001035
Eric Andersen01c3d402003-07-05 07:51:31 +00001036#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001037 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +00001038#define fdformat_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001039 "Format floppy disk\n" \
1040 "\nOptions:" \
1041 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001042
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001043/* Looks like someone forgot to add this to config system */
1044#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1045# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1046# define USE_FEATURE_FDISK_BLKSIZE(a)
1047#endif
1048
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001049#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001050 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1051 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001052#define fdisk_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001053 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001054 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001055 "\n -u Start and End are in sectors (instead of cylinders)" \
1056 "\n -l Show partition table for each DISK, then exit" \
1057 USE_FEATURE_FDISK_BLKSIZE( \
1058 "\n -s Show partition sizes in kb for each DISK, then exit" \
1059 ) \
1060 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1061 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1062 "\n -H HEADS\n" \
1063 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001064
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001065#define fetchmail_trivial_usage \
Denis Vlasenko17db1a92008-02-26 21:13:17 +00001066 "[-w timeout] [-U user] -P password [-X] [-t] [-z] server[:port] maildir [prog]"
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001067#define fetchmail_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001068 "Fetch content of remote mailbox to local Maildir.\n" \
1069 "\nOptions:" \
1070 "\n -w timeout Set timeout on network operations" \
1071 "\n -U username Authenticate with specified username/password" \
1072 "\n -P password" \
1073 "\n -X Use openssl connection helper for secured servers" \
1074 "\n -t Get only headers" \
1075 "\n -z Delete messages on server" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00001076 "\n prog Run prog <message_file> on message delivery" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001077
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001078#define findfs_trivial_usage \
1079 "LABEL=label or UUID=uuid"
1080#define findfs_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001081 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001082#define findfs_example_usage \
1083 "$ findfs LABEL=MyDevice"
1084
Eric Andersen7e9276b2001-02-22 01:15:47 +00001085#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001086 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001087#define find_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001088 "Search for files. The default PATH is the current directory,\n" \
1089 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001090 "\nEXPRESSION may consist of:" \
1091 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001092 USE_FEATURE_FIND_XDEV( \
1093 "\n -xdev Don't descend directories on other filesystems") \
1094 USE_FEATURE_FIND_MAXDEPTH( \
1095 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1096 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001097 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001098 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001099 USE_FEATURE_FIND_PATH( \
1100 "\n -path PATTERN Path matches PATTERN") \
1101 USE_FEATURE_FIND_REGEX( \
1102 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001103 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001104 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001105 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001106 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001107 "\n or exactly (NNN)") \
1108 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001109 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001110 "\n or exactly (N) days") \
1111 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001112 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001113 "\n or exactly (N) minutes") \
1114 USE_FEATURE_FIND_NEWER( \
1115 "\n -newer FILE Modified time is more recent than FILE's") \
1116 USE_FEATURE_FIND_INUM( \
1117 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001118 USE_FEATURE_FIND_USER( \
1119 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1120 USE_FEATURE_FIND_GROUP( \
1121 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1122 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001123 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001124 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001125 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1126 "\n +/-N: file size is bigger/smaller than N") \
1127 "\n -print Print (default and assumed)" \
1128 USE_FEATURE_FIND_PRINT0( \
1129 "\n -print0 Delimit output with null characters rather than" \
1130 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001131 USE_FEATURE_FIND_CONTEXT ( \
1132 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001133 USE_FEATURE_FIND_EXEC( \
1134 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1135 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001136 USE_FEATURE_FIND_PRUNE( \
1137 "\n -prune Stop traversing current subtree") \
1138 USE_FEATURE_FIND_DELETE( \
1139 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001140 USE_FEATURE_FIND_PAREN( \
1141 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001142
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001143#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001144 "$ find / -name passwd\n" \
1145 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001146
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001147#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001148 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001149#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001150 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001151 "standard output\n" \
1152 "\nOptions:" \
1153 "\n -b Count bytes rather than columns" \
1154 "\n -s Break at spaces" \
1155 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001156
Eric Andersen7e9276b2001-02-22 01:15:47 +00001157#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001158 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001159#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001160 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001161#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001162 "$ free\n" \
1163 " total used free shared buffers\n" \
1164 " Mem: 257628 248724 8904 59644 93124\n" \
1165 " Swap: 128516 8404 120112\n" \
1166 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001167
Eric Andersen7e9276b2001-02-22 01:15:47 +00001168#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001169 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001170#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001171 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001172#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001173 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001174
Mike Frysinger51a43b42005-09-24 07:11:16 +00001175#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001176 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001177#define fsck_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001178 "Check and repair filesystems\n" \
1179 "\nOptions:" \
1180 "\n -A Walk /etc/fstab and check all filesystems" \
1181 "\n -N Don't execute, just show what would be done" \
1182 "\n -P With -A, check filesystems in parallel" \
1183 "\n -R With -A, skip the root filesystem" \
1184 "\n -T Don't show title on startup" \
1185 "\n -V Verbose" \
1186 "\n -C n Write status information to specified filedescriptor" \
1187 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001188
Eric Andersen7e9276b2001-02-22 01:15:47 +00001189#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001190 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001191#define fsck_minix_full_usage \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001192 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001193 "\nOptions:" \
1194 "\n -l List all filenames" \
1195 "\n -r Perform interactive repairs" \
1196 "\n -a Perform automatic repairs" \
1197 "\n -v Verbose" \
1198 "\n -s Output super-block information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001199 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001200 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001201
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001202#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001203 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001204#define ftpget_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001205 "Retrieve a remote file via FTP\n" \
1206 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001207 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001208 "\n -c,--continue Continue previous transfer" \
1209 "\n -v,--verbose Verbose" \
1210 "\n -u,--username Username" \
1211 "\n -p,--password Password" \
1212 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001213 ) \
1214 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001215 "\n -c Continue previous transfer" \
1216 "\n -v Verbose" \
1217 "\n -u Username" \
1218 "\n -p Password" \
1219 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001220 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001221
1222#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001223 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001224#define ftpput_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001225 "Store a local file on a remote machine via FTP\n" \
1226 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001227 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001228 "\n -v,--verbose Verbose" \
1229 "\n -u,--username Username" \
1230 "\n -p,--password Password" \
1231 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001232 ) \
1233 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001234 "\n -v Verbose" \
1235 "\n -u Username" \
1236 "\n -p Password" \
1237 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001238 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001239
Rob Landleyaa872762005-10-28 13:05:12 +00001240#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001241 "[options] FILE or PORT/PROTO"
Rob Landleyaa872762005-10-28 13:05:12 +00001242#define fuser_full_usage \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001243 "Find processes which use FILEs or PORTs\n" \
1244 "\nOptions:" \
1245 "\n -m Find processes which use same fs as FILEs" \
1246 "\n -4 Search only IPv4 space" \
1247 "\n -6 Search only IPv6 space" \
1248 "\n -s Silent: just exit with 0 if any processes are found" \
1249 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001250 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001251
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001252#define getenforce_trivial_usage
1253#define getenforce_full_usage
1254
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001256 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001257#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001258 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001259 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001260 "\n -a,--alternative Allow long options starting with single -" \
1261 "\n -l,--longoptions=longopts Long options to be recognized" \
1262 "\n -n,--name=progname The name under which errors are reported" \
1263 "\n -o,--options=optstring Short options to be recognized" \
1264 "\n -q,--quiet Disable error reporting by getopt(3)" \
1265 "\n -Q,--quiet-output No normal output" \
1266 "\n -s,--shell=shell Set shell quoting conventions" \
1267 "\n -T,--test Test for getopt(1) version" \
1268 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001269 ) \
1270 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001271 "\n -a Allow long options starting with single -" \
1272 "\n -l longopts Long options to be recognized" \
1273 "\n -n progname The name under which errors are reported" \
1274 "\n -o optstring Short options to be recognized" \
1275 "\n -q Disable error reporting by getopt(3)" \
1276 "\n -Q No normal output" \
1277 "\n -s shell Set shell quoting conventions" \
1278 "\n -T Test for getopt(1) version" \
1279 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001280 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001281#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001282 "$ cat getopt.test\n" \
1283 "#!/bin/sh\n" \
1284 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1285 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001286 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001287 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001288 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001289 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001290 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1291 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001292 " -c|--c-long)\n" \
1293 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001294 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1295 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1296 " esac;;\n" \
1297 " --) shift; break;;\n" \
1298 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001299 " esac\n" \
1300 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001301
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001302#define getsebool_trivial_usage \
1303 "-a or getsebool boolean..."
1304#define getsebool_full_usage \
1305 " -a Show all SELinux booleans"
1306
Eric Andersenf349e972001-08-21 16:18:59 +00001307#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001308 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Eric Andersenf349e972001-08-21 16:18:59 +00001309#define getty_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001310 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1311 "\nOptions:" \
1312 "\n -h Enable hardware (RTS/CTS) flow control" \
1313 "\n -i Do not display /etc/issue before running login" \
1314 "\n -L Local line, do not do carrier detect" \
1315 "\n -m Get baud rate from modem's CONNECT status message" \
1316 "\n -w Wait for a CR or LF before sending /etc/issue" \
1317 "\n -n Do not prompt the user for a login name" \
1318 "\n -f issue_file Display issue_file instead of /etc/issue" \
1319 "\n -l login_app Invoke login_app instead of /bin/login" \
1320 "\n -t timeout Terminate after timeout if no username is read" \
1321 "\n -I initstring Init string to send before anything else" \
1322 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001323
Eric Andersen7e9276b2001-02-22 01:15:47 +00001324#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001325 "[-HhrilLnqvso" \
1326 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001327 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001328 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1329 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001330 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001331#define grep_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001332 "Search for PATTERN in each FILE or standard input\n" \
1333 "\nOptions:" \
1334 "\n -H Prefix output lines with filename where match was found" \
1335 "\n -h Suppress the prefixing filename on output" \
1336 "\n -r Recurse subdirectories" \
1337 "\n -i Ignore case distinctions" \
1338 "\n -l List names of files that match" \
1339 "\n -L List names of files that do not match" \
1340 "\n -n Print line number with output lines" \
1341 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1342 "\n -v Select non-matching lines" \
1343 "\n -s Suppress file open/read error messages" \
1344 "\n -c Only print count of matching lines" \
1345 "\n -o Show only the part of a line that matches PATTERN" \
1346 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001347 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001348 "\n -w Match whole words only") \
1349 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001350 USE_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001351 "\n -E PATTERN is an extended regular expression") \
1352 "\n -e PTRN Pattern to match" \
1353 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001354 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001355 "\n -A Print NUM lines of trailing context" \
1356 "\n -B Print NUM lines of leading context" \
1357 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001358
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001359#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001360 "$ grep root /etc/passwd\n" \
1361 "root:x:0:0:root:/root:/bin/bash\n" \
1362 "$ grep ^[rR]oo. /etc/passwd\n" \
1363 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001364
Eric Andersen7e9276b2001-02-22 01:15:47 +00001365#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001366 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001367#define gunzip_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001368 "Uncompress FILEs (or standard input)\n" \
1369 "\nOptions:" \
1370 "\n -c Write to standard output" \
1371 "\n -f Force" \
1372 "\n -t Test file integrity" \
1373
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001374#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001375 "$ ls -la /tmp/BusyBox*\n" \
1376 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1377 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1378 "$ ls -la /tmp/BusyBox*\n" \
1379 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001380
1381#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001382 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001383#define gzip_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001384 "Compress FILEs (or standard input)\n" \
1385 "\nOptions:" \
1386 "\n -c Write to standard output" \
1387 "\n -d Decompress" \
1388 "\n -f Force" \
1389
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001390#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001391 "$ ls -la /tmp/busybox*\n" \
1392 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1393 "$ gzip /tmp/busybox.tar\n" \
1394 "$ ls -la /tmp/busybox*\n" \
1395 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001396
1397#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001398 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001399#define halt_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001400 "Halt the system\n" \
1401 "\nOptions:" \
1402 "\n -d Delay interval for halting" \
1403 "\n -n No call to sync()" \
1404 "\n -f Force halt (don't go through init)" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001405 USE_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001406 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001407 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001408
Eric Andersen3443bd72003-07-22 07:30:36 +00001409#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001410 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001411#define hdparm_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001412 "Options:" \
1413 "\n -a Get/set fs readahead" \
1414 "\n -A Set drive read-lookahead flag (0/1)" \
1415 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1416 "\n -B Set Advanced Power Management setting (1-255)" \
1417 "\n -c Get/set IDE 32-bit IO setting" \
1418 "\n -C Check IDE power mode status" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001419 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001420 "\n -d Get/set using_dma flag") \
1421 "\n -D Enable/disable drive defect-mgmt" \
1422 "\n -f Flush buffer cache for device on exit" \
1423 "\n -g Display drive geometry" \
1424 "\n -h Display terse usage information" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001425 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001426 "\n -i Display drive identification") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001427 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001428 "\n -I Detailed/current information directly from drive") \
1429 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1430 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1431 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1432 "\n -m Get/set multiple sector count" \
1433 "\n -n Get/set ignore-write-errors flag (0/1)" \
1434 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1435 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001436/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001437 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1438 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001439 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001440 "\n -R Register an IDE interface (DANGEROUS)") \
1441 "\n -S Set standby (spindown) timeout" \
1442 "\n -t Perform device read timings" \
1443 "\n -T Perform cache read timings" \
1444 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001445 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001446 "\n -U Un-register an IDE interface (DANGEROUS)") \
1447 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1448 "\n -V Display program version and exit immediately" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001449 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001450 "\n -w Perform device reset (DANGEROUS)") \
1451 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001452 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001453 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1454 "\n -X Set IDE xfer mode (DANGEROUS)" \
1455 "\n -y Put IDE drive in standby mode" \
1456 "\n -Y Put IDE drive to sleep" \
1457 "\n -Z Disable Seagate auto-powersaving mode" \
1458 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001459
Eric Andersen7e9276b2001-02-22 01:15:47 +00001460#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001461 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001462#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001463 "Print first 10 lines of each FILE to standard output.\n" \
1464 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001465 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1466 "\nOptions:" \
1467 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001468 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001469 "\n -c NUM Output the first NUM bytes" \
1470 "\n -q Never output headers giving file names" \
1471 "\n -v Always output headers giving file names") \
1472
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001473#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001474 "$ head -n 2 /etc/passwd\n" \
1475 "root:x:0:0:root:/root:/bin/bash\n" \
1476 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001477
Glenn L McGrath60281112001-11-02 11:39:46 +00001478#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001479 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Glenn L McGrath60281112001-11-02 11:39:46 +00001480#define hexdump_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001481 "Display file(s) or standard input in a user specified format\n" \
1482 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001483 "\n -b One-byte octal display" \
1484 "\n -c One-byte character display" \
1485 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1486 "\n -d Two-byte decimal display" \
1487 "\n -e FORMAT STRING" \
1488 "\n -f FORMAT FILE" \
1489 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1490 "\n -o Two-byte octal display" \
1491 "\n -s OFFSET Skip OFFSET bytes" \
1492 "\n -v Display all input data" \
1493 "\n -x Two-byte hexadecimal display" \
1494 USE_FEATURE_HEXDUMP_REVERSE( \
1495 "\n -R Reverse of 'hexdump -Cv'") \
1496
1497#define hd_trivial_usage \
1498 "FILE..."
1499#define hd_full_usage \
1500 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001501
Eric Andersen7e9276b2001-02-22 01:15:47 +00001502#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001503 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001504#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001505 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001506
1507#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001508 "[OPTION] [hostname | -F FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001509#define hostname_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001510 "Get or set hostname or DNS domain name\n" \
1511 "\nOptions:" \
1512 "\n -s Short" \
1513 "\n -i Addresses for the hostname" \
1514 "\n -d DNS domain name" \
1515 "\n -f Fully qualified domain name" \
1516 "\n -F FILE Use the contents of FILE to specify the hostname" \
1517
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001518#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001519 "$ hostname\n" \
1520 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001521
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001522#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001523 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001524 " [-p [ip:]port]" \
1525 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001526 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001527 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001528 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001529 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001530 " [-d/-e string]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001531#define httpd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001532 "Listen for incoming HTTP requests\n" \
1533 "\nOptions:" \
1534 "\n -c FILE Configuration file (default httpd.conf)" \
1535 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1536 "\n -i Inetd mode" \
1537 "\n -f Do not daemonize" \
1538 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001539 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001540 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001541 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001542 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001543 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001544 "\n -m PASS Crypt PASS with md5 algorithm") \
1545 "\n -h HOME Home directory (default .)" \
1546 "\n -e STRING HTML encode STRING" \
1547 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001548
Robert Griebl1cd04452002-07-21 16:50:49 +00001549#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001550 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001551 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1552 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001553 " [-f FILE]" \
1554 ) \
1555 SKIP_GETOPT_LONG( \
1556 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1557 )
Robert Griebl1cd04452002-07-21 16:50:49 +00001558#define hwclock_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001559 "Query and set hardware clock (RTC)\n" \
1560 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001561 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001562 "\n -s Set system time from hardware clock" \
1563 "\n -w Set hardware clock to system time" \
1564 "\n -u Hardware clock is in UTC" \
1565 "\n -l Hardware clock is in local time" \
1566 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001567
Eric Andersen7e9276b2001-02-22 01:15:47 +00001568#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001569 "[OPTIONS]... [USER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001570#define id_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001571 "Print information about USER or the current user\n" \
1572 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001573 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001574 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001575 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001576 "\n -g Print group ID" \
1577 "\n -u Print user ID" \
1578 "\n -n Print name instead of a number" \
1579 "\n -r Print real user ID instead of effective ID" \
1580
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001581#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001582 "$ id\n" \
1583 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001584
Eric Andersen7e9276b2001-02-22 01:15:47 +00001585#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001586 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001587#define ifconfig_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001588 "Configure a network interface\n" \
1589 "\nOptions:" \
1590 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001591 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001592 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001593 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001594 " [del ADDRESS[/PREFIXLEN]]\n") \
1595 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1596 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001597 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001598 " [outfill NN] [keepalive NN]\n") \
1599 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001600 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001601 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001602 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001603 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001604 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001605
Denis Vlasenko06aed432008-02-26 18:25:24 +00001606#define ifenslave_trivial_usage \
1607 "[-cdf] master-iface <slave-iface...>"
1608#define ifenslave_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001609 "Configure network interfaces for parallel routing\n" \
1610 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001611 "\n -c, --change-active Change active slave" \
1612 "\n -d, --detach Remove slave interface from bonding device" \
1613 "\n -f, --force Force, even if interface is not Ethernet" \
1614/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001615
Denis Vlasenko06aed432008-02-26 18:25:24 +00001616#define ifenslave_example_usage \
1617 "To create a bond device, simply follow these three steps :\n" \
1618 "- ensure that the required drivers are properly loaded :\n" \
1619 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1620 "- assign an IP address to the bond device :\n" \
1621 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1622 "- attach all the interfaces you need to the bond device :\n" \
1623 " # ifenslave bond0 eth0 eth1 eth2\n" \
1624 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1625 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1626 " To detach a dead interface without setting the bond device down :\n" \
1627 " # ifenslave -d bond0 eth1\n\n" \
1628 " To set the bond device down and automatically release all the slaves :\n" \
1629 " # ifconfig bond0 down\n\n" \
1630 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001631 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001632
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001633#define ifup_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001634 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001635#define ifup_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001636 "Options:" \
1637 "\n -a De/configure all interfaces automatically" \
1638 "\n -i FILE Use FILE for interface definitions" \
1639 "\n -n Print out what would happen, but don't do it" \
1640 "\n (note: doesn't disable mappings)" \
1641 "\n -v Print out what would happen before doing it" \
1642 "\n -m Don't run any mappings" \
1643 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001644
1645#define ifdown_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001646 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001647#define ifdown_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001648 "Options:" \
1649 "\n -a De/configure all interfaces automatically" \
1650 "\n -i FILE Use FILE for interface definitions" \
1651 "\n -n Print out what would happen, but don't do it" \
1652 "\n (note: doesn't disable mappings)" \
1653 "\n -v Print out what would happen before doing it" \
1654 "\n -m Don't run any mappings" \
1655 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001656
Glenn L McGrath06e95652003-02-09 06:51:14 +00001657#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001658 "[-fe] [-q N] [-R N] [CONFFILE]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001659#define inetd_full_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001660 "Listen for network connections and launch programs\n" \
1661 "\nOptions:" \
1662 "\n -f Run in foreground" \
1663 "\n -e Log to stderr" \
1664 "\n -q N Socket listen queue (default: 128)" \
1665 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001666 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001667
Eric Andersen7e9276b2001-02-22 01:15:47 +00001668#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001669 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001670#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001671 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001672
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001673#define init_notes_usage \
1674"This version of init is designed to be run only by the kernel.\n" \
1675"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001676"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001677"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001678"runlevels, use sysvinit.\n" \
1679"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001680"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001681"it has the following default behavior:\n" \
1682"\n" \
1683" ::sysinit:/etc/init.d/rcS\n" \
1684" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001685" ::ctrlaltdel:/sbin/reboot\n" \
1686" ::shutdown:/sbin/swapoff -a\n" \
1687" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001688" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001689"\n" \
1690"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1691"\n" \
1692" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001693" tty3::askfirst:/bin/sh\n" \
1694" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001695"\n" \
1696"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1697"\n" \
1698" <id>:<runlevels>:<action>:<process>\n" \
1699"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001700" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001701"\n" \
1702" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1703" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001704" the specified process to run on. The contents of this field are\n" \
1705" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1706" be unique, although if it isn't you may have strange results. If this\n" \
1707" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001708" note that if BusyBox detects that a serial console is in use, then only\n" \
1709" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001710" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001711" stinkin' utmp.\n" \
1712"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001713" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001714"\n" \
1715" The runlevels field is completely ignored.\n" \
1716"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001717" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001718"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001719" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001720" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001721"\n" \
1722" The available actions can be classified into two groups: actions\n" \
1723" that are run only once, and actions that are re-run when the specified\n" \
1724" process exits.\n" \
1725"\n" \
1726" Run only-once actions:\n" \
1727"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001728" 'sysinit' is the first item run on boot. init waits until all\n" \
1729" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001730" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001731" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001732" the specified task completes. 'once' actions are asynchronous,\n" \
1733" therefore, init does not wait for them to complete. 'restart' is\n" \
1734" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001735" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001736" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001737" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001738" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001739" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001740" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001741" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001742" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001743"\n" \
1744" Run repeatedly actions:\n" \
1745"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001746" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001747" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001748" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1749" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001750" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001751" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001752" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001753" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001754"\n" \
1755" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001756" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001757" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001758"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001759" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001760"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001761" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001762"\n" \
1763"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001764"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001765" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001766" #\n" \
1767" ::sysinit:/etc/init.d/rcS\n" \
1768" \n" \
1769" # /bin/sh invocations on selected ttys\n" \
1770" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001771" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001772" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001773" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001774" tty2::askfirst:-/bin/sh\n" \
1775" tty3::askfirst:-/bin/sh\n" \
1776" tty4::askfirst:-/bin/sh\n" \
1777" \n" \
1778" # /sbin/getty invocations for selected ttys\n" \
1779" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001780" tty4::respawn:/sbin/getty 38400 tty4\n" \
1781" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001782" \n" \
1783" \n" \
1784" # Example of how to put a getty on a serial line (for a terminal)\n" \
1785" #\n" \
1786" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1787" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1788" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001789" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001790" #::respawn:/sbin/getty 57600 ttyS2\n" \
1791" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001792" # Stuff to do when restarting the init process\n" \
1793" ::restart:/sbin/init\n" \
1794" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001795" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001796" ::ctrlaltdel:/sbin/reboot\n" \
1797" ::shutdown:/bin/umount -a -r\n" \
1798" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001799
1800#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001801 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001802#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001803 "Load the specified kernel modules into the kernel" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001804 USE_FEATURE_2_4_MODULES( "\n" \
1805 "\nOptions:" \
1806 "\n -f Force module to load into the wrong kernel version" \
1807 "\n -k Make module autoclean-able" \
1808 "\n -v Verbose" \
1809 "\n -q Quiet" \
1810 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001811 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001812 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001813 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001814 "\n -o NAME Set internal module name to NAME" \
1815 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001816 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001817
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001818#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001819 "[-cgmops] [sources] dest|directory"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001820#define install_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001821 "Copy files and set attributes\n" \
1822 "\nOptions:" \
1823 "\n -c Copy the file, default" \
1824 "\n -d Create directories" \
1825 "\n -g Set group ownership" \
1826 "\n -m Set permissions" \
1827 "\n -o Set ownership" \
1828 "\n -p Preserve date" \
1829 "\n -s Strip symbol tables" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001830 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001831 "\n -Z Set security context of copy" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001832 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001833
1834/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001835#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001836 "[OPTIONS] {" \
1837 USE_FEATURE_IP_ADDRESS("address | ") \
1838 USE_FEATURE_IP_ROUTE("route | ") \
1839 USE_FEATURE_IP_LINK("link | ") \
1840 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1841 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001842 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001843#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001844 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001845 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001846 USE_FEATURE_IP_ADDRESS("address | ") \
1847 USE_FEATURE_IP_ROUTE("route | ") \
1848 USE_FEATURE_IP_LINK("link | ") \
1849 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1850 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001851 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001852 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001853
1854#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001855 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001856 " [dev STRING] [to PREFIX] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001857#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001858 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001859 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1860 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001861 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001862 " [broadcast ADDR] [anycast ADDR]\n" \
1863 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001864 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001865
Eric Andersende4f07e2003-12-11 01:18:07 +00001866#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001867 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001868#define ipcalc_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001869 "Calculate IP network settings from a IP address\n" \
1870 "\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001871 USE_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001872 "\n -b,--broadcast Display calculated broadcast address" \
1873 "\n -n,--network Display calculated network address" \
1874 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001875 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001876 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1877 "\n -h,--hostname Display first resolved host name" \
1878 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001879 ) \
1880 ) \
1881 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001882 "\n -b Display calculated broadcast address" \
1883 "\n -n Display calculated network address" \
1884 "\n -m Display default netmask for IP" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001885 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001886 "\n -p Display the prefix for IP/NETMASK" \
1887 "\n -h Display first resolved host name" \
1888 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001889 ) \
1890 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001891
Rob Landley6eb1e412005-06-20 04:30:36 +00001892#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001893 "[-MQS key] [-mqs id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001894#define ipcrm_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001895 "Upper-case options MQS remove an object by shmkey value.\n" \
1896 "Lower-case options remove an object by shmid value.\n" \
1897 "\nOptions:" \
1898 "\n -mM Remove memory segment after last detach" \
1899 "\n -qQ Remove message queue" \
1900 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001901
1902#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001903 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001904#define ipcs_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001905 " -i Show specific resource" \
1906 "\nResource specification:" \
1907 "\n -m Shared memory segments" \
1908 "\n -q Message queues" \
1909 "\n -s Semaphore arrays" \
1910 "\n -a All (default)" \
1911 "\nOutput format:" \
1912 "\n -t Time" \
1913 "\n -c Creator" \
1914 "\n -p Pid" \
1915 "\n -l Limits" \
1916 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001917
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001918#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001919 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001920#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001921 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001922 " dynamic { on | off } |\n" \
1923 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001924 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001925
1926#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001927 "{ list | flush | { add | del | change | append |\n" \
1928 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001929#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001930 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001931 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1932 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001933 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001934 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001935 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001936
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001937#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001938 "{[list | add | del] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001939#define iprule_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001940 "iprule [list | add | del] SELECTOR ACTION\n" \
1941 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1942 " [dev STRING] [pref NUMBER]\n" \
1943 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1944 " [prohibit | reject | unreachable]\n" \
1945 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001946 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001947
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001948#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001949 "{ add | change | del | show } [NAME]\n" \
1950 " [mode { ipip | gre | sit }]\n" \
1951 " [remote ADDR] [local ADDR] [ttl TTL]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001952#define iptunnel_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001953 "iptunnel { add | change | del | show } [NAME]\n" \
1954 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1955 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001956 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001957
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001958#define kbd_mode_trivial_usage \
1959 "[-a|k|s|u]"
1960#define kbd_mode_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001961 "Report or set the keyboard mode\n" \
1962 "\nOptions set mode:" \
1963 "\n -a Default (ASCII)" \
1964 "\n -k Medium-raw (keyboard)" \
1965 "\n -s Raw (scancode)" \
1966 "\n -u Unicode (utf-8)" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001967
Eric Andersen7e9276b2001-02-22 01:15:47 +00001968#define kill_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001969 "[-l] [-signal] process-id..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001970#define kill_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001971 "Send a signal (default is TERM) to the specified process(es)\n" \
1972 "\nOptions:" \
1973 "\n -l List all signal names and numbers" \
1974
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001975#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001976 "$ ps | grep apache\n" \
1977 "252 root root S [apache]\n" \
1978 "263 www-data www-data S [apache]\n" \
1979 "264 www-data www-data S [apache]\n" \
1980 "265 www-data www-data S [apache]\n" \
1981 "266 www-data www-data S [apache]\n" \
1982 "267 www-data www-data S [apache]\n" \
1983 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001984
1985#define killall_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001986 "[-l] [-q] [-signal] process-name..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001987#define killall_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001988 "Send a signal (default is TERM) to the specified process(es)\n" \
1989 "\nOptions:" \
1990 "\n -l List all signal names and numbers" \
1991 "\n -q Do not complain if no processes were killed" \
1992
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001993#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001994 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001995
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001996#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001997 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001998#define killall5_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001999 "Send a signal (default is TERM) to all processes outside current session\n" \
2000 "\nOptions:" \
2001 "\n -l List all signal names and numbers" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002002
Mark Whitley6317c4b2001-03-12 22:51:50 +00002003#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002004 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00002005#define klogd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002006 "Kernel logger\n" \
2007 "\nOptions:" \
2008 "\n -c n Set the default log level of console messages to n" \
2009 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002010
Eric Andersen7e9276b2001-02-22 01:15:47 +00002011#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002012 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002013#define length_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002014 "Print STRING's length"
2015
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002016#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002017 "$ length Hello\n" \
2018 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002019
Rob Landley9200e792005-09-15 19:26:59 +00002020#define less_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002021 "[-EMNmh~?] [FILE...]"
Rob Landley9200e792005-09-15 19:26:59 +00002022#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002023 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002024 "changed, and files can be manipulated in various ways.\n" \
2025 "\nOptions:" \
2026 "\n -E Quit once the end of a file is reached" \
2027 "\n -M,-m Display a status line containing the line numbers" \
2028 "\n and percentage through the file" \
2029 "\n -N Prefix line numbers to each line" \
2030 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002031
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002032#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002033 "personality program [args...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002034#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002035 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002036 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002037 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002038
Eric Andersen7e9276b2001-02-22 01:15:47 +00002039#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002040 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002041#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002042 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002043 "Use '--' to indicate that all following arguments are non-options.\n" \
2044 "\nOptions:" \
2045 "\n -s Make symlinks instead of hardlinks" \
2046 "\n -f Remove existing destination files" \
2047 "\n -n Don't dereference symlinks - treat like normal file" \
2048 "\n -b Make a backup of the target (if exists) before link operation" \
2049 "\n -S suf Use suffix instead of ~ when making backup files" \
2050
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002051#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002052 "$ ln -s BusyBox /tmp/ls\n" \
2053 "$ ls -l /tmp/ls\n" \
2054 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002055
Denis Vlasenkob042bd92007-09-26 18:01:32 +00002056#define load_policy_trivial_usage
2057
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002058#define load_policy_full_usage
2059
Eric Andersen7e9276b2001-02-22 01:15:47 +00002060#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002061 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002062#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002063 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002064#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002065 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002066
2067#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002068 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002069#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002070 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002071#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002072 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002073
2074#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002075 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002076#define logger_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002077 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2078 "\nOptions:" \
2079 "\n -s Log to stderr as well as the system log" \
2080 "\n -t TAG Log using the specified tag (defaults to user name)" \
2081 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002082
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002083#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002084 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002085
Robert Griebl1fca5582002-06-04 20:45:46 +00002086#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002087 "[-p] [-h HOST] [[-f] USER]"
Robert Griebl1fca5582002-06-04 20:45:46 +00002088#define login_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002089 "Begin a new session on the system\n" \
2090 "\nOptions:" \
2091 "\n -f Do not authenticate (user already authenticated)" \
2092 "\n -h Name of the remote host" \
2093 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002094
Eric Andersen7e9276b2001-02-22 01:15:47 +00002095#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002096 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002097#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002098 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002099#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002100 "$ logname\n" \
2101 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002102
Mark Whitley6317c4b2001-03-12 22:51:50 +00002103#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002104 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00002105#define logread_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002106 "Show messages in syslogd's circular buffer\n" \
2107 "\nOptions:" \
2108 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002109
Matt Kraai83788da2002-03-20 17:38:37 +00002110#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002111 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2112 " losetup -d LOOPDEV - disassociate\n" \
2113 " losetup [-f] - show"
Matt Kraai83788da2002-03-20 17:38:37 +00002114#define losetup_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002115 "Options:" \
2116 "\n -o OFS Start OFS bytes into FILE" \
2117 "\n -f Show first free loop device" \
2118
Rob Landley1d589b22005-11-29 23:47:10 +00002119#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002120 "No arguments will display all current associations.\n" \
2121 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002122 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002123 "and filename of the file the loop device is currently bound to.\n\n" \
2124 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002125 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2126 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002127
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002128#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002129 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002130#define lpd_full_usage \
2131 "Example:" \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002132 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print"
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002133
Denis Vlasenko68444b92008-02-22 22:24:48 +00002134#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002135 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko68444b92008-02-22 22:24:48 +00002136#define lpq_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002137 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002138 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002139 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002140 "\n -f Force any waiting job to be printed" \
2141 "\n -s Short display" \
2142
2143#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002144 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2145/* -C CLASS exists too, not shown.
2146 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko68444b92008-02-22 22:24:48 +00002147#define lpr_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002148 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002149 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002150 "\n -m Send mail on completion" \
2151 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002152 "\n -V Verbose" \
2153
Eric Andersen7e9276b2001-02-22 01:15:47 +00002154#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002155 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002156 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002157 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2158 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2159 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2160 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2161 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2162 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002163#define ls_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002164 "List directory contents\n" \
2165 "\nOptions:" \
2166 "\n -1 List files in a single column" \
2167 "\n -A Do not list implied . and .." \
2168 "\n -a Do not hide entries starting with ." \
2169 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002170 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002171 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002172 USE_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002173 "\n --color[={always,never,auto}] Control coloring") \
2174 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002175 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002176 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002177 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002178 "\n -F Append indicator (one of */=@|) to entries") \
2179 "\n -i List the i-node for each file" \
2180 "\n -l Use a long listing format" \
2181 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002182 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002183 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002184 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002185 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002186 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002187 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002188 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002189 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002190 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002191 "\n -S Sort the listing by file size") \
2192 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002193 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002194 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002195 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002196 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002197 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002198 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002199 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002200 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002201 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002202 "\n -w NUM Assume the terminal is NUM columns wide") \
2203 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002204 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002205 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002206 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002207 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002208 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002209 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002210 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002211 "\n -K Print security context in long format") \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002212 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002213 "\n -Z Print security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002214
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002215#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002216 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002217#define lsattr_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002218 "List file attributes on an ext2 fs\n" \
2219 "\nOptions:" \
2220 "\n -R Recursively list subdirectories" \
2221 "\n -a Do not hide entries starting with ." \
2222 "\n -d List directory entries instead of contents" \
2223 "\n -l Print long flag names" \
2224 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002225
Eric Andersen7e9276b2001-02-22 01:15:47 +00002226#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002227 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002228#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002229 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002230
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002231#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002232#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002233 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002234#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002235 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002236 "TYPEs include:\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00002237 " b Make a block device\n" \
2238 " c or u Make a character device\n" \
2239 " p Make a named pipe. MAJOR and MINOR are ignored\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002240 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002241 "FIRST specifies the number appended to NAME to create the first device.\n" \
2242 "LAST specifies the number of the last item that should be created\n" \
2243 "If 's' is the last argument, the base device is created as well.\n\n" \
2244 "For example:\n" \
2245 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2246 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002247#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002248 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2249 "[creates ttyS2-ttyS63]\n" \
2250 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2251 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002252#endif
2253
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002254#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002255#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002256 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00002257#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002258 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002259 "Device table entries take the form of:\n" \
2260 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002261 "Where name is the file name, type can be one of:\n" \
2262 " f A regular file\n" \
2263 " d Directory\n" \
2264 " c Character special device file\n" \
2265 " b Block special device file\n" \
2266 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002267 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002268 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2269 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002270#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002271 "For example:\n" \
2272 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2273 "/dev d 755 0 0 - - - - -\n" \
2274 "/dev/console c 666 0 0 5 1 - - -\n" \
2275 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2276 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2277 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2278 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2279 "Will Produce:\n" \
2280 "/dev\n" \
2281 "/dev/console\n" \
2282 "/dev/null\n" \
2283 "/dev/zero\n" \
2284 "/dev/hda\n" \
2285 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002286#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002287
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002288#define matchpathcon_trivial_usage \
2289 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2290#define matchpathcon_full_usage \
2291 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002292 "\n -N Do not use translations" \
2293 "\n -f Use alternate file_context file" \
2294 "\n -p Use prefix to speed translations" \
2295 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002296
Eric Andersen7e9276b2001-02-22 01:15:47 +00002297#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002298 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002299 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002300#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002301 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002302 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2303 "\nOptions:" \
2304 "\n -c Check MD5 sums against given list" \
2305 "\n -s Don't output anything, status code shows success" \
2306 "\n -w Warn about improperly formatted MD5 checksum lines") \
2307
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002308#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002309 "$ md5sum < busybox\n" \
2310 "6fd11e98b98a58f64ff3398d7b324003\n" \
2311 "$ md5sum busybox\n" \
2312 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2313 "$ md5sum -c -\n" \
2314 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2315 "busybox: OK\n" \
2316 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002317
Rob Landley70f7ef72005-12-13 08:21:33 +00002318#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002319 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002320#define mdev_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002321 " -s Scan /sys and populate /dev during system boot\n" \
2322 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002323 "Called with no options (via hotplug) it uses environment variables\n" \
2324 "to determine which device to add/remove."
Denis Vlasenko397de612008-03-17 08:55:44 +00002325
Rob Landleyef10d522006-06-26 14:11:33 +00002326#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002327 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002328 "The mdev config file contains lines that look like:\n" \
2329 " hd[a-z][0-9]* 0:3 660\n\n" \
2330 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002331 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002332 "Optionally, that can be followed (on the same line) by a special character\n" \
2333 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002334 "device(s). The environment variable $MDEV indicates the active device node\n" \
2335 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002336 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2337 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002338 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002339 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002340 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002341 "Config file parsing stops on the first matching line. If no config\n" \
2342 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002343 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002344 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002345
Glenn L McGrath061c9002002-09-16 04:21:46 +00002346#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002347 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002348#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002349 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002350 " y Allow write access to your terminal\n" \
2351 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002352
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002353#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002354 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002355#define microcom_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002356 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2357 "\nOptions:" \
2358 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2359 "\n next byte to it" \
2360 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2361 "\n -s Set serial line to SPEED" \
2362 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002363
Eric Andersen7e9276b2001-02-22 01:15:47 +00002364#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002365 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002366#define mkdir_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002367 "Create DIRECTORY\n" \
2368 "\nOptions:" \
2369 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2370 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002371 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002372 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002373 )
2374
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002375#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002376 "$ mkdir /tmp/foo\n" \
2377 "$ mkdir /tmp/foo\n" \
2378 "/tmp/foo: File exists\n" \
2379 "$ mkdir /tmp/foo/bar/baz\n" \
2380 "/tmp/foo/bar/baz: No such file or directory\n" \
2381 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002382
Mike Frysinger6447ac02005-06-11 05:29:40 +00002383#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002384 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2385 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2386 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2387 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2388 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2389 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002390#define mke2fs_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002391 " -b size Block size in bytes" \
2392 "\n -c Check for bad blocks before creating" \
2393 "\n -E opts Set extended options" \
2394 "\n -f size Fragment size in bytes" \
2395 "\n -F Force (ignore sanity checks)" \
2396 "\n -g num Number of blocks in a block group" \
2397 "\n -i ratio The bytes/inode ratio" \
2398 "\n -j Create a journal (ext3)" \
2399 "\n -J opts Set journal options (size/device)" \
2400 "\n -l file Read bad blocks list from file" \
2401 "\n -L lbl Set the volume label" \
2402 "\n -m percent Percent of fs blocks to reserve for admin" \
2403 "\n -M dir Set last mounted directory" \
2404 "\n -n Do not actually create anything" \
2405 "\n -N num Number of inodes to create" \
2406 "\n -o os Set the 'creator os' field" \
2407 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2408 "\n -q Quiet" \
2409 "\n -r rev Set filesystem revision" \
2410 "\n -S Write superblock and group descriptors only" \
2411 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2412 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002413
Eric Andersen7e9276b2001-02-22 01:15:47 +00002414#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002415 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002416#define mkfifo_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002417 "Create named pipe (identical to 'mknod name p')\n" \
2418 "\nOptions:" \
2419 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002420 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002421 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002422 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002423
Eric Andersen7e9276b2001-02-22 01:15:47 +00002424#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002425 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002426#define mkfs_minix_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002427 "Make a MINIX filesystem\n" \
2428 "\nOptions:" \
2429 "\n -c Check device for bad blocks" \
2430 "\n -n [14|30] Maximum length of filenames" \
2431 "\n -i INODES Number of inodes for the filesystem" \
2432 "\n -l FILENAME Read bad blocks list from FILENAME" \
2433 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002434
Eric Andersen7e9276b2001-02-22 01:15:47 +00002435#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002436 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002437#define mknod_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002438 "Create a special file (block, character, or pipe)\n" \
2439 "\nOptions:" \
2440 "\n -m Create the special file using the specified mode (default a=rw)" \
2441 "\nTYPEs include:" \
2442 "\n b: Make a block device" \
2443 "\n c or u: Make a character device" \
2444 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002445 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002446 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002447 )
2448
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002449#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002450 "$ mknod /dev/fd0 b 2 0\n" \
2451 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002452
Eric Andersen7e9276b2001-02-22 01:15:47 +00002453#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002454 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002455#define mkswap_full_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002456 "Prepare block device to be used as swap partition"
2457#if 0
2458 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002459 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002460 "\n -c Check for readability"
2461 "\n -v0 Make swap version 0 (max 128M)"
2462 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2463 "\n BLOCKS Number of blocks to use (default is entire partition)"
2464#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002465
Eric Andersen7e9276b2001-02-22 01:15:47 +00002466#define mktemp_trivial_usage \
Denis Vlasenko761e1d12008-02-09 06:29:32 +00002467 "[-dt] [-p DIR] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002468#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002469 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002470 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX).\n" \
2471 "\nOptions:" \
2472 "\n -d Make a directory instead of a file" \
2473/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2474 "\n -t Generate a path rooted in temporary directory" \
2475 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2476 "\n" \
2477 "\n" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002478 "For -t or -p, directory is chosen as follows:\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002479 "$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002480
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002481#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002482 "$ mktemp /tmp/temp.XXXXXX\n" \
2483 "/tmp/temp.mWiLjM\n" \
2484 "$ ls -la /tmp/temp.mWiLjM\n" \
2485 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002486
Eric Andersen8d79ce82001-07-22 23:00:15 +00002487#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002488 "[-knqrsv] MODULE [symbol=value...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002489#define modprobe_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002490 "Options:" \
2491 "\n -k Make module autoclean-able" \
2492 "\n -n Dry run" \
2493 "\n -q Quiet" \
2494 "\n -r Remove module (stacks) or do autoclean" \
2495 "\n -s Report via syslog instead of stderr" \
2496 "\n -v Verbose" \
2497
Rob Landley9c32a152005-12-11 20:12:24 +00002498#define modprobe_notes_usage \
2499"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2500"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2501"pass each module it loads.\n" \
2502"\n" \
2503"The configuration file is searched (in order) amongst:\n" \
2504"\n" \
2505" /etc/modprobe.conf (2.6 only)\n" \
2506" /etc/modules.conf\n" \
2507" /etc/conf.modules (deprecated)\n" \
2508"\n" \
2509"They all have the same syntax (see below). If none is present, it is\n" \
2510"_not_ an error; each loaded module is then expected to load without\n" \
2511"options. Once a file is found, the others are tested for.\n" \
2512"\n" \
2513"/etc/modules.conf entry format:\n" \
2514"\n" \
2515" alias <alias_name> <mod_name>\n" \
2516" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002517" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002518" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2519" This makes it also possible to use a different set of options (below) for\n" \
2520" the module and the alias.\n" \
2521" A module can be aliased more than once.\n" \
2522"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002523" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002524" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2525" the \"symbol=value\" pairs as option to that module.\n" \
2526"\n" \
2527"Sample /etc/modules.conf file:\n" \
2528"\n" \
2529" options tulip irq=3\n" \
2530" alias tulip tulip2\n" \
2531" options tulip2 irq=4 io=0x308\n" \
2532"\n" \
2533"Other functionality offered by 'classic' modprobe is not available in\n" \
2534"this implementation.\n" \
2535"\n" \
2536"If module options are present both in the config file, and on the command line,\n" \
2537"then the options from the command line will be passed to the module _after_\n" \
2538"the options from the config file. That way, you can have defaults in the config\n" \
2539"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002540#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002541 "(with the above /etc/modules.conf):\n\n" \
2542 "$ modprobe tulip\n" \
2543 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2544 "$ modprobe tulip irq=5\n" \
2545 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2546 "$ modprobe tulip2\n" \
2547 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2548 " which are the default for alias 'tulip2'\n\n" \
2549 "$ modprobe tulip2 irq=8\n" \
2550 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2551 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2552 " from the command line\n\n" \
2553 "$ modprobe tulip2 irq=2 io=0x210\n" \
2554 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2555 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2556 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002557
Eric Andersen7e9276b2001-02-22 01:15:47 +00002558#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002559 "[FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002560#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002561 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002562
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002563#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002564 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002565
Eric Andersen7e9276b2001-02-22 01:15:47 +00002566#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002567 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002568#define mount_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002569 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2570 "\nOptions:" \
2571 "\n -a Mount all filesystems in fstab" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002572 USE_FEATURE_MOUNT_FAKE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002573 "\n -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002574 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002575 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002576 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002577 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002578 "\n -r Read-only mount" \
2579 "\n -t fs-type Filesystem type" \
2580 "\n -w Read-write mount (default)" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002581 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002582 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002583 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002584 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002585 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002586 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002587 " [a]sync Writes are asynchronous / synchronous\n" \
2588 " [no]atime Disable / enable updates to inode access times\n" \
2589 " [no]diratime Disable / enable atime updates to directories\n" \
2590 " [no]dev Allow use of special device files / disallow them\n" \
2591 " [no]exec Allow use of executable files / disallow them\n" \
2592 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2593 " [r]shared Convert [recursively] to a shared subtree\n" \
2594 " [r]slave Convert [recursively] to a slave subtree\n" \
2595 " [r]private Convert [recursively] to a private subtree\n" \
2596 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2597 " bind Bind a directory to an additional location\n" \
2598 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002599 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002600 " remount Remount a mounted filesystem, changing its flags\n" \
2601 " ro/rw Mount for read-only / read-write\n" \
2602 "\n" \
2603 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002604 "You'll have to see the written documentation for those filesystems" \
2605
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002606#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002607 "$ mount\n" \
2608 "/dev/hda3 on / type minix (rw)\n" \
2609 "proc on /proc type proc (rw)\n" \
2610 "devpts on /dev/pts type devpts (rw)\n" \
2611 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2612 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2613 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002614#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002615 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002616
Rob Landleyd00b3a52005-08-20 05:07:08 +00002617#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002618 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002619#define mountpoint_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002620 "mountpoint checks if the directory is a mountpoint\n" \
2621 "\nOptions:" \
2622 "\n -q Quiet" \
2623 "\n -d Print major/minor device number of the filesystem" \
2624 "\n -x Print major/minor device number of the blockdevice" \
2625
Rob Landleyd00b3a52005-08-20 05:07:08 +00002626#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002627 "$ mountpoint /proc\n" \
2628 "/proc is not a mountpoint\n" \
2629 "$ mountpoint /sys\n" \
2630 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002631
Eric Andersen7e9276b2001-02-22 01:15:47 +00002632#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002633 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002634#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002635 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002636 "\n" \
2637 "Available Opcodes:\n" \
2638 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002639 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2640 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2641 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002642 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002643
Eric Andersen7e9276b2001-02-22 01:15:47 +00002644#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002645 "[OPTION]... SOURCE DEST\n" \
2646 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002647#define mv_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002648 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2649 "\nOptions:" \
2650 "\n -f Don't prompt before overwriting" \
2651 "\n -i Interactive, prompt before overwrite" \
2652
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002653#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002654 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002655
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002656#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002657 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002658#define nameif_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002659 "Rename network interface while it in the down state\n" \
2660 "\nOptions:" \
2661 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2662 "\n -s Use syslog (LOCAL0 facility)" \
2663 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2664
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002665#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002666 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2667 " or\n" \
2668 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002669
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002670#if !ENABLE_DESKTOP
2671
Rob Landley1cca9482006-07-10 19:45:20 +00002672#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002673#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002674#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002675#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002676#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002677
Eric Andersen7e9276b2001-02-22 01:15:47 +00002678#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002679 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002680 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002681#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002682 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002683 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002684 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002685 "\n -e Exec rest of command line after connect" \
2686 "\n -i SECS Delay interval for lines sent" \
2687 "\n -w SECS Timeout for connect" \
2688 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002689 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002690 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002691 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002692 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002693 "\n (use -l twice with -e for persistent server)") \
2694 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002695 )
2696
Rob Landley1cca9482006-07-10 19:45:20 +00002697#define nc_notes_usage "" \
2698 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002699 "To use netcat as a terminal emulator on a serial port:\n\n" \
2700 "$ stty 115200 -F /dev/ttyS0\n" \
2701 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2702 )
Rob Landley1cca9482006-07-10 19:45:20 +00002703
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002704#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002705 "$ nc foobar.somedomain.com 25\n" \
2706 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2707 "help\n" \
2708 "214-Commands supported:\n" \
2709 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2710 "214 NOOP QUIT RSET HELP\n" \
2711 "quit\n" \
2712 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002713
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002714#else /* DESKTOP nc - much more compatible with nc 1.10 */
2715
2716#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002717 "[-options] hostname port - connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002718 USE_NC_SERVER("\n" \
2719 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002720#define nc_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002721 "Options:" \
2722 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002723 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002724 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002725 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002726 "\n -n Don't do DNS resolution" \
2727 "\n -s addr Local address" \
2728 "\n -p port Local port" \
2729 "\n -u UDP mode" \
2730 "\n -v Verbose (cumulative: -vv)" \
2731 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002732 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002733 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
2734 "\n -o file Hex dump of traffic" \
2735 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002736 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002737/* "\n -r Randomize local and remote ports" */
2738/* "\n -g gateway Source-routing hop point[s], up to 8" */
2739/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002740/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2741
2742#endif
2743
Eric Andersen1552ff72001-10-31 11:07:12 +00002744#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002745 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002746#define netstat_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002747 "Display networking information\n" \
2748 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002749 "\n -l Display listening server sockets" \
2750 "\n -a Display all sockets (default: connected)" \
2751 "\n -e Display other/more information" \
2752 "\n -n Don't resolve names" \
2753 "\n -t Tcp sockets" \
2754 "\n -u Udp sockets" \
2755 "\n -w Raw sockets" \
2756 "\n -x Unix sockets" \
2757 "\n -r Display routing table" \
2758 USE_FEATURE_NETSTAT_WIDE( \
2759 "\n -W Display with no column truncation" \
2760 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002761
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002762#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002763 "[-n ADJUST] [COMMAND [ARG]...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002764#define nice_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002765 "Run a program with modified scheduling priority\n" \
2766 "\nOptions:" \
2767 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002768
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002769#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002770 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002771#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002772 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002773 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002774 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002775 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002776 "%[niface] Monitor network interface 'iface'\n" \
2777 "%m Monitor allocated memory\n" \
2778 "%[mf] Monitor free memory\n" \
2779 "%[mt] Monitor total memory\n" \
2780 "%s Monitor allocated swap\n" \
2781 "%f Monitor number of used file descriptors\n" \
2782 "%Ni Monitor total/specific IRQ rate\n" \
2783 "%x Monitor context switch rate\n" \
2784 "%p Monitor forks\n" \
2785 "%[pn] Monitor # of processes\n" \
2786 "%b Monitor block io\n" \
2787 "%Nt Show time (with N decimal points)\n" \
2788 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002789 "%r Print <cr> instead of <lf> at EOL" \
2790
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002791#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002792 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002793
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002794#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002795 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002796#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002797 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002798#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002799 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002800
Eric Andersen7e9276b2001-02-22 01:15:47 +00002801#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002802 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002803#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002804 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002805 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002806#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002807 "$ nslookup localhost\n" \
2808 "Server: default\n" \
2809 "Address: default\n" \
2810 "\n" \
2811 "Name: debian\n" \
2812 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002813
Glenn L McGrath60281112001-11-02 11:39:46 +00002814#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002815 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002816#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002817 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002818 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002819
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002820#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002821 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002822#define openvt_full_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002823 "Start COMMAND on a new virtual terminal\n" \
2824 "\nOptions:" \
2825 "\n -c Use specified VT" \
2826 "\n -s Switch to the VT" \
2827/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
2828 "\n -w Wait for COMMAND to exit" \
2829
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002830#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002831 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002832
Eric Andersen27f64e12002-06-23 04:24:25 +00002833#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002834 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002835#define passwd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002836 "Change user's password. If no name is specified,\n" \
2837 "changes the password for the current user.\n" \
2838 "\nOptions:" \
2839 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
2840 "\n -d Delete password for the account" \
2841 "\n -l Lock (disable) account" \
2842 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002843
Denis Vlasenko21d10142007-07-20 21:28:41 +00002844#define chpasswd_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002845 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko21d10142007-07-20 21:28:41 +00002846#define chpasswd_full_usage \
2847 "Read user:password information from stdin\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002848 "and update /etc/passwd accordingly.\n" \
2849 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002850 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002851 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2852 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002853 ) \
2854 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002855 "\n -e Supplied passwords are in encrypted form" \
2856 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002857 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002858
Glenn L McGrath655d8142003-06-22 15:32:41 +00002859#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002860 "[-p NUM] [-i DIFF] [-R]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002861#define patch_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002862 " -p NUM Strip NUM leading components from file names" \
2863 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002864 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002865
Glenn L McGrath655d8142003-06-22 15:32:41 +00002866#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002867 "$ patch -p1 < example.diff\n" \
2868 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002869
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002870#define pgrep_trivial_usage \
2871 "[-flnovx] pattern"
2872#define pgrep_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002873 "Display process(es) selected by regex pattern\n" \
2874 "\nOptions:" \
2875 "\n -l Show command name too" \
2876 "\n -f Match against entire command line" \
2877 "\n -n Show the newest process only" \
2878 "\n -o Show the oldest process only" \
2879 "\n -v Negate the matching" \
2880 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002881
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002882#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00002883#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002884 "[OPTION] [NAME...]"
2885#define USAGE_PIDOF "\n\nOptions:"
2886#else
2887#define pidof_trivial_usage \
2888 "[NAME...]"
2889#define USAGE_PIDOF /* none */
2890#endif
Eric Andersen221b2ea2001-07-31 19:06:07 +00002891#define pidof_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002892 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002893 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002894 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002895 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002896 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002897 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002898 "\n Use %PPID to omit pid of pidof's parent") \
2899
Eric Andersen221b2ea2001-07-31 19:06:07 +00002900#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002901 "$ pidof init\n" \
2902 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002903 USE_FEATURE_PIDOF_OMIT( \
2904 "$ pidof /bin/sh\n20351 5973 5950\n") \
2905 USE_FEATURE_PIDOF_OMIT( \
2906 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002907
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002908#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002909#define ping_trivial_usage \
2910 "host"
2911#define ping_full_usage \
2912 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002913#define ping6_trivial_usage \
2914 "host"
2915#define ping6_full_usage \
2916 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002917#else
2918#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002919 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002920#define ping_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002921 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
2922 "\nOptions:" \
2923 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
2924 "\n -c CNT Send only CNT pings" \
2925 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
2926 "\n -I iface/IP Use interface or IP address as source" \
2927 "\n -q Quiet, only displays output at start" \
2928 "\n and when finished" \
2929
Eric Andersen51b8bd62002-07-03 11:46:38 +00002930#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002931 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002932#define ping6_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002933 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
2934 "\nOptions:" \
2935 "\n -c CNT Send only CNT pings" \
2936 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
2937 "\n -I iface/IP Use interface or IP address as source" \
2938 "\n -q Quiet, only displays output at start" \
2939 "\n and when finished" \
2940
Eric Andersen51b8bd62002-07-03 11:46:38 +00002941#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002942#define ping_example_usage \
2943 "$ ping localhost\n" \
2944 "PING slag (127.0.0.1): 56 data bytes\n" \
2945 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2946 "\n" \
2947 "--- debian ping statistics ---\n" \
2948 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2949 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002950#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002951 "$ ping6 ip6-localhost\n" \
2952 "PING ip6-localhost (::1): 56 data bytes\n" \
2953 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2954 "\n" \
2955 "--- ip6-localhost ping statistics ---\n" \
2956 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2957 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002958
Eric Andersen7e9276b2001-02-22 01:15:47 +00002959#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002960 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002961#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002962 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002963 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002964
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002965#define pkill_trivial_usage \
2966 "[-l] | [-fnovx] [-signal] pattern"
2967#define pkill_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002968 "Send a signal to process(es) selected by regex pattern\n" \
2969 "\nOptions:" \
2970 "\n -l List all signals" \
2971 "\n -f Match against entire command line" \
2972 "\n -n Signal the newest process only" \
2973 "\n -o Signal the oldest process only" \
2974 "\n -v Negate the matching" \
2975 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002976
Eric Andersen7e9276b2001-02-22 01:15:47 +00002977#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002978 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002979#define poweroff_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002980 "Halt and shut off power\n" \
2981 "\nOptions:" \
2982 "\n -d Delay interval for halting" \
2983 "\n -n No call to sync()" \
2984 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002985
Mike Frysinger95d3c452005-04-21 23:29:24 +00002986#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002987 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002988#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002989 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002990 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002991
Eric Andersen7e9276b2001-02-22 01:15:47 +00002992#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002993 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002994#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002995 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002996 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002997#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002998 "$ printf \"Val=%d\\n\" 5\n" \
2999 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003000
Denis Vlasenko94949192006-11-05 00:45:47 +00003001
3002#if ENABLE_DESKTOP
3003
3004#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003005 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00003006#define ps_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003007 "Report process status\n" \
3008 "\nOptions:" \
3009 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003010
3011#else /* !ENABLE_DESKTOP */
3012
Denis Vlasenko397de612008-03-17 08:55:44 +00003013#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003014#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003015#else
3016#define USAGE_PS "\nOptions:"
3017#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003018
Eric Andersen7e9276b2001-02-22 01:15:47 +00003019#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003020 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003021#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003022 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003023 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003024 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003025 "\n -Z Show SE Linux context" \
3026 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003027 USE_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003028 "\n w Wide output" \
3029 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003030
Denis Vlasenko94949192006-11-05 00:45:47 +00003031#endif /* ENABLE_DESKTOP */
3032
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003033#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003034 "$ ps\n" \
3035 " PID Uid Gid State Command\n" \
3036 " 1 root root S init\n" \
3037 " 2 root root S [kflushd]\n" \
3038 " 3 root root S [kupdate]\n" \
3039 " 4 root root S [kpiod]\n" \
3040 " 5 root root S [kswapd]\n" \
3041 " 742 andersen andersen S [bash]\n" \
3042 " 743 andersen andersen S -bash\n" \
3043 " 745 root root S [getty]\n" \
3044 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003045
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003046#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003047 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003048#define pscan_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003049 "Scan a host, print all open ports\n" \
3050 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003051 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003052 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003053 "\n -p Scan from this port (default 1)" \
3054 "\n -P Scan up to this port (default 1024)" \
3055 "\n -t Timeout (default 5000 ms)" \
3056 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3057
Eric Andersen7e9276b2001-02-22 01:15:47 +00003058#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003059 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003060#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003061 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003062#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003063 "$ pwd\n" \
3064 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003065
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003066#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003067 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003068#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003069 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003070#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003071 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003072
Eric Andersen7e9276b2001-02-22 01:15:47 +00003073#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003074 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003075#define rdate_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003076 "Get and possibly set the system date and time from a remote HOST\n" \
3077 "\nOptions:" \
3078 "\n -s Set the system date and time (default)" \
3079 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003080
Rob Landley0e4690d2006-08-20 22:12:18 +00003081#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003082 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00003083#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003084 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3085 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003086
Eric Andersen7e9276b2001-02-22 01:15:47 +00003087#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003088 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003089#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003090 "Display the value of a symlink" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003091 USE_FEATURE_READLINK_FOLLOW( "\n" \
3092 "\nOptions:" \
3093 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003094
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003095#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003096 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003097#define readprofile_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003098 "Options:" \
3099 "\n -m mapfile (Default: /boot/System.map)" \
3100 "\n -p profile (Default: /proc/profile)" \
3101 "\n -M mult Set the profiling multiplier to mult" \
3102 "\n -i Print only info about the sampling step" \
3103 "\n -v Verbose" \
3104 "\n -a Print all symbols, even if count is 0" \
3105 "\n -b Print individual histogram-bin counts" \
3106 "\n -s Print individual counters within functions" \
3107 "\n -r Reset all the counters (root only)" \
3108 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003109
Glenn L McGrath62fae302002-12-10 00:14:33 +00003110#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003111 "pathname..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00003112#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003113 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003114
Eric Andersen7e9276b2001-02-22 01:15:47 +00003115#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003116 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003117#define reboot_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003118 "Reboot the system\n" \
3119 "\nOptions:" \
3120 "\n -d Delay interval for rebooting" \
3121 "\n -n No call to sync()" \
3122 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003123
3124#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003125 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003126#define renice_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003127 "Change priority of running processes\n" \
3128 "\nOptions:" \
3129 "\n -n Adjust current nice value (smaller is faster)" \
3130 "\n -p Process id(s) (default)" \
3131 "\n -g Process group id(s)" \
3132 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003133
Eric Andersen7e9276b2001-02-22 01:15:47 +00003134#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003135 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003136#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003137 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003138
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003139#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003140 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003141#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003142 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003143
Denis Vlasenko397137b2007-07-23 14:03:30 +00003144#define restorecon_trivial_usage \
3145 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
3146#define restorecon_full_usage \
3147 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003148 "\n -i Ignore files that do not exist" \
3149 "\n -f file File with list of files to process. Use - for stdin" \
3150 "\n -e directory Directory to exclude" \
3151 "\n -R,-r Recurse directories" \
3152 "\n -n Don't change any file labels" \
3153 "\n -o file Save list of files with incorrect context" \
3154 "\n -v Verbose" \
3155 "\n -vv Show changed labels" \
3156 "\n -F Force reset of context to match file_context" \
3157 "\n for customizable files, or the user section," \
3158 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003159
Eric Andersen7e9276b2001-02-22 01:15:47 +00003160#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003161 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003162#define rm_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003163 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003164 "indicate that all following arguments are non-options.\n" \
3165 "\nOptions:" \
3166 "\n -i Always prompt before removing" \
3167 "\n -f Never prompt" \
3168 "\n -r,-R Remove directories recursively" \
3169
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003170#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003171 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003172
Eric Andersen7e9276b2001-02-22 01:15:47 +00003173#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003174 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003175#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003176 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003177#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003178 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003179
Eric Andersen7e9276b2001-02-22 01:15:47 +00003180#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003181 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003182#define rmmod_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003183 "Unload the specified kernel modules from the kernel\n" \
3184 "\nOptions:" \
3185 "\n -a Remove all unused modules (recursively)" \
3186
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003187#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003188 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003189
Eric Andersen7e9276b2001-02-22 01:15:47 +00003190#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003191 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003192#define route_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003193 "Edit the kernel's routing tables\n" \
3194 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003195 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003196 "\n -e Display other/more information" \
3197 "\n -A inet" USE_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003198
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003199#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003200 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003201#define rpm_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003202 "Manipulate RPM packages\n" \
3203 "\nOptions:" \
3204 "\n -i Install package" \
3205 "\n -q Query package" \
3206 "\n -p Query uninstalled package" \
3207 "\n -i Show information" \
3208 "\n -l List contents" \
3209 "\n -d List documents" \
3210 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003211
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003212#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003213 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003214#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003215 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003216
Mike Frysinger6b160e42008-02-15 02:27:19 +00003217#define rtcwake_trivial_usage \
3218 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
3219#define rtcwake_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003220 "Enter a system sleep state until specified wakeup time\n" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003221 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003222 "\n -a,--auto Read clock mode from adjtime" \
3223 "\n -l,--local Clock is set to local time" \
3224 "\n -u,--utc Clock is set to UTC time" \
3225 "\n -d,--device=DEV Specify the RTC device" \
3226 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
3227 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
3228 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003229 ) \
3230 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003231 "\n -a Read clock mode from adjtime" \
3232 "\n -l Clock is set to local time" \
3233 "\n -u Clock is set to UTC time" \
3234 "\n -d DEV Specify the RTC device" \
3235 "\n -m MODE Set the sleep state (default: standby)" \
3236 "\n -s SEC Set the timeout in SEC seconds from now" \
3237 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003238 )
3239
Denis Vlasenko49622d72007-03-10 16:58:49 +00003240#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003241 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3242 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko49622d72007-03-10 16:58:49 +00003243#define runcon_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003244 "Run a program in a different security context\n" \
3245 "\n CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003246 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003247 "\n -c,--compute Compute process transition context before modifying" \
3248 "\n -t,--type=TYPE Type (for same role as parent)" \
3249 "\n -u,--user=USER User identity" \
3250 "\n -r,--role=ROLE Role" \
3251 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003252 ) \
3253 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003254 "\n -c Compute process transition context before modifying" \
3255 "\n -t TYPE Type (for same role as parent)" \
3256 "\n -u USER User identity" \
3257 "\n -r ROLE Role" \
3258 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003259 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003260
Eric Andersen6cf47a72001-10-31 10:24:36 +00003261#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003262 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003263#define run_parts_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003264 "Run a bunch of scripts in a directory\n" \
3265 "\nOptions:" \
3266 "\n -t Print what would be run, but don't actually run anything" \
3267 "\n -a ARG Pass ARG as argument for every program" \
3268 "\n -u MASK Set the umask to MASK before running every program" \
3269 USE_FEATURE_RUN_PARTS_FANCY( \
3270 "\n -l Print names of all matching files even if they are not executable" \
3271 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003272
3273#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003274 "$ run-parts -a start /etc/init.d\n" \
3275 "$ run-parts -a stop=now /etc/init.d\n\n" \
3276 "Let's assume you have a script foo/dosomething:\n" \
3277 "#!/bin/sh\n" \
3278 "for i in $*; do eval $i; done; unset i\n" \
3279 "case \"$1\" in\n" \
3280 "start*) echo starting something;;\n" \
3281 "stop*) set -x; shutdown -h $stop;;\n" \
3282 "esac\n\n" \
3283 "Running this yields:\n" \
3284 "$run-parts -a stop=+4m foo/\n" \
3285 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003286
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003287#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003288 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003289#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003290 "Find the current and previous system runlevel.\n\n" \
3291 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003292 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003293#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003294 "$ runlevel /var/run/utmp\n" \
3295 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003296
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003297#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003298 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003299#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003300 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003301
3302#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003303 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003304#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003305 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003306
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003307#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003308 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003309#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003310 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003311#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003312 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003313
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003314#define script_trivial_usage \
3315 "[-afq] [-c COMMAND] [OUTFILE]"
3316#define script_full_usage \
3317 "Options:" \
3318 "\n -a Append output" \
3319 "\n -c Run COMMAND, not shell" \
3320 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003321 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003322
Eric Andersen7e9276b2001-02-22 01:15:47 +00003323#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003324 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003325#define sed_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003326 "Options:" \
3327 "\n -e script Add the script to the commands to be executed" \
3328 "\n -f scriptfile Add scriptfile contents to the" \
3329 "\n commands to be executed" \
3330 "\n -i Edit files in-place" \
3331 "\n -n Suppress automatic printing of pattern space" \
3332 "\n -r Use extended regular expression syntax" \
3333 "\n" \
3334 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3335 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3336 "\ninput files are specified, then the standard input is read. Source files" \
3337 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003338
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003339#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003340 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3341 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003342
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003343#define selinuxenabled_trivial_usage
3344#define selinuxenabled_full_usage
3345
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003346#define sendmail_trivial_usage \
Denis Vlasenko17db1a92008-02-26 21:13:17 +00003347 "[-w timeout] [-U user] [-P password] [-X]\n" \
3348 "-t to [-t to]... [-n] [-s subject] [-c charset] server[:port] from [body] [attachment ...]"
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003349#define sendmail_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003350 "Send an email.\n" \
3351 "\nOptions:" \
3352 "\n -w timeout Set timeout on network operations" \
3353 "\n -U username Authenticate with specified username/password" \
3354 "\n -P password" \
3355 "\n -t address Recipient(s). May be repeated" \
3356 "\n -X Use openssl connection helper for secured servers" \
3357 "\n -n Request delivery notification to sender" \
3358 "\n -s subject Subject" \
3359 "\n -c charset Assumed charset for body and subject [utf-8]" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003360
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003361#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003362 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003363#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003364 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003365 "FIRST, INCREMENT default to 1" \
3366 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003367 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003368 " FIRST LAST\n" \
3369 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003370
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003371#define sestatus_trivial_usage \
3372 "[-vb]"
3373#define sestatus_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003374 " -v Verbose" \
3375 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003376
Paul Foxfc2256a2005-08-01 18:12:30 +00003377#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003378 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00003379#define setconsole_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003380 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3381 "\nOptions:" \
3382 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003383
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003384#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003385 "[Enforcing | Permissive | 1 | 0]"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003386#define setenforce_full_usage
3387
Denis Vlasenko397137b2007-07-23 14:03:30 +00003388#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003389 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003390 USE_FEATURE_SETFILES_CHECK_OPTION( \
3391 " [-c policyfile] spec_file" \
3392 ) \
3393 " pathname"
Denis Vlasenko397137b2007-07-23 14:03:30 +00003394#define setfiles_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003395 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003396 USE_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003397 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003398 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003399 "\n -d Show which specification matched each file" \
3400 "\n -l Log changes in file labels to syslog" \
3401 "\n -n Don't change any file labels" \
3402 "\n -q Suppress warnings" \
3403 "\n -r dir Use an altenate root path" \
3404 "\n -e dir Exclude directory" \
3405 "\n -F Force reset of context to match file_context for customizable files" \
3406 "\n -o file Save list of files with incorrect context" \
3407 "\n -s Take a list of files from standard input (instead of command line)" \
3408 "\n -v Show changes in file labels, if type or role are changing" \
3409 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3410 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003411
Eric Andersen7e9276b2001-02-22 01:15:47 +00003412#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003413 "SCANCODE KEYCODE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003414#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003415 "Set entries into the kernel's scancode-to-keycode map,\n" \
3416 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3417 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003418 "and KEYCODE is given in decimal" \
3419
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003420#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003421 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003422
Rob Landley87848d92006-03-27 23:23:43 +00003423#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003424 "N"
Rob Landley87848d92006-03-27 23:23:43 +00003425#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003426 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003427
Denis Vlasenkobe039372007-10-14 04:48:44 +00003428#define setsebool_trivial_usage \
3429 "boolean value"
3430
3431#define setsebool_full_usage \
3432 "Change boolean setting"
3433
Paul Fox42403642005-08-01 22:52:09 +00003434#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003435 "PROG [ARG...]"
Paul Fox42403642005-08-01 22:52:09 +00003436#define setsid_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003437 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3438 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3439 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003440
Matt Kraai2d91deb2001-08-01 17:21:35 +00003441#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003442 "[FILE]...\n" \
3443 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00003444#define lash_full_usage \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003445 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003446
Eric Andersen2e9c2572003-08-08 22:26:06 +00003447#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003448 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00003449#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003450 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00003451
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003452#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003453 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003454 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003455#define sha1sum_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003456 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
3457 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
3458 "\nOptions:" \
3459 "\n -c Check SHA1 sums against given list" \
3460 "\n -s Don't output anything, status code shows success" \
3461 "\n -w Warn about improperly formatted SHA1 checksum lines" \
3462 )
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003463
Denis Vlasenko14923db2007-06-20 15:23:03 +00003464#define slattach_trivial_usage \
3465 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3466#define slattach_full_usage \
3467 "Attach network interface(s) to serial line(s)\n" \
3468 "\nOptions:" \
3469 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3470 "\n -s Set line speed" \
3471 "\n -e Exit after initializing device" \
3472 "\n -h Exit when the carrier is lost" \
3473 "\n -c Execute a command when the line is hung up" \
3474 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3475 "\n -L Enable 3-wire operation" \
3476 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003477
Eric Andersen7e9276b2001-02-22 01:15:47 +00003478#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003479 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003480#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003481 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003482 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003483 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003484 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003485#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003486 "$ sleep 2\n" \
3487 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003488 USE_FEATURE_FANCY_SLEEP( \
3489 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003490 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003491
Eric Andersen7e9276b2001-02-22 01:15:47 +00003492#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003493 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003494 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003495 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003496#define sort_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003497 "Sort lines of text\n" \
3498 "\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003499 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003500 "\n -b Ignore leading blanks" \
3501 "\n -c Check whether input is sorted" \
3502 "\n -d Dictionary order (blank or alphanumeric only)" \
3503 "\n -f Ignore case" \
3504 "\n -g General numerical sort" \
3505 "\n -i Ignore unprintable characters" \
3506 "\n -k Sort key" \
3507 "\n -M Sort month" \
3508 ) \
3509 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003510 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003511 "\n -o Output to file" \
3512 "\n -k Sort by key" \
3513 "\n -t CHAR Key separator" \
3514 ) \
3515 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003516 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003517 "\n -s Stable (don't sort ties alphabetically)" \
3518 ) \
3519 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003520 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003521 "\n -z Lines are terminated by NUL, not newline" \
3522 "\n -mST Ignored for GNU compatibility") \
3523
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003524#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003525 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3526 "a\n" \
3527 "b\n" \
3528 "c\n" \
3529 "d\n" \
3530 "e\n" \
3531 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003532 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003533 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3534 "d 2\n" \
3535 "b 2\n" \
3536 "c 3\n" \
3537 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003538 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003539
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003540#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003541 "[OPTION] [INPUT [PREFIX]]"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003542#define split_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003543 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003544 "\n -b n[k|m] Split by bytes" \
3545 "\n -l n Split by lines" \
3546 "\n -a n Use n letters as suffix" \
3547
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003548#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003549 "$ split TODO foo\n" \
3550 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003551
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003552#define start_stop_daemon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003553 "[OPTIONS] [" \
3554 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3555 "] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003556#define start_stop_daemon_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003557 "Start and stop services\n" \
3558 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003559 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003560 "\n -S,--start Start" \
3561 "\n -K,--stop Stop" \
3562 "\n -a,--startas pathname Start process specified by pathname" \
3563 "\n -b,--background Put process into background" \
3564 "\n -u,--user username|uid Stop this user's processes" \
3565 "\n -x,--exec executable Program to either start or check" \
3566 "\n -n,--name process-name Stop processes with this name" \
3567 "\n -p,--pidfile pid-file Save or load pid using a pid-file" \
3568 "\n -m,--make-pidfile Create the -p file and enter pid in it" \
3569 "\n -q,--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003570 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003571 "\n -o,--oknodo Exit status 0 if nothing done" \
3572 "\n -v,--verbose Verbose" \
3573 "\n -N,--nicelevel N Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003574 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003575 "\n -s,--signal signal Signal to send (default TERM)" \
3576 "\n -c,--chuid user[:[grp]] Change to specified user/group" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003577 ) \
3578 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003579 "\n -S Start" \
3580 "\n -K Stop" \
3581 "\n -a pathname Start process specified by pathname" \
3582 "\n -b Put process into background" \
3583 "\n -u username|uid Stop this user's processes" \
3584 "\n -x executable Program to either start or check" \
3585 "\n -n process-name Stop processes with this name" \
3586 "\n -p pid-file Save or load pid using a pid-file" \
3587 "\n -m Create the -p file and enter pid in it" \
3588 "\n -q Quiet" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003589 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003590 "\n -o Exit status 0 if nothing done" \
3591 "\n -v Verbose" \
3592 "\n -N N Add N to process's nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003593 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003594 "\n -s signal Signal to send (default TERM)" \
3595 "\n -c user[:[grp]] Change to specified user/group" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003596 )
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003597
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003598#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003599 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003600#define stat_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003601 "Display file (default) or filesystem status\n" \
3602 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003603 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003604 "\n -c fmt Use the specified format" \
3605 ) \
3606 "\n -f Display filesystem status" \
3607 "\n -L Dereference links" \
3608 "\n -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003609 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003610 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003611 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003612 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003613 "\n\nValid format sequences for files:\n" \
3614 " %a Access rights in octal\n" \
3615 " %A Access rights in human readable form\n" \
3616 " %b Number of blocks allocated (see %B)\n" \
3617 " %B The size in bytes of each block reported by %b\n" \
3618 " %d Device number in decimal\n" \
3619 " %D Device number in hex\n" \
3620 " %f Raw mode in hex\n" \
3621 " %F File type\n" \
3622 " %g Group ID of owner\n" \
3623 " %G Group name of owner\n" \
3624 " %h Number of hard links\n" \
3625 " %i Inode number\n" \
3626 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003627 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003628 " %o I/O block size\n" \
3629 " %s Total size, in bytes\n" \
3630 " %t Major device type in hex\n" \
3631 " %T Minor device type in hex\n" \
3632 " %u User ID of owner\n" \
3633 " %U User name of owner\n" \
3634 " %x Time of last access\n" \
3635 " %X Time of last access as seconds since Epoch\n" \
3636 " %y Time of last modification\n" \
3637 " %Y Time of last modification as seconds since Epoch\n" \
3638 " %z Time of last change\n" \
3639 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003640 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003641 " %a Free blocks available to non-superuser\n" \
3642 " %b Total data blocks in file system\n" \
3643 " %c Total file nodes in file system\n" \
3644 " %d Free file nodes in file system\n" \
3645 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003646 USE_SELINUX( \
3647 " %C Security context in SELinux\n" \
3648 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003649 " %i File System ID in hex\n" \
3650 " %l Maximum length of filenames\n" \
3651 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003652 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003653 " %S Fundamental block size (for block counts)\n" \
3654 " %t Type in hex\n" \
3655 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003656 )
3657
Eric Andersenef5e8f82002-11-07 02:09:37 +00003658#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003659 "[-afo] [-n length] [file...]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003660#define strings_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003661 "Display printable strings in a binary file\n" \
3662 "\nOptions:" \
3663 "\n -a Scan whole file (default)" \
3664 "\n -f Precede strings with filenames" \
3665 "\n -n N At least N characters form a string (default 4)" \
3666 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003667
Eric Andersen7e9276b2001-02-22 01:15:47 +00003668#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003669 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003670#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003671 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003672 "and deviations from stty sane\n" \
3673 "\nOptions:" \
3674 "\n -F DEVICE Open device instead of stdin" \
3675 "\n -a Print all current settings in human-readable form" \
3676 "\n -g Print in stty-readable form" \
3677 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003678
Robert Griebl1fca5582002-06-04 20:45:46 +00003679#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003680 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003681#define su_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003682 "Change user id or become root\n" \
3683 "\nOptions:" \
3684 "\n -p, -m Preserve environment" \
3685 "\n -c Command to pass to 'sh -c'" \
3686 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00003687
Eric Andersen27f64e12002-06-23 04:24:25 +00003688#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003689 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003690#define sulogin_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003691 "Single user login\n" \
3692 "\nOptions:" \
3693 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003694
Mike Frysinger95d3c452005-04-21 23:29:24 +00003695#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003696 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003697#define sum_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003698 "Checksum and count the blocks in a file\n" \
3699 "\nOptions:" \
3700 "\n -r Use BSD sum algorithm (1K blocks)" \
3701 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00003702
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003703#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003704 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003705#define sv_full_usage \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003706 "Control services monitored by runsv supervisor.\n" \
3707 "Commands (only first character is enough):\n" \
3708 "\n" \
3709 "status: query service status\n" \
3710 "up: if service isn't running, start it. If service stops, restart it\n" \
3711 "once: like 'up', but if service stops, don't restart it\n" \
3712 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3713 " if it exists. After it stops, do not restart service\n" \
3714 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3715 " runsv exits too\n" \
3716 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003717 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003718
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003719#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003720 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003721#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003722 "Continuously read log data from standard input, optionally " \
3723 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003724 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003725
Eric Andersen7e9276b2001-02-22 01:15:47 +00003726#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003727 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003728#define swapoff_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003729 "Stop swapping on DEVICE\n" \
3730 "\nOptions:" \
3731 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003732
Eric Andersen7e9276b2001-02-22 01:15:47 +00003733#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003734 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003735#define swapon_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003736 "Start swapping on DEVICE\n" \
3737 "\nOptions:" \
3738 "\n -a Start swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003739
Rob Landley0f34a822005-10-27 22:55:50 +00003740#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003741 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003742#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003743 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003744 "and exec NEW_INIT\n" \
3745 "\nOptions:" \
3746 "\n -c Redirect console to device on new root" \
Rob Landley0f34a822005-10-27 22:55:50 +00003747
Eric Andersen7e9276b2001-02-22 01:15:47 +00003748#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003749 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003750#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003751 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003752
Eric Andersenb9050282003-12-24 06:02:11 +00003753#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003754 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003755#define sysctl_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003756 "Configure kernel parameters at runtime\n" \
3757 "\nOptions:" \
3758 "\n -n Disable printing of key names" \
3759 "\n -e Don't warn about unknown keys" \
3760 "\n -w Change sysctl setting" \
3761 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
3762 "\n -a Display all values" \
3763 "\n -A Display all values in table form" \
3764
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003765#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003766 "sysctl [-n] [-e] variable...\n" \
3767 "sysctl [-n] [-e] -w variable=value...\n" \
3768 "sysctl [-n] [-e] -a\n" \
3769 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3770 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003771
Eric Andersen7e9276b2001-02-22 01:15:47 +00003772#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003773 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003774#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003775 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003776 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
3777 "\nOptions:" \
3778 "\n -n Run in foreground" \
3779 "\n -O FILE Log to given file (default=/var/log/messages)" \
3780 "\n -l n Set local log level" \
3781 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003782 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003783 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3784 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003785 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003786 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3787 "\n -L Log locally and via network (default is network only if -R)") \
3788 USE_FEATURE_SYSLOGD_DUP( \
3789 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003790 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003791 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003792 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003793/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00003794
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003795#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003796 "$ syslogd -R masterlog:514\n" \
3797 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003798
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003799#define tac_trivial_usage \
3800 "[FILE]..."
3801#define tac_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003802 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003803
Eric Andersen7e9276b2001-02-22 01:15:47 +00003804#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003805 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003806#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003807 "Print last 10 lines of each FILE to standard output.\n" \
3808 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003809 "file name. With no FILE, or when FILE is -, read standard input.\n" \
3810 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003811 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003812 "\n -c N[kbm] Output the last N bytes") \
3813 "\n -n N[kbm] Print last N lines instead of last 10" \
3814 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003815 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003816 "\n -q Never output headers giving file names" \
3817 "\n -s SEC Wait SEC seconds between reads with -f" \
3818 "\n -v Always output headers giving file names" \
3819 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003820 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3821 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003822 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
3823
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003824#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003825 "$ tail -n 1 /etc/resolv.conf\n" \
3826 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003827
Eric Andersen7e9276b2001-02-22 01:15:47 +00003828#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003829 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003830 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3831 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003832 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003833 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003834#define tar_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003835 "Create, extract, or list files from a tar file\n" \
3836 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003837 USE_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003838 "\n c Create") \
3839 "\n x Extract" \
3840 "\n t List" \
3841 "\nArchive format selection:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003842 USE_FEATURE_TAR_GZIP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003843 "\n z Filter the archive through gzip" \
3844 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003845 USE_FEATURE_TAR_BZIP2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003846 "\n j Filter the archive through bzip2" \
3847 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003848 USE_FEATURE_TAR_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003849 "\n a Filter the archive through lzma" \
3850 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003851 USE_FEATURE_TAR_COMPRESS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003852 "\n Z Filter the archive through compress" \
3853 ) \
3854 "\nFile selection:" \
3855 "\n f Name of TARFILE or \"-\" for stdin" \
3856 "\n O Extract to stdout" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003857 USE_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003858 "\n exclude File to exclude" \
3859 "\n X File with names to exclude" \
3860 ) \
3861 "\n C Change to directory DIR before operation" \
3862 "\n v Verbose" \
3863
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003864#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003865 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3866 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003867
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003868#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00003869 "[-p] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003870#define taskset_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003871 "Set or get CPU affinity\n" \
3872 "\nOptions:" \
3873 "\n -p Operate on an existing PID" \
3874
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003875#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003876 "$ taskset 0x7 ./dgemm_test&\n" \
3877 "$ taskset -p 0x1 $!\n" \
3878 "pid 4790's current affinity mask: 7\n" \
3879 "pid 4790's new affinity mask: 1\n" \
3880 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3881 "pid 6671's current affinity mask: 1\n" \
3882 "pid 6671's new affinity mask: 1\n" \
3883 "$ taskset -p 1\n" \
3884 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003885
Eric Andersen7e9276b2001-02-22 01:15:47 +00003886#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003887 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003888#define tee_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003889 "Copy standard input to each FILE, and also to standard output\n" \
3890 "\nOptions:" \
3891 "\n -a Append to the given FILEs, do not overwrite" \
3892 "\n -i Ignore interrupt signals (SIGINT)" \
3893
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003894#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003895 "$ echo \"Hello\" | tee /tmp/foo\n" \
3896 "$ cat /tmp/foo\n" \
3897 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003898
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003899#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003900#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003901 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003902#define telnet_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003903 "Connect to telnet server\n" \
3904 "\nOptions:" \
3905 "\n -a Attempt an automatic login with USER variable" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003906 "\n -l USER Attempt an automatic login with USER argument" \
3907
Eric Andersen539ffc92004-02-22 12:25:47 +00003908#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003909#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003910 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003911#define telnet_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003912 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003913#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003914
Eric Andersen08a72202002-09-30 20:52:10 +00003915#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003916 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003917#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003918 "Handle incoming telnet connections" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003919 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
3920 "\nOptions:" \
3921 "\n -l LOGIN Exec LOGIN on connect" \
3922 "\n -f issue_file Display issue_file instead of /etc/issue" \
3923 "\n -K Close connection as soon as login exits" \
3924 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003925 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003926 "\n -p PORT Port to listen on" \
3927 "\n -b ADDR Address to bind to" \
3928 "\n -F Run in foreground" \
3929 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003930 )
Eric Andersen08a72202002-09-30 20:52:10 +00003931
Eric Andersen7e9276b2001-02-22 01:15:47 +00003932#define test_trivial_usage \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00003933 "EXPRESSION\n" \
3934 " or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003935#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003936 "Check file types and compares values returning an exit code\n" \
3937 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003938#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003939 "$ test 1 -eq 2\n" \
3940 "$ echo $?\n" \
3941 "1\n" \
3942 "$ test 1 -eq 1\n" \
3943 "$ echo $?\n" \
3944 "0\n" \
3945 "$ [ -d /etc ]\n" \
3946 "$ echo $?\n" \
3947 "0\n" \
3948 "$ [ -d /junk ]\n" \
3949 "$ echo $?\n" \
3950 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003951
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003952#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003953 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003954/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003955/* "[-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 +00003956#define tcpsvd_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003957 "Create TCP socket, bind it to ip:port and listen\n" \
3958 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003959 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003960 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003961 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003962 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3963 "\n-u user[:group] Change to user/group after bind" \
3964 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003965 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003966 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3967 "\n New connections from this IP address are closed" \
3968 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003969 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003970 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003971 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003972
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003973#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003974 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003975#define udpsvd_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003976 "Create UDP socket, bind it to ip:port and wait\n" \
3977 "for incoming packets. Run PROG for each packet,\n" \
3978 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003979 "\nip IP to listen on. '0' = all" \
3980 "\nport Port to listen on" \
3981 "\nprog [arg] Program to run" \
3982 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3983 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003984 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003985 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003986 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003987 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003988
Mark Whitley450736c2001-03-02 19:08:50 +00003989#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003990 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003991#define tftp_full_usage \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00003992 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003993 "\nOptions:" \
3994 "\n -l FILE Local FILE" \
3995 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003996 USE_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003997 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003998 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003999 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004000 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004001 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004002 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004003 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004004 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004005
4006#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004007 "[-cr] [-u USER] [DIR]"
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004008#define tftpd_full_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004009 "Transfer a file on tftp client's request.\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004010 "\nOptions:" \
4011 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004012 "\n -c Allow file creation via upload" \
4013 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004014
Eric Andersenc3657422001-11-30 07:54:32 +00004015#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004016 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00004017#define time_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004018 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004019 "COMMAND's resource usage information is displayed.\n" \
4020 "\nOptions:" \
4021 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004022
Eric Andersen420b2082002-09-17 22:14:58 +00004023#define top_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004024 "[-b] [-n COUNT] [-d SECONDS]"
Eric Andersen420b2082002-09-17 22:14:58 +00004025#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004026 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004027 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004028 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004029
Eric Andersen7e9276b2001-02-22 01:15:47 +00004030#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004031 "[-c] FILE [FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004032#define touch_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004033 "Update the last-modified date on the given FILE[s]\n" \
4034 "\nOptions:" \
4035 "\n -c Do not create any files" \
4036
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004037#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004038 "$ ls -l /tmp/foo\n" \
4039 "/bin/ls: /tmp/foo: No such file or directory\n" \
4040 "$ touch /tmp/foo\n" \
4041 "$ ls -l /tmp/foo\n" \
4042 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004043
4044#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004045 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004046#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004047 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004048 "standard input, writing to standard output\n" \
4049 "\nOptions:" \
4050 "\n -c Take complement of STRING1" \
4051 "\n -d Delete input characters coded STRING1" \
4052 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4053
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004054#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004055 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4056 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004057
Eric Andersen5c58d282001-07-10 16:29:00 +00004058#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004059 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4060 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004061 " [-z pausemsecs] HOST [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00004062#define traceroute_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004063 "Trace the route to HOST\n" \
4064 "\nOptions:" \
4065 "\n -F Set the don't fragment bit" \
4066 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4067 "\n -l Display the ttl value of the returned packet" \
4068 "\n -d Set SO_DEBUG options to socket" \
4069 "\n -n Print hop addresses numerically rather than symbolically" \
4070 "\n -r Bypass the normal routing tables and send directly to a host" \
4071 "\n -v Verbose" \
4072 "\n -m max_ttl Max time-to-live (max number of hops)" \
4073 "\n -p port# Base UDP port number used in probes" \
4074 "\n (default is 33434)" \
4075 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4076 "\n -s src_addr IP address to use as the source address" \
4077 "\n -t tos Type-of-service in probe packets (default 0)" \
4078 "\n -w wait Time in seconds to wait for a response" \
4079 "\n (default 3 sec)" \
4080 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004081
Eric Andersen7e9276b2001-02-22 01:15:47 +00004082#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004083 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004084#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004085 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004086#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004087 "$ true\n" \
4088 "$ echo $?\n" \
4089 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004090
Eric Andersen7e9276b2001-02-22 01:15:47 +00004091#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004092 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004093#define tty_full_usage \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004094 "Print file name of standard input's terminal" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004095 USE_INCLUDE_SUSv2( "\n" \
4096 "\nOptions:" \
4097 "\n -s Print nothing, only return exit status" \
4098 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004099#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004100 "$ tty\n" \
4101 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004102
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004103#define ttysize_trivial_usage \
4104 "[w] [h]"
4105#define ttysize_full_usage \
4106 "Print dimension(s) of standard input's terminal, on error return 80x25"
4107
Mike Frysinger174808c2005-06-11 01:14:09 +00004108#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004109 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4110 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4111 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4112 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4113 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4114 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00004115#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004116 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004117
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004118#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004119 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004120 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004121#define udhcpc_full_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004122 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004123 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004124 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4125 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4126 "\n -c,--clientid=CLIENTID Client identifier" \
4127 "\n -C,--clientid-none Suppress default client identifier" \
4128 "\n -p,--pidfile=file Create pidfile" \
4129 "\n -r,--request=IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004130 "\n -s,--script=file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004131 "\n -t,--retries=N Send up to N request packets" \
4132 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4133 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004134 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4135 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004136 "\n -f,--foreground Run in foreground" \
4137 "\n -b,--background Background if lease is not immediately obtained" \
4138 "\n -S,--syslog Log to syslog too" \
4139 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4140 "\n -q,--quit Quit after obtaining lease" \
4141 "\n -R,--release Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004142 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004143 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004144 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004145 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004146 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004147 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004148 ) \
4149 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004150 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004151 "\n -i INTERFACE Interface to use (default: eth0)" \
4152 "\n -H,-h HOSTNAME Client hostname" \
4153 "\n -c CLIENTID Client identifier" \
4154 "\n -C Suppress default client identifier" \
4155 "\n -p file Create pidfile" \
4156 "\n -r IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004157 "\n -s file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004158 "\n -t N Send up to N request packets" \
4159 "\n -T N Try to get a lease for N seconds (default 3)" \
4160 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004161 "\n -O OPT Request DHCP option OPT (cumulative)" \
4162 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004163 "\n -f Run in foreground" \
4164 "\n -b Background if lease is not immediately obtained" \
4165 "\n -S Log to syslog too" \
4166 "\n -n Exit with failure if lease is not immediately obtained" \
4167 "\n -q Quit after obtaining lease" \
4168 "\n -R 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 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 Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004174 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004175 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004176
Russ Dill61fb4892002-10-14 21:41:28 +00004177#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004178 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004179
4180#define udhcpd_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004181 "DHCP server\n" \
4182 "\n -f Run in foreground" \
4183 "\n -S Log to syslog too" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004184 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004185 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004186 )
Russ Dill61fb4892002-10-14 21:41:28 +00004187
Eric Andersen7e9276b2001-02-22 01:15:47 +00004188#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004189 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004190#define umount_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004191 "Unmount file systems\n" \
4192 "\nOptions:" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004193 USE_FEATURE_UMOUNT_ALL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004194 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
4195 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004196 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004197 "\n -n Don't erase /etc/mtab entries" \
4198 ) \
4199 "\n -r Try to remount devices as read-only if mount is busy" \
4200 "\n -l Lazy umount (detach filesystem)" \
4201 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004202 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004203 "\n -d Free loop device if it has been used" \
4204 )
4205
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004206#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004207 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004208
4209#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004210 "[-amnrspv]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004211#define uname_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004212 "Print system information.\n" \
4213 "\nOptions:" \
4214 "\n -a Print all" \
4215 "\n -m The machine (hardware) type" \
4216 "\n -n Hostname" \
4217 "\n -r OS release" \
4218 "\n -s OS name (default)" \
4219 "\n -p Processor type" \
4220 "\n -v OS version" \
4221
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004222#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004223 "$ uname -a\n" \
4224 "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 +00004225
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004226#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004227 "[-c] [-f] [name...]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004228#define uncompress_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004229 "Uncompress .Z file[s]\n" \
4230 "\nOptions:" \
4231 "\n -c Extract to stdout" \
4232 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004233
Denis Vlasenko3952f202007-08-13 14:10:24 +00004234#define unexpand_trivial_usage \
4235 "[-f][-a][-t NUM] [FILE|-]"
4236#define unexpand_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004237 "Convert spaces to tabs, writing to standard output.\n" \
4238 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004239 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004240 "\n -a,--all Convert all blanks" \
4241 "\n -f,--first-only Convert only leading blanks" \
4242 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004243 ) \
4244 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004245 "\n -a Convert all blanks" \
4246 "\n -f Convert only leading blanks" \
4247 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004248 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004249
Eric Andersen7e9276b2001-02-22 01:15:47 +00004250#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004251 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004252#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004253 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004254 "(or standard input), writing to OUTPUT (or standard output)\n" \
4255 "\nOptions:" \
4256 "\n -c Prefix lines by the number of occurrences" \
4257 "\n -d Only print duplicate lines" \
4258 "\n -u Only print unique lines" \
4259 "\n -f N Skip the first N fields" \
4260 "\n -s N Skip the first N chars (after any skipped fields)" \
4261
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004262#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004263 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4264 "a\n" \
4265 "b\n" \
4266 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004267
4268#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004269 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004270#define unix2dos_full_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004271 "Convert FILE from unix to dos format.\n" \
4272 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004273 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004274 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004275 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004276
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004277#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004278 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004279#define unzip_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004280 "Extract files from ZIP archives\n" \
4281 "\nOptions:" \
4282 "\n -l List archive contents (with -q for short form)" \
4283 "\n -n Never overwrite existing files (default)" \
4284 "\n -o Overwrite files without prompting" \
4285 "\n -p Send output to stdout" \
4286 "\n -q Quiet" \
4287 "\n -x Exclude these files" \
4288 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004289
Eric Andersen7e9276b2001-02-22 01:15:47 +00004290#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004291 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004292#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004293 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004294
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004295#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004296 "$ uptime\n" \
4297 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004298
4299#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004300 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004301#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004302 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004303
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004304#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004305 "$ usleep 1000000\n" \
4306 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004307
4308#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004309 "[-o outfile] [infile]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004310#define uudecode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004311 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004312 "Finds outfile name in uuencoded source unless -o is given"
4313
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004314#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004315 "$ uudecode -o busybox busybox.uu\n" \
4316 "$ ls -l busybox\n" \
4317 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004318
4319#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004320 "[-m] [infile] stored_filename"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004321#define uuencode_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004322 "Uuencode a file to stdout\n" \
4323 "\nOptions:" \
4324 "\n -m Use base64 encoding per RFC1521" \
4325
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004326#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004327 "$ uuencode busybox busybox\n" \
4328 "begin 755 busybox\n" \
4329 "<encoded file snipped>\n" \
4330 "$ uudecode busybox busybox > busybox.uu\n" \
4331 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004332
Eric Andersen853c4942003-01-23 05:59:32 +00004333#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004334 "COMMAND [OPTIONS]..."
Eric Andersen853c4942003-01-23 05:59:32 +00004335#define vconfig_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004336 "Create and remove virtual ethernet devices\n" \
4337 "\nOptions:" \
4338 "\n add [interface-name] [vlan_id]" \
4339 "\n rem [vlan-name]" \
4340 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4341 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4342 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4343 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004344
Eric Andersen3f980402001-04-04 17:31:15 +00004345#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004346 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00004347#define vi_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004348 "Edit FILE\n" \
4349 "\nOptions:" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004350 USE_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004351 "\n -c Initial command to run ($EXINIT also available)") \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004352 USE_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004353 "\n -R Read-only - do not write to the file") \
4354 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004355
Eric Andersen27f64e12002-06-23 04:24:25 +00004356#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004357 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00004358#define vlock_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004359 "Lock a virtual terminal. A password is required to unlock.\n" \
4360 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004361 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004362
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004363#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004364 "[-n seconds] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004365#define watch_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004366 "Execute a program periodically\n" \
4367 "\nOptions:" \
4368 "\n -n Loop period in seconds (default 2)" \
4369 "\n -t Don't print header" \
4370
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004371#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004372 "$ watch date\n" \
4373 "Mon Dec 17 10:31:40 GMT 2000\n" \
4374 "Mon Dec 17 10:31:42 GMT 2000\n" \
4375 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004376
Eric Andersen7e9276b2001-02-22 01:15:47 +00004377#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004378 "[-t N[ms]] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004379#define watchdog_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004380 "Periodically write to watchdog device DEV\n" \
4381 "\nOptions:" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004382 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004383 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004384 "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004385 "\nUse -t 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004386
4387#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004388 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004389#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004390 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004391 "more than one FILE is specified. With no FILE, read standard input.\n" \
4392 "\nOptions:" \
4393 "\n -c Print the byte counts" \
4394 "\n -l Print the newline counts" \
4395 "\n -L Print the length of the longest line" \
4396 "\n -w Print the word counts" \
4397
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004398#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004399 "$ wc /etc/passwd\n" \
4400 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004401
4402#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004403 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004404 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004405 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4406 " [-U|--user-agent agent] url" \
4407 ) \
4408 SKIP_GETOPT_LONG( \
4409 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4410 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00004411#define wget_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004412 "Retrieve files via HTTP or FTP\n" \
4413 "\nOptions:" \
4414 "\n -s Spider mode - only check file existence" \
4415 "\n -c Continue retrieval of aborted transfer" \
4416 "\n -q Quiet" \
4417 "\n -P Set directory prefix to DIR" \
4418 "\n -O Save to filename ('-' for stdout)" \
4419 "\n -U Adjust 'User-Agent' field" \
4420 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004421
4422#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004423 "[COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004424#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004425 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004426#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004427 "$ which login\n" \
4428 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004429
Eric Andersen00a6a752002-04-26 23:53:10 +00004430#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004431 "[-a]"
Eric Andersen00a6a752002-04-26 23:53:10 +00004432#define who_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004433 "Show who is logged on\n" \
4434 "\nOptions:" \
4435 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004436
4437#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004438 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004439#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004440 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004441
4442#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004443 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004444#define xargs_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004445 "Execute COMMAND on every item given by standard input\n" \
4446 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004447 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004448 "\n -p Prompt the user about whether to run each command") \
4449 "\n -r Do not run command for empty read lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004450 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004451 "\n -x Exit if the size is exceeded") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004452 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004453 "\n -0 Input filenames are terminated by a null character") \
4454 "\n -t Print the command line on stderr before executing it" \
4455
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004456#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004457 "$ ls | xargs gzip\n" \
4458 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004459
4460#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004461 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004462#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004463 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004464
Eric Andersen7e9276b2001-02-22 01:15:47 +00004465#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004466 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004467#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004468 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004469
Rob Landleyad8071f2005-04-30 03:49:37 +00004470#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004471 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00004472#define zcip_full_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00004473 "Manage a ZeroConf IPv4 link-local address\n" \
4474 "\nOptions:" \
4475 "\n -f Run in foreground" \
4476 "\n -q Quit after address (no daemon)" \
4477 "\n -r 169.254.x.x Request this address first" \
4478 "\n -v Verbose" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004479
Eric Andersen178de172004-04-06 16:36:20 +00004480#endif /* __BB_USAGE_H__ */