blob: 1e05eabc6d60cb27d150e52d62fd10ef91476ee2 [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
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000693#define devfsd_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000694 "mntpnt [-v]" USE_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000695#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000696 "Manage devfs permissions and old device name symlinks\n" \
697 "\nOptions:" \
698 "\n mntpnt The mount point where devfs is mounted" \
699 "\n -v Print the protocol version numbers for devfsd" \
700 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000701 USE_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000702 "\n -fg Run in foreground" \
703 "\n -np Exit after parsing the configuration file" \
704 "\n and processing synthetic REGISTER events," \
705 "\n do not poll for events" \
706 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000707
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000708/* -k is accepted but ignored for !HUMAN_READABLE,
709 * but we won't mention this (unimportant) */
710#if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
711#define DF_HAS_OPTIONS(x) x
712#else
713#define DF_HAS_OPTIONS(x)
714#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000715#define df_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000716 DF_HAS_OPTIONS("[-") \
717 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
718 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000719#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000720 "Print filesystem usage statistics\n" \
721 DF_HAS_OPTIONS("\nOptions:") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000722 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000723 "\n -h Human readable (e.g. 1K 243M 2G)" \
724 "\n -m 1024*1024 blocks" \
725 "\n -k 1024 blocks" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000726 ) \
727 USE_FEATURE_DF_INODE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000728 "\n -i Inodes" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000729 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000730#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000731 "$ df\n" \
732 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
733 "/dev/sda3 8690864 8553540 137324 98% /\n" \
734 "/dev/sda1 64216 36364 27852 57% /boot\n" \
735 "$ df /dev/sda3\n" \
736 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
737 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000738
Denis Vlasenko736230e2006-11-20 19:40:36 +0000739#define dhcprelay_trivial_usage \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000740 "[client1,client2,...] [server_device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000741#define dhcprelay_full_usage "\n\n" \
Bernhard Reutner-Fischer55fb9da2008-05-27 12:42:39 +0000742 "Relay dhcp requests from client devices to server device.\n" \
743 "Pass clients as CSV"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000744
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000745#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000746 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000747#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000748 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000749 "This implementation supports unified diffs only.\n" \
750 "\nOptions:" \
751 "\n -a Treat all files as text" \
752 "\n -b Ignore changes in the amount of whitespace" \
753 "\n -d Try hard to find a smaller set of changes" \
754 "\n -i Ignore case differences" \
755 "\n -L Use LABEL instead of the filename in the unified header" \
756 "\n -N Treat absent files as empty" \
757 "\n -q Output only whether files differ" \
758 "\n -r Recursively compare subdirectories" \
759 "\n -S Start with FILE when comparing directories" \
760 "\n -T Make tabs line up by prefixing a tab when necessary" \
761 "\n -s Report when two files are the same" \
762 "\n -t Expand tabs to spaces in output" \
763 "\n -U Output LINES lines of context" \
764 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000765
Eric Andersen7e9276b2001-02-22 01:15:47 +0000766#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000767 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000768#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000769 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000770#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000771 "$ dirname /tmp/foo\n" \
772 "/tmp\n" \
773 "$ dirname /tmp/foo/\n" \
774 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000775
Eric Andersen7e9276b2001-02-22 01:15:47 +0000776#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000777 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000778#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000779 "Print or control the kernel ring buffer\n" \
780 "\nOptions:" \
781 "\n -c Clear ring buffer after printing" \
782 "\n -n LEVEL Set console logging level" \
783 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000784
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000785#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000786 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000787#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000788 "Small static DNS server daemon\n" \
789 "\nOptions:" \
790 "\n -c Config filename" \
791 "\n -t TTL in seconds" \
792 "\n -p Listening port" \
793 "\n -i Listening ip (default all)" \
794 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000795
Eric Andersen7e9276b2001-02-22 01:15:47 +0000796#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000797 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000798#define dos2unix_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000799 "Convert FILE from dos to unix format.\n" \
800 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000801 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000802 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000803 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000804
Eric Andersen7e9276b2001-02-22 01:15:47 +0000805#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000806 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000807#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000808 "Install, remove and manage Debian packages\n" \
809 "\nOptions:" \
810 "\n -i Install the package" \
811 "\n -l List of installed packages" \
812 "\n -C Configure an unpackaged package" \
813 "\n -F depends Ignore dependency problems" \
814 "\n -P Purge all files of a package" \
815 "\n -r Remove all but the configuration files for a package" \
816 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000817
Eric Andersen7e9276b2001-02-22 01:15:47 +0000818#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000819 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000820#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000821 "Perform actions on Debian packages (.debs)\n" \
822 "\nOptions:" \
823 "\n -c List contents of filesystem tree" \
824 "\n -e Extract control files to [argument] directory" \
825 "\n -f Display control field name starting with [argument]" \
826 "\n -x Extract packages filesystem tree to directory" \
827 "\n -X Verbose extract" \
828
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000829#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000830 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000831
Eric Andersen7e9276b2001-02-22 01:15:47 +0000832#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000833 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000834#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000835 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000836 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000837 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
838 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000839 " bytes.\n" \
840 "\nOptions:" \
841 "\n -a Show file sizes too" \
842 "\n -H Follow symlinks on command line" \
843 "\n -L Follow all symlinks" \
844 "\n -d N Limit output to directories (and files with -a) of depth < N" \
845 "\n -c Show grand total" \
846 "\n -l Count sizes many times if hard linked" \
847 "\n -s Display only a total for each argument" \
848 "\n -x Skip directories on different filesystems" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000849 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000850 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
851 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000852 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000853 "\n -k Sizes in kilobytes" \
854 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
855
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000856#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000857 "$ du\n" \
858 "16 ./CVS\n" \
859 "12 ./kernel-patches/CVS\n" \
860 "80 ./kernel-patches\n" \
861 "12 ./tests/CVS\n" \
862 "36 ./tests\n" \
863 "12 ./scripts/CVS\n" \
864 "16 ./scripts\n" \
865 "12 ./docs/CVS\n" \
866 "104 ./docs\n" \
867 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000868
Eric Andersen7e9276b2001-02-22 01:15:47 +0000869#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000870 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000871#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000872 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000873#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000874 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000875
Russ Dill61fb4892002-10-14 21:41:28 +0000876#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000877 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000878#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000879 "Display DHCP leases granted by udhcpd\n" \
880 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000881 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000882 "\n -f,--file=FILE Leases file to load" \
883 "\n -r,--remaining Interpret lease times as time remaining" \
884 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000885 ) \
886 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000887 "\n -f FILE Leases file to load" \
888 "\n -r Interpret lease times as time remaining" \
889 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000890 )
Russ Dill61fb4892002-10-14 21:41:28 +0000891
Mike Frysinger51a43b42005-09-24 07:11:16 +0000892#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000893 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
894 "[-I inode_buffer_blocks] [-P process_inode_size] " \
895 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
896 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000897#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000898 "Check ext2/ext3 file system\n" \
899 "\nOptions:" \
900 "\n -p Automatic repair (no questions)" \
901 "\n -n Make no changes to the filesystem" \
902 "\n -y Assume 'yes' to all questions" \
903 "\n -c Check for bad blocks and add them to the badblock list" \
904 "\n -f Force checking even if filesystem is marked clean" \
905 "\n -v Verbose" \
906 "\n -b superblock Use alternative superblock" \
907 "\n -B blocksize Force blocksize when looking for superblock" \
908 "\n -j journal Set location of the external journal" \
909 "\n -l file Add to badblocks list" \
910 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000911
Eric Andersen7e9276b2001-02-22 01:15:47 +0000912#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000913 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000914#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000915 "Print the specified ARGs to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000916 USE_FEATURE_FANCY_ECHO( "\n" \
917 "\nOptions:" \
918 "\n -n Suppress trailing newline" \
919 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
920 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000921 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000922#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000923 "$ echo \"Erik is cool\"\n" \
924 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000925 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000926 "Erik\n" \
927 "is\n" \
928 "cool\n" \
929 "$ echo \"Erik\\nis\\ncool\"\n" \
930 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000931
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000932#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000933 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000934#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000935 "Eject specified DEVICE (or default /dev/cdrom)\n" \
936 "\nOptions:" \
937 USE_FEATURE_EJECT_SCSI( \
938 "\n -s SCSI device" \
939 ) \
940 "\n -t Close tray" \
941 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000942
Rob Landley3b890392006-05-04 20:56:43 +0000943#define ed_trivial_usage ""
944#define ed_full_usage ""
945
Eric Andersen84e229c2001-03-29 22:48:33 +0000946#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000947 "[-iu] [-] [name=value]... [command]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000948#define env_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000949 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000950 "up the specified environment\n" \
951 "\nOptions:" \
952 "\n -, -i Start with an empty environment" \
953 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +0000954
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000955#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000956 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000957#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000958 "Send a magic packet to wake up sleeping machines.\n" \
959 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000960 "a hostname with a known 'ethers' entry.\n" \
961 "\nOptions:" \
962 "\n -b Send wake-up packet to the broadcast address" \
963 "\n -i iface Interface to use (default eth0)" \
964 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000965
Denis Vlasenko3952f202007-08-13 14:10:24 +0000966#define expand_trivial_usage \
967 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000968#define expand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000969 "Convert tabs to spaces, writing to standard output.\n" \
970 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000971 USE_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000972 "\n -i,--initial Do not convert tabs after non blanks" \
973 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000974 ) \
975 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000976 "\n -i Do not convert tabs after non blanks" \
977 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000978 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000979
Eric Andersen7e9276b2001-02-22 01:15:47 +0000980#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000981 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000982#define expr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000983 "Print the value of EXPRESSION to standard output.\n" \
984 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000985 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000986 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
987 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
988 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
989 " ARG1 <= ARG2\n" \
990 " ARG1 = ARG2\n" \
991 " ARG1 != ARG2\n" \
992 " ARG1 >= ARG2\n" \
993 " ARG1 > ARG2\n" \
994 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
995 " ARG1 - ARG2\n" \
996 " ARG1 * ARG2\n" \
997 " ARG1 / ARG2\n" \
998 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000999 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1000 " match STRING REGEXP Same as STRING : REGEXP\n" \
1001 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1002 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1003 " length STRING Length of STRING\n" \
1004 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001005 " it is a keyword like 'match' or an\n" \
1006 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001007 " (EXPRESSION) Value of EXPRESSION\n" \
1008 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001009 "Beware that many operators need to be escaped or quoted for shells.\n" \
1010 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001011 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001012 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1013 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001014
Mike Frysingerfa69f112005-04-17 07:24:19 +00001015#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001016 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001017#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001018 "Provide fake ident (auth) service\n" \
1019 "\nOptions:" \
1020 "\n -f Run in foreground" \
1021 "\n -i Inetd mode" \
1022 "\n -w Inetd 'wait' mode" \
1023 "\n -b ADDR Bind to specified address" \
1024 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001025
Eric Andersen7e9276b2001-02-22 01:15:47 +00001026#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001027 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001028#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001029 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001030
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001031#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001032 "$ false\n" \
1033 "$ echo $?\n" \
1034 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001035
1036#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001037 "[options] [mode]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001038#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001039 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001040
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001041#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001042 "$ fbset\n" \
1043 "mode \"1024x768-76\"\n" \
1044 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1045 " geometry 1024 768 1024 768 16\n" \
1046 " timings 12714 128 32 16 4 128 4\n" \
1047 " accel false\n" \
1048 " rgba 5/11,6/5,5/0,0/0\n" \
1049 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001050
Eric Andersen7e9276b2001-02-22 01:15:47 +00001051#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001052 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001053#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001054 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001055
Eric Andersen01c3d402003-07-05 07:51:31 +00001056#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001057 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001058#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001059 "Format floppy disk\n" \
1060 "\nOptions:" \
1061 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001062
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001063/* Looks like someone forgot to add this to config system */
1064#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1065# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1066# define USE_FEATURE_FDISK_BLKSIZE(a)
1067#endif
1068
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001069#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001070 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1071 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001072#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001073 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001074 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001075 "\n -u Start and End are in sectors (instead of cylinders)" \
1076 "\n -l Show partition table for each DISK, then exit" \
1077 USE_FEATURE_FDISK_BLKSIZE( \
1078 "\n -s Show partition sizes in kb for each DISK, then exit" \
1079 ) \
1080 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1081 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1082 "\n -H HEADS\n" \
1083 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001084
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001085#define fetchmail_trivial_usage \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00001086 "[-w timeout] [-H [user:pass@]server[:port]] [-S] [-t] [-z] maildir [prog]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001087#define fetchmail_full_usage "\n\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00001088 "Fetch content of remote mailbox to local maildir\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001089 "\nOptions:" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00001090 "\n -w timeout Network timeout" \
1091 "\n -H [user:pass@]server[:port] Server" \
1092 "\n -S Use openssl connection helper for secure servers" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001093 "\n -t Get only headers" \
1094 "\n -z Delete messages on server" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00001095 "\n prog Run 'prog <message_file>' on message delivery" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001096
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001097#define findfs_trivial_usage \
1098 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001099#define findfs_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001100 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001101#define findfs_example_usage \
1102 "$ findfs LABEL=MyDevice"
1103
Eric Andersen7e9276b2001-02-22 01:15:47 +00001104#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001105 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001106#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001107 "Search for files. The default PATH is the current directory,\n" \
1108 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001109 "\nEXPRESSION may consist of:" \
1110 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001111 USE_FEATURE_FIND_XDEV( \
1112 "\n -xdev Don't descend directories on other filesystems") \
1113 USE_FEATURE_FIND_MAXDEPTH( \
1114 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1115 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001116 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001117 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001118 USE_FEATURE_FIND_PATH( \
1119 "\n -path PATTERN Path matches PATTERN") \
1120 USE_FEATURE_FIND_REGEX( \
1121 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001122 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001123 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001124 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001125 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001126 "\n or exactly (NNN)") \
1127 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001128 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001129 "\n or exactly (N) days") \
1130 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001131 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001132 "\n or exactly (N) minutes") \
1133 USE_FEATURE_FIND_NEWER( \
1134 "\n -newer FILE Modified time is more recent than FILE's") \
1135 USE_FEATURE_FIND_INUM( \
1136 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001137 USE_FEATURE_FIND_USER( \
1138 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1139 USE_FEATURE_FIND_GROUP( \
1140 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1141 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001142 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001143 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001144 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1145 "\n +/-N: file size is bigger/smaller than N") \
1146 "\n -print Print (default and assumed)" \
1147 USE_FEATURE_FIND_PRINT0( \
1148 "\n -print0 Delimit output with null characters rather than" \
1149 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001150 USE_FEATURE_FIND_CONTEXT ( \
1151 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001152 USE_FEATURE_FIND_EXEC( \
1153 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1154 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001155 USE_FEATURE_FIND_PRUNE( \
1156 "\n -prune Stop traversing current subtree") \
1157 USE_FEATURE_FIND_DELETE( \
1158 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001159 USE_FEATURE_FIND_PAREN( \
1160 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001161
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001162#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001163 "$ find / -name passwd\n" \
1164 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001165
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001166#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001167 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001168#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001169 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001170 "standard output\n" \
1171 "\nOptions:" \
1172 "\n -b Count bytes rather than columns" \
1173 "\n -s Break at spaces" \
1174 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001175
Eric Andersen7e9276b2001-02-22 01:15:47 +00001176#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001177 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001178#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001179 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001180#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001181 "$ free\n" \
1182 " total used free shared buffers\n" \
1183 " Mem: 257628 248724 8904 59644 93124\n" \
1184 " Swap: 128516 8404 120112\n" \
1185 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001186
Eric Andersen7e9276b2001-02-22 01:15:47 +00001187#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001188 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001189#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001190 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001191#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001192 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001193
Mike Frysinger51a43b42005-09-24 07:11:16 +00001194#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001195 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001196#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001197 "Check and repair filesystems\n" \
1198 "\nOptions:" \
1199 "\n -A Walk /etc/fstab and check all filesystems" \
1200 "\n -N Don't execute, just show what would be done" \
1201 "\n -P With -A, check filesystems in parallel" \
1202 "\n -R With -A, skip the root filesystem" \
1203 "\n -T Don't show title on startup" \
1204 "\n -V Verbose" \
1205 "\n -C n Write status information to specified filedescriptor" \
1206 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001207
Eric Andersen7e9276b2001-02-22 01:15:47 +00001208#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001209 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001210#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001211 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001212 "\nOptions:" \
1213 "\n -l List all filenames" \
1214 "\n -r Perform interactive repairs" \
1215 "\n -a Perform automatic repairs" \
1216 "\n -v Verbose" \
Bernhard Reutner-Fischere1e51742008-07-21 13:33:22 +00001217 "\n -s Output superblock information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001218 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001219 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001220
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001221#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001222 "[options] remote-host local-file remote-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001223#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001224 "Retrieve a remote file via FTP\n" \
1225 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001226 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001227 "\n -c,--continue Continue previous transfer" \
1228 "\n -v,--verbose Verbose" \
1229 "\n -u,--username Username" \
1230 "\n -p,--password Password" \
1231 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001232 ) \
1233 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001234 "\n -c Continue previous transfer" \
1235 "\n -v Verbose" \
1236 "\n -u Username" \
1237 "\n -p Password" \
1238 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001239 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001240
1241#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001242 "[options] remote-host remote-file local-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001243#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001244 "Store a local file on a remote machine via FTP\n" \
1245 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001246 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001247 "\n -v,--verbose Verbose" \
1248 "\n -u,--username Username" \
1249 "\n -p,--password Password" \
1250 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001251 ) \
1252 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001253 "\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
Rob Landleyaa872762005-10-28 13:05:12 +00001259#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001260 "[options] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001261#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001262 "Find processes which use FILEs or PORTs\n" \
1263 "\nOptions:" \
1264 "\n -m Find processes which use same fs as FILEs" \
1265 "\n -4 Search only IPv4 space" \
1266 "\n -6 Search only IPv6 space" \
1267 "\n -s Silent: just exit with 0 if any processes are found" \
1268 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001269 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001270
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001271#define getenforce_trivial_usage NOUSAGE_STR
1272#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001273
Eric Andersen7e9276b2001-02-22 01:15:47 +00001274#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001275 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001276#define getopt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001277 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001278 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001279 "\n -a,--alternative Allow long options starting with single -" \
1280 "\n -l,--longoptions=longopts Long options to be recognized" \
1281 "\n -n,--name=progname The name under which errors are reported" \
1282 "\n -o,--options=optstring Short options to be recognized" \
1283 "\n -q,--quiet Disable error reporting by getopt(3)" \
1284 "\n -Q,--quiet-output No normal output" \
1285 "\n -s,--shell=shell Set shell quoting conventions" \
1286 "\n -T,--test Test for getopt(1) version" \
1287 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001288 ) \
1289 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001290 "\n -a Allow long options starting with single -" \
1291 "\n -l longopts Long options to be recognized" \
1292 "\n -n progname The name under which errors are reported" \
1293 "\n -o optstring Short options to be recognized" \
1294 "\n -q Disable error reporting by getopt(3)" \
1295 "\n -Q No normal output" \
1296 "\n -s shell Set shell quoting conventions" \
1297 "\n -T Test for getopt(1) version" \
1298 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001299 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001300#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001301 "$ cat getopt.test\n" \
1302 "#!/bin/sh\n" \
1303 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1304 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001305 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001306 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001307 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001308 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001309 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1310 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001311 " -c|--c-long)\n" \
1312 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001313 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1314 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1315 " esac;;\n" \
1316 " --) shift; break;;\n" \
1317 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001318 " esac\n" \
1319 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001320
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001321#define getsebool_trivial_usage \
1322 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001323#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001324 " -a Show all SELinux booleans"
1325
Eric Andersenf349e972001-08-21 16:18:59 +00001326#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001327 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001328#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001329 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1330 "\nOptions:" \
1331 "\n -h Enable hardware (RTS/CTS) flow control" \
1332 "\n -i Do not display /etc/issue before running login" \
1333 "\n -L Local line, do not do carrier detect" \
1334 "\n -m Get baud rate from modem's CONNECT status message" \
1335 "\n -w Wait for a CR or LF before sending /etc/issue" \
1336 "\n -n Do not prompt the user for a login name" \
1337 "\n -f issue_file Display issue_file instead of /etc/issue" \
1338 "\n -l login_app Invoke login_app instead of /bin/login" \
1339 "\n -t timeout Terminate after timeout if no username is read" \
1340 "\n -I initstring Init string to send before anything else" \
1341 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001342
Eric Andersen7e9276b2001-02-22 01:15:47 +00001343#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001344 "[-HhrilLnqvso" \
1345 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001346 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001347 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1348 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001349 "] PATTERN [FILEs...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001350#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001351 "Search for PATTERN in each FILE or standard input\n" \
1352 "\nOptions:" \
1353 "\n -H Prefix output lines with filename where match was found" \
1354 "\n -h Suppress the prefixing filename on output" \
1355 "\n -r Recurse subdirectories" \
1356 "\n -i Ignore case distinctions" \
1357 "\n -l List names of files that match" \
1358 "\n -L List names of files that do not match" \
1359 "\n -n Print line number with output lines" \
1360 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1361 "\n -v Select non-matching lines" \
1362 "\n -s Suppress file open/read error messages" \
1363 "\n -c Only print count of matching lines" \
1364 "\n -o Show only the part of a line that matches PATTERN" \
1365 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001366 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001367 "\n -w Match whole words only") \
1368 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001369 USE_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001370 "\n -E PATTERN is an extended regular expression") \
1371 "\n -e PTRN Pattern to match" \
1372 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001373 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001374 "\n -A Print NUM lines of trailing context" \
1375 "\n -B Print NUM lines of leading context" \
1376 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001377
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001378#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001379 "$ grep root /etc/passwd\n" \
1380 "root:x:0:0:root:/root:/bin/bash\n" \
1381 "$ grep ^[rR]oo. /etc/passwd\n" \
1382 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001383
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001384#define egrep_trivial_usage NOUSAGE_STR
1385#define egrep_full_usage ""
1386
1387#define fgrep_trivial_usage NOUSAGE_STR
1388#define fgrep_full_usage ""
1389
Eric Andersen7e9276b2001-02-22 01:15:47 +00001390#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001391 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001392#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001393 "Uncompress FILEs (or standard input)\n" \
1394 "\nOptions:" \
1395 "\n -c Write to standard output" \
1396 "\n -f Force" \
1397 "\n -t Test file integrity" \
1398
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001399#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001400 "$ ls -la /tmp/BusyBox*\n" \
1401 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1402 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1403 "$ ls -la /tmp/BusyBox*\n" \
1404 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405
1406#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001407 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001408#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001409 "Compress FILEs (or standard input)\n" \
1410 "\nOptions:" \
1411 "\n -c Write to standard output" \
1412 "\n -d Decompress" \
1413 "\n -f Force" \
1414
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001415#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001416 "$ ls -la /tmp/busybox*\n" \
1417 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1418 "$ gzip /tmp/busybox.tar\n" \
1419 "$ ls -la /tmp/busybox*\n" \
1420 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001421
1422#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001423 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001424#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001425 "Halt the system\n" \
1426 "\nOptions:" \
1427 "\n -d Delay interval for halting" \
1428 "\n -n No call to sync()" \
1429 "\n -f Force halt (don't go through init)" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001430 USE_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001431 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001432 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001433
Eric Andersen3443bd72003-07-22 07:30:36 +00001434#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001435 "[options] [device] .."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001436#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001437 "Options:" \
1438 "\n -a Get/set fs readahead" \
1439 "\n -A Set drive read-lookahead flag (0/1)" \
1440 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1441 "\n -B Set Advanced Power Management setting (1-255)" \
1442 "\n -c Get/set IDE 32-bit IO setting" \
1443 "\n -C Check IDE power mode status" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001444 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001445 "\n -d Get/set using_dma flag") \
1446 "\n -D Enable/disable drive defect-mgmt" \
1447 "\n -f Flush buffer cache for device on exit" \
1448 "\n -g Display drive geometry" \
1449 "\n -h Display terse usage information" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001450 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001451 "\n -i Display drive identification") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001452 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001453 "\n -I Detailed/current information directly from drive") \
1454 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1455 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1456 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1457 "\n -m Get/set multiple sector count" \
1458 "\n -n Get/set ignore-write-errors flag (0/1)" \
1459 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1460 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001461/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001462 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1463 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001464 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001465 "\n -R Register an IDE interface (DANGEROUS)") \
1466 "\n -S Set standby (spindown) timeout" \
1467 "\n -t Perform device read timings" \
1468 "\n -T Perform cache read timings" \
1469 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001470 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001471 "\n -U Un-register an IDE interface (DANGEROUS)") \
1472 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1473 "\n -V Display program version and exit immediately" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001474 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001475 "\n -w Perform device reset (DANGEROUS)") \
1476 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001477 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001478 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1479 "\n -X Set IDE xfer mode (DANGEROUS)" \
1480 "\n -y Put IDE drive in standby mode" \
1481 "\n -Y Put IDE drive to sleep" \
1482 "\n -Z Disable Seagate auto-powersaving mode" \
1483 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001484
Eric Andersen7e9276b2001-02-22 01:15:47 +00001485#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001486 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001487#define head_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001488 "Print first 10 lines of each FILE to standard output.\n" \
1489 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001490 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1491 "\nOptions:" \
1492 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001493 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001494 "\n -c NUM Output the first NUM bytes" \
1495 "\n -q Never output headers giving file names" \
1496 "\n -v Always output headers giving file names") \
1497
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001498#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001499 "$ head -n 2 /etc/passwd\n" \
1500 "root:x:0:0:root:/root:/bin/bash\n" \
1501 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001502
Glenn L McGrath60281112001-11-02 11:39:46 +00001503#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001504 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001505#define hexdump_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001506 "Display file(s) or standard input in a user specified format\n" \
1507 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001508 "\n -b One-byte octal display" \
1509 "\n -c One-byte character display" \
1510 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1511 "\n -d Two-byte decimal display" \
1512 "\n -e FORMAT STRING" \
1513 "\n -f FORMAT FILE" \
1514 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1515 "\n -o Two-byte octal display" \
1516 "\n -s OFFSET Skip OFFSET bytes" \
1517 "\n -v Display all input data" \
1518 "\n -x Two-byte hexadecimal display" \
1519 USE_FEATURE_HEXDUMP_REVERSE( \
1520 "\n -R Reverse of 'hexdump -Cv'") \
1521
1522#define hd_trivial_usage \
1523 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001524#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001525 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001526
Eric Andersen7e9276b2001-02-22 01:15:47 +00001527#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001528 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001529#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001530 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001531
1532#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001533 "[OPTION] [hostname | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001534#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001535 "Get or set hostname or DNS domain name\n" \
1536 "\nOptions:" \
1537 "\n -s Short" \
1538 "\n -i Addresses for the hostname" \
1539 "\n -d DNS domain name" \
1540 "\n -f Fully qualified domain name" \
1541 "\n -F FILE Use the contents of FILE to specify the hostname" \
1542
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001543#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001544 "$ hostname\n" \
1545 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001546
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001547#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001548 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001549 " [-p [ip:]port]" \
1550 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001551 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001552 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001553 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001554 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001555 " [-d/-e string]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001556#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001557 "Listen for incoming HTTP requests\n" \
1558 "\nOptions:" \
1559 "\n -c FILE Configuration file (default httpd.conf)" \
1560 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1561 "\n -i Inetd mode" \
1562 "\n -f Do not daemonize" \
1563 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001564 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001565 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001566 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001567 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001568 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001569 "\n -m PASS Crypt PASS with md5 algorithm") \
1570 "\n -h HOME Home directory (default .)" \
1571 "\n -e STRING HTML encode STRING" \
1572 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001573
Robert Griebl1cd04452002-07-21 16:50:49 +00001574#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001575 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001576 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1577 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001578 " [-f FILE]" \
1579 ) \
1580 SKIP_GETOPT_LONG( \
1581 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1582 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001583#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001584 "Query and set hardware clock (RTC)\n" \
1585 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001586 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001587 "\n -s Set system time from hardware clock" \
1588 "\n -w Set hardware clock to system time" \
1589 "\n -u Hardware clock is in UTC" \
1590 "\n -l Hardware clock is in local time" \
1591 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001592
Eric Andersen7e9276b2001-02-22 01:15:47 +00001593#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001594 "[OPTIONS]... [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001595#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001596 "Print information about USER or the current user\n" \
1597 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001598 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001599 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001600 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001601 "\n -g Print group ID" \
1602 "\n -u Print user ID" \
1603 "\n -n Print name instead of a number" \
1604 "\n -r Print real user ID instead of effective ID" \
1605
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001606#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001607 "$ id\n" \
1608 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001609
Eric Andersen7e9276b2001-02-22 01:15:47 +00001610#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001611 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001612#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001613 "Configure a network interface\n" \
1614 "\nOptions:" \
1615 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001616 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001617 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001618 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001619 " [del ADDRESS[/PREFIXLEN]]\n") \
1620 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1621 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001622 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001623 " [outfill NN] [keepalive NN]\n") \
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001624 " " USE_FEATURE_IFCONFIG_HW("[hw ether" USE_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001625 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001626 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001627 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001628 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001629 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001630
Denis Vlasenko06aed432008-02-26 18:25:24 +00001631#define ifenslave_trivial_usage \
1632 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001633#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001634 "Configure network interfaces for parallel routing\n" \
1635 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001636 "\n -c, --change-active Change active slave" \
1637 "\n -d, --detach Remove slave interface from bonding device" \
1638 "\n -f, --force Force, even if interface is not Ethernet" \
1639/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001640
Denis Vlasenko06aed432008-02-26 18:25:24 +00001641#define ifenslave_example_usage \
1642 "To create a bond device, simply follow these three steps :\n" \
1643 "- ensure that the required drivers are properly loaded :\n" \
1644 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1645 "- assign an IP address to the bond device :\n" \
1646 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1647 "- attach all the interfaces you need to the bond device :\n" \
1648 " # ifenslave bond0 eth0 eth1 eth2\n" \
1649 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1650 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1651 " To detach a dead interface without setting the bond device down :\n" \
1652 " # ifenslave -d bond0 eth1\n\n" \
1653 " To set the bond device down and automatically release all the slaves :\n" \
1654 " # ifconfig bond0 down\n\n" \
1655 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001656 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001657
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001658#define ifup_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001659 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001660#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001661 "Options:" \
1662 "\n -a De/configure all interfaces automatically" \
1663 "\n -i FILE Use FILE for interface definitions" \
1664 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001665 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001666 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001667 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001668 ) \
1669 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001670 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001671
1672#define ifdown_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001673 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001674#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001675 "Options:" \
1676 "\n -a De/configure all interfaces automatically" \
1677 "\n -i FILE Use FILE for interface definitions" \
1678 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001679 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001680 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001681 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001682 ) \
1683 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001684 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001685
Glenn L McGrath06e95652003-02-09 06:51:14 +00001686#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001687 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001688#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001689 "Listen for network connections and launch programs\n" \
1690 "\nOptions:" \
1691 "\n -f Run in foreground" \
1692 "\n -e Log to stderr" \
1693 "\n -q N Socket listen queue (default: 128)" \
1694 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001695 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001696
Eric Andersen7e9276b2001-02-22 01:15:47 +00001697#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001698 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001699#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001700 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001701
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001702#define init_notes_usage \
1703"This version of init is designed to be run only by the kernel.\n" \
1704"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001705"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001706"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001707"runlevels, use sysvinit.\n" \
1708"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001709"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001710"it has the following default behavior:\n" \
1711"\n" \
1712" ::sysinit:/etc/init.d/rcS\n" \
1713" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001714" ::ctrlaltdel:/sbin/reboot\n" \
1715" ::shutdown:/sbin/swapoff -a\n" \
1716" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001717" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001718"\n" \
1719"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1720"\n" \
1721" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001722" tty3::askfirst:/bin/sh\n" \
1723" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001724"\n" \
1725"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1726"\n" \
1727" <id>:<runlevels>:<action>:<process>\n" \
1728"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001729" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001730"\n" \
1731" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1732" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001733" the specified process to run on. The contents of this field are\n" \
1734" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1735" be unique, although if it isn't you may have strange results. If this\n" \
1736" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001737" note that if BusyBox detects that a serial console is in use, then only\n" \
1738" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001739" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001740" stinkin' utmp.\n" \
1741"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001742" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001743"\n" \
1744" The runlevels field is completely ignored.\n" \
1745"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001746" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001747"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001748" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001749" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001750"\n" \
1751" The available actions can be classified into two groups: actions\n" \
1752" that are run only once, and actions that are re-run when the specified\n" \
1753" process exits.\n" \
1754"\n" \
1755" Run only-once actions:\n" \
1756"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001757" 'sysinit' is the first item run on boot. init waits until all\n" \
1758" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001759" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001760" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001761" the specified task completes. 'once' actions are asynchronous,\n" \
1762" therefore, init does not wait for them to complete. 'restart' is\n" \
1763" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001764" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001765" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001766" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001767" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001768" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001769" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001770" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001771" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001772"\n" \
1773" Run repeatedly actions:\n" \
1774"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001775" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001776" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001777" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1778" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001779" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001780" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001781" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001782" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001783"\n" \
1784" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001785" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001786" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001787"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001788" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001789"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001790" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001791"\n" \
1792"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001793"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001794" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001795" #\n" \
1796" ::sysinit:/etc/init.d/rcS\n" \
1797" \n" \
1798" # /bin/sh invocations on selected ttys\n" \
1799" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001800" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001801" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001802" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001803" tty2::askfirst:-/bin/sh\n" \
1804" tty3::askfirst:-/bin/sh\n" \
1805" tty4::askfirst:-/bin/sh\n" \
1806" \n" \
1807" # /sbin/getty invocations for selected ttys\n" \
1808" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001809" tty4::respawn:/sbin/getty 38400 tty4\n" \
1810" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001811" \n" \
1812" \n" \
1813" # Example of how to put a getty on a serial line (for a terminal)\n" \
1814" #\n" \
1815" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1816" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1817" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001818" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001819" #::respawn:/sbin/getty 57600 ttyS2\n" \
1820" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001821" # Stuff to do when restarting the init process\n" \
1822" ::restart:/sbin/init\n" \
1823" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001824" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001825" ::ctrlaltdel:/sbin/reboot\n" \
1826" ::shutdown:/bin/umount -a -r\n" \
1827" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001828
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001829#define inotifyd_trivial_usage \
1830 "/user/space/agent dir/or/file/being/watched[:mask] ..."
1831#define inotifyd_full_usage "\n\n" \
1832 "Spawn userspace agent on filesystem changes." \
1833 "\nWhen a filesystem event matching the mask occurs" \
1834 "\non specified file/directory an userspace agent is spawned" \
1835 "\nwith the parameters:" \
1836 "\n1. actual event(s)" \
1837 "\n2. file/directory name" \
1838 "\n3. name of subfile (if any), in case of watching a directory" \
1839 "\n" \
1840 "\n a File is accessed" \
1841 "\n c File is modified" \
1842 "\n e Metadata changed" \
1843 "\n w Writtable file is closed" \
1844 "\n 0 Unwrittable file is closed" \
1845 "\n r File is opened" \
1846 "\n m File is moved from X" \
1847 "\n y File is moved to Y" \
1848 "\n n Subfile is created" \
1849 "\n d Subfile is deleted" \
1850 "\n D Self is deleted" \
1851 "\n M Self is moved" \
1852
Eric Andersen7e9276b2001-02-22 01:15:47 +00001853#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001854 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001855#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001856 "Load the specified kernel modules into the kernel" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001857 USE_FEATURE_2_4_MODULES( "\n" \
1858 "\nOptions:" \
1859 "\n -f Force module to load into the wrong kernel version" \
1860 "\n -k Make module autoclean-able" \
1861 "\n -v Verbose" \
1862 "\n -q Quiet" \
1863 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001864 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001865 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001866 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001867 "\n -o NAME Set internal module name to NAME" \
1868 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001869 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001870
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001871#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001872 "[-cgmops] [sources] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001873#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001874 "Copy files and set attributes\n" \
1875 "\nOptions:" \
1876 "\n -c Copy the file, default" \
1877 "\n -d Create directories" \
1878 "\n -g Set group ownership" \
1879 "\n -m Set permissions" \
1880 "\n -o Set ownership" \
1881 "\n -p Preserve date" \
1882 "\n -s Strip symbol tables" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001883 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001884 "\n -Z Set security context of copy" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001885 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001886
1887/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001888#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001889 "[OPTIONS] {" \
1890 USE_FEATURE_IP_ADDRESS("address | ") \
1891 USE_FEATURE_IP_ROUTE("route | ") \
1892 USE_FEATURE_IP_LINK("link | ") \
1893 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1894 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001895 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001896#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001897 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001898 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001899 USE_FEATURE_IP_ADDRESS("address | ") \
1900 USE_FEATURE_IP_ROUTE("route | ") \
1901 USE_FEATURE_IP_LINK("link | ") \
1902 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1903 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001904 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001905 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001906
1907#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001908 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001909 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001910#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001911 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001912 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1913 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001914 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001915 " [broadcast ADDR] [anycast ADDR]\n" \
1916 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001917 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001918
Eric Andersende4f07e2003-12-11 01:18:07 +00001919#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001920 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001921#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001922 "Calculate IP network settings from a IP address\n" \
1923 "\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001924 USE_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001925 "\n -b,--broadcast Display calculated broadcast address" \
1926 "\n -n,--network Display calculated network address" \
1927 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001928 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001929 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1930 "\n -h,--hostname Display first resolved host name" \
1931 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001932 ) \
1933 ) \
1934 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001935 "\n -b Display calculated broadcast address" \
1936 "\n -n Display calculated network address" \
1937 "\n -m Display default netmask for IP" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001938 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001939 "\n -p Display the prefix for IP/NETMASK" \
1940 "\n -h Display first resolved host name" \
1941 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001942 ) \
1943 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001944
Rob Landley6eb1e412005-06-20 04:30:36 +00001945#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001946 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001947#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001948 "Upper-case options MQS remove an object by shmkey value.\n" \
1949 "Lower-case options remove an object by shmid value.\n" \
1950 "\nOptions:" \
1951 "\n -mM Remove memory segment after last detach" \
1952 "\n -qQ Remove message queue" \
1953 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001954
1955#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001956 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001957#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001958 " -i Show specific resource" \
1959 "\nResource specification:" \
1960 "\n -m Shared memory segments" \
1961 "\n -q Message queues" \
1962 "\n -s Semaphore arrays" \
1963 "\n -a All (default)" \
1964 "\nOutput format:" \
1965 "\n -t Time" \
1966 "\n -c Creator" \
1967 "\n -p Pid" \
1968 "\n -l Limits" \
1969 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001970
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001971#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001972 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001973#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001974 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001975 " dynamic { on | off } |\n" \
1976 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001977 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001978
1979#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001980 "{ list | flush | { add | del | change | append |\n" \
1981 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001982#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001983 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001984 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1985 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001986 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001987 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001988 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001989
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001990#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001991 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001992#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001993 "iprule [list | add | del] SELECTOR ACTION\n" \
1994 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1995 " [dev STRING] [pref NUMBER]\n" \
1996 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1997 " [prohibit | reject | unreachable]\n" \
1998 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001999 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002000
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002001#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002002 "{ add | change | del | show } [NAME]\n" \
2003 " [mode { ipip | gre | sit }]\n" \
2004 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002005#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002006 "iptunnel { add | change | del | show } [NAME]\n" \
2007 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2008 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002009 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002010
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002011#define kbd_mode_trivial_usage \
2012 "[-a|k|s|u]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002013#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002014 "Report or set the keyboard mode\n" \
2015 "\nOptions set mode:" \
2016 "\n -a Default (ASCII)" \
2017 "\n -k Medium-raw (keyboard)" \
2018 "\n -s Raw (scancode)" \
2019 "\n -u Unicode (utf-8)" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002020
Eric Andersen7e9276b2001-02-22 01:15:47 +00002021#define kill_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002022 "[-l] [-signal] process-id..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002023#define kill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002024 "Send a signal (default is TERM) to the specified process(es)\n" \
2025 "\nOptions:" \
2026 "\n -l List all signal names and numbers" \
2027
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002028#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002029 "$ ps | grep apache\n" \
2030 "252 root root S [apache]\n" \
2031 "263 www-data www-data S [apache]\n" \
2032 "264 www-data www-data S [apache]\n" \
2033 "265 www-data www-data S [apache]\n" \
2034 "266 www-data www-data S [apache]\n" \
2035 "267 www-data www-data S [apache]\n" \
2036 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002037
2038#define killall_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002039 "[-l] [-q] [-signal] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002040#define killall_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002041 "Send a signal (default is TERM) to the specified process(es)\n" \
2042 "\nOptions:" \
2043 "\n -l List all signal names and numbers" \
2044 "\n -q Do not complain if no processes were killed" \
2045
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002046#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002047 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002048
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002049#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002050 "[-l] [-signal]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002051#define killall5_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002052 "Send a signal (default is TERM) to all processes outside current session\n" \
2053 "\nOptions:" \
2054 "\n -l List all signal names and numbers" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002055
Mark Whitley6317c4b2001-03-12 22:51:50 +00002056#define klogd_trivial_usage \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002057 "[-c N] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002058#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002059 "Kernel logger\n" \
2060 "\nOptions:" \
Denis Vlasenko7bdf0c82008-06-06 16:08:04 +00002061 "\n -c N Only messages with level < N are printed to console" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002062 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002063
Eric Andersen7e9276b2001-02-22 01:15:47 +00002064#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002065 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002066#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002067 "Print STRING's length"
2068
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002069#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002070 "$ length Hello\n" \
2071 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002072
Rob Landley9200e792005-09-15 19:26:59 +00002073#define less_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002074 "[-EMNmh~?] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002075#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002076 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002077 "changed, and files can be manipulated in various ways.\n" \
2078 "\nOptions:" \
2079 "\n -E Quit once the end of a file is reached" \
2080 "\n -M,-m Display a status line containing the line numbers" \
2081 "\n and percentage through the file" \
2082 "\n -N Prefix line numbers to each line" \
2083 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002084
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002085#define linux32_trivial_usage NOUSAGE_STR
2086#define linux32_full_usage ""
2087#define linux64_trivial_usage NOUSAGE_STR
2088#define linux64_full_usage ""
2089
2090#define linuxrc_trivial_usage NOUSAGE_STR
2091#define linuxrc_full_usage ""
2092
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002093#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002094 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002095#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002096 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002097 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002098 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002099
Eric Andersen7e9276b2001-02-22 01:15:47 +00002100#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002101 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002102#define ln_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002103 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002104 "Use '--' to indicate that all following arguments are non-options.\n" \
2105 "\nOptions:" \
2106 "\n -s Make symlinks instead of hardlinks" \
2107 "\n -f Remove existing destination files" \
2108 "\n -n Don't dereference symlinks - treat like normal file" \
2109 "\n -b Make a backup of the target (if exists) before link operation" \
2110 "\n -S suf Use suffix instead of ~ when making backup files" \
2111
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002112#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002113 "$ ln -s BusyBox /tmp/ls\n" \
2114 "$ ls -l /tmp/ls\n" \
2115 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002116
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002117#define load_policy_trivial_usage NOUSAGE_STR
Denis Vlasenkob042bd92007-09-26 18:01:32 +00002118
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002119#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002120
Eric Andersen7e9276b2001-02-22 01:15:47 +00002121#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002122 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002123#define loadfont_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002124 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002125#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002126 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002127
2128#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002129 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002130#define loadkmap_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002131 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002132#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002133 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002134
2135#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002136 "[OPTION]... [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002137#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002138 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2139 "\nOptions:" \
2140 "\n -s Log to stderr as well as the system log" \
2141 "\n -t TAG Log using the specified tag (defaults to user name)" \
2142 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002143
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002144#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002145 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002146
Robert Griebl1fca5582002-06-04 20:45:46 +00002147#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002148 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002149#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002150 "Begin a new session on the system\n" \
2151 "\nOptions:" \
2152 "\n -f Do not authenticate (user already authenticated)" \
2153 "\n -h Name of the remote host" \
2154 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002155
Eric Andersen7e9276b2001-02-22 01:15:47 +00002156#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002157 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002158#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002159 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002160#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002161 "$ logname\n" \
2162 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002163
Mark Whitley6317c4b2001-03-12 22:51:50 +00002164#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002165 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002166#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002167 "Show messages in syslogd's circular buffer\n" \
2168 "\nOptions:" \
2169 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002170
Matt Kraai83788da2002-03-20 17:38:37 +00002171#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002172 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2173 " losetup -d LOOPDEV - disassociate\n" \
2174 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002175#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002176 "Options:" \
2177 "\n -o OFS Start OFS bytes into FILE" \
2178 "\n -f Show first free loop device" \
2179
Rob Landley1d589b22005-11-29 23:47:10 +00002180#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002181 "No arguments will display all current associations.\n" \
2182 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002183 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002184 "and filename of the file the loop device is currently bound to.\n\n" \
2185 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002186 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2187 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002188
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002189#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002190 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002191#define lpd_full_usage "\n\n" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002192 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
2193 "\nwith names matching print queue names. In the first case, jobs are" \
Denis Vlasenko49a5eba2008-07-23 08:41:08 +00002194 "\nsent directly to the device. Otherwise each job is stored in queue" \
Denis Vlasenko040e32f2008-07-23 08:39:19 +00002195 "\ndirectory and HELPER program is called. Name of file to print" \
2196 "\nis passed in $DATAFILE variable." \
2197 "\nExample:" \
2198 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002199
Denis Vlasenko68444b92008-02-22 22:24:48 +00002200#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002201 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002202#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002203 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002204 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002205 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002206 "\n -f Force any waiting job to be printed" \
2207 "\n -s Short display" \
2208
2209#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002210 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2211/* -C CLASS exists too, not shown.
2212 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002213#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002214 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002215 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002216 "\n -m Send mail on completion" \
2217 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002218 "\n -V Verbose" \
2219
Eric Andersen7e9276b2001-02-22 01:15:47 +00002220#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002221 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002222 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002223 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2224 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2225 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2226 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2227 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2228 USE_SELINUX("K") "] [filenames...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002229#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002230 "List directory contents\n" \
2231 "\nOptions:" \
2232 "\n -1 List files in a single column" \
2233 "\n -A Do not list implied . and .." \
2234 "\n -a Do not hide entries starting with ." \
2235 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002236 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002237 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002238 USE_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002239 "\n --color[={always,never,auto}] Control coloring") \
2240 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002241 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002242 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002243 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002244 "\n -F Append indicator (one of */=@|) to entries") \
2245 "\n -i List the i-node for each file" \
2246 "\n -l Use a long listing format" \
2247 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002248 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002249 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002250 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002251 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002252 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002253 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002254 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002255 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002256 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002257 "\n -S Sort the listing by file size") \
2258 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002259 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002260 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002261 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002262 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002263 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002264 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002265 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002266 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002267 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002268 "\n -w NUM Assume the terminal is NUM columns wide") \
2269 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002270 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002271 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002272 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002273 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002274 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002275 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002276 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002277 "\n -K Print security context in long format") \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002278 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002279 "\n -Z Print security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002280
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002281#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002282 "[-Radlv] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002283#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002284 "List file attributes on an ext2 fs\n" \
2285 "\nOptions:" \
2286 "\n -R Recursively list subdirectories" \
2287 "\n -a Do not hide entries starting with ." \
2288 "\n -d List directory entries instead of contents" \
2289 "\n -l Print long flag names" \
2290 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002291
Eric Andersen7e9276b2001-02-22 01:15:47 +00002292#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002293 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002294#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002295 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002296
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002297#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002298#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002299 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002300#define makedevs_full_usage "\n\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002301 "Create a range of block or character special files" \
2302 "\n" \
2303 "\nTYPE is:" \
2304 "\n b Block device" \
2305 "\n c Character device" \
2306 "\n f FIFO, MAJOR and MINOR are ignored" \
2307 "\n" \
2308 "\nFIRST..LAST specify numbers appended to NAME." \
2309 "\nIf 's' is the last argument, the base device is created as well." \
2310 "\n" \
2311 "\nExamples:" \
2312 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
2313 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002314#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002315 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2316 "[creates ttyS2-ttyS63]\n" \
2317 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2318 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002319#endif
2320
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002321#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002322#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002323 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002324#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002325 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002326 "Device table entries take the form of:\n" \
2327 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002328 "Where name is the file name, type can be one of:\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002329 " f Regular file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002330 " d Directory\n" \
Denis Vlasenko9ef1a5d2008-08-01 02:15:51 +00002331 " c Character device\n" \
2332 " b Block device\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002333 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002334 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002335 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2336 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002337#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002338 "For example:\n" \
2339 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2340 "/dev d 755 0 0 - - - - -\n" \
2341 "/dev/console c 666 0 0 5 1 - - -\n" \
2342 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2343 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2344 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2345 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2346 "Will Produce:\n" \
2347 "/dev\n" \
2348 "/dev/console\n" \
2349 "/dev/null\n" \
2350 "/dev/zero\n" \
2351 "/dev/hda\n" \
2352 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002353#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002354
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002355#define man_trivial_usage \
2356 "[OPTION]... [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002357#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002358 "Format and display manual page\n" \
2359 "\nOptions:" \
2360 "\n -a Display all pages" \
2361 "\n -w Show page locations" \
2362
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002363#define matchpathcon_trivial_usage \
2364 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002365#define matchpathcon_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002366 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002367 "\n -N Do not use translations" \
2368 "\n -f Use alternate file_context file" \
2369 "\n -p Use prefix to speed translations" \
2370 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002371
Eric Andersen7e9276b2001-02-22 01:15:47 +00002372#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002373 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002374 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002375#define md5sum_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002376 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002377 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2378 "\nOptions:" \
2379 "\n -c Check MD5 sums against given list" \
2380 "\n -s Don't output anything, status code shows success" \
2381 "\n -w Warn about improperly formatted MD5 checksum lines") \
2382
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002383#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002384 "$ md5sum < busybox\n" \
2385 "6fd11e98b98a58f64ff3398d7b324003\n" \
2386 "$ md5sum busybox\n" \
2387 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2388 "$ md5sum -c -\n" \
2389 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2390 "busybox: OK\n" \
2391 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002392
Rob Landley70f7ef72005-12-13 08:21:33 +00002393#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002394 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002395#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002396 " -s Scan /sys and populate /dev during system boot\n" \
2397 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002398 "Called with no options (via hotplug) it uses environment variables\n" \
2399 "to determine which device to add/remove."
Denis Vlasenko397de612008-03-17 08:55:44 +00002400
Rob Landleyef10d522006-06-26 14:11:33 +00002401#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002402 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002403 "The mdev config file contains lines that look like:\n" \
2404 " hd[a-z][0-9]* 0:3 660\n\n" \
2405 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002406 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002407 "Optionally, that can be followed (on the same line) by a special character\n" \
2408 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002409 "device(s). The environment variable $MDEV indicates the active device node\n" \
2410 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002411 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2412 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002413 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002414 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002415 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002416 "Config file parsing stops on the first matching line. If no config\n" \
2417 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002418 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002419 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002420
Glenn L McGrath061c9002002-09-16 04:21:46 +00002421#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002422 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002423#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002424 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002425 " y Allow write access to your terminal\n" \
2426 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002427
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002428#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002429 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002430#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002431 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2432 "\nOptions:" \
2433 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2434 "\n next byte to it" \
2435 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2436 "\n -s Set serial line to SPEED" \
2437 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002438
Eric Andersen7e9276b2001-02-22 01:15:47 +00002439#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002440 "[OPTION] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002441#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002442 "Create DIRECTORY\n" \
2443 "\nOptions:" \
2444 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2445 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002446 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002447 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002448 )
2449
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002450#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002451 "$ mkdir /tmp/foo\n" \
2452 "$ mkdir /tmp/foo\n" \
2453 "/tmp/foo: File exists\n" \
2454 "$ mkdir /tmp/foo/bar/baz\n" \
2455 "/tmp/foo/bar/baz: No such file or directory\n" \
2456 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002457
Mike Frysinger6447ac02005-06-11 05:29:40 +00002458#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002459 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2460 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2461 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2462 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2463 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2464 "device [blocks-count]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002465#define mke2fs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002466 " -b size Block size in bytes" \
2467 "\n -c Check for bad blocks before creating" \
2468 "\n -E opts Set extended options" \
2469 "\n -f size Fragment size in bytes" \
2470 "\n -F Force (ignore sanity checks)" \
2471 "\n -g num Number of blocks in a block group" \
2472 "\n -i ratio The bytes/inode ratio" \
2473 "\n -j Create a journal (ext3)" \
2474 "\n -J opts Set journal options (size/device)" \
2475 "\n -l file Read bad blocks list from file" \
2476 "\n -L lbl Set the volume label" \
2477 "\n -m percent Percent of fs blocks to reserve for admin" \
2478 "\n -M dir Set last mounted directory" \
2479 "\n -n Do not actually create anything" \
2480 "\n -N num Number of inodes to create" \
2481 "\n -o os Set the 'creator os' field" \
2482 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2483 "\n -q Quiet" \
2484 "\n -r rev Set filesystem revision" \
2485 "\n -S Write superblock and group descriptors only" \
2486 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2487 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002488
Eric Andersen7e9276b2001-02-22 01:15:47 +00002489#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002490 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002491#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002492 "Create named pipe (identical to 'mknod name p')\n" \
2493 "\nOptions:" \
2494 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002495 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002496 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002497 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002498
Eric Andersen7e9276b2001-02-22 01:15:47 +00002499#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002500 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002501#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002502 "Make a MINIX filesystem\n" \
2503 "\nOptions:" \
2504 "\n -c Check device for bad blocks" \
2505 "\n -n [14|30] Maximum length of filenames" \
2506 "\n -i INODES Number of inodes for the filesystem" \
2507 "\n -l FILENAME Read bad blocks list from FILENAME" \
2508 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002509
Eric Andersen7e9276b2001-02-22 01:15:47 +00002510#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002511 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002512#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002513 "Create a special file (block, character, or pipe)\n" \
2514 "\nOptions:" \
2515 "\n -m Create the special file using the specified mode (default a=rw)" \
2516 "\nTYPEs include:" \
2517 "\n b: Make a block device" \
2518 "\n c or u: Make a character device" \
2519 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002520 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002521 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002522 )
2523
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002524#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002525 "$ mknod /dev/fd0 b 2 0\n" \
2526 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002527
Eric Andersen7e9276b2001-02-22 01:15:47 +00002528#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002529 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002530#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002531 "Prepare block device to be used as swap partition"
2532#if 0
2533 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002534 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002535 "\n -c Check for readability"
2536 "\n -v0 Make swap version 0 (max 128M)"
2537 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2538 "\n BLOCKS Number of blocks to use (default is entire partition)"
2539#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002540
Eric Andersen7e9276b2001-02-22 01:15:47 +00002541#define mktemp_trivial_usage \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002542 "[-dt] [-p DIR] [TEMPLATE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002543#define mktemp_full_usage "\n\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002544 "Create a temporary file with name based on TEMPLATE and print its name.\n" \
Denis Vlasenkof2cccbc2008-06-08 20:40:33 +00002545 "TEMPLATE must end with XXXXXX (e.g. [/dir/]nameXXXXXX).\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002546 "\nOptions:" \
2547 "\n -d Make a directory instead of a file" \
2548/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2549 "\n -t Generate a path rooted in temporary directory" \
2550 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2551 "\n" \
Denis Vlasenkoc05b1682008-06-05 12:06:00 +00002552 "\nFor -t or -p, directory is chosen as follows:" \
2553 "\n$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002554
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002555#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002556 "$ mktemp /tmp/temp.XXXXXX\n" \
2557 "/tmp/temp.mWiLjM\n" \
2558 "$ ls -la /tmp/temp.mWiLjM\n" \
2559 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002560
Eric Andersen8d79ce82001-07-22 23:00:15 +00002561#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002562 "[-knqrsv] MODULE [symbol=value...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002563#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002564 "Options:" \
2565 "\n -k Make module autoclean-able" \
2566 "\n -n Dry run" \
2567 "\n -q Quiet" \
2568 "\n -r Remove module (stacks) or do autoclean" \
2569 "\n -s Report via syslog instead of stderr" \
2570 "\n -v Verbose" \
2571
Rob Landley9c32a152005-12-11 20:12:24 +00002572#define modprobe_notes_usage \
2573"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2574"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2575"pass each module it loads.\n" \
2576"\n" \
2577"The configuration file is searched (in order) amongst:\n" \
2578"\n" \
2579" /etc/modprobe.conf (2.6 only)\n" \
2580" /etc/modules.conf\n" \
2581" /etc/conf.modules (deprecated)\n" \
2582"\n" \
2583"They all have the same syntax (see below). If none is present, it is\n" \
2584"_not_ an error; each loaded module is then expected to load without\n" \
2585"options. Once a file is found, the others are tested for.\n" \
2586"\n" \
2587"/etc/modules.conf entry format:\n" \
2588"\n" \
2589" alias <alias_name> <mod_name>\n" \
2590" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002591" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002592" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2593" This makes it also possible to use a different set of options (below) for\n" \
2594" the module and the alias.\n" \
2595" A module can be aliased more than once.\n" \
2596"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002597" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002598" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2599" the \"symbol=value\" pairs as option to that module.\n" \
2600"\n" \
2601"Sample /etc/modules.conf file:\n" \
2602"\n" \
2603" options tulip irq=3\n" \
2604" alias tulip tulip2\n" \
2605" options tulip2 irq=4 io=0x308\n" \
2606"\n" \
2607"Other functionality offered by 'classic' modprobe is not available in\n" \
2608"this implementation.\n" \
2609"\n" \
2610"If module options are present both in the config file, and on the command line,\n" \
2611"then the options from the command line will be passed to the module _after_\n" \
2612"the options from the config file. That way, you can have defaults in the config\n" \
2613"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002614#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002615 "(with the above /etc/modules.conf):\n\n" \
2616 "$ modprobe tulip\n" \
2617 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2618 "$ modprobe tulip irq=5\n" \
2619 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2620 "$ modprobe tulip2\n" \
2621 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2622 " which are the default for alias 'tulip2'\n\n" \
2623 "$ modprobe tulip2 irq=8\n" \
2624 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2625 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2626 " from the command line\n\n" \
2627 "$ modprobe tulip2 irq=2 io=0x210\n" \
2628 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2629 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2630 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002631
Eric Andersen7e9276b2001-02-22 01:15:47 +00002632#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002633 "[FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002634#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002635 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002636
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002637#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002638 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002639
Eric Andersen7e9276b2001-02-22 01:15:47 +00002640#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002641 "[flags] DEVICE NODE [-o options,more-options]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002642#define mount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002643 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2644 "\nOptions:" \
2645 "\n -a Mount all filesystems in fstab" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002646 USE_FEATURE_MOUNT_FAKE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002647 "\n -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002648 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002649 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002650 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002651 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002652 "\n -r Read-only mount" \
2653 "\n -t fs-type Filesystem type" \
2654 "\n -w Read-write mount (default)" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002655 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002656 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002657 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002658 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002659 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002660 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002661 " [a]sync Writes are asynchronous / synchronous\n" \
2662 " [no]atime Disable / enable updates to inode access times\n" \
2663 " [no]diratime Disable / enable atime updates to directories\n" \
Bernhard Reutner-Fischerfb5902c2008-08-06 18:14:38 +00002664 " [no]relatime Disable / enable atime updates relative to modification time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002665 " [no]dev Allow use of special device files / disallow them\n" \
2666 " [no]exec Allow use of executable files / disallow them\n" \
2667 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2668 " [r]shared Convert [recursively] to a shared subtree\n" \
2669 " [r]slave Convert [recursively] to a slave subtree\n" \
2670 " [r]private Convert [recursively] to a private subtree\n" \
2671 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2672 " bind Bind a directory to an additional location\n" \
2673 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002674 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002675 " remount Remount a mounted filesystem, changing its flags\n" \
2676 " ro/rw Mount for read-only / read-write\n" \
2677 "\n" \
2678 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002679 "You'll have to see the written documentation for those filesystems" \
2680
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002681#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002682 "$ mount\n" \
2683 "/dev/hda3 on / type minix (rw)\n" \
2684 "proc on /proc type proc (rw)\n" \
2685 "devpts on /dev/pts type devpts (rw)\n" \
2686 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2687 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2688 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002689#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002690 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002691
Rob Landleyd00b3a52005-08-20 05:07:08 +00002692#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002693 "[-q] <[-d] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002694#define mountpoint_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002695 "mountpoint checks if the directory is a mountpoint\n" \
2696 "\nOptions:" \
2697 "\n -q Quiet" \
2698 "\n -d Print major/minor device number of the filesystem" \
2699 "\n -x Print major/minor device number of the blockdevice" \
2700
Rob Landleyd00b3a52005-08-20 05:07:08 +00002701#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002702 "$ mountpoint /proc\n" \
2703 "/proc is not a mountpoint\n" \
2704 "$ mountpoint /sys\n" \
2705 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002706
Eric Andersen7e9276b2001-02-22 01:15:47 +00002707#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002708 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002709#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002710 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002711 "\n" \
2712 "Available Opcodes:\n" \
2713 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002714 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2715 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2716 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002717 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002718
Eric Andersen7e9276b2001-02-22 01:15:47 +00002719#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002720 "[OPTION]... SOURCE DEST\n" \
2721 "or: mv [OPTION]... SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002722#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002723 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2724 "\nOptions:" \
2725 "\n -f Don't prompt before overwriting" \
2726 "\n -i Interactive, prompt before overwrite" \
2727
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002728#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002729 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002730
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002731#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002732 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002733#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002734 "Rename network interface while it in the down state\n" \
2735 "\nOptions:" \
2736 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2737 "\n -s Use syslog (LOCAL0 facility)" \
2738 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2739
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002740#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002741 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2742 " or\n" \
2743 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002744
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002745#if !ENABLE_DESKTOP
2746
Rob Landley1cca9482006-07-10 19:45:20 +00002747#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002748#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002749#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002750#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002751#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002752
Eric Andersen7e9276b2001-02-22 01:15:47 +00002753#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002754 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002755 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002756#define nc_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002757 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002758 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002759 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002760 "\n -e Exec rest of command line after connect" \
2761 "\n -i SECS Delay interval for lines sent" \
2762 "\n -w SECS Timeout for connect" \
2763 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002764 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002765 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002766 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002767 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002768 "\n (use -l twice with -e for persistent server)") \
2769 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002770 )
2771
Rob Landley1cca9482006-07-10 19:45:20 +00002772#define nc_notes_usage "" \
2773 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002774 "To use netcat as a terminal emulator on a serial port:\n\n" \
2775 "$ stty 115200 -F /dev/ttyS0\n" \
2776 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2777 )
Rob Landley1cca9482006-07-10 19:45:20 +00002778
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002779#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002780 "$ nc foobar.somedomain.com 25\n" \
2781 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2782 "help\n" \
2783 "214-Commands supported:\n" \
2784 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2785 "214 NOOP QUIT RSET HELP\n" \
2786 "quit\n" \
2787 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002788
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002789#else /* DESKTOP nc - much more compatible with nc 1.10 */
2790
2791#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002792 "[-options] hostname port - connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002793 USE_NC_SERVER("\n" \
2794 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002795#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002796 "Options:" \
2797 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002798 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002799 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002800 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002801 "\n -n Don't do DNS resolution" \
2802 "\n -s addr Local address" \
2803 "\n -p port Local port" \
2804 "\n -u UDP mode" \
2805 "\n -v Verbose (cumulative: -vv)" \
2806 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002807 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002808 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
2809 "\n -o file Hex dump of traffic" \
2810 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002811 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002812/* "\n -r Randomize local and remote ports" */
2813/* "\n -g gateway Source-routing hop point[s], up to 8" */
2814/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002815/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2816
2817#endif
2818
Eric Andersen1552ff72001-10-31 11:07:12 +00002819#define netstat_trivial_usage \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002820 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")USE_FEATURE_NETSTAT_PRG("p")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002821#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002822 "Display networking information\n" \
2823 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002824 "\n -l Display listening server sockets" \
2825 "\n -a Display all sockets (default: connected)" \
2826 "\n -e Display other/more information" \
2827 "\n -n Don't resolve names" \
2828 "\n -t Tcp sockets" \
2829 "\n -u Udp sockets" \
2830 "\n -w Raw sockets" \
2831 "\n -x Unix sockets" \
2832 "\n -r Display routing table" \
2833 USE_FEATURE_NETSTAT_WIDE( \
2834 "\n -W Display with no column truncation" \
Denis Vlasenko6e69e422008-07-27 12:10:07 +00002835 ) \
2836 USE_FEATURE_NETSTAT_PRG( \
2837 "\n -p Display PID/Program name for sockets" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002838 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002839
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002840#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002841 "[-n ADJUST] [COMMAND [ARG]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002842#define nice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002843 "Run a program with modified scheduling priority\n" \
2844 "\nOptions:" \
2845 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002846
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002847#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002848 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002849#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002850 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002851 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002852 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002853 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002854 "%[niface] Monitor network interface 'iface'\n" \
2855 "%m Monitor allocated memory\n" \
2856 "%[mf] Monitor free memory\n" \
2857 "%[mt] Monitor total memory\n" \
2858 "%s Monitor allocated swap\n" \
2859 "%f Monitor number of used file descriptors\n" \
2860 "%Ni Monitor total/specific IRQ rate\n" \
2861 "%x Monitor context switch rate\n" \
2862 "%p Monitor forks\n" \
2863 "%[pn] Monitor # of processes\n" \
2864 "%b Monitor block io\n" \
2865 "%Nt Show time (with N decimal points)\n" \
2866 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002867 "%r Print <cr> instead of <lf> at EOL" \
2868
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002869#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002870 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002871
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002872#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002873 "COMMAND [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002874#define nohup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002875 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002876#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002877 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002878
Eric Andersen7e9276b2001-02-22 01:15:47 +00002879#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002880 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002881#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002882 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002883 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002884#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002885 "$ nslookup localhost\n" \
2886 "Server: default\n" \
2887 "Address: default\n" \
2888 "\n" \
2889 "Name: debian\n" \
2890 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002891
Glenn L McGrath60281112001-11-02 11:39:46 +00002892#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002893 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002894#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002895 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002896 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002897
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002898#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002899 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002900#define openvt_full_usage "\n\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002901 "Start COMMAND on a new virtual terminal\n" \
2902 "\nOptions:" \
2903 "\n -c Use specified VT" \
2904 "\n -s Switch to the VT" \
2905/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
2906 "\n -w Wait for COMMAND to exit" \
2907
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002908#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002909 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002910
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00002911#define parse_trivial_usage \
2912 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
2913#define parse_full_usage "\n\n" \
2914 "[-n maxtokens] [-m mintokens] [-d delims] [-f flags] file ..."
2915
Eric Andersen27f64e12002-06-23 04:24:25 +00002916#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002917 "[OPTION] [name]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002918#define passwd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002919 "Change user's password. If no name is specified,\n" \
2920 "changes the password for the current user.\n" \
2921 "\nOptions:" \
2922 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
2923 "\n -d Delete password for the account" \
2924 "\n -l Lock (disable) account" \
2925 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002926
Denis Vlasenko21d10142007-07-20 21:28:41 +00002927#define chpasswd_trivial_usage \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00002928 USE_GETOPT_LONG("[--md5|--encrypted]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002929#define chpasswd_full_usage "\n\n" \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00002930 "Read user:password information from stdin " \
Denis Vlasenko397de612008-03-17 08:55:44 +00002931 "and update /etc/passwd accordingly.\n" \
2932 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002933 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer9b446132008-08-05 09:56:56 +00002934 "\n -e,--encrypted Supplied passwords are in encrypted form" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002935 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002936 ) \
2937 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002938 "\n -e Supplied passwords are in encrypted form" \
2939 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002940 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002941
Glenn L McGrath655d8142003-06-22 15:32:41 +00002942#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002943 "[-p NUM] [-i DIFF] [-R]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002944#define patch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002945 " -p NUM Strip NUM leading components from file names" \
2946 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002947 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002948
Glenn L McGrath655d8142003-06-22 15:32:41 +00002949#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002950 "$ patch -p1 < example.diff\n" \
2951 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002952
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002953#define pgrep_trivial_usage \
2954 "[-flnovx] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002955#define pgrep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002956 "Display process(es) selected by regex pattern\n" \
2957 "\nOptions:" \
2958 "\n -l Show command name too" \
2959 "\n -f Match against entire command line" \
2960 "\n -n Show the newest process only" \
2961 "\n -o Show the oldest process only" \
2962 "\n -v Negate the matching" \
2963 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002964
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002965#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00002966#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002967 "[OPTION] [NAME...]"
2968#define USAGE_PIDOF "\n\nOptions:"
2969#else
2970#define pidof_trivial_usage \
2971 "[NAME...]"
2972#define USAGE_PIDOF /* none */
2973#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002974#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002975 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002976 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002977 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002978 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002979 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002980 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002981 "\n Use %PPID to omit pid of pidof's parent") \
2982
Eric Andersen221b2ea2001-07-31 19:06:07 +00002983#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002984 "$ pidof init\n" \
2985 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002986 USE_FEATURE_PIDOF_OMIT( \
2987 "$ pidof /bin/sh\n20351 5973 5950\n") \
2988 USE_FEATURE_PIDOF_OMIT( \
2989 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002990
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002991#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002992#define ping_trivial_usage \
2993 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002994#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002995 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002996#define ping6_trivial_usage \
2997 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002998#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002999 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003000#else
3001#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003002 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003003#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003004 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3005 "\nOptions:" \
3006 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3007 "\n -c CNT Send only CNT pings" \
3008 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3009 "\n -I iface/IP Use interface or IP address as source" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003010 "\n -W timeout Seconds to wait for the first response (default:10)" \
3011 "\n (after all -c CNT packets are sent)" \
3012 "\n -w deadline Seconds until ping exits (default:infinite)" \
3013 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003014 "\n -q Quiet, only displays output at start" \
3015 "\n and when finished" \
3016
Eric Andersen51b8bd62002-07-03 11:46:38 +00003017#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003018 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003019#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003020 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3021 "\nOptions:" \
3022 "\n -c CNT Send only CNT pings" \
3023 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3024 "\n -I iface/IP Use interface or IP address as source" \
3025 "\n -q Quiet, only displays output at start" \
3026 "\n and when finished" \
3027
Eric Andersen51b8bd62002-07-03 11:46:38 +00003028#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003029#define ping_example_usage \
3030 "$ ping localhost\n" \
3031 "PING slag (127.0.0.1): 56 data bytes\n" \
3032 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3033 "\n" \
3034 "--- debian ping statistics ---\n" \
3035 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3036 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003037#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003038 "$ ping6 ip6-localhost\n" \
3039 "PING ip6-localhost (::1): 56 data bytes\n" \
3040 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3041 "\n" \
3042 "--- ip6-localhost ping statistics ---\n" \
3043 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3044 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003045
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003046#define pipe_progress_trivial_usage NOUSAGE_STR
3047#define pipe_progress_full_usage ""
3048
Eric Andersen7e9276b2001-02-22 01:15:47 +00003049#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003050 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003051#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003052 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003053 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003054
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003055#define pkill_trivial_usage \
3056 "[-l] | [-fnovx] [-signal] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003057#define pkill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003058 "Send a signal to process(es) selected by regex pattern\n" \
3059 "\nOptions:" \
3060 "\n -l List all signals" \
3061 "\n -f Match against entire command line" \
3062 "\n -n Signal the newest process only" \
3063 "\n -o Signal the oldest process only" \
3064 "\n -v Negate the matching" \
3065 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003066
Eric Andersen7e9276b2001-02-22 01:15:47 +00003067#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003068 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003069#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003070 "Halt and shut off power\n" \
3071 "\nOptions:" \
3072 "\n -d Delay interval for halting" \
3073 "\n -n No call to sync()" \
3074 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003075
Mike Frysinger95d3c452005-04-21 23:29:24 +00003076#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003077 "[VARIABLES...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003078#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003079 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003080 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003081
Eric Andersen7e9276b2001-02-22 01:15:47 +00003082#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003083 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003084#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003085 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003086 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003087#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003088 "$ printf \"Val=%d\\n\" 5\n" \
3089 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003090
Denis Vlasenko94949192006-11-05 00:45:47 +00003091
3092#if ENABLE_DESKTOP
3093
3094#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003095 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003096#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003097 "Report process status\n" \
3098 "\nOptions:" \
3099 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003100
3101#else /* !ENABLE_DESKTOP */
3102
Denis Vlasenko397de612008-03-17 08:55:44 +00003103#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003104#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003105#else
3106#define USAGE_PS "\nOptions:"
3107#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003108
Eric Andersen7e9276b2001-02-22 01:15:47 +00003109#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003110 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003111#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003112 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003113 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003114 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003115 "\n -Z Show SE Linux context" \
3116 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003117 USE_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003118 "\n w Wide output" \
3119 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003120
Denis Vlasenko94949192006-11-05 00:45:47 +00003121#endif /* ENABLE_DESKTOP */
3122
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003123#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003124 "$ ps\n" \
3125 " PID Uid Gid State Command\n" \
3126 " 1 root root S init\n" \
3127 " 2 root root S [kflushd]\n" \
3128 " 3 root root S [kupdate]\n" \
3129 " 4 root root S [kpiod]\n" \
3130 " 5 root root S [kswapd]\n" \
3131 " 742 andersen andersen S [bash]\n" \
3132 " 743 andersen andersen S -bash\n" \
3133 " 745 root root S [getty]\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003134 " 2990 andersen andersen R ps\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003135
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003136#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003137 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003138#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003139 "Scan a host, print all open ports\n" \
3140 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003141 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003142 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003143 "\n -p Scan from this port (default 1)" \
3144 "\n -P Scan up to this port (default 1024)" \
3145 "\n -t Timeout (default 5000 ms)" \
3146 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3147
Eric Andersen7e9276b2001-02-22 01:15:47 +00003148#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003149 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003150#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003151 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003152#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003153 "$ pwd\n" \
3154 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003155
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003156#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003157 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003158#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003159 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003160#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003161 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003162
Eric Andersen7e9276b2001-02-22 01:15:47 +00003163#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003164 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003165#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003166 "Get and possibly set the system date and time from a remote HOST\n" \
3167 "\nOptions:" \
3168 "\n -s Set the system date and time (default)" \
3169 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003170
Rob Landley0e4690d2006-08-20 22:12:18 +00003171#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003172 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003173#define readahead_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003174 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3175 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003176
Eric Andersen7e9276b2001-02-22 01:15:47 +00003177#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003178 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003179#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003180 "Display the value of a symlink" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003181 USE_FEATURE_READLINK_FOLLOW( "\n" \
3182 "\nOptions:" \
3183 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003184
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003185#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003186 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003187#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003188 "Options:" \
3189 "\n -m mapfile (Default: /boot/System.map)" \
3190 "\n -p profile (Default: /proc/profile)" \
3191 "\n -M mult Set the profiling multiplier to mult" \
3192 "\n -i Print only info about the sampling step" \
3193 "\n -v Verbose" \
3194 "\n -a Print all symbols, even if count is 0" \
3195 "\n -b Print individual histogram-bin counts" \
3196 "\n -s Print individual counters within functions" \
3197 "\n -r Reset all the counters (root only)" \
3198 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003199
Glenn L McGrath62fae302002-12-10 00:14:33 +00003200#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003201 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003202#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003203 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003204
Eric Andersen7e9276b2001-02-22 01:15:47 +00003205#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003206 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003207#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003208 "Reboot the system\n" \
3209 "\nOptions:" \
3210 "\n -d Delay interval for rebooting" \
3211 "\n -n No call to sync()" \
3212 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003213
3214#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003215 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003216#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003217 "Change priority of running processes\n" \
3218 "\nOptions:" \
3219 "\n -n Adjust current nice value (smaller is faster)" \
3220 "\n -p Process id(s) (default)" \
3221 "\n -g Process group id(s)" \
3222 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003223
Eric Andersen7e9276b2001-02-22 01:15:47 +00003224#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003225 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003226#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003227 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003228
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003229#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003230 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003231#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003232 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003233
Denis Vlasenko397137b2007-07-23 14:03:30 +00003234#define restorecon_trivial_usage \
3235 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003236#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003237 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003238 "\n -i Ignore files that do not exist" \
3239 "\n -f file File with list of files to process. Use - for stdin" \
3240 "\n -e directory Directory to exclude" \
3241 "\n -R,-r Recurse directories" \
3242 "\n -n Don't change any file labels" \
3243 "\n -o file Save list of files with incorrect context" \
3244 "\n -v Verbose" \
3245 "\n -vv Show changed labels" \
3246 "\n -F Force reset of context to match file_context" \
3247 "\n for customizable files, or the user section," \
3248 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003249
Eric Andersen7e9276b2001-02-22 01:15:47 +00003250#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003251 "[OPTION]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003252#define rm_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003253 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003254 "indicate that all following arguments are non-options.\n" \
3255 "\nOptions:" \
3256 "\n -i Always prompt before removing" \
3257 "\n -f Never prompt" \
3258 "\n -r,-R Remove directories recursively" \
3259
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003260#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003261 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003262
Eric Andersen7e9276b2001-02-22 01:15:47 +00003263#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003264 "[OPTION]... DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003265#define rmdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003266 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003267#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003268 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003269
Eric Andersen7e9276b2001-02-22 01:15:47 +00003270#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003271 "[OPTION]... [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003272#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003273 "Unload the specified kernel modules from the kernel\n" \
3274 "\nOptions:" \
3275 "\n -a Remove all unused modules (recursively)" \
3276
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003277#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003278 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003279
Eric Andersen7e9276b2001-02-22 01:15:47 +00003280#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003281 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003282#define route_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003283 "Edit the kernel's routing tables\n" \
3284 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003285 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003286 "\n -e Display other/more information" \
3287 "\n -A inet" USE_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003288
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003289#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003290 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003291#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003292 "Manipulate RPM packages\n" \
3293 "\nOptions:" \
3294 "\n -i Install package" \
3295 "\n -q Query package" \
3296 "\n -p Query uninstalled package" \
3297 "\n -i Show information" \
3298 "\n -l List contents" \
3299 "\n -d List documents" \
3300 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003301
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003302#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003303 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003304#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003305 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003306
Mike Frysinger6b160e42008-02-15 02:27:19 +00003307#define rtcwake_trivial_usage \
3308 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003309#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003310 "Enter a system sleep state until specified wakeup time\n" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003311 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003312 "\n -a,--auto Read clock mode from adjtime" \
3313 "\n -l,--local Clock is set to local time" \
3314 "\n -u,--utc Clock is set to UTC time" \
3315 "\n -d,--device=DEV Specify the RTC device" \
Mike Frysinger1e93f3c2008-06-04 10:33:33 +00003316 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003317 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
3318 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003319 ) \
3320 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003321 "\n -a Read clock mode from adjtime" \
3322 "\n -l Clock is set to local time" \
3323 "\n -u Clock is set to UTC time" \
3324 "\n -d DEV Specify the RTC device" \
3325 "\n -m MODE Set the sleep state (default: standby)" \
3326 "\n -s SEC Set the timeout in SEC seconds from now" \
3327 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003328 )
3329
Denis Vlasenko49622d72007-03-10 16:58:49 +00003330#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003331 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3332 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003333#define runcon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003334 "Run a program in a different security context\n" \
3335 "\n CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003336 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003337 "\n -c,--compute Compute process transition context before modifying" \
3338 "\n -t,--type=TYPE Type (for same role as parent)" \
3339 "\n -u,--user=USER User identity" \
3340 "\n -r,--role=ROLE Role" \
3341 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003342 ) \
3343 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003344 "\n -c Compute process transition context before modifying" \
3345 "\n -t TYPE Type (for same role as parent)" \
3346 "\n -u USER User identity" \
3347 "\n -r ROLE Role" \
3348 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003349 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003350
Eric Andersen6cf47a72001-10-31 10:24:36 +00003351#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003352 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003353#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003354 "Run a bunch of scripts in a directory\n" \
3355 "\nOptions:" \
3356 "\n -t Print what would be run, but don't actually run anything" \
3357 "\n -a ARG Pass ARG as argument for every program" \
3358 "\n -u MASK Set the umask to MASK before running every program" \
3359 USE_FEATURE_RUN_PARTS_FANCY( \
3360 "\n -l Print names of all matching files even if they are not executable" \
3361 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003362
3363#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003364 "$ run-parts -a start /etc/init.d\n" \
3365 "$ run-parts -a stop=now /etc/init.d\n\n" \
3366 "Let's assume you have a script foo/dosomething:\n" \
3367 "#!/bin/sh\n" \
3368 "for i in $*; do eval $i; done; unset i\n" \
3369 "case \"$1\" in\n" \
3370 "start*) echo starting something;;\n" \
3371 "stop*) set -x; shutdown -h $stop;;\n" \
3372 "esac\n\n" \
3373 "Running this yields:\n" \
3374 "$run-parts -a stop=+4m foo/\n" \
3375 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003376
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003377#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003378 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003379#define runlevel_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003380 "Find the current and previous system runlevel.\n\n" \
3381 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003382 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003383#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003384 "$ runlevel /var/run/utmp\n" \
3385 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003386
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003387#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003388 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003389#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003390 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003391
3392#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003393 "[-P] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003394#define runsvdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003395 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003396
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003397#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003398 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003399#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003400 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003401#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003402 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003403
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003404#define script_trivial_usage \
3405 "[-afq] [-c COMMAND] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003406#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003407 "Options:" \
3408 "\n -a Append output" \
3409 "\n -c Run COMMAND, not shell" \
3410 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003411 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003412
Eric Andersen7e9276b2001-02-22 01:15:47 +00003413#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003414 "[-efinr] pattern [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003415#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003416 "Options:" \
3417 "\n -e script Add the script to the commands to be executed" \
3418 "\n -f scriptfile Add scriptfile contents to the" \
3419 "\n commands to be executed" \
3420 "\n -i Edit files in-place" \
3421 "\n -n Suppress automatic printing of pattern space" \
3422 "\n -r Use extended regular expression syntax" \
3423 "\n" \
3424 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3425 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3426 "\ninput files are specified, then the standard input is read. Source files" \
3427 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003428
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003429#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003430 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3431 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003432
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003433#define selinuxenabled_trivial_usage NOUSAGE_STR
3434#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003435
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003436#define sendmail_trivial_usage \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003437 "[-w timeout] [-H [user:pass@]server[:port]] [-S]\n" \
3438 "[-c charset] [-N type] [-i] [-s subject] [-a attach]... [-t] [-f sender] [rcpt]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003439#define sendmail_full_usage "\n\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003440 "Send an email\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003441 "\nOptions:" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003442 "\n -w timeout Network timeout" \
3443 "\n -H [user:pass@]server[:port] Server" \
3444 "\n -S Use openssl connection helper for secure servers" \
3445 "\n -c charset Assume charset for body and subject (utf-8)" \
3446 "\n -N type Request delivery notification. Type is ignored" \
Denis Vlasenko3dee8e22008-06-27 21:24:08 +00003447 "\n -i Ignore single dots in mail body. Implied" \
3448 "\n -s subject Subject" \
3449 "\n -a file File to attach. May be multiple" \
3450 "\n -t Read recipients and subject from body" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003451 "\n -f sender Sender" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003452
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003453#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003454 "[first [increment]] last"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003455#define seq_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003456 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003457 "FIRST, INCREMENT default to 1\n" \
3458 "\nArguments:" \
3459 "\n LAST" \
3460 "\n FIRST LAST" \
3461 "\n FIRST INCREMENT LAST" \
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003462
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003463#define sestatus_trivial_usage \
3464 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003465#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003466 " -v Verbose" \
3467 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003468
Paul Foxfc2256a2005-08-01 18:12:30 +00003469#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003470 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003471#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003472 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3473 "\nOptions:" \
3474 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003475
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003476#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003477 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003478#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003479
Denis Vlasenko397137b2007-07-23 14:03:30 +00003480#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003481 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003482 USE_FEATURE_SETFILES_CHECK_OPTION( \
3483 " [-c policyfile] spec_file" \
3484 ) \
3485 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003486#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003487 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003488 USE_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003489 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003490 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003491 "\n -d Show which specification matched each file" \
3492 "\n -l Log changes in file labels to syslog" \
3493 "\n -n Don't change any file labels" \
3494 "\n -q Suppress warnings" \
3495 "\n -r dir Use an altenate root path" \
3496 "\n -e dir Exclude directory" \
3497 "\n -F Force reset of context to match file_context for customizable files" \
3498 "\n -o file Save list of files with incorrect context" \
3499 "\n -s Take a list of files from standard input (instead of command line)" \
3500 "\n -v Show changes in file labels, if type or role are changing" \
3501 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3502 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003503
Denis Vlasenkoc8d02aa2008-08-17 14:12:26 +00003504#define setfont_trivial_usage \
3505 "[-m mapfile] font"
3506#define setfont_full_usage "\n\n" \
3507 "Load a console font\n" \
3508 "\nOptions:" \
3509 "\n -m mapfile Load console screen map from mapfile"
3510#define setfont_example_usage \
3511 "$ setfont -m koi8-r /etc/i18n/fontname\n"
3512
Eric Andersen7e9276b2001-02-22 01:15:47 +00003513#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003514 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003515#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003516 "Set entries into the kernel's scancode-to-keycode map,\n" \
3517 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3518 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003519 "and KEYCODE is given in decimal" \
3520
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003521#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003522 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003523
Rob Landley87848d92006-03-27 23:23:43 +00003524#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003525 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003526#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003527 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003528
Denis Vlasenkobe039372007-10-14 04:48:44 +00003529#define setsebool_trivial_usage \
3530 "boolean value"
3531
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003532#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003533 "Change boolean setting"
3534
Paul Fox42403642005-08-01 22:52:09 +00003535#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003536 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003537#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003538 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3539 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3540 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003541
Matt Kraai2d91deb2001-08-01 17:21:35 +00003542#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003543 "[FILE]...\n" \
3544 "or: sh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003545#define lash_full_usage "\n\n" \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003546 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003547
Eric Andersen2e9c2572003-08-08 22:26:06 +00003548#define last_trivial_usage \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003549 ""USE_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003550#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003551 "Show listing of the last users that logged into the system" \
3552 USE_FEATURE_LAST_FANCY( "\n" \
3553 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003554/* "\n -H Show header line" */ \
3555 "\n -W Display with no host column truncation" \
3556 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003557 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003558
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003559#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003560 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003561 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003562#define sha1sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003563 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
3564 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
3565 "\nOptions:" \
3566 "\n -c Check SHA1 sums against given list" \
3567 "\n -s Don't output anything, status code shows success" \
3568 "\n -w Warn about improperly formatted SHA1 checksum lines" \
3569 )
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003570
Denis Vlasenkod7cc2e62008-08-17 14:17:48 +00003571#define showkey_trivial_usage \
3572 "[-a | -k | -s]"
3573#define showkey_full_usage "\n\n" \
3574 "Show keys pressed\n" \
3575 "\nOptions:" \
3576 "\n -a Display decimal/octal/hex values of the keys" \
3577 "\n -k Display interpreted keycodes (default)" \
3578 "\n -s Display raw scan-codes" \
3579
Denis Vlasenko14923db2007-06-20 15:23:03 +00003580#define slattach_trivial_usage \
3581 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003582#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003583 "Attach network interface(s) to serial line(s)\n" \
3584 "\nOptions:" \
3585 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3586 "\n -s Set line speed" \
3587 "\n -e Exit after initializing device" \
3588 "\n -h Exit when the carrier is lost" \
3589 "\n -c Execute a command when the line is hung up" \
3590 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3591 "\n -L Enable 3-wire operation" \
3592 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003593
Eric Andersen7e9276b2001-02-22 01:15:47 +00003594#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003595 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003596#define sleep_full_usage "\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003597 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003598 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003599 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003600 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003601#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003602 "$ sleep 2\n" \
3603 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003604 USE_FEATURE_FANCY_SLEEP( \
3605 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003606 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003607
Eric Andersen7e9276b2001-02-22 01:15:47 +00003608#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003609 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003610 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003611 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003612#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003613 "Sort lines of text\n" \
3614 "\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003615 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003616 "\n -b Ignore leading blanks" \
3617 "\n -c Check whether input is sorted" \
3618 "\n -d Dictionary order (blank or alphanumeric only)" \
3619 "\n -f Ignore case" \
3620 "\n -g General numerical sort" \
3621 "\n -i Ignore unprintable characters" \
3622 "\n -k Sort key" \
3623 "\n -M Sort month" \
3624 ) \
3625 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003626 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003627 "\n -o Output to file" \
3628 "\n -k Sort by key" \
3629 "\n -t CHAR Key separator" \
3630 ) \
3631 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003632 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003633 "\n -s Stable (don't sort ties alphabetically)" \
3634 ) \
3635 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003636 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003637 "\n -z Lines are terminated by NUL, not newline" \
3638 "\n -mST Ignored for GNU compatibility") \
3639
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003640#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003641 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3642 "a\n" \
3643 "b\n" \
3644 "c\n" \
3645 "d\n" \
3646 "e\n" \
3647 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003648 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003649 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3650 "d 2\n" \
3651 "b 2\n" \
3652 "c 3\n" \
3653 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003654 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003655
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003656#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003657 "[OPTION] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003658#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003659 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003660 "\n -b n[k|m] Split by bytes" \
3661 "\n -l n Split by lines" \
3662 "\n -a n Use n letters as suffix" \
3663
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003664#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003665 "$ split TODO foo\n" \
3666 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003667
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003668#define start_stop_daemon_trivial_usage \
Denis Vlasenko7987a182008-07-01 10:00:46 +00003669 "[OPTIONS] [-S|-K] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003670#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003671 "Search for matching processes, and then\n" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003672 "-K: stop all matching processes.\n" \
3673 "-S: start a process unless a matching process is found.\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003674 USE_GETOPT_LONG( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003675 "\nProcess matching:" \
3676 "\n -u,--user USERNAME|UID Match only this user's processes" \
3677 "\n -n,--name NAME Match processes with NAME" \
3678 "\n in comm field in /proc/PID/stat" \
3679 "\n -x,--exec EXECUTABLE Match processes with this command" \
3680 "\n in /proc/PID/cmdline" \
3681 "\n -p,--pidfile FILE Match a process with PID from the file" \
3682 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003683 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003684 "\n -x,--exec EXECUTABLE Program to run" \
3685 "\n -a,--startas NAME Zeroth argument" \
3686 "\n -b,--background Background" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003687 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003688 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003689 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003690 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3691 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003692 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003693 "\n -s,--signal SIG Signal to send" \
3694 "\n -t,--test Match only, exit with 0 if a process is found" \
3695 "\nOther:" \
3696 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3697 "\n -o,--oknodo Exit with status 0 if nothing is done" \
3698 "\n -q,--quiet Quiet" \
3699 ) \
3700 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003701 ) \
3702 SKIP_GETOPT_LONG( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003703 "\nProcess matching:" \
3704 "\n -u USERNAME|UID Match only this user's processes" \
3705 "\n -n NAME Match processes with NAME" \
3706 "\n in comm field in /proc/PID/stat" \
3707 "\n -x EXECUTABLE Match processes with this command" \
3708 "\n command in /proc/PID/cmdline" \
3709 "\n -p FILE Match a process with PID from the file" \
3710 "\n All specified conditions must match" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003711 "\n-S only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003712 "\n -x EXECUTABLE Program to run" \
3713 "\n -a NAME Zeroth argument" \
3714 "\n -b Background" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003715 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003716 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003717 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003718 "\n -c USER[:[GRP]] Change to user/group" \
3719 "\n -m Write PID to the pidfile specified by -p" \
Denis Vlasenko7ce47e62008-08-03 19:23:30 +00003720 "\n-K only:" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003721 "\n -s SIG Signal to send" \
3722 "\n -t Match only, exit with 0 if a process is found" \
3723 "\nOther:" \
3724 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3725 "\n -o Exit with status 0 if nothing is done" \
3726 "\n -q Quiet" \
3727 ) \
3728 "\n -v Verbose" \
3729 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003730
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003731#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003732 "[OPTION] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003733#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003734 "Display file (default) or filesystem status\n" \
3735 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003736 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003737 "\n -c fmt Use the specified format" \
3738 ) \
3739 "\n -f Display filesystem status" \
3740 "\n -L Dereference links" \
3741 "\n -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003742 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003743 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003744 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003745 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003746 "\n\nValid format sequences for files:\n" \
3747 " %a Access rights in octal\n" \
3748 " %A Access rights in human readable form\n" \
3749 " %b Number of blocks allocated (see %B)\n" \
3750 " %B The size in bytes of each block reported by %b\n" \
3751 " %d Device number in decimal\n" \
3752 " %D Device number in hex\n" \
3753 " %f Raw mode in hex\n" \
3754 " %F File type\n" \
3755 " %g Group ID of owner\n" \
3756 " %G Group name of owner\n" \
3757 " %h Number of hard links\n" \
3758 " %i Inode number\n" \
3759 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003760 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003761 " %o I/O block size\n" \
3762 " %s Total size, in bytes\n" \
3763 " %t Major device type in hex\n" \
3764 " %T Minor device type in hex\n" \
3765 " %u User ID of owner\n" \
3766 " %U User name of owner\n" \
3767 " %x Time of last access\n" \
3768 " %X Time of last access as seconds since Epoch\n" \
3769 " %y Time of last modification\n" \
3770 " %Y Time of last modification as seconds since Epoch\n" \
3771 " %z Time of last change\n" \
3772 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003773 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003774 " %a Free blocks available to non-superuser\n" \
3775 " %b Total data blocks in file system\n" \
3776 " %c Total file nodes in file system\n" \
3777 " %d Free file nodes in file system\n" \
3778 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003779 USE_SELINUX( \
3780 " %C Security context in SELinux\n" \
3781 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003782 " %i File System ID in hex\n" \
3783 " %l Maximum length of filenames\n" \
3784 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003785 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003786 " %S Fundamental block size (for block counts)\n" \
3787 " %t Type in hex\n" \
3788 " %T Type in human readable form" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003789 ) \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003790
Eric Andersenef5e8f82002-11-07 02:09:37 +00003791#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003792 "[-afo] [-n length] [file...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003793#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003794 "Display printable strings in a binary file\n" \
3795 "\nOptions:" \
3796 "\n -a Scan whole file (default)" \
3797 "\n -f Precede strings with filenames" \
3798 "\n -n N At least N characters form a string (default 4)" \
3799 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003800
Eric Andersen7e9276b2001-02-22 01:15:47 +00003801#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003802 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003803#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003804 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003805 "and deviations from stty sane\n" \
3806 "\nOptions:" \
3807 "\n -F DEVICE Open device instead of stdin" \
3808 "\n -a Print all current settings in human-readable form" \
3809 "\n -g Print in stty-readable form" \
3810 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003811
Robert Griebl1fca5582002-06-04 20:45:46 +00003812#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003813 "[OPTION]... [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003814#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003815 "Change user id or become root\n" \
3816 "\nOptions:" \
3817 "\n -p, -m Preserve environment" \
3818 "\n -c Command to pass to 'sh -c'" \
3819 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00003820
Eric Andersen27f64e12002-06-23 04:24:25 +00003821#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003822 "[OPTION]... [tty-device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003823#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003824 "Single user login\n" \
3825 "\nOptions:" \
3826 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003827
Mike Frysinger95d3c452005-04-21 23:29:24 +00003828#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003829 "[rs] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003830#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003831 "Checksum and count the blocks in a file\n" \
3832 "\nOptions:" \
3833 "\n -r Use BSD sum algorithm (1K blocks)" \
3834 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00003835
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003836#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003837 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003838#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003839 "Control services monitored by runsv supervisor.\n" \
3840 "Commands (only first character is enough):\n" \
3841 "\n" \
3842 "status: query service status\n" \
3843 "up: if service isn't running, start it. If service stops, restart it\n" \
3844 "once: like 'up', but if service stops, don't restart it\n" \
3845 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003846 " if it exists. After it stops, do not restart service\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003847 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003848 " runsv exits too\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003849 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003850 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003851
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003852#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003853 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003854#define svlogd_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003855 "Continuously read log data from standard input, optionally " \
3856 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003857 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003858
Eric Andersen7e9276b2001-02-22 01:15:47 +00003859#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003860 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003861#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003862 "Stop swapping on DEVICE\n" \
3863 "\nOptions:" \
3864 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003865
Eric Andersen7e9276b2001-02-22 01:15:47 +00003866#define swapon_trivial_usage \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00003867 "[-a]" USE_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003868#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003869 "Start swapping on DEVICE\n" \
3870 "\nOptions:" \
3871 "\n -a Start swapping on all swap devices" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00003872 USE_FEATURE_SWAPON_PRI( \
3873 "\n -p pri Set swap device priority" \
3874 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003875
Rob Landley0f34a822005-10-27 22:55:50 +00003876#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003877 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003878#define switch_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003879 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003880 "and exec NEW_INIT\n" \
3881 "\nOptions:" \
3882 "\n -c Redirect console to device on new root" \
Rob Landley0f34a822005-10-27 22:55:50 +00003883
Eric Andersen7e9276b2001-02-22 01:15:47 +00003884#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003885 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003886#define sync_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003887 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003888
Eric Andersenb9050282003-12-24 06:02:11 +00003889#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003890 "[OPTIONS]... [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003891#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003892 "Configure kernel parameters at runtime\n" \
3893 "\nOptions:" \
3894 "\n -n Disable printing of key names" \
3895 "\n -e Don't warn about unknown keys" \
3896 "\n -w Change sysctl setting" \
3897 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
3898 "\n -a Display all values" \
3899 "\n -A Display all values in table form" \
3900
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003901#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003902 "sysctl [-n] [-e] variable...\n" \
3903 "sysctl [-n] [-e] -w variable=value...\n" \
3904 "sysctl [-n] [-e] -a\n" \
3905 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3906 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003907
Eric Andersen7e9276b2001-02-22 01:15:47 +00003908#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003909 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003910#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003911 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003912 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
3913 "\nOptions:" \
3914 "\n -n Run in foreground" \
3915 "\n -O FILE Log to given file (default=/var/log/messages)" \
3916 "\n -l n Set local log level" \
3917 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003918 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003919 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3920 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003921 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003922 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3923 "\n -L Log locally and via network (default is network only if -R)") \
3924 USE_FEATURE_SYSLOGD_DUP( \
3925 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003926 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003927 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003928 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003929/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00003930
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003931#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003932 "$ syslogd -R masterlog:514\n" \
3933 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003934
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003935#define tac_trivial_usage \
3936 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003937#define tac_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003938 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003939
Eric Andersen7e9276b2001-02-22 01:15:47 +00003940#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003941 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003942#define tail_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003943 "Print last 10 lines of each FILE to standard output.\n" \
3944 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003945 "file name. With no FILE, or when FILE is -, read standard input.\n" \
3946 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003947 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003948 "\n -c N[kbm] Output the last N bytes") \
3949 "\n -n N[kbm] Print last N lines instead of last 10" \
3950 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003951 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003952 "\n -q Never output headers giving file names" \
3953 "\n -s SEC Wait SEC seconds between reads with -f" \
3954 "\n -v Always output headers giving file names" \
Denis Vlasenko6ea75e22008-06-28 21:46:41 +00003955 "\n" \
3956 "\nIf the first character of N (bytes or lines) is a '+', output begins with" \
3957 "\nthe Nth item from the start of each file, otherwise, print the last N items" \
3958 "\nin the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003959
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003960#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003961 "$ tail -n 1 /etc/resolv.conf\n" \
3962 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003963
Eric Andersen7e9276b2001-02-22 01:15:47 +00003964#define tar_trivial_usage \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00003965 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_SEAMLESS_GZ("z") \
3966 USE_FEATURE_SEAMLESS_BZ2("j") USE_FEATURE_SEAMLESS_LZMA("a") \
3967 USE_FEATURE_SEAMLESS_Z("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003968 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003969 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003970#define tar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003971 "Create, extract, or list files from a tar file\n" \
3972 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003973 USE_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003974 "\n c Create") \
3975 "\n x Extract" \
3976 "\n t List" \
3977 "\nArchive format selection:" \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00003978 USE_FEATURE_SEAMLESS_GZ( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003979 "\n z Filter the archive through gzip" \
3980 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00003981 USE_FEATURE_SEAMLESS_BZ2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003982 "\n j Filter the archive through bzip2" \
3983 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00003984 USE_FEATURE_SEAMLESS_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003985 "\n a Filter the archive through lzma" \
3986 ) \
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +00003987 USE_FEATURE_SEAMLESS_Z( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003988 "\n Z Filter the archive through compress" \
3989 ) \
3990 "\nFile selection:" \
3991 "\n f Name of TARFILE or \"-\" for stdin" \
3992 "\n O Extract to stdout" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003993 USE_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003994 "\n exclude File to exclude" \
3995 "\n X File with names to exclude" \
3996 ) \
3997 "\n C Change to directory DIR before operation" \
3998 "\n v Verbose" \
3999
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004000#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004001 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4002 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004003
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004004#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00004005 "[-p] [mask] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004006#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004007 "Set or get CPU affinity\n" \
4008 "\nOptions:" \
4009 "\n -p Operate on an existing PID" \
4010
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004011#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004012 "$ taskset 0x7 ./dgemm_test&\n" \
4013 "$ taskset -p 0x1 $!\n" \
4014 "pid 4790's current affinity mask: 7\n" \
4015 "pid 4790's new affinity mask: 1\n" \
4016 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
4017 "pid 6671's current affinity mask: 1\n" \
4018 "pid 6671's new affinity mask: 1\n" \
4019 "$ taskset -p 1\n" \
4020 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004021
Eric Andersen7e9276b2001-02-22 01:15:47 +00004022#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004023 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004024#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004025 "Copy standard input to each FILE, and also to standard output\n" \
4026 "\nOptions:" \
4027 "\n -a Append to the given FILEs, do not overwrite" \
4028 "\n -i Ignore interrupt signals (SIGINT)" \
4029
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004030#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004031 "$ echo \"Hello\" | tee /tmp/foo\n" \
4032 "$ cat /tmp/foo\n" \
4033 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004034
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004035#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004036#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004037 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004038#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004039 "Connect to telnet server\n" \
4040 "\nOptions:" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004041 "\n -a Automatic login with $USER variable" \
4042 "\n -l USER Automatic login as USER" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004043
Eric Andersen539ffc92004-02-22 12:25:47 +00004044#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004045#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004046 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004047#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004048 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004049#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004050
Eric Andersen08a72202002-09-30 20:52:10 +00004051#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004052 "[OPTION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004053#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004054 "Handle incoming telnet connections" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004055 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
4056 "\nOptions:" \
4057 "\n -l LOGIN Exec LOGIN on connect" \
4058 "\n -f issue_file Display issue_file instead of /etc/issue" \
4059 "\n -K Close connection as soon as login exits" \
4060 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004061 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004062 "\n -p PORT Port to listen on" \
4063 "\n -b ADDR Address to bind to" \
4064 "\n -F Run in foreground" \
4065 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004066 )
Eric Andersen08a72202002-09-30 20:52:10 +00004067
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004068/* "test --help" does not print help (POSIX compat), only "[ --help" does.
4069 * We display "<applet> EXPRESSION ]" here (not "<applet> EXPRESSION") */
Eric Andersen7e9276b2001-02-22 01:15:47 +00004070#define test_trivial_usage \
Denis Vlasenko84c8daa2008-07-21 08:37:13 +00004071 "EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004072#define test_full_usage "\n\n" \
Denis Vlasenko1101d1c2008-07-21 09:22:28 +00004073 "Check file types, compare values etc. Return a 0/1 exit code\n" \
4074 "depending on logical value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004075#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004076 "$ test 1 -eq 2\n" \
4077 "$ echo $?\n" \
4078 "1\n" \
4079 "$ test 1 -eq 1\n" \
4080 "$ echo $?\n" \
4081 "0\n" \
4082 "$ [ -d /etc ]\n" \
4083 "$ echo $?\n" \
4084 "0\n" \
4085 "$ [ -d /junk ]\n" \
4086 "$ echo $?\n" \
4087 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004088
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004089#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004090 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004091/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004092/* "[-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 +00004093#define tcpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004094 "Create TCP socket, bind it to ip:port and listen\n" \
4095 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004096 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004097 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004098 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004099 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4100 "\n-u user[:group] Change to user/group after bind" \
4101 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004102 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004103 "\n-C n[:msg] Allow only up to n connections from the same IP" \
4104 "\n New connections from this IP address are closed" \
4105 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004106 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004107 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004108 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004109
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004110#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00004111 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004112#define udpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004113 "Create UDP socket, bind it to ip:port and wait\n" \
4114 "for incoming packets. Run PROG for each packet,\n" \
4115 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004116 "\nip IP to listen on. '0' = all" \
4117 "\nport Port to listen on" \
4118 "\nprog [arg] Program to run" \
4119 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4120 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004121 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004122 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004123 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004124 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004125
Mark Whitley450736c2001-03-02 19:08:50 +00004126#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004127 "[OPTION]... HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004128#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004129 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004130 "\nOptions:" \
4131 "\n -l FILE Local FILE" \
4132 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004133 USE_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004134 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004135 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004136 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004137 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004138 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004139 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004140 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004141 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004142
4143#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004144 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004145#define tftpd_full_usage "\n\n" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004146 "Transfer a file on tftp client's request.\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004147 "\nOptions:" \
4148 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004149 "\n -c Allow file creation via upload" \
4150 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004151
Eric Andersenc3657422001-11-30 07:54:32 +00004152#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004153 "[OPTION]... COMMAND [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004154#define time_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004155 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004156 "COMMAND's resource usage information is displayed.\n" \
4157 "\nOptions:" \
4158 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004159
Eric Andersen420b2082002-09-17 22:14:58 +00004160#define top_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004161 "[-b] [-n COUNT] [-d SECONDS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004162#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004163 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004164 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004165 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004166
Eric Andersen7e9276b2001-02-22 01:15:47 +00004167#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004168 "[-c] FILE [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004169#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004170 "Update the last-modified date on the given FILE[s]\n" \
4171 "\nOptions:" \
4172 "\n -c Do not create any files" \
4173
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004174#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004175 "$ ls -l /tmp/foo\n" \
4176 "/bin/ls: /tmp/foo: No such file or directory\n" \
4177 "$ touch /tmp/foo\n" \
4178 "$ ls -l /tmp/foo\n" \
4179 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004180
4181#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004182 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004183#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004184 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004185 "standard input, writing to standard output\n" \
4186 "\nOptions:" \
4187 "\n -c Take complement of STRING1" \
4188 "\n -d Delete input characters coded STRING1" \
4189 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4190
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004191#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004192 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4193 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004194
Eric Andersen5c58d282001-07-10 16:29:00 +00004195#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004196 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4197 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004198 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004199#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004200 "Trace the route to HOST\n" \
4201 "\nOptions:" \
4202 "\n -F Set the don't fragment bit" \
4203 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4204 "\n -l Display the ttl value of the returned packet" \
4205 "\n -d Set SO_DEBUG options to socket" \
4206 "\n -n Print hop addresses numerically rather than symbolically" \
4207 "\n -r Bypass the normal routing tables and send directly to a host" \
4208 "\n -v Verbose" \
4209 "\n -m max_ttl Max time-to-live (max number of hops)" \
4210 "\n -p port# Base UDP port number used in probes" \
4211 "\n (default is 33434)" \
4212 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4213 "\n -s src_addr IP address to use as the source address" \
4214 "\n -t tos Type-of-service in probe packets (default 0)" \
4215 "\n -w wait Time in seconds to wait for a response" \
4216 "\n (default 3 sec)" \
4217 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004218
Eric Andersen7e9276b2001-02-22 01:15:47 +00004219#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004220 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004221#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004222 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004223#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004224 "$ true\n" \
4225 "$ echo $?\n" \
4226 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004227
Eric Andersen7e9276b2001-02-22 01:15:47 +00004228#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004229 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004230#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004231 "Print file name of standard input's terminal" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004232 USE_INCLUDE_SUSv2( "\n" \
4233 "\nOptions:" \
4234 "\n -s Print nothing, only return exit status" \
4235 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004236#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004237 "$ tty\n" \
4238 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004239
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004240#define ttysize_trivial_usage \
4241 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004242#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004243 "Print dimension(s) of standard input's terminal, on error return 80x25"
4244
Mike Frysinger174808c2005-06-11 01:14:09 +00004245#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004246 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4247 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4248 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4249 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4250 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4251 "[-T last-check-time] [-U UUID] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004252#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004253 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004254
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004255#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004256 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004257 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004258#define udhcpc_full_usage "\n\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004259 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004260 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004261 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4262 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4263 "\n -c,--clientid=CLIENTID Client identifier" \
4264 "\n -C,--clientid-none Suppress default client identifier" \
4265 "\n -p,--pidfile=file Create pidfile" \
4266 "\n -r,--request=IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004267 "\n -s,--script=file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004268 "\n -t,--retries=N Send up to N request packets" \
4269 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4270 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004271 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4272 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004273 "\n -f,--foreground Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004274 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004275 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004276 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004277 "\n -S,--syslog Log to syslog too" \
4278 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4279 "\n -q,--quit Quit after obtaining lease" \
4280 "\n -R,--release Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004281 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004282 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004283 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004284 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004285 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004286 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004287 ) \
4288 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004289 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004290 "\n -i INTERFACE Interface to use (default: eth0)" \
4291 "\n -H,-h HOSTNAME Client hostname" \
4292 "\n -c CLIENTID Client identifier" \
4293 "\n -C Suppress default client identifier" \
4294 "\n -p file Create pidfile" \
4295 "\n -r IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004296 "\n -s file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004297 "\n -t N Send up to N request packets" \
4298 "\n -T N Try to get a lease for N seconds (default 3)" \
4299 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004300 "\n -O OPT Request DHCP option OPT (cumulative)" \
4301 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004302 "\n -f Run in foreground" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004303 USE_FOR_MMU( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004304 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko21765fa2008-06-13 20:44:05 +00004305 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00004306 "\n -S Log to syslog too" \
4307 "\n -n Exit with failure if lease is not immediately obtained" \
4308 "\n -q Quit after obtaining lease" \
4309 "\n -R Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004310 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004311 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004312 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004313 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004314 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004315 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004316 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004317
Russ Dill61fb4892002-10-14 21:41:28 +00004318#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004319 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004320
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004321#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004322 "DHCP server\n" \
4323 "\n -f Run in foreground" \
4324 "\n -S Log to syslog too" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004325 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004326 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004327 )
Russ Dill61fb4892002-10-14 21:41:28 +00004328
Eric Andersen7e9276b2001-02-22 01:15:47 +00004329#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004330 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004331#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004332 "Unmount file systems\n" \
4333 "\nOptions:" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004334 USE_FEATURE_UMOUNT_ALL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004335 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
4336 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004337 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004338 "\n -n Don't erase /etc/mtab entries" \
4339 ) \
4340 "\n -r Try to remount devices as read-only if mount is busy" \
4341 "\n -l Lazy umount (detach filesystem)" \
4342 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004343 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004344 "\n -d Free loop device if it has been used" \
4345 )
4346
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004347#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004348 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004349
4350#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004351 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004352#define uname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004353 "Print system information.\n" \
4354 "\nOptions:" \
4355 "\n -a Print all" \
4356 "\n -m The machine (hardware) type" \
4357 "\n -n Hostname" \
4358 "\n -r OS release" \
4359 "\n -s OS name (default)" \
4360 "\n -p Processor type" \
4361 "\n -v OS version" \
4362
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004363#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004364 "$ uname -a\n" \
4365 "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 +00004366
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004367#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004368 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004369#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004370 "Uncompress .Z file[s]\n" \
4371 "\nOptions:" \
4372 "\n -c Extract to stdout" \
4373 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004374
Denis Vlasenko3952f202007-08-13 14:10:24 +00004375#define unexpand_trivial_usage \
4376 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004377#define unexpand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004378 "Convert spaces to tabs, writing to standard output.\n" \
4379 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004380 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004381 "\n -a,--all Convert all blanks" \
4382 "\n -f,--first-only Convert only leading blanks" \
4383 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004384 ) \
4385 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004386 "\n -a Convert all blanks" \
4387 "\n -f Convert only leading blanks" \
4388 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004389 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004390
Eric Andersen7e9276b2001-02-22 01:15:47 +00004391#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004392 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004393#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004394 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004395 "\nOptions:" \
4396 "\n -c Prefix lines by the number of occurrences" \
4397 "\n -d Only print duplicate lines" \
4398 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004399 "\n -f N Skip first N fields" \
4400 "\n -s N Skip first N chars (after any skipped fields)" \
4401 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004402
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004403#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004404 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4405 "a\n" \
4406 "b\n" \
4407 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004408
4409#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004410 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004411#define unix2dos_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004412 "Convert FILE from unix to dos format.\n" \
4413 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004414 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004415 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004416 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004417
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004418#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004419 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004420#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004421 "Extract files from ZIP archives\n" \
4422 "\nOptions:" \
4423 "\n -l List archive contents (with -q for short form)" \
4424 "\n -n Never overwrite existing files (default)" \
4425 "\n -o Overwrite files without prompting" \
4426 "\n -p Send output to stdout" \
4427 "\n -q Quiet" \
4428 "\n -x Exclude these files" \
4429 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004430
Eric Andersen7e9276b2001-02-22 01:15:47 +00004431#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004432 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004433#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004434 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004435
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004436#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004437 "$ uptime\n" \
4438 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004439
4440#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004441 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004442#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004443 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004444
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004445#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004446 "$ usleep 1000000\n" \
4447 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004448
4449#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004450 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004451#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004452 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004453 "Finds outfile name in uuencoded source unless -o is given"
4454
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004455#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004456 "$ uudecode -o busybox busybox.uu\n" \
4457 "$ ls -l busybox\n" \
4458 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004459
4460#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004461 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004462#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004463 "Uuencode a file to stdout\n" \
4464 "\nOptions:" \
4465 "\n -m Use base64 encoding per RFC1521" \
4466
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004467#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004468 "$ uuencode busybox busybox\n" \
4469 "begin 755 busybox\n" \
4470 "<encoded file snipped>\n" \
4471 "$ uudecode busybox busybox > busybox.uu\n" \
4472 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004473
Eric Andersen853c4942003-01-23 05:59:32 +00004474#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004475 "COMMAND [OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004476#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004477 "Create and remove virtual ethernet devices\n" \
4478 "\nOptions:" \
4479 "\n add [interface-name] [vlan_id]" \
4480 "\n rem [vlan-name]" \
4481 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4482 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4483 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4484 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004485
Eric Andersen3f980402001-04-04 17:31:15 +00004486#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004487 "[OPTION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004488#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004489 "Edit FILE\n" \
4490 "\nOptions:" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004491 USE_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004492 "\n -c Initial command to run ($EXINIT also available)") \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004493 USE_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004494 "\n -R Read-only - do not write to the file") \
4495 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004496
Eric Andersen27f64e12002-06-23 04:24:25 +00004497#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004498 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004499#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004500 "Lock a virtual terminal. A password is required to unlock.\n" \
4501 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004502 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004503
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004504#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004505 "[-n seconds] [-t] COMMAND..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004506#define watch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004507 "Execute a program periodically\n" \
4508 "\nOptions:" \
4509 "\n -n Loop period in seconds (default 2)" \
4510 "\n -t Don't print header" \
4511
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004512#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004513 "$ watch date\n" \
4514 "Mon Dec 17 10:31:40 GMT 2000\n" \
4515 "Mon Dec 17 10:31:42 GMT 2000\n" \
4516 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004517
Eric Andersen7e9276b2001-02-22 01:15:47 +00004518#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004519 "[-t N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004520#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004521 "Periodically write to watchdog device DEV\n" \
4522 "\nOptions:" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004523 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004524 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004525 "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004526 "\nUse -t 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004527
4528#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004529 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004530#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004531 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004532 "more than one FILE is specified. With no FILE, read standard input.\n" \
4533 "\nOptions:" \
4534 "\n -c Print the byte counts" \
4535 "\n -l Print the newline counts" \
4536 "\n -L Print the length of the longest line" \
4537 "\n -w Print the word counts" \
4538
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004539#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004540 "$ wc /etc/passwd\n" \
4541 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004542
4543#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004544 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004545 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004546 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4547 " [-U|--user-agent agent] url" \
4548 ) \
4549 SKIP_GETOPT_LONG( \
4550 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4551 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004552#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004553 "Retrieve files via HTTP or FTP\n" \
4554 "\nOptions:" \
4555 "\n -s Spider mode - only check file existence" \
4556 "\n -c Continue retrieval of aborted transfer" \
4557 "\n -q Quiet" \
4558 "\n -P Set directory prefix to DIR" \
4559 "\n -O Save to filename ('-' for stdout)" \
4560 "\n -U Adjust 'User-Agent' field" \
4561 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004562
4563#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004564 "[COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004565#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004566 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004567#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004568 "$ which login\n" \
4569 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004570
Eric Andersen00a6a752002-04-26 23:53:10 +00004571#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004572 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004573#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004574 "Show who is logged on\n" \
4575 "\nOptions:" \
4576 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004577
4578#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004579 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004580#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004581 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004582
4583#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004584 "[OPTIONS] [COMMAND] [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004585#define xargs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004586 "Execute COMMAND on every item given by standard input\n" \
4587 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004588 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004589 "\n -p Ask user whether to run each command") \
4590 "\n -r Do not run command if input is empty" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004591 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenkoc45b5392008-08-03 19:20:25 +00004592 "\n -0 Input is separated by NUL characters") \
4593 "\n -t Print the command on stderr before execution" \
4594 "\n -e[STR] STR stops input processing (default _)" \
4595 "\n -n N Pass no more than N args to COMMAND" \
4596 "\n -s N Pass command line of no more than N bytes" \
4597 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4598 "\n -x Exit if size is exceeded") \
Denis Vlasenko397de612008-03-17 08:55:44 +00004599
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004600#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004601 "$ ls | xargs gzip\n" \
4602 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004603
4604#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004605 "[OPTION]... [STRING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004606#define yes_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004607 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004608
Eric Andersen7e9276b2001-02-22 01:15:47 +00004609#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004610 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004611#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004612 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004613
Rob Landleyad8071f2005-04-30 03:49:37 +00004614#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004615 "[OPTIONS] ifname script"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004616#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004617 "Manage a ZeroConf IPv4 link-local address\n" \
4618 "\nOptions:" \
4619 "\n -f Run in foreground" \
4620 "\n -q Quit after address (no daemon)" \
4621 "\n -r 169.254.x.x Request this address first" \
4622 "\n -v Verbose" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004623
Eric Andersen178de172004-04-06 16:36:20 +00004624#endif /* __BB_USAGE_H__ */