blob: 97f4f27be6ca6d44aa2c99bffafe8ee8f7ae6a6c [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
Denis Vlasenko4f98e192008-04-13 22:12:19 +000016
17#define NOUSAGE_STR "\b"
18
19
Eric Andersenf349e972001-08-21 16:18:59 +000020#define addgroup_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +000021 "[-g GID] " USE_FEATURE_ADDUSER_TO_GROUP("[user_name] ") "group_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000022#define addgroup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000023 "Add a group " USE_FEATURE_ADDUSER_TO_GROUP("or add an user to a group") "\n" \
24 "\nOptions:" \
Denis Vlasenko4f98e192008-04-13 22:12:19 +000025 "\n -g GID Group id" \
Eric Andersenf349e972001-08-21 16:18:59 +000026
27#define adduser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000028 "[OPTIONS] user_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000029#define adduser_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000030 "Add an user\n" \
31 "\nOptions:" \
32 "\n -h DIR Home directory" \
33 "\n -g GECOS GECOS field" \
34 "\n -s SHELL Login shell" \
35 "\n -G GROUP Add user to existing group" \
36 "\n -S Create a system user" \
37 "\n -D Do not assign a password" \
38 "\n -H Do not create home directory" \
Eric Andersenf349e972001-08-21 16:18:59 +000039
Mark Whitley6f932772001-03-20 19:18:10 +000040#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000041 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000042#define adjtimex_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000043 "Read and optionally set system timebase parameters. See adjtimex(2).\n" \
44 "\nOptions:" \
45 "\n -q Quiet" \
46 "\n -o offset Time offset, microseconds" \
47 "\n -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)" \
48 "\n (positive values make clock run faster)" \
49 "\n -t tick Microseconds per tick, usually 10000" \
50 "\n -p timeconstant" \
Mark Whitley6f932772001-03-20 19:18:10 +000051
Eric Andersen7e9276b2001-02-22 01:15:47 +000052#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000053 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000054#define ar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000055 "Extract or list FILES from an ar archive\n" \
56 "\nOptions:" \
57 "\n -o Preserve original dates" \
58 "\n -p Extract to stdout" \
59 "\n -t List" \
60 "\n -x Extract" \
61 "\n -v Verbose" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000062
Denis Vlasenkofa85b862007-01-07 01:24:12 +000063#define arp_trivial_usage \
64 "\n" \
65 "[-vn] [-H type] [-i if] -a [hostname]\n" \
66 "[-v] [-i if] -d hostname [pub]\n" \
67 "[-v] [-H type] [-i if] -s hostname hw_addr [temp]\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +000068 "[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub\n" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000069 "[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub\n"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000070#define arp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000071 "Manipulate ARP cache\n" \
72 "\nOptions:" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000073 "\n -a Display (all) hosts" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000074 "\n -s Set new ARP entry" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000075 "\n -d Delete a specified entry" \
76 "\n -v Verbose" \
77 "\n -n Don't resolve names" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000078 "\n -i IF Network interface" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000079 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +000080 "\n -A, -p AF Protocol family" \
Denis Vlasenko397de612008-03-17 08:55:44 +000081 "\n -H HWTYPE Hardware address type" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000082
Glenn L McGrath9e598412003-01-09 10:06:01 +000083#define arping_trivial_usage \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +000084 "[-fqbDUA] [-c count] [-w timeout] [-I dev] [-s sender] target"
Denis Vlasenko4f98e192008-04-13 22:12:19 +000085#define arping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +000086 "Send ARP requests/replies\n" \
87 "\nOptions:" \
88 "\n -f Quit on first ARP reply" \
89 "\n -q Quiet" \
90 "\n -b Keep broadcasting, don't go unicast" \
91 "\n -D Duplicated address detection mode" \
92 "\n -U Unsolicited ARP mode, update your neighbors" \
93 "\n -A ARP answer mode, update your neighbors" \
94 "\n -c N Stop after sending N ARP requests" \
95 "\n -w timeout Time to wait for ARP reply, in seconds" \
96 "\n -I dev Interface to use (default eth0)" \
97 "\n -s sender Sender IP address" \
98 "\n target Target IP address" \
Glenn L McGrath9e598412003-01-09 10:06:01 +000099
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000100#define sh_trivial_usage NOUSAGE_STR
101#define sh_full_usage ""
102#define ash_trivial_usage NOUSAGE_STR
103#define ash_full_usage ""
104#define hush_trivial_usage NOUSAGE_STR
105#define hush_full_usage ""
106#define msh_trivial_usage NOUSAGE_STR
107#define msh_full_usage ""
Eric Andersen08f59e32004-03-12 22:07:10 +0000108
109#define awk_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000110 "[OPTION]... [program-text] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000111#define awk_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000112 "Options:" \
113 "\n -v var=val Set variable" \
114 "\n -F sep Use sep as field separator" \
115 "\n -f file Read program from file" \
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000116
Eric Andersen7e9276b2001-02-22 01:15:47 +0000117#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000118 "FILE [SUFFIX]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000119#define basename_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000120 "Strip directory path and suffixes from FILE.\n" \
121 "If specified, also remove any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000122#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000123 "$ basename /usr/local/bin/foo\n" \
124 "foo\n" \
125 "$ basename /usr/local/bin/\n" \
126 "bin\n" \
127 "$ basename /foo/bar.txt .txt\n" \
128 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000129
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000130#define fbsplash_trivial_usage \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000131 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000132#define fbsplash_full_usage "\n\n" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000133 "Options:\n" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000134 "\n -s Image" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000135 "\n -c Hide cursor" \
136 "\n -d Framebuffer device (default /dev/fb0)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000137 "\n -i Config file (var=value):" \
138 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
139 "\n BAR_R,BAR_G,BAR_B" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000140 "\n -f Control pipe (else exit after drawing image)" \
Denis Vlasenkoc6dbb852008-03-26 14:57:49 +0000141 "\n commands: 'NN' (% for progress bar) or 'exit'" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +0000142
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000143#define brctl_trivial_usage \
144 "COMMAND [BRIDGE [INTERFACE]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000145#define brctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000146 "Manage ethernet bridges.\n" \
147 "\nCommands:" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000148 USE_FEATURE_BRCTL_SHOW( \
149 "\n show Show a list of bridges" \
150 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000151 "\n addbr BRIDGE Create BRIDGE" \
152 "\n delbr BRIDGE Delete BRIDGE" \
153 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
154 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
155 USE_FEATURE_BRCTL_FANCY( \
156 "\n setageing BRIDGE TIME Set ageing time" \
157 "\n setfd BRIDGE TIME Set bridge forward delay" \
158 "\n sethello BRIDGE TIME Set hello time" \
159 "\n setmaxage BRIDGE TIME Set max message age" \
160 "\n setpathcost BRIDGE COST Set path cost" \
161 "\n setportprio BRIDGE PRIO Set port priority" \
162 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
163 "\n stp BRIDGE [1|0] STP on/off" \
Denis Vlasenko278a1c22008-04-06 07:17:02 +0000164 ) \
165
Glenn L McGrath24e28332001-10-05 03:48:57 +0000166#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000167 "[OPTION]... [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000168#define bunzip2_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000169 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
170 "\nOptions:" \
171 "\n -c Write to standard output" \
172 "\n -f Force" \
Glenn L McGrath24e28332001-10-05 03:48:57 +0000173
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000174#define bzip2_trivial_usage \
175 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000176#define bzip2_full_usage "\n\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000177 "Compress FILE(s) with bzip2 algorithm.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000178 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n" \
179 "\nOptions:" \
180 "\n -c Write to standard output" \
181 "\n -d Decompress" \
182 "\n -f Force" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000183 "\n -1..-9 Compression level" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000184
Rob Landley6130b9b2006-01-23 21:10:38 +0000185#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000186 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000187
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000188#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000189 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000190#define bzcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000191 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000192
Rob Landleyc1d69902006-01-20 18:28:50 +0000193#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000194 "[OPTION]... [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000195#define unlzma_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000196 "Uncompress FILE (or standard input if FILE is '-' or omitted)\n" \
197 "\nOptions:" \
198 "\n -c Write to standard output" \
199 "\n -f Force" \
Rob Landleyc1d69902006-01-20 18:28:50 +0000200
201#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000202 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000203#define lzmacat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000204 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000205
Eric Andersenc98c0622001-12-06 15:16:43 +0000206#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000207 "[-jy] [[month] year]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000208#define cal_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000209 "Display a calendar\n" \
210 "\nOptions:" \
211 "\n -j Use julian dates" \
212 "\n -y Display the entire year" \
Eric Andersenc98c0622001-12-06 15:16:43 +0000213
Eric Andersen7e9276b2001-02-22 01:15:47 +0000214#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000215 "[-u] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000216#define cat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000217 "Concatenate FILE(s) and print them to stdout\n" \
218 "\nOptions:" \
219 "\n -u Use unbuffered i/o (ignored)" \
220
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000221#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000222 "$ cat /proc/uptime\n" \
223 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000224
Rob Landley8abbee42006-05-31 19:36:04 +0000225#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000226 "[-etv] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000227#define catv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000228 "Display nonprinting characters as ^x or M-x\n" \
229 "\nOptions:" \
230 "\n -e End each line with $" \
231 "\n -t Show tabs as ^I" \
232 "\n -v Don't use ^x or M-x escapes" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000233
234#define chat_trivial_usage \
235 "EXPECT [SEND [EXPECT [SEND...]]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000236#define chat_full_usage "\n\n" \
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000237 "Useful for interacting with a modem connected to stdin/stdout.\n" \
238 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
239 "each pair is a pair of arguments. Example:\n" \
240 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
241
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000242#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000243 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000244#define chattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000245 "Change file attributes on an ext2 fs\n" \
246 "\nModifiers:" \
247 "\n - Remove attributes" \
248 "\n + Add attributes" \
249 "\n = Set attributes" \
250 "\nAttributes:" \
251 "\n A Don't track atime" \
252 "\n a Append mode only" \
253 "\n c Enable compress" \
254 "\n D Write dir contents synchronously" \
255 "\n d Do not backup with dump" \
256 "\n i Cannot be modified (immutable)" \
257 "\n j Write all data to journal first" \
258 "\n s Zero disk storage when deleted" \
259 "\n S Write file contents synchronously" \
260 "\n t Disable tail-merging of partial blocks with other files" \
261 "\n u Allow file to be undeleted" \
262 "\nOptions:" \
263 "\n -R Recursively list subdirectories" \
264 "\n -v Set the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000265
Denis Vlasenko49622d72007-03-10 16:58:49 +0000266#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000267 "[OPTIONS] CONTEXT FILE..." \
268 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
269 USE_FEATURE_CHCON_LONG_OPTIONS( \
270 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
271 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000272#define chcon_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000273 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000274 USE_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000275 "\n -v,--verbose Verbose" \
276 "\n -c,--changes Report changes made" \
277 "\n -h,--no-dereference Affect symlinks instead of their targets" \
278 "\n -f,--silent,--quiet Suppress most error messages" \
279 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
280 "\n -u,--user=USER Set user/role/type/range in the target" \
281 "\n -r,--role=ROLE security context" \
282 "\n -t,--type=TYPE" \
283 "\n -l,--range=RANGE" \
284 "\n -R,--recursive Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000285 ) \
286 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000287 "\n -v Verbose" \
288 "\n -c Report changes made" \
289 "\n -h Affect symlinks instead of their targets" \
290 "\n -f Suppress most error messages" \
291 "\n -u USER Set user/role/type/range in the target security context" \
292 "\n -r ROLE" \
293 "\n -t TYPE" \
294 "\n -l RNG" \
295 "\n -R Recurse subdirectories" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000296 )
297
Eric Andersen7e9276b2001-02-22 01:15:47 +0000298#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000299 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000300#define chmod_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000301 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000302 "symbols +-= and one or more of the letters rwxst\n" \
303 "\nOptions:" \
304 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000305 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000306 "\n -c List changed files" \
307 "\n -v List all files" \
308 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000309 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000310#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000311 "$ ls -l /tmp/foo\n" \
312 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
313 "$ chmod u+x /tmp/foo\n" \
314 "$ ls -l /tmp/foo\n" \
315 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
316 "$ chmod 444 /tmp/foo\n" \
317 "$ ls -l /tmp/foo\n" \
318 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000319
Denis Vlasenko081ef792007-03-17 16:38:21 +0000320#define chgrp_trivial_usage \
321 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000322#define chgrp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000323 "Change the group membership of each FILE to GROUP\n" \
324 "\nOptions:" \
325 "\n -R Recurse directories" \
326 "\n -h Affect symlinks instead of symlink targets" \
327 "\n -L Traverse all symlinks to directories" \
328 "\n -H Traverse symlinks on command line only" \
329 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000330 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000331 "\n -c List changed files" \
332 "\n -v Verbose" \
333 "\n -f Hide errors" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000334 )
335#define chgrp_example_usage \
336 "$ ls -l /tmp/foo\n" \
337 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
338 "$ chgrp root /tmp/foo\n" \
339 "$ ls -l /tmp/foo\n" \
340 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
341
Eric Andersen7e9276b2001-02-22 01:15:47 +0000342#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000343 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000344#define chown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000345 "Change the owner and/or group of each FILE to OWNER and/or GROUP\n" \
346 "\nOptions:" \
347 "\n -R Recurse directories" \
348 "\n -h Affect symlinks instead of symlink targets" \
349 "\n -L Traverse all symlinks to directories" \
350 "\n -H Traverse symlinks on command line only" \
351 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000352 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000353 "\n -c List changed files" \
354 "\n -v List all files" \
355 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000356 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000357#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000358 "$ ls -l /tmp/foo\n" \
359 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
360 "$ chown root /tmp/foo\n" \
361 "$ ls -l /tmp/foo\n" \
362 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
363 "$ chown root.root /tmp/foo\n" \
364 "ls -l /tmp/foo\n" \
365 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000366
Denis Vlasenkofe544582006-10-03 15:57:40 +0000367#define chpst_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000368 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
369 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
370 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000371#define chpst_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000372 "Change the process state and run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000373 "\nOptions:" \
374 "\n -u USER[:GRP] Set uid and gid" \
375 "\n -U USER[:GRP] Set $UID and $GID in environment" \
376 "\n -e DIR Set environment variables as specified by files" \
377 "\n in DIR: file=1st_line_of_file" \
378 "\n -/ DIR Chroot to DIR" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000379 "\n -n NICE Add NICE to nice value" \
380 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000381 "\n -d BYTES Limit data segment" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000382 "\n -o N Limit number of open files per process" \
383 "\n -p N Limit number of processes per uid" \
384 "\n -f BYTES Limit output file sizes" \
385 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000386 "\n -v Verbose" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000387 "\n -P Create new process group" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000388 "\n -0 Close standard input" \
389 "\n -1 Close standard output" \
390 "\n -2 Close standard error" \
391
Denis Vlasenkofe544582006-10-03 15:57:40 +0000392#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000393 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000394#define setuidgid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000395 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000396 "groups and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000397#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000398 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000399#define envuidgid_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000400 "Set $UID to account's uid and $GID to account's gid and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000401#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000402 "dir prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000403#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000404 "Set various environment variables as specified by files\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000405 "in the directory dir and run PROG"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000406#define softlimit_trivial_usage \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000407 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
408 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
409 " PROG ARGS"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000410#define softlimit_full_usage "\n\n" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000411 "Set soft resource limits, then run PROG\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000412 "\nOptions:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000413 "\n -a BYTES Limit total size of all segments" \
414 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
415 "\n -d BYTES Limit data segment" \
416 "\n -s BYTES Limit stack segment" \
417 "\n -l BYTES Limit locked memory size" \
418 "\n -o N Limit number of open files per process" \
419 "\n -p N Limit number of processes per uid" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000420 "\nOptions controlling file sizes:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000421 "\n -f BYTES Limit output file sizes" \
422 "\n -c BYTES Limit core file size" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000423 "\nEfficiency opts:" \
Denis Vlasenkob3571492008-07-30 21:23:26 +0000424 "\n -r BYTES Limit resident set size" \
425 "\n -t N Limit CPU time, process receives" \
426 "\n a SIGXCPU after N seconds" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000427
Eric Andersen7e9276b2001-02-22 01:15:47 +0000428#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000429 "NEWROOT [COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000430#define chroot_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000431 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000432#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000433 "$ ls -l /bin/ls\n" \
434 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
435 "# mount /dev/hdc1 /mnt -t minix\n" \
436 "# chroot /mnt\n" \
437 "# ls -l /bin/ls\n" \
438 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000439
Eric Andersen7e9276b2001-02-22 01:15:47 +0000440#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000441 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000442#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000443 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000444
Rob Landley856489b2006-04-18 20:57:28 +0000445#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000446 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000447#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000448 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000449
Eric Andersen7e9276b2001-02-22 01:15:47 +0000450#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000451 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000452#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000453 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000454
Eric Andersen7e9276b2001-02-22 01:15:47 +0000455#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000456 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000457#define cmp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000458 "Compares FILE1 vs stdin if FILE2 is not specified\n" \
459 "\nOptions:" \
460 "\n -l Write the byte numbers (decimal) and values (octal)" \
461 "\n for all differing bytes" \
462 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000463
Rob Landley2acfd7b2005-05-11 23:12:49 +0000464#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000465 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000466#define comm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000467 "Compare FILE1 to FILE2, or to stdin if - is specified\n" \
468 "\nOptions:" \
469 "\n -1 Suppress lines unique to FILE1" \
470 "\n -2 Suppress lines unique to FILE2" \
471 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000472
Paul Fox79c142d2005-08-01 16:04:40 +0000473#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000474 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000475#define bbconfig_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000476 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000477
Rob Landley69674942006-09-11 00:34:01 +0000478#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000479 "[FILE]...\n" \
480 "or: bbsh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000481#define bbsh_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000482 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000483
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000484#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000485 "[OPTION]... [prio] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000486#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000487 "Manipulate real-time attributes of a process\n" \
488 "\nOptions:" \
489 "\n -p Operate on pid" \
490 "\n -r Set scheduling policy to SCHED_RR" \
491 "\n -f Set scheduling policy to SCHED_FIFO" \
492 "\n -o Set scheduling policy to SCHED_OTHER" \
493 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000494
495#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000496 "$ chrt -r 4 sleep 900; x=$!\n" \
497 "$ chrt -f -p 3 $x\n" \
498 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000499
Eric Andersen7e9276b2001-02-22 01:15:47 +0000500#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000501 "[OPTION]... SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000502#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000503 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
504 "\nOptions:" \
505 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000506 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000507 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000508 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000509 "\n -d,-P Preserve links" \
510 "\n -H,-L Dereference all symlinks (default)" \
511 "\n -p Preserve file attributes if possible" \
512 "\n -f Force overwrite" \
513 "\n -i Prompt before overwrite" \
514 "\n -R,-r Recurse directories" \
515 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000516
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000517#define cpio_trivial_usage \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000518 "-[dim" USE_FEATURE_CPIO_O("o") "tuv][F cpiofile]" \
Denis Vlasenko1f228982008-04-22 00:16:29 +0000519 USE_FEATURE_CPIO_O( "[H newc]" )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000520#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000521 "Extract or list files from a cpio archive" \
522 USE_FEATURE_CPIO_O( ", or create a cpio archive" ) \
523 "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000524 "Main operation mode:" \
525 "\n d Make leading directories" \
526 "\n i Extract" \
527 "\n m Preserve mtime" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000528 USE_FEATURE_CPIO_O( \
529 "\n o Create" \
530 "\n H newc Define format" \
531 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000532 "\n t List" \
533 "\n v Verbose" \
534 "\n u Unconditional overwrite" \
535 "\n F Input from file" \
Tim Riker7b253f82003-12-28 05:02:40 +0000536
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000537#define crond_trivial_usage \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000538 "-fbS -l N " USE_DEBUG_CROND_OPTION("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000539#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000540 " -f Foreground" \
541 "\n -b Background (default)" \
542 "\n -S Log to syslog (default)" \
543 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000544 USE_DEBUG_CROND_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000545 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000546 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000547 "\n -L Log to file" \
548 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000549
550#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000551 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000552#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000553 " -c Crontab directory" \
554 "\n -u User" \
555 "\n -l List crontab" \
556 "\n -e Edit crontab" \
557 "\n -r Delete crontab" \
558 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000559
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000560#define cryptpw_trivial_usage \
561 "[-a des|md5] [string]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000562#define cryptpw_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000563 "Output crypted string.\n" \
564 "If string isn't supplied on cmdline, read it from stdin.\n" \
565 "\nOptions:" \
566 "\n -a Algorithm to use (default: md5)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000567
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000568#define cttyhack_trivial_usage NOUSAGE_STR
569#define cttyhack_full_usage ""
570
Eric Andersen7e9276b2001-02-22 01:15:47 +0000571#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000572 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000573#define cut_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000574 "Print selected fields from each input FILE to standard output\n" \
575 "\nOptions:" \
576 "\n -b LIST Output only bytes from LIST" \
577 "\n -c LIST Output only characters from LIST" \
578 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
579 "\n -s Output only the lines containing delimiter" \
580 "\n -f N Print only these fields" \
581 "\n -n Ignored" \
582
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000583#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000584 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
585 "Hello\n" \
586 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
587 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000588
Eric Andersen7e9276b2001-02-22 01:15:47 +0000589#define date_trivial_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000590 "[OPTION]... [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000591#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000592 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000593 "\nOptions:" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000594 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000595 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000596 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000597 "\n -I[SPEC] Output ISO-8601 compliant date string" \
598 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000599 "\n 'hours', 'minutes', or 'seconds' for date and" \
600 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000601 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000602 "\n -d TIME Display TIME, not 'now'" \
603 "\n -r FILE Display last modification time of FILE" \
604 "\n [-s] TIME Set time to TIME" \
605 USE_FEATURE_DATE_ISOFMT( \
606 "\n -D FMT Use FMT for str->date conversion" \
607 ) \
608 "\n" \
609 "\nRecognized formats for TIME:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000610 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000611 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000612 "\n YYYY-MM-DD hh:mm[:ss]" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000613 "\n MMDDhhmm[[YY]YY][.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000614
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000615#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000616 "$ date\n" \
617 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000618
Eric Andersen7e9276b2001-02-22 01:15:47 +0000619#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000620 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000621#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000622 "Tiny RPN calculator. Operations:\n" \
623 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
624 "p - print top of the stack (without altering the stack),\n" \
625 "f - print entire stack, o - pop the value and set output radix\n" \
626 "(value must be 10 or 16).\n" \
627 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000628
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000629#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000630 "$ dc 2 2 + p\n" \
631 "4\n" \
632 "$ dc 8 8 \\* 2 2 + / p\n" \
633 "16\n" \
634 "$ dc 0 1 and p\n" \
635 "0\n" \
636 "$ dc 0 1 or p\n" \
637 "1\n" \
638 "$ echo 72 9 div 8 mul p | dc\n" \
639 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000640
Eric Andersen7e9276b2001-02-22 01:15:47 +0000641#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000642 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000643 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000644#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000645 "Copy a file with converting and formatting\n" \
646 "\nOptions:" \
647 "\n if=FILE Read from FILE instead of stdin" \
648 "\n of=FILE Write to FILE instead of stdout" \
649 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000650 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000651 "\n ibs=N Read N bytes at a time" \
652 ) \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000653 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000654 "\n obs=N Write N bytes at a time" \
655 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000656 "\n count=N Copy only N input blocks" \
657 "\n skip=N Skip N input blocks" \
658 "\n seek=N Skip N output blocks" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000659 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000660 "\n conv=notrunc Don't truncate output file" \
661 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000662 "\n conv=sync Pad blocks with zeros" \
663 "\n conv=fsync Physically write data out before finishing" \
664 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000665 "\n" \
666 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
667 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
668
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000669#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000670 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
671 "4+0 records in\n" \
672 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000673
Eric Andersen7e9276b2001-02-22 01:15:47 +0000674#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000675 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000676#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000677 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000678
Eric Andersenf349e972001-08-21 16:18:59 +0000679#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000680 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000681#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000682 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000683 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000684
685#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000686 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000687#define deluser_full_usage "\n\n" \
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000688 "Delete USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000689
Denis Vlasenkoa80d0e42008-06-22 20:14:00 +0000690#define depmod_trivial_usage NOUSAGE_STR
691#define depmod_full_usage ""
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000692
Denis Vlasenkoc94fa562008-10-26 11:08:14 +0000693#define devmem_trivial_usage \
694 "ADDRESS [WIDTH [VALUE]]"
695
696#define devmem_full_usage "\n\n" \
697 "Read/write from physical address\n" \
698 "\n ADDRESS Address to act upon" \
699 "\n WIDTH Width (8/16/...)" \
700 "\n VALUE Data to be written" \
701
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000702#define devfsd_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000703 "mntpnt [-v]" USE_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000704#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000705 "Manage devfs permissions and old device name symlinks\n" \
706 "\nOptions:" \
707 "\n mntpnt The mount point where devfs is mounted" \
708 "\n -v Print the protocol version numbers for devfsd" \
709 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000710 USE_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000711 "\n -fg Run in foreground" \
712 "\n -np Exit after parsing the configuration file" \
713 "\n and processing synthetic REGISTER events," \
714 "\n do not poll for events" \
715 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000716
Eric Andersen7e9276b2001-02-22 01:15:47 +0000717#define df_trivial_usage \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000718 "[-Pk" \
719 USE_FEATURE_HUMAN_READABLE("mh") \
720 USE_FEATURE_DF_FANCY("ai] [-B SIZE") \
721 "] [FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000722#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000723 "Print filesystem usage statistics\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000724 "\nOptions:" \
725 "\n -P POSIX output format" \
726 "\n -k 1024-byte blocks (default)" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000727 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000728 "\n -m 1M-byte blocks" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000729 "\n -h Human readable (e.g. 1K 243M 2G)" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000730 ) \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000731 USE_FEATURE_DF_FANCY( \
732 "\n -a Show all filesystems" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000733 "\n -i Inodes" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000734 "\n -B SIZE Blocksize" \
735 ) \
736
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000737#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000738 "$ df\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000739 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000740 "/dev/sda3 8690864 8553540 137324 98% /\n" \
741 "/dev/sda1 64216 36364 27852 57% /boot\n" \
742 "$ df /dev/sda3\n" \
Denis Vlasenkod66aa3c2008-08-28 22:42:52 +0000743 "Filesystem 1K-blocks Used Available Use% Mounted on\n" \
744 "/dev/sda3 8690864 8553540 137324 98% /\n" \
745 "$ POSIXLY_CORRECT=sure df /dev/sda3\n" \
746 "Filesystem 512B-blocks Used Available Use% Mounted on\n" \
747 "/dev/sda3 17381728 17107080 274648 98% /\n" \
748 "$ POSIXLY_CORRECT=yep df -P /dev/sda3\n" \
749 "Filesystem 512-blocks Used Available Capacity Mounted on\n" \
750 "/dev/sda3 17381728 17107080 274648 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000751
Denis Vlasenko736230e2006-11-20 19:40:36 +0000752#define dhcprelay_trivial_usage \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000753 "[client1,client2,...] [server_device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000754#define dhcprelay_full_usage "\n\n" \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000755 "Relay dhcp requests from client devices to server device.\n" \
756 "Pass clients as CSV"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000757
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000758#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000759 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000760#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000761 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000762 "This implementation supports unified diffs only.\n" \
763 "\nOptions:" \
764 "\n -a Treat all files as text" \
765 "\n -b Ignore changes in the amount of whitespace" \
766 "\n -d Try hard to find a smaller set of changes" \
767 "\n -i Ignore case differences" \
768 "\n -L Use LABEL instead of the filename in the unified header" \
769 "\n -N Treat absent files as empty" \
770 "\n -q Output only whether files differ" \
771 "\n -r Recursively compare subdirectories" \
772 "\n -S Start with FILE when comparing directories" \
773 "\n -T Make tabs line up by prefixing a tab when necessary" \
774 "\n -s Report when two files are the same" \
775 "\n -t Expand tabs to spaces in output" \
776 "\n -U Output LINES lines of context" \
777 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000778
Eric Andersen7e9276b2001-02-22 01:15:47 +0000779#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000780 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000781#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000782 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000783#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000784 "$ dirname /tmp/foo\n" \
785 "/tmp\n" \
786 "$ dirname /tmp/foo/\n" \
787 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000788
Eric Andersen7e9276b2001-02-22 01:15:47 +0000789#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000790 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000791#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000792 "Print or control the kernel ring buffer\n" \
793 "\nOptions:" \
794 "\n -c Clear ring buffer after printing" \
795 "\n -n LEVEL Set console logging level" \
796 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000797
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000798#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000799 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000800#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000801 "Small static DNS server daemon\n" \
802 "\nOptions:" \
803 "\n -c Config filename" \
804 "\n -t TTL in seconds" \
805 "\n -p Listening port" \
806 "\n -i Listening ip (default all)" \
807 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000808
Eric Andersen7e9276b2001-02-22 01:15:47 +0000809#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000810 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000811#define dos2unix_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000812 "Convert FILE from dos to unix format.\n" \
813 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000814 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000815 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000816 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000817
Eric Andersen7e9276b2001-02-22 01:15:47 +0000818#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000819 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000820#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000821 "Install, remove and manage Debian packages\n" \
822 "\nOptions:" \
823 "\n -i Install the package" \
824 "\n -l List of installed packages" \
825 "\n -C Configure an unpackaged package" \
826 "\n -F depends Ignore dependency problems" \
827 "\n -P Purge all files of a package" \
828 "\n -r Remove all but the configuration files for a package" \
829 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000830
Eric Andersen7e9276b2001-02-22 01:15:47 +0000831#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000832 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000833#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000834 "Perform actions on Debian packages (.debs)\n" \
835 "\nOptions:" \
836 "\n -c List contents of filesystem tree" \
837 "\n -e Extract control files to [argument] directory" \
838 "\n -f Display control field name starting with [argument]" \
839 "\n -x Extract packages filesystem tree to directory" \
840 "\n -X Verbose extract" \
841
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000842#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000843 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000844
Eric Andersen7e9276b2001-02-22 01:15:47 +0000845#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000846 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000847#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000848 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000849 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000850 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
851 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000852 " bytes.\n" \
853 "\nOptions:" \
854 "\n -a Show file sizes too" \
855 "\n -H Follow symlinks on command line" \
856 "\n -L Follow all symlinks" \
857 "\n -d N Limit output to directories (and files with -a) of depth < N" \
858 "\n -c Show grand total" \
859 "\n -l Count sizes many times if hard linked" \
860 "\n -s Display only a total for each argument" \
861 "\n -x Skip directories on different filesystems" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000862 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000863 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
864 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000865 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000866 "\n -k Sizes in kilobytes" \
867 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
868
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000869#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000870 "$ du\n" \
871 "16 ./CVS\n" \
872 "12 ./kernel-patches/CVS\n" \
873 "80 ./kernel-patches\n" \
874 "12 ./tests/CVS\n" \
875 "36 ./tests\n" \
876 "12 ./scripts/CVS\n" \
877 "16 ./scripts\n" \
878 "12 ./docs/CVS\n" \
879 "104 ./docs\n" \
880 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000881
Eric Andersen7e9276b2001-02-22 01:15:47 +0000882#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000883 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000884#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000885 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000886#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000887 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000888
Russ Dill61fb4892002-10-14 21:41:28 +0000889#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000890 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000891#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000892 "Display DHCP leases granted by udhcpd\n" \
893 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000894 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000895 "\n -f,--file=FILE Leases file to load" \
896 "\n -r,--remaining Interpret lease times as time remaining" \
897 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000898 ) \
899 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000900 "\n -f FILE Leases file to load" \
901 "\n -r Interpret lease times as time remaining" \
902 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000903 )
Russ Dill61fb4892002-10-14 21:41:28 +0000904
Mike Frysinger51a43b42005-09-24 07:11:16 +0000905#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000906 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
907 "[-I inode_buffer_blocks] [-P process_inode_size] " \
908 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
909 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000910#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000911 "Check ext2/ext3 file system\n" \
912 "\nOptions:" \
913 "\n -p Automatic repair (no questions)" \
914 "\n -n Make no changes to the filesystem" \
915 "\n -y Assume 'yes' to all questions" \
916 "\n -c Check for bad blocks and add them to the badblock list" \
917 "\n -f Force checking even if filesystem is marked clean" \
918 "\n -v Verbose" \
919 "\n -b superblock Use alternative superblock" \
920 "\n -B blocksize Force blocksize when looking for superblock" \
921 "\n -j journal Set location of the external journal" \
922 "\n -l file Add to badblocks list" \
923 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000924
Eric Andersen7e9276b2001-02-22 01:15:47 +0000925#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000926 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000927#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000928 "Print the specified ARGs to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000929 USE_FEATURE_FANCY_ECHO( "\n" \
930 "\nOptions:" \
931 "\n -n Suppress trailing newline" \
932 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
933 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000934 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000935#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000936 "$ echo \"Erik is cool\"\n" \
937 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000938 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000939 "Erik\n" \
940 "is\n" \
941 "cool\n" \
942 "$ echo \"Erik\\nis\\ncool\"\n" \
943 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000944
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000945#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000946 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000947#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000948 "Eject specified DEVICE (or default /dev/cdrom)\n" \
949 "\nOptions:" \
950 USE_FEATURE_EJECT_SCSI( \
951 "\n -s SCSI device" \
952 ) \
953 "\n -t Close tray" \
954 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000955
Rob Landley3b890392006-05-04 20:56:43 +0000956#define ed_trivial_usage ""
957#define ed_full_usage ""
958
Eric Andersen84e229c2001-03-29 22:48:33 +0000959#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000960 "[-iu] [-] [name=value]... [command]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000961#define env_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000962 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000963 "up the specified environment\n" \
964 "\nOptions:" \
965 "\n -, -i Start with an empty environment" \
966 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +0000967
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000968#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000969 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000970#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000971 "Send a magic packet to wake up sleeping machines.\n" \
972 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000973 "a hostname with a known 'ethers' entry.\n" \
974 "\nOptions:" \
975 "\n -b Send wake-up packet to the broadcast address" \
976 "\n -i iface Interface to use (default eth0)" \
977 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000978
Denis Vlasenko3952f202007-08-13 14:10:24 +0000979#define expand_trivial_usage \
980 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000981#define expand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000982 "Convert tabs to spaces, writing to standard output.\n" \
983 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000984 USE_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000985 "\n -i,--initial Do not convert tabs after non blanks" \
986 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000987 ) \
988 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000989 "\n -i Do not convert tabs after non blanks" \
990 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000991 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000992
Eric Andersen7e9276b2001-02-22 01:15:47 +0000993#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000994 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000995#define expr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000996 "Print the value of EXPRESSION to standard output.\n" \
997 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000998 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000999 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
1000 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1001 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1002 " ARG1 <= ARG2\n" \
1003 " ARG1 = ARG2\n" \
1004 " ARG1 != ARG2\n" \
1005 " ARG1 >= ARG2\n" \
1006 " ARG1 > ARG2\n" \
1007 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1008 " ARG1 - ARG2\n" \
1009 " ARG1 * ARG2\n" \
1010 " ARG1 / ARG2\n" \
1011 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001012 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1013 " match STRING REGEXP Same as STRING : REGEXP\n" \
1014 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1015 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1016 " length STRING Length of STRING\n" \
1017 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001018 " it is a keyword like 'match' or an\n" \
1019 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001020 " (EXPRESSION) Value of EXPRESSION\n" \
1021 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001022 "Beware that many operators need to be escaped or quoted for shells.\n" \
1023 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001024 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001025 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1026 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001027
Mike Frysingerfa69f112005-04-17 07:24:19 +00001028#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001029 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001030#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001031 "Provide fake ident (auth) service\n" \
1032 "\nOptions:" \
1033 "\n -f Run in foreground" \
1034 "\n -i Inetd mode" \
1035 "\n -w Inetd 'wait' mode" \
1036 "\n -b ADDR Bind to specified address" \
1037 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001038
Eric Andersen7e9276b2001-02-22 01:15:47 +00001039#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001040 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001041#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001042 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001043
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001044#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001045 "$ false\n" \
1046 "$ echo $?\n" \
1047 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001048
1049#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001050 "[options] [mode]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001051#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001052 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001053
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001054#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001055 "$ fbset\n" \
1056 "mode \"1024x768-76\"\n" \
1057 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1058 " geometry 1024 768 1024 768 16\n" \
1059 " timings 12714 128 32 16 4 128 4\n" \
1060 " accel false\n" \
1061 " rgba 5/11,6/5,5/0,0/0\n" \
1062 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001063
Eric Andersen7e9276b2001-02-22 01:15:47 +00001064#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001065 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001066#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001067 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001068
Eric Andersen01c3d402003-07-05 07:51:31 +00001069#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001070 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001071#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001072 "Format floppy disk\n" \
1073 "\nOptions:" \
1074 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001075
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001076/* Looks like someone forgot to add this to config system */
1077#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1078# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1079# define USE_FEATURE_FDISK_BLKSIZE(a)
1080#endif
1081
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001082#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001083 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1084 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001085#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001086 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001087 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001088 "\n -u Start and End are in sectors (instead of cylinders)" \
1089 "\n -l Show partition table for each DISK, then exit" \
1090 USE_FEATURE_FDISK_BLKSIZE( \
1091 "\n -s Show partition sizes in kb for each DISK, then exit" \
1092 ) \
1093 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1094 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1095 "\n -H HEADS\n" \
1096 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001097
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001098#define fetchmail_trivial_usage \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00001099 "[-w timeout] [-H [user:pass@]server[:port]] [-S] [-t] [-z] maildir [prog]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001100#define fetchmail_full_usage "\n\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00001101 "Fetch content of remote mailbox to local maildir\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001102 "\nOptions:" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00001103 "\n -w timeout Network timeout" \
1104 "\n -H [user:pass@]server[:port] Server" \
1105 "\n -S Use openssl connection helper for secure servers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001106 "\n -t Get only headers" \
1107 "\n -z Delete messages on server" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00001108 "\n prog Run 'prog <message_file>' on message delivery" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001109
Denis Vlasenko1e19afd2008-10-12 11:20:08 +00001110#define blkid_trivial_usage \
1111 ""
1112#define blkid_full_usage "\n\n" \
1113 "Print UUIDs of all filesystems."
1114
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001115#define findfs_trivial_usage \
1116 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001117#define findfs_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001118 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001119#define findfs_example_usage \
1120 "$ findfs LABEL=MyDevice"
1121
Eric Andersen7e9276b2001-02-22 01:15:47 +00001122#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001123 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001124#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001125 "Search for files. The default PATH is the current directory,\n" \
1126 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001127 "\nEXPRESSION may consist of:" \
1128 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001129 USE_FEATURE_FIND_XDEV( \
1130 "\n -xdev Don't descend directories on other filesystems") \
1131 USE_FEATURE_FIND_MAXDEPTH( \
1132 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1133 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001134 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001135 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001136 USE_FEATURE_FIND_PATH( \
1137 "\n -path PATTERN Path matches PATTERN") \
1138 USE_FEATURE_FIND_REGEX( \
1139 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001140 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001141 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001142 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001143 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001144 "\n or exactly (NNN)") \
1145 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001146 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001147 "\n or exactly (N) days") \
1148 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001149 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001150 "\n or exactly (N) minutes") \
1151 USE_FEATURE_FIND_NEWER( \
1152 "\n -newer FILE Modified time is more recent than FILE's") \
1153 USE_FEATURE_FIND_INUM( \
1154 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001155 USE_FEATURE_FIND_USER( \
1156 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1157 USE_FEATURE_FIND_GROUP( \
1158 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1159 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001160 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001161 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001162 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1163 "\n +/-N: file size is bigger/smaller than N") \
1164 "\n -print Print (default and assumed)" \
1165 USE_FEATURE_FIND_PRINT0( \
1166 "\n -print0 Delimit output with null characters rather than" \
1167 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001168 USE_FEATURE_FIND_CONTEXT ( \
1169 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001170 USE_FEATURE_FIND_EXEC( \
1171 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1172 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001173 USE_FEATURE_FIND_PRUNE( \
1174 "\n -prune Stop traversing current subtree") \
1175 USE_FEATURE_FIND_DELETE( \
1176 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001177 USE_FEATURE_FIND_PAREN( \
1178 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001179
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001180#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001181 "$ find / -name passwd\n" \
1182 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001183
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001184#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001185 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001186#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001187 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001188 "standard output\n" \
1189 "\nOptions:" \
1190 "\n -b Count bytes rather than columns" \
1191 "\n -s Break at spaces" \
1192 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001193
Eric Andersen7e9276b2001-02-22 01:15:47 +00001194#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001195 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001196#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001197 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001198#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001199 "$ free\n" \
1200 " total used free shared buffers\n" \
1201 " Mem: 257628 248724 8904 59644 93124\n" \
1202 " Swap: 128516 8404 120112\n" \
1203 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001204
Eric Andersen7e9276b2001-02-22 01:15:47 +00001205#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001206 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001207#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001208 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001209#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001210 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001211
Mike Frysinger51a43b42005-09-24 07:11:16 +00001212#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001213 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001214#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001215 "Check and repair filesystems\n" \
1216 "\nOptions:" \
1217 "\n -A Walk /etc/fstab and check all filesystems" \
1218 "\n -N Don't execute, just show what would be done" \
1219 "\n -P With -A, check filesystems in parallel" \
1220 "\n -R With -A, skip the root filesystem" \
1221 "\n -T Don't show title on startup" \
1222 "\n -V Verbose" \
1223 "\n -C n Write status information to specified filedescriptor" \
1224 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001225
Eric Andersen7e9276b2001-02-22 01:15:47 +00001226#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001227 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001228#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001229 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001230 "\nOptions:" \
1231 "\n -l List all filenames" \
1232 "\n -r Perform interactive repairs" \
1233 "\n -a Perform automatic repairs" \
1234 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001235 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001236 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001237 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001238
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001239#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001240 "[options] remote-host local-file remote-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001241#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001242 "Retrieve a remote file via FTP\n" \
1243 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001244 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001245 "\n -c,--continue Continue previous transfer" \
1246 "\n -v,--verbose Verbose" \
1247 "\n -u,--username Username" \
1248 "\n -p,--password Password" \
1249 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001250 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001251 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001252 "\n -c Continue previous transfer" \
1253 "\n -v Verbose" \
1254 "\n -u Username" \
1255 "\n -p Password" \
1256 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001257 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001258
1259#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001260 "[options] remote-host remote-file local-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001261#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001262 "Store a local file on a remote machine via FTP\n" \
1263 "\nOptions:" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001264 USE_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001265 "\n -v,--verbose Verbose" \
1266 "\n -u,--username Username" \
1267 "\n -p,--password Password" \
1268 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001269 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001270 SKIP_FEATURE_FTPGETPUT_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001271 "\n -v Verbose" \
1272 "\n -u Username" \
1273 "\n -p Password" \
1274 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001275 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001276
Rob Landleyaa872762005-10-28 13:05:12 +00001277#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001278 "[options] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001279#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001280 "Find processes which use FILEs or PORTs\n" \
1281 "\nOptions:" \
1282 "\n -m Find processes which use same fs as FILEs" \
1283 "\n -4 Search only IPv4 space" \
1284 "\n -6 Search only IPv6 space" \
1285 "\n -s Silent: just exit with 0 if any processes are found" \
1286 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001287 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001288
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001289#define getenforce_trivial_usage NOUSAGE_STR
1290#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001291
Eric Andersen7e9276b2001-02-22 01:15:47 +00001292#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001293 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001294#define getopt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001295 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001296 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001297 "\n -a,--alternative Allow long options starting with single -" \
1298 "\n -l,--longoptions=longopts Long options to be recognized" \
1299 "\n -n,--name=progname The name under which errors are reported" \
1300 "\n -o,--options=optstring Short options to be recognized" \
1301 "\n -q,--quiet Disable error reporting by getopt(3)" \
1302 "\n -Q,--quiet-output No normal output" \
1303 "\n -s,--shell=shell Set shell quoting conventions" \
1304 "\n -T,--test Test for getopt(1) version" \
1305 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001306 ) \
1307 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001308 "\n -a Allow long options starting with single -" \
1309 "\n -l longopts Long options to be recognized" \
1310 "\n -n progname The name under which errors are reported" \
1311 "\n -o optstring Short options to be recognized" \
1312 "\n -q Disable error reporting by getopt(3)" \
1313 "\n -Q No normal output" \
1314 "\n -s shell Set shell quoting conventions" \
1315 "\n -T Test for getopt(1) version" \
1316 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001317 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001318#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001319 "$ cat getopt.test\n" \
1320 "#!/bin/sh\n" \
1321 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1322 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001323 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001324 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001325 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001326 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001327 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1328 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001329 " -c|--c-long)\n" \
1330 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001331 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1332 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1333 " esac;;\n" \
1334 " --) shift; break;;\n" \
1335 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001336 " esac\n" \
1337 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001338
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001339#define getsebool_trivial_usage \
1340 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001341#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001342 " -a Show all SELinux booleans"
1343
Eric Andersenf349e972001-08-21 16:18:59 +00001344#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001345 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001346#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001347 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1348 "\nOptions:" \
1349 "\n -h Enable hardware (RTS/CTS) flow control" \
1350 "\n -i Do not display /etc/issue before running login" \
1351 "\n -L Local line, do not do carrier detect" \
1352 "\n -m Get baud rate from modem's CONNECT status message" \
1353 "\n -w Wait for a CR or LF before sending /etc/issue" \
1354 "\n -n Do not prompt the user for a login name" \
1355 "\n -f issue_file Display issue_file instead of /etc/issue" \
1356 "\n -l login_app Invoke login_app instead of /bin/login" \
1357 "\n -t timeout Terminate after timeout if no username is read" \
1358 "\n -I initstring Init string to send before anything else" \
1359 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001360
Eric Andersen7e9276b2001-02-22 01:15:47 +00001361#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001362 "[-HhrilLnqvso" \
1363 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001364 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001365 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1366 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001367 "] PATTERN [FILEs...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001368#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001369 "Search for PATTERN in each FILE or standard input\n" \
1370 "\nOptions:" \
1371 "\n -H Prefix output lines with filename where match was found" \
1372 "\n -h Suppress the prefixing filename on output" \
1373 "\n -r Recurse subdirectories" \
1374 "\n -i Ignore case distinctions" \
1375 "\n -l List names of files that match" \
1376 "\n -L List names of files that do not match" \
1377 "\n -n Print line number with output lines" \
1378 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1379 "\n -v Select non-matching lines" \
1380 "\n -s Suppress file open/read error messages" \
1381 "\n -c Only print count of matching lines" \
1382 "\n -o Show only the part of a line that matches PATTERN" \
1383 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001384 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001385 "\n -w Match whole words only") \
1386 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001387 USE_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001388 "\n -E PATTERN is an extended regular expression") \
1389 "\n -e PTRN Pattern to match" \
1390 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001391 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001392 "\n -A Print NUM lines of trailing context" \
1393 "\n -B Print NUM lines of leading context" \
1394 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001395
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001396#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001397 "$ grep root /etc/passwd\n" \
1398 "root:x:0:0:root:/root:/bin/bash\n" \
1399 "$ grep ^[rR]oo. /etc/passwd\n" \
1400 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001401
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001402#define egrep_trivial_usage NOUSAGE_STR
1403#define egrep_full_usage ""
1404
1405#define fgrep_trivial_usage NOUSAGE_STR
1406#define fgrep_full_usage ""
1407
Eric Andersen7e9276b2001-02-22 01:15:47 +00001408#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001409 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001410#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001411 "Uncompress FILEs (or standard input)\n" \
1412 "\nOptions:" \
1413 "\n -c Write to standard output" \
1414 "\n -f Force" \
1415 "\n -t Test file integrity" \
1416
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001417#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001418 "$ ls -la /tmp/BusyBox*\n" \
1419 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1420 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1421 "$ ls -la /tmp/BusyBox*\n" \
1422 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423
1424#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001425 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001426#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001427 "Compress FILEs (or standard input)\n" \
1428 "\nOptions:" \
1429 "\n -c Write to standard output" \
1430 "\n -d Decompress" \
1431 "\n -f Force" \
1432
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001433#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001434 "$ ls -la /tmp/busybox*\n" \
1435 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1436 "$ gzip /tmp/busybox.tar\n" \
1437 "$ ls -la /tmp/busybox*\n" \
1438 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001439
1440#define halt_trivial_usage \
Bernhard Reutner-Fischerd93179f2008-09-01 15:24:52 +00001441 "[-d delay] [-n] [-f]" USE_FEATURE_WTMP(" [-w]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001442#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001443 "Halt the system\n" \
1444 "\nOptions:" \
1445 "\n -d Delay interval for halting" \
1446 "\n -n No call to sync()" \
1447 "\n -f Force halt (don't go through init)" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001448 USE_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001449 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001450 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001451
Eric Andersen3443bd72003-07-22 07:30:36 +00001452#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001453 "[options] [device] .."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001454#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001455 "Options:" \
1456 "\n -a Get/set fs readahead" \
1457 "\n -A Set drive read-lookahead flag (0/1)" \
1458 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1459 "\n -B Set Advanced Power Management setting (1-255)" \
1460 "\n -c Get/set IDE 32-bit IO setting" \
1461 "\n -C Check IDE power mode status" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001462 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001463 "\n -d Get/set using_dma flag") \
1464 "\n -D Enable/disable drive defect-mgmt" \
1465 "\n -f Flush buffer cache for device on exit" \
1466 "\n -g Display drive geometry" \
1467 "\n -h Display terse usage information" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001468 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001469 "\n -i Display drive identification") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001470 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001471 "\n -I Detailed/current information directly from drive") \
1472 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1473 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1474 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1475 "\n -m Get/set multiple sector count" \
1476 "\n -n Get/set ignore-write-errors flag (0/1)" \
1477 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1478 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001479/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001480 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1481 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001482 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001483 "\n -R Register an IDE interface (DANGEROUS)") \
1484 "\n -S Set standby (spindown) timeout" \
1485 "\n -t Perform device read timings" \
1486 "\n -T Perform cache read timings" \
1487 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001488 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001489 "\n -U Un-register an IDE interface (DANGEROUS)") \
1490 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1491 "\n -V Display program version and exit immediately" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001492 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001493 "\n -w Perform device reset (DANGEROUS)") \
1494 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001495 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001496 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1497 "\n -X Set IDE xfer mode (DANGEROUS)" \
1498 "\n -y Put IDE drive in standby mode" \
1499 "\n -Y Put IDE drive to sleep" \
1500 "\n -Z Disable Seagate auto-powersaving mode" \
1501 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001502
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001504 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001505#define head_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001506 "Print first 10 lines of each FILE to standard output.\n" \
1507 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001508 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1509 "\nOptions:" \
1510 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001511 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001512 "\n -c NUM Output the first NUM bytes" \
1513 "\n -q Never output headers giving file names" \
1514 "\n -v Always output headers giving file names") \
1515
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001516#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001517 "$ head -n 2 /etc/passwd\n" \
1518 "root:x:0:0:root:/root:/bin/bash\n" \
1519 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001520
Glenn L McGrath60281112001-11-02 11:39:46 +00001521#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001522 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001523#define hexdump_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001524 "Display file(s) or standard input in a user specified format\n" \
1525 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001526 "\n -b One-byte octal display" \
1527 "\n -c One-byte character display" \
1528 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1529 "\n -d Two-byte decimal display" \
1530 "\n -e FORMAT STRING" \
1531 "\n -f FORMAT FILE" \
1532 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1533 "\n -o Two-byte octal display" \
1534 "\n -s OFFSET Skip OFFSET bytes" \
1535 "\n -v Display all input data" \
1536 "\n -x Two-byte hexadecimal display" \
1537 USE_FEATURE_HEXDUMP_REVERSE( \
1538 "\n -R Reverse of 'hexdump -Cv'") \
1539
1540#define hd_trivial_usage \
1541 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001542#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001543 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001544
Eric Andersen7e9276b2001-02-22 01:15:47 +00001545#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001546 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001547#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001548 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001549
1550#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001551 "[OPTION] [hostname | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001552#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001553 "Get or set hostname or DNS domain name\n" \
1554 "\nOptions:" \
1555 "\n -s Short" \
1556 "\n -i Addresses for the hostname" \
1557 "\n -d DNS domain name" \
1558 "\n -f Fully qualified domain name" \
1559 "\n -F FILE Use the contents of FILE to specify the hostname" \
1560
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001561#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001562 "$ hostname\n" \
1563 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001564
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001565#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001566 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001567 " [-p [ip:]port]" \
1568 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001569 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001570 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001571 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001572 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001573 " [-d/-e string]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001574#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001575 "Listen for incoming HTTP requests\n" \
1576 "\nOptions:" \
1577 "\n -c FILE Configuration file (default httpd.conf)" \
1578 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1579 "\n -i Inetd mode" \
1580 "\n -f Do not daemonize" \
1581 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001582 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001583 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001584 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001585 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001586 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001587 "\n -m PASS Crypt PASS with md5 algorithm") \
1588 "\n -h HOME Home directory (default .)" \
1589 "\n -e STRING HTML encode STRING" \
1590 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001591
Robert Griebl1cd04452002-07-21 16:50:49 +00001592#define hwclock_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001593 USE_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001594 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1595 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001596 " [-f FILE]" \
1597 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00001598 SKIP_FEATURE_HWCLOCK_LONG_OPTIONS( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001599 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1600 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001601#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001602 "Query and set hardware clock (RTC)\n" \
1603 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001604 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001605 "\n -s Set system time from hardware clock" \
1606 "\n -w Set hardware clock to system time" \
1607 "\n -u Hardware clock is in UTC" \
1608 "\n -l Hardware clock is in local time" \
1609 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001610
Eric Andersen7e9276b2001-02-22 01:15:47 +00001611#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001612 "[OPTIONS]... [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001613#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001614 "Print information about USER or the current user\n" \
1615 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001616 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001617 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001618 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001619 "\n -u Print user ID" \
Denis Vlasenko4f3209b2008-09-13 12:51:10 +00001620 "\n -g Print group ID" \
1621 "\n -G Print supplementary group IDs" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001622 "\n -n Print name instead of a number" \
1623 "\n -r Print real user ID instead of effective ID" \
1624
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001625#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001626 "$ id\n" \
1627 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001628
Eric Andersen7e9276b2001-02-22 01:15:47 +00001629#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001630 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001631#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001632 "Configure a network interface\n" \
1633 "\nOptions:" \
1634 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001635 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001636 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001637 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001638 " [del ADDRESS[/PREFIXLEN]]\n") \
1639 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1640 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001641 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001642 " [outfill NN] [keepalive NN]\n") \
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001643 " " USE_FEATURE_IFCONFIG_HW("[hw ether" USE_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001644 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001645 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001646 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001647 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001648 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001649
Denis Vlasenko06aed432008-02-26 18:25:24 +00001650#define ifenslave_trivial_usage \
1651 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001652#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001653 "Configure network interfaces for parallel routing\n" \
1654 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001655 "\n -c, --change-active Change active slave" \
1656 "\n -d, --detach Remove slave interface from bonding device" \
1657 "\n -f, --force Force, even if interface is not Ethernet" \
1658/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001659
Denis Vlasenko06aed432008-02-26 18:25:24 +00001660#define ifenslave_example_usage \
1661 "To create a bond device, simply follow these three steps :\n" \
1662 "- ensure that the required drivers are properly loaded :\n" \
1663 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1664 "- assign an IP address to the bond device :\n" \
1665 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1666 "- attach all the interfaces you need to the bond device :\n" \
1667 " # ifenslave bond0 eth0 eth1 eth2\n" \
1668 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1669 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1670 " To detach a dead interface without setting the bond device down :\n" \
1671 " # ifenslave -d bond0 eth1\n\n" \
1672 " To set the bond device down and automatically release all the slaves :\n" \
1673 " # ifconfig bond0 down\n\n" \
1674 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001675 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001676
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001677#define ifup_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001678 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001679#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001680 "Options:" \
1681 "\n -a De/configure all interfaces automatically" \
1682 "\n -i FILE Use FILE for interface definitions" \
1683 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001684 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001685 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001686 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001687 ) \
1688 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001689 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001690
1691#define ifdown_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001692 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001693#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001694 "Options:" \
1695 "\n -a De/configure all interfaces automatically" \
1696 "\n -i FILE Use FILE for interface definitions" \
1697 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001698 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001699 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001700 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001701 ) \
1702 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001703 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001704
Glenn L McGrath06e95652003-02-09 06:51:14 +00001705#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001706 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001707#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001708 "Listen for network connections and launch programs\n" \
1709 "\nOptions:" \
1710 "\n -f Run in foreground" \
1711 "\n -e Log to stderr" \
1712 "\n -q N Socket listen queue (default: 128)" \
1713 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001714 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001715
Eric Andersen7e9276b2001-02-22 01:15:47 +00001716#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001717 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001718#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001719 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001720
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001721#define init_notes_usage \
1722"This version of init is designed to be run only by the kernel.\n" \
1723"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001724"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001725"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001726"runlevels, use sysvinit.\n" \
1727"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001728"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001729"it has the following default behavior:\n" \
1730"\n" \
1731" ::sysinit:/etc/init.d/rcS\n" \
1732" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001733" ::ctrlaltdel:/sbin/reboot\n" \
1734" ::shutdown:/sbin/swapoff -a\n" \
1735" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001736" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001737"\n" \
1738"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1739"\n" \
1740" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001741" tty3::askfirst:/bin/sh\n" \
1742" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001743"\n" \
1744"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1745"\n" \
1746" <id>:<runlevels>:<action>:<process>\n" \
1747"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001748" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001749"\n" \
1750" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1751" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001752" the specified process to run on. The contents of this field are\n" \
1753" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1754" be unique, although if it isn't you may have strange results. If this\n" \
1755" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001756" note that if BusyBox detects that a serial console is in use, then only\n" \
1757" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001758" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001759" stinkin' utmp.\n" \
1760"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001761" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001762"\n" \
1763" The runlevels field is completely ignored.\n" \
1764"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001765" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001766"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001767" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001768" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001769"\n" \
1770" The available actions can be classified into two groups: actions\n" \
1771" that are run only once, and actions that are re-run when the specified\n" \
1772" process exits.\n" \
1773"\n" \
1774" Run only-once actions:\n" \
1775"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001776" 'sysinit' is the first item run on boot. init waits until all\n" \
1777" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001778" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001779" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001780" the specified task completes. 'once' actions are asynchronous,\n" \
1781" therefore, init does not wait for them to complete. 'restart' is\n" \
1782" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001783" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001784" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001785" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001786" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001787" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001788" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001789" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001790" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001791"\n" \
1792" Run repeatedly actions:\n" \
1793"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001794" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001795" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001796" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1797" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001798" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001799" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001800" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001801" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001802"\n" \
1803" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001804" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001805" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001806"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001807" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001808"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001809" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001810"\n" \
1811"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001812"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001813" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001814" #\n" \
1815" ::sysinit:/etc/init.d/rcS\n" \
1816" \n" \
1817" # /bin/sh invocations on selected ttys\n" \
1818" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001819" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001820" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001821" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001822" tty2::askfirst:-/bin/sh\n" \
1823" tty3::askfirst:-/bin/sh\n" \
1824" tty4::askfirst:-/bin/sh\n" \
1825" \n" \
1826" # /sbin/getty invocations for selected ttys\n" \
1827" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001828" tty4::respawn:/sbin/getty 38400 tty4\n" \
1829" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001830" \n" \
1831" \n" \
1832" # Example of how to put a getty on a serial line (for a terminal)\n" \
1833" #\n" \
1834" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1835" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1836" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001837" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001838" #::respawn:/sbin/getty 57600 ttyS2\n" \
1839" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001840" # Stuff to do when restarting the init process\n" \
1841" ::restart:/sbin/init\n" \
1842" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001843" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001844" ::ctrlaltdel:/sbin/reboot\n" \
1845" ::shutdown:/bin/umount -a -r\n" \
1846" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001847
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001848#define inotifyd_trivial_usage \
1849 "/user/space/agent dir/or/file/being/watched[:mask] ..."
1850#define inotifyd_full_usage "\n\n" \
1851 "Spawn userspace agent on filesystem changes." \
1852 "\nWhen a filesystem event matching the mask occurs" \
1853 "\non specified file/directory an userspace agent is spawned" \
1854 "\nwith the parameters:" \
1855 "\n1. actual event(s)" \
1856 "\n2. file/directory name" \
1857 "\n3. name of subfile (if any), in case of watching a directory" \
1858 "\n" \
1859 "\n a File is accessed" \
1860 "\n c File is modified" \
1861 "\n e Metadata changed" \
1862 "\n w Writtable file is closed" \
1863 "\n 0 Unwrittable file is closed" \
1864 "\n r File is opened" \
1865 "\n m File is moved from X" \
1866 "\n y File is moved to Y" \
1867 "\n n Subfile is created" \
1868 "\n d Subfile is deleted" \
1869 "\n D Self is deleted" \
1870 "\n M Self is moved" \
1871
Eric Andersen7e9276b2001-02-22 01:15:47 +00001872#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001873 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001874#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001875 "Load the specified kernel modules into the kernel" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001876 USE_FEATURE_2_4_MODULES( "\n" \
1877 "\nOptions:" \
1878 "\n -f Force module to load into the wrong kernel version" \
1879 "\n -k Make module autoclean-able" \
1880 "\n -v Verbose" \
1881 "\n -q Quiet" \
1882 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001883 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001884 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001885 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001886 "\n -o NAME Set internal module name to NAME" \
1887 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001888 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001889
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001890/* -v, -b, -c are ignored */
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001891#define install_trivial_usage \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001892 "[-cdDsp] [-o USER] [-g GRP] [-m MODE] [source] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001893#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001894 "Copy files and set attributes\n" \
1895 "\nOptions:" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001896 "\n -c Just copy (default)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001897 "\n -d Create directories" \
Bernhard Reutner-Fischer161931e2008-09-04 09:33:23 +00001898 "\n -D Create leading target directories" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001899 "\n -s Strip symbol table" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001900 "\n -p Preserve date" \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001901 "\n -o USER Set ownership" \
1902 "\n -g GRP Set group ownership" \
1903 "\n -m MODE Set permissions" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001904 USE_SELINUX( \
Denis Vlasenkod4b71982008-09-03 21:54:46 +00001905 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001906 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001907
1908/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001909#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001910 "[OPTIONS] {" \
1911 USE_FEATURE_IP_ADDRESS("address | ") \
1912 USE_FEATURE_IP_ROUTE("route | ") \
1913 USE_FEATURE_IP_LINK("link | ") \
1914 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1915 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001916 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001917#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001918 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001919 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001920 USE_FEATURE_IP_ADDRESS("address | ") \
1921 USE_FEATURE_IP_ROUTE("route | ") \
1922 USE_FEATURE_IP_LINK("link | ") \
1923 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1924 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001925 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001926 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001927
1928#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001929 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001930 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001931#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001932 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001933 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1934 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001935 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001936 " [broadcast ADDR] [anycast ADDR]\n" \
1937 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001938 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001939
Eric Andersende4f07e2003-12-11 01:18:07 +00001940#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001941 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001942#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001943 "Calculate IP network settings from a IP address\n" \
1944 "\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001945 USE_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001946 "\n -b,--broadcast Display calculated broadcast address" \
1947 "\n -n,--network Display calculated network address" \
1948 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001949 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001950 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1951 "\n -h,--hostname Display first resolved host name" \
1952 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001953 ) \
1954 ) \
1955 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001956 "\n -b Display calculated broadcast address" \
1957 "\n -n Display calculated network address" \
1958 "\n -m Display default netmask for IP" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001959 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001960 "\n -p Display the prefix for IP/NETMASK" \
1961 "\n -h Display first resolved host name" \
1962 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001963 ) \
1964 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001965
Rob Landley6eb1e412005-06-20 04:30:36 +00001966#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001967 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001968#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001969 "Upper-case options MQS remove an object by shmkey value.\n" \
1970 "Lower-case options remove an object by shmid value.\n" \
1971 "\nOptions:" \
1972 "\n -mM Remove memory segment after last detach" \
1973 "\n -qQ Remove message queue" \
1974 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001975
1976#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001977 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001978#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001979 " -i Show specific resource" \
1980 "\nResource specification:" \
1981 "\n -m Shared memory segments" \
1982 "\n -q Message queues" \
1983 "\n -s Semaphore arrays" \
1984 "\n -a All (default)" \
1985 "\nOutput format:" \
1986 "\n -t Time" \
1987 "\n -c Creator" \
1988 "\n -p Pid" \
1989 "\n -l Limits" \
1990 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001991
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001992#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001993 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001994#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001995 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001996 " dynamic { on | off } |\n" \
1997 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001998 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001999
2000#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002001 "{ list | flush | { add | del | change | append |\n" \
2002 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002003#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002004 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002005 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
2006 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002007 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002008 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Bernhard Reutner-Fischer578de862008-10-07 17:00:58 +00002009 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
2010 " [metric METRIC]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002011
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002012#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002013 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002014#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002015 "iprule [list | add | del] SELECTOR ACTION\n" \
2016 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2017 " [dev STRING] [pref NUMBER]\n" \
2018 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2019 " [prohibit | reject | unreachable]\n" \
2020 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002021 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002022
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002023#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002024 "{ add | change | del | show } [NAME]\n" \
2025 " [mode { ipip | gre | sit }]\n" \
2026 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002027#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002028 "iptunnel { add | change | del | show } [NAME]\n" \
2029 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2030 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002031 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002032
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002033#define kbd_mode_trivial_usage \
2034 "[-a|k|s|u]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002035#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002036 "Report or set the keyboard mode\n" \
2037 "\nOptions set mode:" \
2038 "\n -a Default (ASCII)" \
2039 "\n -k Medium-raw (keyboard)" \
2040 "\n -s Raw (scancode)" \
2041 "\n -u Unicode (utf-8)" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002042
Eric Andersen7e9276b2001-02-22 01:15:47 +00002043#define kill_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002044 "[-l] [-signal] process-id..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002045#define kill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002046 "Send a signal (default is TERM) to the specified process(es)\n" \
2047 "\nOptions:" \
2048 "\n -l List all signal names and numbers" \
2049
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002050#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002051 "$ ps | grep apache\n" \
2052 "252 root root S [apache]\n" \
2053 "263 www-data www-data S [apache]\n" \
2054 "264 www-data www-data S [apache]\n" \
2055 "265 www-data www-data S [apache]\n" \
2056 "266 www-data www-data S [apache]\n" \
2057 "267 www-data www-data S [apache]\n" \
2058 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002059
2060#define killall_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002061 "[-l] [-q] [-signal] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002062#define killall_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002063 "Send a signal (default is TERM) to the specified process(es)\n" \
2064 "\nOptions:" \
2065 "\n -l List all signal names and numbers" \
2066 "\n -q Do not complain if no processes were killed" \
2067
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002068#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002069 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002070
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002071#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002072 "[-l] [-signal]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002073#define killall5_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002074 "Send a signal (default is TERM) to all processes outside current session\n" \
2075 "\nOptions:" \
2076 "\n -l List all signal names and numbers" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002077
Mark Whitley6317c4b2001-03-12 22:51:50 +00002078#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002079 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002080#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002081 "Kernel logger\n" \
2082 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002083 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002084 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002085
Eric Andersen7e9276b2001-02-22 01:15:47 +00002086#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002087 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002088#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002089 "Print STRING's length"
2090
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002091#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002092 "$ length Hello\n" \
2093 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002094
Rob Landley9200e792005-09-15 19:26:59 +00002095#define less_trivial_usage \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002096 "[-EMNmh~I?] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002097#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002098 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002099 "changed, and files can be manipulated in various ways.\n" \
2100 "\nOptions:" \
2101 "\n -E Quit once the end of a file is reached" \
2102 "\n -M,-m Display a status line containing the line numbers" \
2103 "\n and percentage through the file" \
2104 "\n -N Prefix line numbers to each line" \
Bernhard Reutner-Fischer48a67732008-09-26 14:10:17 +00002105 "\n -I Ignore case in all searches" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002106 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002107
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002108#define linux32_trivial_usage NOUSAGE_STR
2109#define linux32_full_usage ""
2110#define linux64_trivial_usage NOUSAGE_STR
2111#define linux64_full_usage ""
2112
2113#define linuxrc_trivial_usage NOUSAGE_STR
2114#define linuxrc_full_usage ""
2115
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002116#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002117 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002118#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002119 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002120 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002121 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002122
Eric Andersen7e9276b2001-02-22 01:15:47 +00002123#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002124 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002125#define ln_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002126 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002127 "Use '--' to indicate that all following arguments are non-options.\n" \
2128 "\nOptions:" \
2129 "\n -s Make symlinks instead of hardlinks" \
2130 "\n -f Remove existing destination files" \
2131 "\n -n Don't dereference symlinks - treat like normal file" \
2132 "\n -b Make a backup of the target (if exists) before link operation" \
2133 "\n -S suf Use suffix instead of ~ when making backup files" \
2134
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002135#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002136 "$ ln -s BusyBox /tmp/ls\n" \
2137 "$ ls -l /tmp/ls\n" \
2138 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002139
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002140#define load_policy_trivial_usage NOUSAGE_STR
Denis Vlasenkob042bd92007-09-26 18:01:32 +00002141
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002142#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002143
Eric Andersen7e9276b2001-02-22 01:15:47 +00002144#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002145 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002146#define loadfont_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002147 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002148#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002149 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002150
2151#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002152 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002153#define loadkmap_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002154 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002155#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002156 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002157
2158#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002159 "[OPTION]... [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002160#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002161 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2162 "\nOptions:" \
2163 "\n -s Log to stderr as well as the system log" \
2164 "\n -t TAG Log using the specified tag (defaults to user name)" \
2165 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002166
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002167#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002168 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002169
Robert Griebl1fca5582002-06-04 20:45:46 +00002170#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002171 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002172#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002173 "Begin a new session on the system\n" \
2174 "\nOptions:" \
2175 "\n -f Do not authenticate (user already authenticated)" \
2176 "\n -h Name of the remote host" \
2177 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002178
Eric Andersen7e9276b2001-02-22 01:15:47 +00002179#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002180 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002181#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002182 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002183#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002184 "$ logname\n" \
2185 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002186
Mark Whitley6317c4b2001-03-12 22:51:50 +00002187#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002188 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002189#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002190 "Show messages in syslogd's circular buffer\n" \
2191 "\nOptions:" \
2192 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002193
Matt Kraai83788da2002-03-20 17:38:37 +00002194#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002195 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2196 " losetup -d LOOPDEV - disassociate\n" \
2197 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002198#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002199 "Options:" \
2200 "\n -o OFS Start OFS bytes into FILE" \
2201 "\n -f Show first free loop device" \
2202
Rob Landley1d589b22005-11-29 23:47:10 +00002203#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002204 "No arguments will display all current associations.\n" \
2205 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002206 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002207 "and filename of the file the loop device is currently bound to.\n\n" \
2208 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002209 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2210 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002211
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002212#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002213 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002214#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002215 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2216 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002217 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002218 "\ndirectory and HELPER program is called. Name of file to print" \
2219 "\nis passed in $DATAFILE variable." \
2220 "\nExample:" \
2221 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002222
Denis Vlasenko68444b92008-02-22 22:24:48 +00002223#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002224 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002225#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002226 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002227 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002228 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002229 "\n -f Force any waiting job to be printed" \
2230 "\n -s Short display" \
2231
2232#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002233 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2234/* -C CLASS exists too, not shown.
2235 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002236#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002237 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002238 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002239 "\n -m Send mail on completion" \
2240 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002241 "\n -V Verbose" \
2242
Eric Andersen7e9276b2001-02-22 01:15:47 +00002243#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002244 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002245 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002246 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2247 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2248 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2249 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2250 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2251 USE_SELINUX("K") "] [filenames...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002252#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002253 "List directory contents\n" \
2254 "\nOptions:" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002255 "\n -1 List in a single column" \
2256 "\n -A Don't list . and .." \
2257 "\n -a Don't hide entries starting with ." \
2258 "\n -C List by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002259 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002260 "\n -c With -l: sort by ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002261 USE_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002262 "\n --color[={always,never,auto}] Control coloring") \
2263 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002264 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002265 "\n -e List full date and time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002266 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002267 "\n -F Append indicator (one of */=@|) to entries") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002268 "\n -i List inode numbers" \
2269 "\n -l Long listing format" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002270 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002271 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002272 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002273 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002274 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002275 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002276 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002277 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002278 "\n -r Sort in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002279 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002280 "\n -S Sort by file size") \
Denis Vlasenko397de612008-03-17 08:55:44 +00002281 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002282 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002283 "\n -T NUM Assume tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002284 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002285 "\n -t With -l: sort by modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002286 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002287 "\n -u With -l: sort by access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002288 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002289 "\n -v Sort by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002290 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002291 "\n -w NUM Assume the terminal is NUM columns wide") \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002292 "\n -x List by lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002293 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002294 "\n -X Sort by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002295 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002296 "\n -h List sizes in human readable format (1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002297 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002298 "\n -k List security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002299 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002300 "\n -K List security context in long format") \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002301 USE_SELINUX( \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002302 "\n -Z List security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002303
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002304#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002305 "[-Radlv] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002306#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002307 "List file attributes on an ext2 fs\n" \
2308 "\nOptions:" \
2309 "\n -R Recursively list subdirectories" \
2310 "\n -a Do not hide entries starting with ." \
2311 "\n -d List directory entries instead of contents" \
Denis Vlasenkode5f6452008-10-27 12:37:22 +00002312 "\n -l List long flag names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002313 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002314
Eric Andersen7e9276b2001-02-22 01:15:47 +00002315#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002316 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002317#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002318 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002319
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002320#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002321#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002322 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002323#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002324 "Create a range of block or character special files" \
2325 "\n" \
2326 "\nTYPE is:" \
2327 "\n b Block device" \
2328 "\n c Character device" \
2329 "\n f FIFO, MAJOR and MINOR are ignored" \
2330 "\n" \
2331 "\nFIRST..LAST specify numbers appended to NAME." \
2332 "\nIf 's' is the last argument, the base device is created as well." \
2333 "\n" \
2334 "\nExamples:" \
2335 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2336 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002337#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002338 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2339 "[creates ttyS2-ttyS63]\n" \
2340 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2341 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002342#endif
2343
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002344#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002345#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002346 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002347#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002348 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002349 "Device table entries take the form of:\n" \
2350 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002351 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002352 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002353 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002354 " c Character device\n" \
2355 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002356 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002357 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002358 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2359 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002360#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002361 "For example:\n" \
2362 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2363 "/dev d 755 0 0 - - - - -\n" \
2364 "/dev/console c 666 0 0 5 1 - - -\n" \
2365 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2366 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2367 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2368 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2369 "Will Produce:\n" \
2370 "/dev\n" \
2371 "/dev/console\n" \
2372 "/dev/null\n" \
2373 "/dev/zero\n" \
2374 "/dev/hda\n" \
2375 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002376#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002377
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002378#define man_trivial_usage \
2379 "[OPTION]... [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002380#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002381 "Format and display manual page\n" \
2382 "\nOptions:" \
2383 "\n -a Display all pages" \
2384 "\n -w Show page locations" \
2385
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002386#define matchpathcon_trivial_usage \
2387 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002388#define matchpathcon_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002389 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002390 "\n -N Do not use translations" \
2391 "\n -f Use alternate file_context file" \
2392 "\n -p Use prefix to speed translations" \
2393 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002394
Eric Andersen7e9276b2001-02-22 01:15:47 +00002395#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002396 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002397 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002398#define md5sum_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002399 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002400 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2401 "\nOptions:" \
2402 "\n -c Check MD5 sums against given list" \
2403 "\n -s Don't output anything, status code shows success" \
2404 "\n -w Warn about improperly formatted MD5 checksum lines") \
2405
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002406#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002407 "$ md5sum < busybox\n" \
2408 "6fd11e98b98a58f64ff3398d7b324003\n" \
2409 "$ md5sum busybox\n" \
2410 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2411 "$ md5sum -c -\n" \
2412 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2413 "busybox: OK\n" \
2414 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002415
Rob Landley70f7ef72005-12-13 08:21:33 +00002416#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002417 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002418#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002419 " -s Scan /sys and populate /dev during system boot\n" \
2420 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002421 "Called with no options (via hotplug) it uses environment variables\n" \
2422 "to determine which device to add/remove."
Denis Vlasenko397de612008-03-17 08:55:44 +00002423
Rob Landleyef10d522006-06-26 14:11:33 +00002424#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002425 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002426 "The mdev config file contains lines that look like:\n" \
2427 " hd[a-z][0-9]* 0:3 660\n\n" \
2428 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002429 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002430 "Optionally, that can be followed (on the same line) by a special character\n" \
2431 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002432 "device(s). The environment variable $MDEV indicates the active device node\n" \
2433 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002434 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2435 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002436 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002437 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002438 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002439 "Config file parsing stops on the first matching line. If no config\n" \
2440 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002441 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002442 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002443
Glenn L McGrath061c9002002-09-16 04:21:46 +00002444#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002445 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002446#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002447 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002448 " y Allow write access to your terminal\n" \
2449 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002450
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002451#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002452 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002453#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002454 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2455 "\nOptions:" \
2456 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2457 "\n next byte to it" \
2458 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2459 "\n -s Set serial line to SPEED" \
2460 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002461
Eric Andersen7e9276b2001-02-22 01:15:47 +00002462#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002463 "[OPTION] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002464#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002465 "Create DIRECTORY\n" \
2466 "\nOptions:" \
2467 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2468 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002469 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002470 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002471 )
2472
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002473#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002474 "$ mkdir /tmp/foo\n" \
2475 "$ mkdir /tmp/foo\n" \
2476 "/tmp/foo: File exists\n" \
2477 "$ mkdir /tmp/foo/bar/baz\n" \
2478 "/tmp/foo/bar/baz: No such file or directory\n" \
2479 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002480
Mike Frysinger6447ac02005-06-11 05:29:40 +00002481#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002482 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2483 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2484 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2485 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2486 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2487 "device [blocks-count]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002488#define mke2fs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002489 " -b size Block size in bytes" \
2490 "\n -c Check for bad blocks before creating" \
2491 "\n -E opts Set extended options" \
2492 "\n -f size Fragment size in bytes" \
2493 "\n -F Force (ignore sanity checks)" \
2494 "\n -g num Number of blocks in a block group" \
2495 "\n -i ratio The bytes/inode ratio" \
2496 "\n -j Create a journal (ext3)" \
2497 "\n -J opts Set journal options (size/device)" \
2498 "\n -l file Read bad blocks list from file" \
2499 "\n -L lbl Set the volume label" \
2500 "\n -m percent Percent of fs blocks to reserve for admin" \
2501 "\n -M dir Set last mounted directory" \
2502 "\n -n Do not actually create anything" \
2503 "\n -N num Number of inodes to create" \
2504 "\n -o os Set the 'creator os' field" \
2505 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2506 "\n -q Quiet" \
2507 "\n -r rev Set filesystem revision" \
2508 "\n -S Write superblock and group descriptors only" \
2509 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2510 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002511
Eric Andersen7e9276b2001-02-22 01:15:47 +00002512#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002513 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002514#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002515 "Create named pipe (identical to 'mknod name p')\n" \
2516 "\nOptions:" \
2517 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002518 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002519 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002520 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002521
Eric Andersen7e9276b2001-02-22 01:15:47 +00002522#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002523 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002524#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002525 "Make a MINIX filesystem\n" \
2526 "\nOptions:" \
2527 "\n -c Check device for bad blocks" \
2528 "\n -n [14|30] Maximum length of filenames" \
2529 "\n -i INODES Number of inodes for the filesystem" \
2530 "\n -l FILENAME Read bad blocks list from FILENAME" \
2531 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002532
Eric Andersen7e9276b2001-02-22 01:15:47 +00002533#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002534 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002535#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002536 "Create a special file (block, character, or pipe)\n" \
2537 "\nOptions:" \
2538 "\n -m Create the special file using the specified mode (default a=rw)" \
2539 "\nTYPEs include:" \
2540 "\n b: Make a block device" \
2541 "\n c or u: Make a character device" \
2542 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002543 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002544 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002545 )
2546
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002547#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002548 "$ mknod /dev/fd0 b 2 0\n" \
2549 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002550
Eric Andersen7e9276b2001-02-22 01:15:47 +00002551#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002552 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002553#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002554 "Prepare block device to be used as swap partition"
2555#if 0
2556 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002557 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002558 "\n -c Check for readability"
2559 "\n -v0 Make swap version 0 (max 128M)"
2560 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2561 "\n BLOCKS Number of blocks to use (default is entire partition)"
2562#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002563
Eric Andersen7e9276b2001-02-22 01:15:47 +00002564#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002565 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002566#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002567 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002568 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002569 "\nOptions:" \
2570 "\n -d Make a directory instead of a file" \
2571/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2572 "\n -t Generate a path rooted in temporary directory" \
2573 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2574 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002575 "\nFor -t or -p, directory is chosen as follows:" \
2576 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002577
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002578#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002579 "$ mktemp /tmp/temp.XXXXXX\n" \
2580 "/tmp/temp.mWiLjM\n" \
2581 "$ ls -la /tmp/temp.mWiLjM\n" \
2582 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002583
Eric Andersen8d79ce82001-07-22 23:00:15 +00002584#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002585 "[-knqrsv] MODULE [symbol=value...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002586#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002587 "Options:" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002588 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002589 "\n -k Make module autoclean-able" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002590 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002591 "\n -n Dry run" \
2592 "\n -q Quiet" \
2593 "\n -r Remove module (stacks) or do autoclean" \
2594 "\n -s Report via syslog instead of stderr" \
2595 "\n -v Verbose" \
Denis Vlasenkoba1315d2008-09-13 14:59:38 +00002596 USE_FEATURE_MODPROBE_BLACKLIST( \
2597 "\n -b Apply blacklist to module names too" \
2598 )
Denis Vlasenko397de612008-03-17 08:55:44 +00002599
Rob Landley9c32a152005-12-11 20:12:24 +00002600#define modprobe_notes_usage \
2601"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2602"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2603"pass each module it loads.\n" \
2604"\n" \
2605"The configuration file is searched (in order) amongst:\n" \
2606"\n" \
2607" /etc/modprobe.conf (2.6 only)\n" \
2608" /etc/modules.conf\n" \
2609" /etc/conf.modules (deprecated)\n" \
2610"\n" \
2611"They all have the same syntax (see below). If none is present, it is\n" \
2612"_not_ an error; each loaded module is then expected to load without\n" \
2613"options. Once a file is found, the others are tested for.\n" \
2614"\n" \
2615"/etc/modules.conf entry format:\n" \
2616"\n" \
2617" alias <alias_name> <mod_name>\n" \
2618" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002619" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002620" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2621" This makes it also possible to use a different set of options (below) for\n" \
2622" the module and the alias.\n" \
2623" A module can be aliased more than once.\n" \
2624"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002625" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002626" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2627" the \"symbol=value\" pairs as option to that module.\n" \
2628"\n" \
2629"Sample /etc/modules.conf file:\n" \
2630"\n" \
2631" options tulip irq=3\n" \
2632" alias tulip tulip2\n" \
2633" options tulip2 irq=4 io=0x308\n" \
2634"\n" \
2635"Other functionality offered by 'classic' modprobe is not available in\n" \
2636"this implementation.\n" \
2637"\n" \
2638"If module options are present both in the config file, and on the command line,\n" \
2639"then the options from the command line will be passed to the module _after_\n" \
2640"the options from the config file. That way, you can have defaults in the config\n" \
2641"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002642#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002643 "(with the above /etc/modules.conf):\n\n" \
2644 "$ modprobe tulip\n" \
2645 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2646 "$ modprobe tulip irq=5\n" \
2647 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2648 "$ modprobe tulip2\n" \
2649 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2650 " which are the default for alias 'tulip2'\n\n" \
2651 "$ modprobe tulip2 irq=8\n" \
2652 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2653 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2654 " from the command line\n\n" \
2655 "$ modprobe tulip2 irq=2 io=0x210\n" \
2656 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2657 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2658 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002659
Eric Andersen7e9276b2001-02-22 01:15:47 +00002660#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002661 "[FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002662#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002663 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002664
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002665#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002666 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002667
Eric Andersen7e9276b2001-02-22 01:15:47 +00002668#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002669 "[flags] DEVICE NODE [-o options,more-options]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002670#define mount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002671 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2672 "\nOptions:" \
2673 "\n -a Mount all filesystems in fstab" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002674 USE_FEATURE_MOUNT_FAKE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002675 "\n -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002676 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002677 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002678 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002679 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002680 "\n -r Read-only mount" \
2681 "\n -t fs-type Filesystem type" \
2682 "\n -w Read-write mount (default)" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002683 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002684 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002685 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002686 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002687 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002688 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002689 " [a]sync Writes are asynchronous / synchronous\n" \
2690 " [no]atime Disable / enable updates to inode access times\n" \
2691 " [no]diratime Disable / enable atime updates to directories\n" \
Bernhard Reutner-Fischerfb5902c2008-08-06 18:14:38 +00002692 " [no]relatime Disable / enable atime updates relative to modification time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002693 " [no]dev Allow use of special device files / disallow them\n" \
2694 " [no]exec Allow use of executable files / disallow them\n" \
2695 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2696 " [r]shared Convert [recursively] to a shared subtree\n" \
2697 " [r]slave Convert [recursively] to a slave subtree\n" \
2698 " [r]private Convert [recursively] to a private subtree\n" \
2699 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2700 " bind Bind a directory to an additional location\n" \
2701 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002702 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002703 " remount Remount a mounted filesystem, changing its flags\n" \
2704 " ro/rw Mount for read-only / read-write\n" \
2705 "\n" \
2706 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002707 "You'll have to see the written documentation for those filesystems" \
2708
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002709#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002710 "$ mount\n" \
2711 "/dev/hda3 on / type minix (rw)\n" \
2712 "proc on /proc type proc (rw)\n" \
2713 "devpts on /dev/pts type devpts (rw)\n" \
2714 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2715 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2716 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002717#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002718 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002719
Rob Landleyd00b3a52005-08-20 05:07:08 +00002720#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002721 "[-q] <[-d] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002722#define mountpoint_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002723 "mountpoint checks if the directory is a mountpoint\n" \
2724 "\nOptions:" \
2725 "\n -q Quiet" \
2726 "\n -d Print major/minor device number of the filesystem" \
2727 "\n -x Print major/minor device number of the blockdevice" \
2728
Rob Landleyd00b3a52005-08-20 05:07:08 +00002729#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002730 "$ mountpoint /proc\n" \
2731 "/proc is not a mountpoint\n" \
2732 "$ mountpoint /sys\n" \
2733 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002734
Eric Andersen7e9276b2001-02-22 01:15:47 +00002735#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002736 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002737#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002738 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002739 "\n" \
2740 "Available Opcodes:\n" \
2741 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002742 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2743 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2744 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002745 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002746
Eric Andersen7e9276b2001-02-22 01:15:47 +00002747#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002748 "[OPTION]... SOURCE DEST\n" \
2749 "or: mv [OPTION]... SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002750#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002751 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2752 "\nOptions:" \
2753 "\n -f Don't prompt before overwriting" \
2754 "\n -i Interactive, prompt before overwrite" \
2755
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002756#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002757 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002758
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002759#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002760 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002761#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002762 "Rename network interface while it in the down state\n" \
2763 "\nOptions:" \
2764 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2765 "\n -s Use syslog (LOCAL0 facility)" \
2766 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2767
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002768#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002769 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2770 " or\n" \
2771 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002772
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002773#if !ENABLE_DESKTOP
2774
Rob Landley1cca9482006-07-10 19:45:20 +00002775#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002776#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002777#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002778#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002779#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002780
Eric Andersen7e9276b2001-02-22 01:15:47 +00002781#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002782 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002783 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002784#define nc_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002785 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002786 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002787 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002788 "\n -e Exec rest of command line after connect" \
2789 "\n -i SECS Delay interval for lines sent" \
2790 "\n -w SECS Timeout for connect" \
2791 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002792 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002793 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002794 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002795 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002796 "\n (use -l twice with -e for persistent server)") \
2797 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002798 )
2799
Rob Landley1cca9482006-07-10 19:45:20 +00002800#define nc_notes_usage "" \
2801 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002802 "To use netcat as a terminal emulator on a serial port:\n\n" \
2803 "$ stty 115200 -F /dev/ttyS0\n" \
2804 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2805 )
Rob Landley1cca9482006-07-10 19:45:20 +00002806
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002807#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002808 "$ nc foobar.somedomain.com 25\n" \
2809 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2810 "help\n" \
2811 "214-Commands supported:\n" \
2812 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2813 "214 NOOP QUIT RSET HELP\n" \
2814 "quit\n" \
2815 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002816
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002817#else /* DESKTOP nc - much more compatible with nc 1.10 */
2818
2819#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002820 "[-options] hostname port - connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002821 USE_NC_SERVER("\n" \
2822 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002823#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002824 "Options:" \
2825 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002826 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002827 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002828 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002829 "\n -n Don't do DNS resolution" \
2830 "\n -s addr Local address" \
2831 "\n -p port Local port" \
2832 "\n -u UDP mode" \
2833 "\n -v Verbose (cumulative: -vv)" \
2834 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002835 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002836 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
2837 "\n -o file Hex dump of traffic" \
2838 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002839 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002840/* "\n -r Randomize local and remote ports" */
2841/* "\n -g gateway Source-routing hop point[s], up to 8" */
2842/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002843/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2844
2845#endif
2846
Eric Andersen1552ff72001-10-31 11:07:12 +00002847#define netstat_trivial_usage \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002848 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")USE_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002849#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002850 "Display networking information\n" \
2851 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002852 "\n -l Display listening server sockets" \
2853 "\n -a Display all sockets (default: connected)" \
2854 "\n -e Display other/more information" \
2855 "\n -n Don't resolve names" \
2856 "\n -t Tcp sockets" \
2857 "\n -u Udp sockets" \
2858 "\n -w Raw sockets" \
2859 "\n -x Unix sockets" \
2860 "\n -r Display routing table" \
2861 USE_FEATURE_NETSTAT_WIDE( \
2862 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002863 ) \
2864 USE_FEATURE_NETSTAT_PRG( \
2865 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002866 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002867
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002868#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002869 "[-n ADJUST] [COMMAND [ARG]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002870#define nice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002871 "Run a program with modified scheduling priority\n" \
2872 "\nOptions:" \
2873 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002874
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002875#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002876 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002877#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002878 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002879 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002880 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002881 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002882 "%[niface] Monitor network interface 'iface'\n" \
2883 "%m Monitor allocated memory\n" \
2884 "%[mf] Monitor free memory\n" \
2885 "%[mt] Monitor total memory\n" \
2886 "%s Monitor allocated swap\n" \
2887 "%f Monitor number of used file descriptors\n" \
2888 "%Ni Monitor total/specific IRQ rate\n" \
2889 "%x Monitor context switch rate\n" \
2890 "%p Monitor forks\n" \
2891 "%[pn] Monitor # of processes\n" \
2892 "%b Monitor block io\n" \
2893 "%Nt Show time (with N decimal points)\n" \
2894 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002895 "%r Print <cr> instead of <lf> at EOL" \
2896
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002897#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002898 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002899
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002900#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002901 "COMMAND [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002902#define nohup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002903 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002904#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002905 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002906
Eric Andersen7e9276b2001-02-22 01:15:47 +00002907#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002908 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002909#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002910 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002911 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002912#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002913 "$ nslookup localhost\n" \
2914 "Server: default\n" \
2915 "Address: default\n" \
2916 "\n" \
2917 "Name: debian\n" \
2918 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002919
Glenn L McGrath60281112001-11-02 11:39:46 +00002920#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002921 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002922#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002923 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002924 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002925
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002926#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002927 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002928#define openvt_full_usage "\n\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002929 "Start COMMAND on a new virtual terminal\n" \
2930 "\nOptions:" \
2931 "\n -c Use specified VT" \
2932 "\n -s Switch to the VT" \
2933/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
2934 "\n -w Wait for COMMAND to exit" \
2935
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002936#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002937 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002938
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00002939#define parse_trivial_usage \
2940 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
2941#define parse_full_usage "\n\n" \
2942 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
2943
Eric Andersen27f64e12002-06-23 04:24:25 +00002944#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002945 "[OPTION] [name]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002946#define passwd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002947 "Change user's password. If no name is specified,\n" \
2948 "changes the password for the current user.\n" \
2949 "\nOptions:" \
2950 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
2951 "\n -d Delete password for the account" \
2952 "\n -l Lock (disable) account" \
2953 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002954
Denis Vlasenko21d10142007-07-20 21:28:41 +00002955#define chpasswd_trivial_usage \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00002956 USE_GETOPT_LONG("[--md5|--encrypted]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002957#define chpasswd_full_usage "\n\n" \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00002958 "Read user:password information from stdin " \
Denis Vlasenko397de612008-03-17 08:55:44 +00002959 "and update /etc/passwd accordingly.\n" \
2960 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002961 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00002962 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002963 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002964 ) \
2965 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002966 "\n -e Supplied passwords are in encrypted form" \
2967 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002968 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002969
Glenn L McGrath655d8142003-06-22 15:32:41 +00002970#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002971 "[-p NUM] [-i DIFF] [-R]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002972#define patch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002973 " -p NUM Strip NUM leading components from file names" \
2974 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002975 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002976
Glenn L McGrath655d8142003-06-22 15:32:41 +00002977#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002978 "$ patch -p1 < example.diff\n" \
2979 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002980
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002981#define pgrep_trivial_usage \
2982 "[-flnovx] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002983#define pgrep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002984 "Display process(es) selected by regex pattern\n" \
2985 "\nOptions:" \
2986 "\n -l Show command name too" \
2987 "\n -f Match against entire command line" \
2988 "\n -n Show the newest process only" \
2989 "\n -o Show the oldest process only" \
2990 "\n -v Negate the matching" \
2991 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002992
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002993#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00002994#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002995 "[OPTION] [NAME...]"
2996#define USAGE_PIDOF "\n\nOptions:"
2997#else
2998#define pidof_trivial_usage \
2999 "[NAME...]"
3000#define USAGE_PIDOF /* none */
3001#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003002#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003003 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00003004 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003005 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003006 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003007 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003008 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003009 "\n Use %PPID to omit pid of pidof's parent") \
3010
Eric Andersen221b2ea2001-07-31 19:06:07 +00003011#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003012 "$ pidof init\n" \
3013 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003014 USE_FEATURE_PIDOF_OMIT( \
3015 "$ pidof /bin/sh\n20351 5973 5950\n") \
3016 USE_FEATURE_PIDOF_OMIT( \
3017 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00003018
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003019#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003020#define ping_trivial_usage \
3021 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003022#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003023 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003024#define ping6_trivial_usage \
3025 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003026#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003027 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003028#else
3029#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003030 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003031#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003032 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3033 "\nOptions:" \
3034 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3035 "\n -c CNT Send only CNT pings" \
3036 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3037 "\n -I iface/IP Use interface or IP address as source" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003038 "\n -W timeout Seconds to wait for the first response (default:10)" \
3039 "\n (after all -c CNT packets are sent)" \
3040 "\n -w deadline Seconds until ping exits (default:infinite)" \
3041 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003042 "\n -q Quiet, only displays output at start" \
3043 "\n and when finished" \
3044
Eric Andersen51b8bd62002-07-03 11:46:38 +00003045#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003046 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003047#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003048 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3049 "\nOptions:" \
3050 "\n -c CNT Send only CNT pings" \
3051 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3052 "\n -I iface/IP Use interface or IP address as source" \
3053 "\n -q Quiet, only displays output at start" \
3054 "\n and when finished" \
3055
Eric Andersen51b8bd62002-07-03 11:46:38 +00003056#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003057#define ping_example_usage \
3058 "$ ping localhost\n" \
3059 "PING slag (127.0.0.1): 56 data bytes\n" \
3060 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3061 "\n" \
3062 "--- debian ping statistics ---\n" \
3063 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3064 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003065#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003066 "$ ping6 ip6-localhost\n" \
3067 "PING ip6-localhost (::1): 56 data bytes\n" \
3068 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3069 "\n" \
3070 "--- ip6-localhost ping statistics ---\n" \
3071 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3072 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003073
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003074#define pipe_progress_trivial_usage NOUSAGE_STR
3075#define pipe_progress_full_usage ""
3076
Eric Andersen7e9276b2001-02-22 01:15:47 +00003077#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003078 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003079#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003080 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003081 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003082
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003083#define pkill_trivial_usage \
3084 "[-l] | [-fnovx] [-signal] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003085#define pkill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003086 "Send a signal to process(es) selected by regex pattern\n" \
3087 "\nOptions:" \
3088 "\n -l List all signals" \
3089 "\n -f Match against entire command line" \
3090 "\n -n Signal the newest process only" \
3091 "\n -o Signal the oldest process only" \
3092 "\n -v Negate the matching" \
3093 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003094
Eric Andersen7e9276b2001-02-22 01:15:47 +00003095#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003096 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003097#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003098 "Halt and shut off power\n" \
3099 "\nOptions:" \
3100 "\n -d Delay interval for halting" \
3101 "\n -n No call to sync()" \
3102 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003103
Mike Frysinger95d3c452005-04-21 23:29:24 +00003104#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003105 "[VARIABLES...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003106#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003107 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003108 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003109
Eric Andersen7e9276b2001-02-22 01:15:47 +00003110#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003111 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003112#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003113 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003114 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003115#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003116 "$ printf \"Val=%d\\n\" 5\n" \
3117 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003118
Denis Vlasenko94949192006-11-05 00:45:47 +00003119
3120#if ENABLE_DESKTOP
3121
3122#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003123 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003124#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003125 "Report process status\n" \
3126 "\nOptions:" \
3127 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003128
3129#else /* !ENABLE_DESKTOP */
3130
Denis Vlasenko397de612008-03-17 08:55:44 +00003131#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003132#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003133#else
3134#define USAGE_PS "\nOptions:"
3135#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003136
Eric Andersen7e9276b2001-02-22 01:15:47 +00003137#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003138 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003139#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003140 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003141 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003142 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003143 "\n -Z Show SE Linux context" \
3144 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003145 USE_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003146 "\n w Wide output" \
3147 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003148
Denis Vlasenko94949192006-11-05 00:45:47 +00003149#endif /* ENABLE_DESKTOP */
3150
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003151#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003152 "$ ps\n" \
3153 " PID Uid Gid State Command\n" \
3154 " 1 root root S init\n" \
3155 " 2 root root S [kflushd]\n" \
3156 " 3 root root S [kupdate]\n" \
3157 " 4 root root S [kpiod]\n" \
3158 " 5 root root S [kswapd]\n" \
3159 " 742 andersen andersen S [bash]\n" \
3160 " 743 andersen andersen S -bash\n" \
3161 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003162 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003163
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003164#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003165 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003166#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003167 "Scan a host, print all open ports\n" \
3168 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003169 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003170 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003171 "\n -p Scan from this port (default 1)" \
3172 "\n -P Scan up to this port (default 1024)" \
3173 "\n -t Timeout (default 5000 ms)" \
3174 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3175
Eric Andersen7e9276b2001-02-22 01:15:47 +00003176#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003177 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003178#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003179 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003180#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003181 "$ pwd\n" \
3182 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003183
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003184#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003185 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003186#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003187 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003188#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003189 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003190
Eric Andersen7e9276b2001-02-22 01:15:47 +00003191#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003192 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003193#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003194 "Get and possibly set the system date and time from a remote HOST\n" \
3195 "\nOptions:" \
3196 "\n -s Set the system date and time (default)" \
3197 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003198
Bernhard Reutner-Fischerc77e8432008-08-19 11:28:52 +00003199#define rdev_trivial_usage \
3200 ""
3201#define rdev_full_usage "\n\n" \
3202 "Print the device node associated with the filesystem mounted at '/'"
3203#define rdev_example_usage \
3204 "$ rdev\n" \
3205 "/dev/mtdblock9 /\n"
3206
Rob Landley0e4690d2006-08-20 22:12:18 +00003207#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003208 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003209#define readahead_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003210 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3211 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003212
Eric Andersen7e9276b2001-02-22 01:15:47 +00003213#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003214 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003215#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003216 "Display the value of a symlink" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003217 USE_FEATURE_READLINK_FOLLOW( "\n" \
3218 "\nOptions:" \
3219 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003220
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003221#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003222 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003223#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003224 "Options:" \
3225 "\n -m mapfile (Default: /boot/System.map)" \
3226 "\n -p profile (Default: /proc/profile)" \
3227 "\n -M mult Set the profiling multiplier to mult" \
3228 "\n -i Print only info about the sampling step" \
3229 "\n -v Verbose" \
3230 "\n -a Print all symbols, even if count is 0" \
3231 "\n -b Print individual histogram-bin counts" \
3232 "\n -s Print individual counters within functions" \
3233 "\n -r Reset all the counters (root only)" \
3234 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003235
Glenn L McGrath62fae302002-12-10 00:14:33 +00003236#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003237 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003238#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003239 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003240
Eric Andersen7e9276b2001-02-22 01:15:47 +00003241#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003242 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003243#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003244 "Reboot the system\n" \
3245 "\nOptions:" \
3246 "\n -d Delay interval for rebooting" \
3247 "\n -n No call to sync()" \
3248 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003249
3250#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003251 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003252#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003253 "Change priority of running processes\n" \
3254 "\nOptions:" \
3255 "\n -n Adjust current nice value (smaller is faster)" \
3256 "\n -p Process id(s) (default)" \
3257 "\n -g Process group id(s)" \
3258 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003259
Eric Andersen7e9276b2001-02-22 01:15:47 +00003260#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003261 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003262#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003263 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003264
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003265#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003266 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003267#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003268 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003269
Denis Vlasenko397137b2007-07-23 14:03:30 +00003270#define restorecon_trivial_usage \
3271 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003272#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003273 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003274 "\n -i Ignore files that do not exist" \
3275 "\n -f file File with list of files to process. Use - for stdin" \
3276 "\n -e directory Directory to exclude" \
3277 "\n -R,-r Recurse directories" \
3278 "\n -n Don't change any file labels" \
3279 "\n -o file Save list of files with incorrect context" \
3280 "\n -v Verbose" \
3281 "\n -vv Show changed labels" \
3282 "\n -F Force reset of context to match file_context" \
3283 "\n for customizable files, or the user section," \
3284 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003285
Eric Andersen7e9276b2001-02-22 01:15:47 +00003286#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003287 "[OPTION]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003288#define rm_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003289 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003290 "indicate that all following arguments are non-options.\n" \
3291 "\nOptions:" \
3292 "\n -i Always prompt before removing" \
3293 "\n -f Never prompt" \
3294 "\n -r,-R Remove directories recursively" \
3295
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003296#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003297 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003298
Eric Andersen7e9276b2001-02-22 01:15:47 +00003299#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003300 "[OPTION]... DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003301#define rmdir_full_usage "\n\n" \
Bernhard Reutner-Fischer99ecc462008-08-21 20:52:55 +00003302 "Remove the DIRECTORY, if it is empty.\n" \
3303 "\nOptions:" \
3304 USE_FEATURE_RMDIR_LONG_OPTIONS( \
3305 "\n -p|--parents Include parents" \
3306 "\n -ignore-fail-on-non-empty" \
3307 ) \
3308 SKIP_FEATURE_RMDIR_LONG_OPTIONS( \
3309 "\n -p Include parents" \
3310 )
3311
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003312#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003313 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003314
Eric Andersen7e9276b2001-02-22 01:15:47 +00003315#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003316 "[OPTION]... [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003317#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003318 "Unload the specified kernel modules from the kernel\n" \
3319 "\nOptions:" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003320 "\n -w Wait until the module is no longer used" \
3321 "\n -f Force unloading" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003322 "\n -a Remove all unused modules (recursively)" \
3323
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003324#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003325 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003326
Eric Andersen7e9276b2001-02-22 01:15:47 +00003327#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003328 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003329#define route_full_usage "\n\n" \
Bernhard Reutner-Fischer63758532008-08-21 20:18:55 +00003330 "Edit kernel routing tables\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003331 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003332 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003333 "\n -e Display other/more information" \
3334 "\n -A inet" USE_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003335
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003336#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003337 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003338#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003339 "Manipulate RPM packages\n" \
3340 "\nOptions:" \
3341 "\n -i Install package" \
3342 "\n -q Query package" \
3343 "\n -p Query uninstalled package" \
3344 "\n -i Show information" \
3345 "\n -l List contents" \
3346 "\n -d List documents" \
3347 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003348
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003349#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003350 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003351#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003352 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003353
Mike Frysinger6b160e42008-02-15 02:27:19 +00003354#define rtcwake_trivial_usage \
3355 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003356#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003357 "Enter a system sleep state until specified wakeup time\n" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003358 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003359 "\n -a,--auto Read clock mode from adjtime" \
3360 "\n -l,--local Clock is set to local time" \
3361 "\n -u,--utc Clock is set to UTC time" \
3362 "\n -d,--device=DEV Specify the RTC device" \
Mike Frysinger1e93f3c2008-06-04 10:33:33 +00003363 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003364 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
3365 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003366 ) \
3367 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003368 "\n -a Read clock mode from adjtime" \
3369 "\n -l Clock is set to local time" \
3370 "\n -u Clock is set to UTC time" \
3371 "\n -d DEV Specify the RTC device" \
3372 "\n -m MODE Set the sleep state (default: standby)" \
3373 "\n -s SEC Set the timeout in SEC seconds from now" \
3374 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003375 )
3376
Denis Vlasenko49622d72007-03-10 16:58:49 +00003377#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003378 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3379 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003380#define runcon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003381 "Run a program in a different security context\n" \
3382 "\n CONTEXT Complete security context\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003383 USE_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003384 "\n -c,--compute Compute process transition context before modifying" \
3385 "\n -t,--type=TYPE Type (for same role as parent)" \
3386 "\n -u,--user=USER User identity" \
3387 "\n -r,--role=ROLE Role" \
3388 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003389 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003390 SKIP_FEATURE_RUNCON_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003391 "\n -c Compute process transition context before modifying" \
3392 "\n -t TYPE Type (for same role as parent)" \
3393 "\n -u USER User identity" \
3394 "\n -r ROLE Role" \
3395 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003396 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003397
Eric Andersen6cf47a72001-10-31 10:24:36 +00003398#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003399 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003400#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003401 "Run a bunch of scripts in a directory\n" \
3402 "\nOptions:" \
3403 "\n -t Print what would be run, but don't actually run anything" \
3404 "\n -a ARG Pass ARG as argument for every program" \
3405 "\n -u MASK Set the umask to MASK before running every program" \
3406 USE_FEATURE_RUN_PARTS_FANCY( \
3407 "\n -l Print names of all matching files even if they are not executable" \
3408 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003409
3410#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003411 "$ run-parts -a start /etc/init.d\n" \
3412 "$ run-parts -a stop=now /etc/init.d\n\n" \
3413 "Let's assume you have a script foo/dosomething:\n" \
3414 "#!/bin/sh\n" \
3415 "for i in $*; do eval $i; done; unset i\n" \
3416 "case \"$1\" in\n" \
3417 "start*) echo starting something;;\n" \
3418 "stop*) set -x; shutdown -h $stop;;\n" \
3419 "esac\n\n" \
3420 "Running this yields:\n" \
3421 "$run-parts -a stop=+4m foo/\n" \
3422 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003423
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003424#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003425 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003426#define runlevel_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003427 "Find the current and previous system runlevel.\n\n" \
3428 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003429 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003430#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003431 "$ runlevel /var/run/utmp\n" \
3432 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003433
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003434#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003435 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003436#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003437 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003438
3439#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003440 "[-P] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003441#define runsvdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003442 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003443
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003444#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003445 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003446#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003447 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003448#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003449 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003450
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003451#define script_trivial_usage \
3452 "[-afq] [-c COMMAND] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003453#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003454 "Options:" \
3455 "\n -a Append output" \
3456 "\n -c Run COMMAND, not shell" \
3457 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003458 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003459
Eric Andersen7e9276b2001-02-22 01:15:47 +00003460#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003461 "[-efinr] pattern [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003462#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003463 "Options:" \
3464 "\n -e script Add the script to the commands to be executed" \
3465 "\n -f scriptfile Add scriptfile contents to the" \
3466 "\n commands to be executed" \
3467 "\n -i Edit files in-place" \
3468 "\n -n Suppress automatic printing of pattern space" \
3469 "\n -r Use extended regular expression syntax" \
3470 "\n" \
3471 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3472 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3473 "\ninput files are specified, then the standard input is read. Source files" \
3474 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003475
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003476#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003477 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3478 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003479
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003480#define selinuxenabled_trivial_usage NOUSAGE_STR
3481#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003482
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003483#define sendmail_trivial_usage \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003484 "[-w timeout] [-H [user:pass@]server[:port]] [-S]\n" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003485 "[-N type] [-f sender] [-F fullname] " \
Denis Vlasenko2b2d9772008-09-28 13:50:57 +00003486 USE_FEATURE_SENDMAIL_MAILX("[-s subject] [-c cc-rcpt]... [-j charset] [-a attach]... [-e err-rcpt] ") "[-t] [rcpt]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003487#define sendmail_full_usage "\n\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003488 "Send an email\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003489 "\nOptions:" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003490 "\n -w timeout Network timeout" \
3491 "\n -H [user:pass@]server[:port] Server" \
3492 "\n -S Use openssl connection helper for secure servers" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003493 "\n -N type Request delivery notification. Type is ignored" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003494 "\n -f sender Sender" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003495 "\n -F fullname Sender full name. Overrides $NAME" \
3496 USE_FEATURE_SENDMAIL_MAILX( \
3497 "\n -s subject Subject" \
Denis Vlasenko2b2d9772008-09-28 13:50:57 +00003498 "\n -c rcpt Cc: recipient. May be multiple" \
3499 "\n -j charset Assume charset for body and subject (" CONFIG_FEATURE_SENDMAIL_CHARSET ")" \
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003500 "\n -a file File to attach. May be multiple" \
Denis Vlasenko2b2d9772008-09-28 13:50:57 +00003501 "\n -e rcpt Errors-To: recipient" \
3502 )
Denis Vlasenkobed22a02008-09-27 14:01:22 +00003503 "\n -t Read recipients and subject from body" \
3504 "\n" \
3505 "\nOther options are silently ignored; -oi is implied" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003506
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003507#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003508 "[first [increment]] last"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003509#define seq_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003510 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003511 "FIRST, INCREMENT default to 1\n" \
3512 "\nArguments:" \
3513 "\n LAST" \
3514 "\n FIRST LAST" \
3515 "\n FIRST INCREMENT LAST" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003516
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003517#define sestatus_trivial_usage \
3518 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003519#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003520 " -v Verbose" \
3521 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003522
Paul Foxfc2256a2005-08-01 18:12:30 +00003523#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003524 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003525#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003526 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3527 "\nOptions:" \
3528 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003529
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003530#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003531 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003532#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003533
Denis Vlasenko397137b2007-07-23 14:03:30 +00003534#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003535 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003536 USE_FEATURE_SETFILES_CHECK_OPTION( \
3537 " [-c policyfile] spec_file" \
3538 ) \
3539 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003540#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003541 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003542 USE_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003543 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003544 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003545 "\n -d Show which specification matched each file" \
3546 "\n -l Log changes in file labels to syslog" \
3547 "\n -n Don't change any file labels" \
3548 "\n -q Suppress warnings" \
3549 "\n -r dir Use an altenate root path" \
3550 "\n -e dir Exclude directory" \
3551 "\n -F Force reset of context to match file_context for customizable files" \
3552 "\n -o file Save list of files with incorrect context" \
3553 "\n -s Take a list of files from standard input (instead of command line)" \
3554 "\n -v Show changes in file labels, if type or role are changing" \
3555 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3556 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003557
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003558#define setfont_trivial_usage \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003559 "FONT [-m MAPFILE] [-C TTY]"
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003560#define setfont_full_usage "\n\n" \
3561 "Load a console font\n" \
3562 "\nOptions:" \
Denis Vlasenko53f219e2008-09-16 19:35:42 +00003563 "\n -m MAPFILE Load console screen map" \
3564 "\n -C TTY Affect TTY instead of /dev/tty" \
3565
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003566#define setfont_example_usage \
3567 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3568
Eric Andersen7e9276b2001-02-22 01:15:47 +00003569#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003570 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003571#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003572 "Set entries into the kernel's scancode-to-keycode map,\n" \
3573 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3574 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003575 "and KEYCODE is given in decimal" \
3576
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003577#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003578 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003579
Rob Landley87848d92006-03-27 23:23:43 +00003580#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003581 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003582#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003583 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003584
Denis Vlasenkobe039372007-10-14 04:48:44 +00003585#define setsebool_trivial_usage \
3586 "boolean value"
3587
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003588#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003589 "Change boolean setting"
3590
Paul Fox42403642005-08-01 22:52:09 +00003591#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003592 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003593#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003594 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3595 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3596 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003597
Matt Kraai2d91deb2001-08-01 17:21:35 +00003598#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003599 "[FILE]...\n" \
3600 "or: sh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003601#define lash_full_usage "\n\n" \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003602 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003603
Eric Andersen2e9c2572003-08-08 22:26:06 +00003604#define last_trivial_usage \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003605 ""USE_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003606#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003607 "Show listing of the last users that logged into the system" \
3608 USE_FEATURE_LAST_FANCY( "\n" \
3609 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003610/* "\n -H Show header line" */ \
3611 "\n -W Display with no host column truncation" \
3612 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003613 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003614
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003615#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003616 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003617 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003618#define sha1sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003619 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
3620 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
3621 "\nOptions:" \
3622 "\n -c Check SHA1 sums against given list" \
3623 "\n -s Don't output anything, status code shows success" \
3624 "\n -w Warn about improperly formatted SHA1 checksum lines" \
3625 )
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003626
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003627#define showkey_trivial_usage \
3628 "[-a | -k | -s]"
3629#define showkey_full_usage "\n\n" \
3630 "Show keys pressed\n" \
3631 "\nOptions:" \
3632 "\n -a Display decimal/octal/hex values of the keys" \
3633 "\n -k Display interpreted keycodes (default)" \
3634 "\n -s Display raw scan-codes" \
3635
Denis Vlasenko14923db2007-06-20 15:23:03 +00003636#define slattach_trivial_usage \
3637 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003638#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003639 "Attach network interface(s) to serial line(s)\n" \
3640 "\nOptions:" \
3641 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3642 "\n -s Set line speed" \
3643 "\n -e Exit after initializing device" \
3644 "\n -h Exit when the carrier is lost" \
3645 "\n -c Execute a command when the line is hung up" \
3646 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3647 "\n -L Enable 3-wire operation" \
3648 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003649
Eric Andersen7e9276b2001-02-22 01:15:47 +00003650#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003651 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003652#define sleep_full_usage "\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003653 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003654 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003655 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003656 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003657#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003658 "$ sleep 2\n" \
3659 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003660 USE_FEATURE_FANCY_SLEEP( \
3661 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003662 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003663
Eric Andersen7e9276b2001-02-22 01:15:47 +00003664#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003665 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003666 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003667 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003668#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003669 "Sort lines of text\n" \
3670 "\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003671 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003672 "\n -b Ignore leading blanks" \
3673 "\n -c Check whether input is sorted" \
3674 "\n -d Dictionary order (blank or alphanumeric only)" \
3675 "\n -f Ignore case" \
3676 "\n -g General numerical sort" \
3677 "\n -i Ignore unprintable characters" \
3678 "\n -k Sort key" \
3679 "\n -M Sort month" \
3680 ) \
3681 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003682 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003683 "\n -o Output to file" \
3684 "\n -k Sort by key" \
3685 "\n -t CHAR Key separator" \
3686 ) \
3687 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003688 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003689 "\n -s Stable (don't sort ties alphabetically)" \
3690 ) \
3691 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003692 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003693 "\n -z Lines are terminated by NUL, not newline" \
3694 "\n -mST Ignored for GNU compatibility") \
3695
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003696#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003697 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3698 "a\n" \
3699 "b\n" \
3700 "c\n" \
3701 "d\n" \
3702 "e\n" \
3703 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003704 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003705 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3706 "d 2\n" \
3707 "b 2\n" \
3708 "c 3\n" \
3709 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003710 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003711
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003712#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003713 "[OPTION] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003714#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003715 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003716 "\n -b n[k|m] Split by bytes" \
3717 "\n -l n Split by lines" \
3718 "\n -a n Use n letters as suffix" \
3719
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003720#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003721 "$ split TODO foo\n" \
3722 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003723
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003724#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00003725 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003726#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003727 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003728 "-K: stop all matching processes.\n" \
3729 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003730 USE_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003731 "\nProcess matching:" \
3732 "\n -u,--user USERNAME|UID Match only this user's processes" \
3733 "\n -n,--name NAME Match processes with NAME" \
3734 "\n in comm field in /proc/PID/stat" \
3735 "\n -x,--exec EXECUTABLE Match processes with this command" \
3736 "\n in /proc/PID/cmdline" \
3737 "\n -p,--pidfile FILE Match a process with PID from the file" \
3738 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003739 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003740 "\n -x,--exec EXECUTABLE Program to run" \
3741 "\n -a,--startas NAME Zeroth argument" \
3742 "\n -b,--background Background" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003743 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003744 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003745 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003746 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3747 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003748 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003749 "\n -s,--signal SIG Signal to send" \
3750 "\n -t,--test Match only, exit with 0 if a process is found" \
3751 "\nOther:" \
3752 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3753 "\n -o,--oknodo Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003754 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003755 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003756 "\n -q,--quiet Quiet" \
3757 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00003758 SKIP_FEATURE_START_STOP_DAEMON_LONG_OPTIONS( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003759 "\nProcess matching:" \
3760 "\n -u USERNAME|UID Match only this user's processes" \
3761 "\n -n NAME Match processes with NAME" \
3762 "\n in comm field in /proc/PID/stat" \
3763 "\n -x EXECUTABLE Match processes with this command" \
3764 "\n command in /proc/PID/cmdline" \
3765 "\n -p FILE Match a process with PID from the file" \
3766 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003767 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003768 "\n -x EXECUTABLE Program to run" \
3769 "\n -a NAME Zeroth argument" \
3770 "\n -b Background" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003771 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003772 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003773 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003774 "\n -c USER[:[GRP]] Change to user/group" \
3775 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003776 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003777 "\n -s SIG Signal to send" \
3778 "\n -t Match only, exit with 0 if a process is found" \
3779 "\nOther:" \
3780 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3781 "\n -o Exit with status 0 if nothing is done" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003782 "\n -v Verbose" \
3783 ) \
Bernhard Reutner-Fischer1a891332008-09-26 15:14:56 +00003784 "\n -q Quiet" \
3785 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003786
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003787#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003788 "[OPTION] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003789#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003790 "Display file (default) or filesystem status\n" \
3791 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003792 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003793 "\n -c fmt Use the specified format" \
3794 ) \
3795 "\n -f Display filesystem status" \
3796 "\n -L Dereference links" \
3797 "\n -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003798 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003799 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003800 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003801 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003802 "\n\nValid format sequences for files:\n" \
3803 " %a Access rights in octal\n" \
3804 " %A Access rights in human readable form\n" \
3805 " %b Number of blocks allocated (see %B)\n" \
3806 " %B The size in bytes of each block reported by %b\n" \
3807 " %d Device number in decimal\n" \
3808 " %D Device number in hex\n" \
3809 " %f Raw mode in hex\n" \
3810 " %F File type\n" \
3811 " %g Group ID of owner\n" \
3812 " %G Group name of owner\n" \
3813 " %h Number of hard links\n" \
3814 " %i Inode number\n" \
3815 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003816 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003817 " %o I/O block size\n" \
3818 " %s Total size, in bytes\n" \
3819 " %t Major device type in hex\n" \
3820 " %T Minor device type in hex\n" \
3821 " %u User ID of owner\n" \
3822 " %U User name of owner\n" \
3823 " %x Time of last access\n" \
3824 " %X Time of last access as seconds since Epoch\n" \
3825 " %y Time of last modification\n" \
3826 " %Y Time of last modification as seconds since Epoch\n" \
3827 " %z Time of last change\n" \
3828 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003829 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003830 " %a Free blocks available to non-superuser\n" \
3831 " %b Total data blocks in file system\n" \
3832 " %c Total file nodes in file system\n" \
3833 " %d Free file nodes in file system\n" \
3834 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003835 USE_SELINUX( \
3836 " %C Security context in SELinux\n" \
3837 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003838 " %i File System ID in hex\n" \
3839 " %l Maximum length of filenames\n" \
3840 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003841 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003842 " %S Fundamental block size (for block counts)\n" \
3843 " %t Type in hex\n" \
3844 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003845 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003846
Eric Andersenef5e8f82002-11-07 02:09:37 +00003847#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003848 "[-afo] [-n length] [file...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003849#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003850 "Display printable strings in a binary file\n" \
3851 "\nOptions:" \
3852 "\n -a Scan whole file (default)" \
3853 "\n -f Precede strings with filenames" \
3854 "\n -n N At least N characters form a string (default 4)" \
3855 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003856
Eric Andersen7e9276b2001-02-22 01:15:47 +00003857#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003858 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003859#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003860 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003861 "and deviations from stty sane\n" \
3862 "\nOptions:" \
3863 "\n -F DEVICE Open device instead of stdin" \
3864 "\n -a Print all current settings in human-readable form" \
3865 "\n -g Print in stty-readable form" \
3866 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003867
Robert Griebl1fca5582002-06-04 20:45:46 +00003868#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003869 "[OPTION]... [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003870#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003871 "Change user id or become root\n" \
3872 "\nOptions:" \
3873 "\n -p, -m Preserve environment" \
3874 "\n -c Command to pass to 'sh -c'" \
3875 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00003876
Eric Andersen27f64e12002-06-23 04:24:25 +00003877#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003878 "[OPTION]... [tty-device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003879#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003880 "Single user login\n" \
3881 "\nOptions:" \
3882 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003883
Mike Frysinger95d3c452005-04-21 23:29:24 +00003884#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003885 "[rs] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003886#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003887 "Checksum and count the blocks in a file\n" \
3888 "\nOptions:" \
3889 "\n -r Use BSD sum algorithm (1K blocks)" \
3890 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00003891
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003892#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003893 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003894#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003895 "Control services monitored by runsv supervisor.\n" \
3896 "Commands (only first character is enough):\n" \
3897 "\n" \
3898 "status: query service status\n" \
3899 "up: if service isn't running, start it. If service stops, restart it\n" \
3900 "once: like 'up', but if service stops, don't restart it\n" \
3901 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003902 " if it exists. After it stops, do not restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003903 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003904 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003905 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003906 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003907
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003908#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003909 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003910#define svlogd_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003911 "Continuously read log data from standard input, optionally " \
3912 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003913 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003914
Eric Andersen7e9276b2001-02-22 01:15:47 +00003915#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003916 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003917#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003918 "Stop swapping on DEVICE\n" \
3919 "\nOptions:" \
3920 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003921
Eric Andersen7e9276b2001-02-22 01:15:47 +00003922#define swapon_trivial_usage \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00003923 "[-a]" USE_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003924#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003925 "Start swapping on DEVICE\n" \
3926 "\nOptions:" \
3927 "\n -a Start swapping on all swap devices" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00003928 USE_FEATURE_SWAPON_PRI( \
3929 "\n -p pri Set swap device priority" \
3930 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003931
Rob Landley0f34a822005-10-27 22:55:50 +00003932#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003933 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003934#define switch_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003935 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003936 "and exec NEW_INIT\n" \
3937 "\nOptions:" \
3938 "\n -c Redirect console to device on new root" \
Rob Landley0f34a822005-10-27 22:55:50 +00003939
Eric Andersen7e9276b2001-02-22 01:15:47 +00003940#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003941 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003942#define sync_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003943 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003944
Eric Andersenb9050282003-12-24 06:02:11 +00003945#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003946 "[OPTIONS]... [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003947#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003948 "Configure kernel parameters at runtime\n" \
3949 "\nOptions:" \
3950 "\n -n Disable printing of key names" \
3951 "\n -e Don't warn about unknown keys" \
3952 "\n -w Change sysctl setting" \
3953 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
3954 "\n -a Display all values" \
3955 "\n -A Display all values in table form" \
3956
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003957#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003958 "sysctl [-n] [-e] variable...\n" \
3959 "sysctl [-n] [-e] -w variable=value...\n" \
3960 "sysctl [-n] [-e] -a\n" \
3961 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3962 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003963
Eric Andersen7e9276b2001-02-22 01:15:47 +00003964#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003965 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003966#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003967 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003968 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
3969 "\nOptions:" \
3970 "\n -n Run in foreground" \
3971 "\n -O FILE Log to given file (default=/var/log/messages)" \
3972 "\n -l n Set local log level" \
3973 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003974 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003975 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3976 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003977 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003978 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3979 "\n -L Log locally and via network (default is network only if -R)") \
3980 USE_FEATURE_SYSLOGD_DUP( \
3981 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003982 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003983 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003984 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003985/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00003986
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003987#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003988 "$ syslogd -R masterlog:514\n" \
3989 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003990
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003991#define tac_trivial_usage \
3992 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003993#define tac_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003994 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003995
Eric Andersen7e9276b2001-02-22 01:15:47 +00003996#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003997 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003998#define tail_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003999 "Print last 10 lines of each FILE to standard output.\n" \
4000 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004001 "file name. With no FILE, or when FILE is -, read standard input.\n" \
4002 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004003 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004004 "\n -c N[kbm] Output the last N bytes") \
4005 "\n -n N[kbm] Print last N lines instead of last 10" \
4006 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004007 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004008 "\n -q Never output headers giving file names" \
4009 "\n -s SEC Wait SEC seconds between reads with -f" \
4010 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00004011 "\n" \
4012 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
4013 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
4014 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004015
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004016#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004017 "$ tail -n 1 /etc/resolv.conf\n" \
4018 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004019
Eric Andersen7e9276b2001-02-22 01:15:47 +00004020#define tar_trivial_usage \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004021 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_SEAMLESS_GZ("z") \
4022 USE_FEATURE_SEAMLESS_BZ2("j") USE_FEATURE_SEAMLESS_LZMA("a") \
4023 USE_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00004024 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004025 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004026#define tar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004027 "Create, extract, or list files from a tar file\n" \
4028 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004029 USE_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004030 "\n c Create") \
4031 "\n x Extract" \
4032 "\n t List" \
4033 "\nArchive format selection:" \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004034 USE_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004035 "\n z Filter the archive through gzip" \
4036 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004037 USE_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004038 "\n j Filter the archive through bzip2" \
4039 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004040 USE_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004041 "\n a Filter the archive through lzma" \
4042 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00004043 USE_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004044 "\n Z Filter the archive through compress" \
4045 ) \
4046 "\nFile selection:" \
4047 "\n f Name of TARFILE or \"-\" for stdin" \
4048 "\n O Extract to stdout" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004049 USE_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004050 "\n exclude File to exclude" \
4051 "\n X File with names to exclude" \
4052 ) \
4053 "\n C Change to directory DIR before operation" \
4054 "\n v Verbose" \
4055
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004056#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004057 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4058 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004059
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004060#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00004061 "[-p] [mask] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004062#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004063 "Set or get CPU affinity\n" \
4064 "\nOptions:" \
4065 "\n -p Operate on an existing PID" \
4066
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004067#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004068 "$ taskset 0x7 ./dgemm_test&\n" \
4069 "$ taskset -p 0x1 $!\n" \
4070 "pid 4790's current affinity mask: 7\n" \
4071 "pid 4790's new affinity mask: 1\n" \
4072 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4073 "pid 6671's current affinity mask: 1\n" \
4074 "pid 6671's new affinity mask: 1\n" \
4075 "$ taskset -p 1\n" \
4076 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004077
Eric Andersen7e9276b2001-02-22 01:15:47 +00004078#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004079 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004080#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004081 "Copy standard input to each FILE, and also to standard output\n" \
4082 "\nOptions:" \
4083 "\n -a Append to the given FILEs, do not overwrite" \
4084 "\n -i Ignore interrupt signals (SIGINT)" \
4085
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004086#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004087 "$ echo \"Hello\" | tee /tmp/foo\n" \
4088 "$ cat /tmp/foo\n" \
4089 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004090
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004091#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004092#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004093 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004094#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004095 "Connect to telnet server\n" \
4096 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004097 "\n -a Automatic login with $USER variable" \
4098 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004099
Eric Andersen539ffc92004-02-22 12:25:47 +00004100#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004101#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004102 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004103#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004104 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004105#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004106
Eric Andersen08a72202002-09-30 20:52:10 +00004107#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004108 "[OPTION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004109#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004110 "Handle incoming telnet connections" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004111 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
4112 "\nOptions:" \
4113 "\n -l LOGIN Exec LOGIN on connect" \
4114 "\n -f issue_file Display issue_file instead of /etc/issue" \
4115 "\n -K Close connection as soon as login exits" \
4116 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004117 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004118 "\n -p PORT Port to listen on" \
4119 "\n -b ADDR Address to bind to" \
4120 "\n -F Run in foreground" \
4121 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004122 )
Eric Andersen08a72202002-09-30 20:52:10 +00004123
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004124/* "test --help" does not print help (POSIX compat), only "[ --help" does.
4125 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION") */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004126#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004127 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004128#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004129 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4130 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004131#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004132 "$ test 1 -eq 2\n" \
4133 "$ echo $?\n" \
4134 "1\n" \
4135 "$ test 1 -eq 1\n" \
4136 "$ echo $?\n" \
4137 "0\n" \
4138 "$ [ -d /etc ]\n" \
4139 "$ echo $?\n" \
4140 "0\n" \
4141 "$ [ -d /junk ]\n" \
4142 "$ echo $?\n" \
4143 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004144
Bernhard Reutner-Fischer0901c512008-09-04 13:22:58 +00004145#define tc_trivial_usage \
4146 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
4147#define tc_full_usage "\n\n" \
4148 "OBJECT: {qdisc|class|filter}\n" \
4149 "CMD: {add|del|change|replace|show}\n" \
4150 "\n" \
4151 "qdisc [ handle QHANDLE ] [ root |"USE_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
4152 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4153 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4154 "\tQDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
4155 "qdisc show [ dev STRING ]"USE_FEATURE_TC_INGRESS(" [ingress]")"\n" \
4156 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
4157 "\t[ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
4158 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
4159 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
4160 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
4161 "\t[ root | classid CLASSID ] [ handle FILTERID ]\n" \
4162 "\t[ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
4163 "filter show [ dev STRING ] [ root | parent CLASSID ]"
4164
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004165#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004166 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004167/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004168/* "[-hpEvv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] [-i dir|-x cdb] [-t sec] ip port prog..." */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004169#define tcpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004170 "Create TCP socket, bind it to ip:port and listen\n" \
4171 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004172 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004173 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004174 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004175 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4176 "\n-u user[:group] Change to user/group after bind" \
4177 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004178 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004179 "\n-C n[:msg] Allow only up to n connections from the same IP" \
4180 "\n New connections from this IP address are closed" \
4181 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004182 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004183 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004184 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004185
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004186#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00004187 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004188#define udpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004189 "Create UDP socket, bind it to ip:port and wait\n" \
4190 "for incoming packets. Run PROG for each packet,\n" \
4191 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004192 "\nip IP to listen on. '0' = all" \
4193 "\nport Port to listen on" \
4194 "\nprog [arg] Program to run" \
4195 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4196 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004197 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004198 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004199 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004200 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004201
Mark Whitley450736c2001-03-02 19:08:50 +00004202#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004203 "[OPTION]... HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004204#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004205 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004206 "\nOptions:" \
4207 "\n -l FILE Local FILE" \
4208 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004209 USE_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004210 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004211 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004212 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004213 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004214 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004215 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004216 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004217 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004218
4219#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004220 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004221#define tftpd_full_usage "\n\n" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004222 "Transfer a file on tftp client's request.\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004223 "\nOptions:" \
4224 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004225 "\n -c Allow file creation via upload" \
4226 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004227
Eric Andersenc3657422001-11-30 07:54:32 +00004228#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004229 "[OPTION]... COMMAND [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004230#define time_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004231 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004232 "COMMAND's resource usage information is displayed.\n" \
4233 "\nOptions:" \
4234 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004235
Eric Andersen420b2082002-09-17 22:14:58 +00004236#define top_trivial_usage \
Denis Vlasenko42cc6ba2008-09-25 11:17:10 +00004237 "[-b] [-nCOUNT] [-dSECONDS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004238#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004239 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004240 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004241 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004242
Eric Andersen7e9276b2001-02-22 01:15:47 +00004243#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004244 "[-c] FILE [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004245#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004246 "Update the last-modified date on the given FILE[s]\n" \
4247 "\nOptions:" \
4248 "\n -c Do not create any files" \
4249
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004250#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004251 "$ ls -l /tmp/foo\n" \
4252 "/bin/ls: /tmp/foo: No such file or directory\n" \
4253 "$ touch /tmp/foo\n" \
4254 "$ ls -l /tmp/foo\n" \
4255 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004256
4257#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004258 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004259#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004260 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004261 "standard input, writing to standard output\n" \
4262 "\nOptions:" \
4263 "\n -c Take complement of STRING1" \
4264 "\n -d Delete input characters coded STRING1" \
4265 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4266
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004267#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004268 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4269 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004270
Eric Andersen5c58d282001-07-10 16:29:00 +00004271#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004272 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4273 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004274 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004275#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004276 "Trace the route to HOST\n" \
4277 "\nOptions:" \
4278 "\n -F Set the don't fragment bit" \
4279 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4280 "\n -l Display the ttl value of the returned packet" \
4281 "\n -d Set SO_DEBUG options to socket" \
4282 "\n -n Print hop addresses numerically rather than symbolically" \
4283 "\n -r Bypass the normal routing tables and send directly to a host" \
4284 "\n -v Verbose" \
4285 "\n -m max_ttl Max time-to-live (max number of hops)" \
4286 "\n -p port# Base UDP port number used in probes" \
4287 "\n (default is 33434)" \
4288 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4289 "\n -s src_addr IP address to use as the source address" \
4290 "\n -t tos Type-of-service in probe packets (default 0)" \
4291 "\n -w wait Time in seconds to wait for a response" \
4292 "\n (default 3 sec)" \
4293 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004294
Eric Andersen7e9276b2001-02-22 01:15:47 +00004295#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004296 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004297#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004298 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004299#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004300 "$ true\n" \
4301 "$ echo $?\n" \
4302 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004303
Eric Andersen7e9276b2001-02-22 01:15:47 +00004304#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004305 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004306#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004307 "Print file name of standard input's terminal" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004308 USE_INCLUDE_SUSv2( "\n" \
4309 "\nOptions:" \
4310 "\n -s Print nothing, only return exit status" \
4311 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004312#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004313 "$ tty\n" \
4314 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004315
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004316#define ttysize_trivial_usage \
4317 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004318#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004319 "Print dimension(s) of standard input's terminal, on error return 80x25"
4320
Mike Frysinger174808c2005-06-11 01:14:09 +00004321#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004322 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4323 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4324 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4325 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4326 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4327 "[-T last-check-time] [-U UUID] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004328#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004329 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004330
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004331#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004332 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004333 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004334#define udhcpc_full_usage "\n\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004335 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004336 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004337 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4338 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4339 "\n -c,--clientid=CLIENTID Client identifier" \
4340 "\n -C,--clientid-none Suppress default client identifier" \
4341 "\n -p,--pidfile=file Create pidfile" \
4342 "\n -r,--request=IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004343 "\n -s,--script=file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004344 "\n -t,--retries=N Send up to N request packets" \
4345 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4346 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004347 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4348 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004349 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004350 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004351 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004352 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004353 "\n -S,--syslog Log to syslog too" \
4354 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4355 "\n -q,--quit Quit after obtaining lease" \
4356 "\n -R,--release Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004357 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004358 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004359 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004360 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004361 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004362 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004363 ) \
4364 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004365 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004366 "\n -i INTERFACE Interface to use (default: eth0)" \
4367 "\n -H,-h HOSTNAME Client hostname" \
4368 "\n -c CLIENTID Client identifier" \
4369 "\n -C Suppress default client identifier" \
4370 "\n -p file Create pidfile" \
4371 "\n -r IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004372 "\n -s file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004373 "\n -t N Send up to N request packets" \
4374 "\n -T N Try to get a lease for N seconds (default 3)" \
4375 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004376 "\n -O OPT Request DHCP option OPT (cumulative)" \
4377 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004378 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004379 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004380 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004381 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004382 "\n -S Log to syslog too" \
4383 "\n -n Exit with failure if lease is not immediately obtained" \
4384 "\n -q Quit after obtaining lease" \
4385 "\n -R Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004386 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004387 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004388 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004389 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004390 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004391 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004392 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004393
Russ Dill61fb4892002-10-14 21:41:28 +00004394#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004395 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004396
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004397#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004398 "DHCP server\n" \
4399 "\n -f Run in foreground" \
4400 "\n -S Log to syslog too" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004401 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004402 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004403 )
Russ Dill61fb4892002-10-14 21:41:28 +00004404
Eric Andersen7e9276b2001-02-22 01:15:47 +00004405#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004406 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004407#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004408 "Unmount file systems\n" \
4409 "\nOptions:" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004410 USE_FEATURE_UMOUNT_ALL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004411 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
4412 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004413 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004414 "\n -n Don't erase /etc/mtab entries" \
4415 ) \
4416 "\n -r Try to remount devices as read-only if mount is busy" \
4417 "\n -l Lazy umount (detach filesystem)" \
4418 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004419 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004420 "\n -d Free loop device if it has been used" \
4421 )
4422
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004423#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004424 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004425
4426#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004427 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004428#define uname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004429 "Print system information.\n" \
4430 "\nOptions:" \
4431 "\n -a Print all" \
4432 "\n -m The machine (hardware) type" \
4433 "\n -n Hostname" \
4434 "\n -r OS release" \
4435 "\n -s OS name (default)" \
4436 "\n -p Processor type" \
4437 "\n -v OS version" \
4438
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004439#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004440 "$ uname -a\n" \
4441 "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 +00004442
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004443#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004444 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004445#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004446 "Uncompress .Z file[s]\n" \
4447 "\nOptions:" \
4448 "\n -c Extract to stdout" \
4449 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004450
Denis Vlasenko3952f202007-08-13 14:10:24 +00004451#define unexpand_trivial_usage \
4452 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004453#define unexpand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004454 "Convert spaces to tabs, writing to standard output.\n" \
4455 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004456 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004457 "\n -a,--all Convert all blanks" \
4458 "\n -f,--first-only Convert only leading blanks" \
4459 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004460 ) \
4461 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004462 "\n -a Convert all blanks" \
4463 "\n -f Convert only leading blanks" \
4464 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004465 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004466
Eric Andersen7e9276b2001-02-22 01:15:47 +00004467#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004468 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004469#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004470 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004471 "\nOptions:" \
4472 "\n -c Prefix lines by the number of occurrences" \
4473 "\n -d Only print duplicate lines" \
4474 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004475 "\n -f N Skip first N fields" \
4476 "\n -s N Skip first N chars (after any skipped fields)" \
4477 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004478
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004479#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004480 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4481 "a\n" \
4482 "b\n" \
4483 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004484
4485#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004486 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004487#define unix2dos_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004488 "Convert FILE from unix to dos format.\n" \
4489 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004490 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004491 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004492 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004493
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004494#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004495 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004496#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004497 "Extract files from ZIP archives\n" \
4498 "\nOptions:" \
4499 "\n -l List archive contents (with -q for short form)" \
4500 "\n -n Never overwrite existing files (default)" \
4501 "\n -o Overwrite files without prompting" \
4502 "\n -p Send output to stdout" \
4503 "\n -q Quiet" \
4504 "\n -x Exclude these files" \
4505 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004506
Eric Andersen7e9276b2001-02-22 01:15:47 +00004507#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004508 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004509#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004510 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004511
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004512#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004513 "$ uptime\n" \
4514 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004515
4516#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004517 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004518#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004519 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004520
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004521#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004522 "$ usleep 1000000\n" \
4523 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004524
4525#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004526 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004527#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004528 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004529 "Finds outfile name in uuencoded source unless -o is given"
4530
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004531#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004532 "$ uudecode -o busybox busybox.uu\n" \
4533 "$ ls -l busybox\n" \
4534 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004535
4536#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004537 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004538#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004539 "Uuencode a file to stdout\n" \
4540 "\nOptions:" \
4541 "\n -m Use base64 encoding per RFC1521" \
4542
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004543#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004544 "$ uuencode busybox busybox\n" \
4545 "begin 755 busybox\n" \
4546 "<encoded file snipped>\n" \
4547 "$ uudecode busybox busybox > busybox.uu\n" \
4548 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004549
Eric Andersen853c4942003-01-23 05:59:32 +00004550#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004551 "COMMAND [OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004552#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004553 "Create and remove virtual ethernet devices\n" \
4554 "\nOptions:" \
4555 "\n add [interface-name] [vlan_id]" \
4556 "\n rem [vlan-name]" \
4557 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4558 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4559 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4560 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004561
Eric Andersen3f980402001-04-04 17:31:15 +00004562#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004563 "[OPTION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004564#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004565 "Edit FILE\n" \
4566 "\nOptions:" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004567 USE_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004568 "\n -c Initial command to run ($EXINIT also available)") \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004569 USE_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004570 "\n -R Read-only - do not write to the file") \
4571 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004572
Eric Andersen27f64e12002-06-23 04:24:25 +00004573#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004574 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004575#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004576 "Lock a virtual terminal. A password is required to unlock.\n" \
4577 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004578 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004579
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004580#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004581 "[-n seconds] [-t] COMMAND..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004582#define watch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004583 "Execute a program periodically\n" \
4584 "\nOptions:" \
4585 "\n -n Loop period in seconds (default 2)" \
4586 "\n -t Don't print header" \
4587
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004588#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004589 "$ watch date\n" \
4590 "Mon Dec 17 10:31:40 GMT 2000\n" \
4591 "Mon Dec 17 10:31:42 GMT 2000\n" \
4592 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004593
Eric Andersen7e9276b2001-02-22 01:15:47 +00004594#define watchdog_trivial_usage \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004595 "[-t N[ms]] [-T N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004596#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004597 "Periodically write to watchdog device DEV\n" \
4598 "\nOptions:" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004599 "\n -T N Reboot after N seconds if not reset (default 60)" \
4600 "\n -t N Reset every N seconds (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004601 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004602 "\n" \
Denis Vlasenko8d89bed2008-09-07 23:22:08 +00004603 "\nUse 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004604
4605#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004606 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004607#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004608 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004609 "more than one FILE is specified. With no FILE, read standard input.\n" \
4610 "\nOptions:" \
4611 "\n -c Print the byte counts" \
4612 "\n -l Print the newline counts" \
4613 "\n -L Print the length of the longest line" \
4614 "\n -w Print the word counts" \
4615
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004616#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004617 "$ wc /etc/passwd\n" \
4618 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004619
4620#define wget_trivial_usage \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004621 USE_FEATURE_WGET_LONG_OPTIONS( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004622 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004623 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4624 " [-U|--user-agent agent] url" \
4625 ) \
Denis Vlasenkob46d5f92008-09-25 21:06:24 +00004626 SKIP_FEATURE_WGET_LONG_OPTIONS( \
Denis Vlasenko03630782007-10-18 11:11:12 +00004627 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4628 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004629#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004630 "Retrieve files via HTTP or FTP\n" \
4631 "\nOptions:" \
4632 "\n -s Spider mode - only check file existence" \
4633 "\n -c Continue retrieval of aborted transfer" \
4634 "\n -q Quiet" \
4635 "\n -P Set directory prefix to DIR" \
4636 "\n -O Save to filename ('-' for stdout)" \
4637 "\n -U Adjust 'User-Agent' field" \
4638 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004639
4640#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004641 "[COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004642#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004643 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004644#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004645 "$ which login\n" \
4646 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004647
Eric Andersen00a6a752002-04-26 23:53:10 +00004648#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004649 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004650#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004651 "Show who is logged on\n" \
4652 "\nOptions:" \
4653 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004654
4655#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004656 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004657#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004658 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004659
4660#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004661 "[OPTIONS] [COMMAND] [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004662#define xargs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004663 "Execute COMMAND on every item given by standard input\n" \
4664 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004665 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004666 "\n -p Ask user whether to run each command") \
4667 "\n -r Do not run command if input is empty" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004668 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004669 "\n -0 Input is separated by NUL characters") \
4670 "\n -t Print the command on stderr before execution" \
Denis Vlasenkoe82da4d2008-08-21 19:59:30 +00004671 "\n -e[STR] STR stops input processing" \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004672 "\n -n N Pass no more than N args to COMMAND" \
4673 "\n -s N Pass command line of no more than N bytes" \
4674 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4675 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004676
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004677#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004678 "$ ls | xargs gzip\n" \
4679 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004680
4681#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004682 "[OPTION]... [STRING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004683#define yes_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004684 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004685
Eric Andersen7e9276b2001-02-22 01:15:47 +00004686#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004687 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004688#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004689 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004690
Rob Landleyad8071f2005-04-30 03:49:37 +00004691#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004692 "[OPTIONS] ifname script"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004693#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004694 "Manage a ZeroConf IPv4 link-local address\n" \
4695 "\nOptions:" \
4696 "\n -f Run in foreground" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004697 "\n -q Quit after obtaining address" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004698 "\n -r 169.254.x.x Request this address first" \
4699 "\n -v Verbose" \
Denis Vlasenkocdd1f732008-10-10 11:28:39 +00004700 "\n" \
4701 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
4702 "\nexits only on I/O errors (link down etc)" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004703
Eric Andersen178de172004-04-06 16:36:20 +00004704#endif /* __BB_USAGE_H__ */