blob: e9943d53903659a8a0439dc0d96550427e66d8ec [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 Vlasenko1fffe382006-11-28 00:06:39 +0000368 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
369 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
370 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000371#define chpst_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000372 "Change the process state and run specified program\n" \
373 "\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" \
379 "\n -n INC Add INC to nice value" \
380 "\n -m BYTES Limit data segment, stack segment, locked physical pages," \
381 "\n and total of all segment per process to BYTES each" \
382 "\n -d BYTES Limit data segment" \
383 "\n -o N Limit the number of open file descriptors per process to N" \
384 "\n -p N Limit number of processes per uid to N" \
385 "\n -f BYTES Limit output file size to BYTES" \
386 "\n -c BYTES Limit core file size to BYTES" \
387 "\n -v Verbose" \
388 "\n -P Run prog in a new process group" \
389 "\n -0 Close standard input" \
390 "\n -1 Close standard output" \
391 "\n -2 Close standard error" \
392
Denis Vlasenkofe544582006-10-03 15:57:40 +0000393#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000394 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000395#define setuidgid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000396 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
397 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000398#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000399 "account prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000400#define envuidgid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000401 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000402#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000403 "dir prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000404#define envdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000405 "Set various environment variables as specified by files\n" \
406 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000407#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000408 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
409 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
410 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000411#define softlimit_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000412 "Set soft resource limits, then run prog\n" \
413 "\nOptions:" \
414 "\n -m n Same as -d n -s n -l n -a n" \
415 "\n -d n Limit the data segment per process to n bytes" \
416 "\n -s n Limit the stack segment per process to n bytes" \
417 "\n -l n Limit the locked physical pages per process to n bytes" \
418 "\n -a n Limit the total of all segments per process to n bytes" \
419 "\n -o n Limit the number of open file descriptors per process to n" \
420 "\n -p n Limit the number of processes per uid to n" \
421 "\nOptions controlling file sizes:" \
422 "\n -f n Limit output file sizes to n bytes" \
423 "\n -c n Limit core file sizes to n bytes" \
424 "\nEfficiency opts:" \
425 "\n -r n Limit the resident set size to n bytes. This limit is not" \
426 "\n enforced unless physical memory is full" \
427 "\n -t n Limit the CPU time to n seconds. This limit is not enforced" \
428 "\n except that the process receives a SIGXCPU signal after n seconds" \
429 "\n" \
430 "\nSome options may have no effect on some operating systems" \
431 "\nn may be =, indicating that soft limit should be set equal to hard limit" \
Denis Vlasenkofe544582006-10-03 15:57:40 +0000432
Eric Andersen7e9276b2001-02-22 01:15:47 +0000433#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000434 "NEWROOT [COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000435#define chroot_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000436 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000437#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000438 "$ ls -l /bin/ls\n" \
439 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
440 "# mount /dev/hdc1 /mnt -t minix\n" \
441 "# chroot /mnt\n" \
442 "# ls -l /bin/ls\n" \
443 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000444
Eric Andersen7e9276b2001-02-22 01:15:47 +0000445#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000446 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000447#define chvt_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000448 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000449
Rob Landley856489b2006-04-18 20:57:28 +0000450#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000451 "FILES..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000452#define cksum_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000453 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000454
Eric Andersen7e9276b2001-02-22 01:15:47 +0000455#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000456 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000457#define clear_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000458 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000459
Eric Andersen7e9276b2001-02-22 01:15:47 +0000460#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000461 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000462#define cmp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000463 "Compares FILE1 vs stdin if FILE2 is not specified\n" \
464 "\nOptions:" \
465 "\n -l Write the byte numbers (decimal) and values (octal)" \
466 "\n for all differing bytes" \
467 "\n -s Quiet" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000468
Rob Landley2acfd7b2005-05-11 23:12:49 +0000469#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000470 "[-123] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000471#define comm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000472 "Compare FILE1 to FILE2, or to stdin if - is specified\n" \
473 "\nOptions:" \
474 "\n -1 Suppress lines unique to FILE1" \
475 "\n -2 Suppress lines unique to FILE2" \
476 "\n -3 Suppress lines common to both files" \
Rob Landley2acfd7b2005-05-11 23:12:49 +0000477
Paul Fox79c142d2005-08-01 16:04:40 +0000478#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000479 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000480#define bbconfig_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000481 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000482
Rob Landley69674942006-09-11 00:34:01 +0000483#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000484 "[FILE]...\n" \
485 "or: bbsh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000486#define bbsh_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000487 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000488
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000489#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000490 "[OPTION]... [prio] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000491#define chrt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000492 "Manipulate real-time attributes of a process\n" \
493 "\nOptions:" \
494 "\n -p Operate on pid" \
495 "\n -r Set scheduling policy to SCHED_RR" \
496 "\n -f Set scheduling policy to SCHED_FIFO" \
497 "\n -o Set scheduling policy to SCHED_OTHER" \
498 "\n -m Show min and max priorities" \
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000499
500#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000501 "$ chrt -r 4 sleep 900; x=$!\n" \
502 "$ chrt -f -p 3 $x\n" \
503 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000504
Eric Andersen7e9276b2001-02-22 01:15:47 +0000505#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000506 "[OPTION]... SOURCE DEST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000507#define cp_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000508 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY\n" \
509 "\nOptions:" \
510 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000511 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000512 "\n -c Preserve security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000513 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000514 "\n -d,-P Preserve links" \
515 "\n -H,-L Dereference all symlinks (default)" \
516 "\n -p Preserve file attributes if possible" \
517 "\n -f Force overwrite" \
518 "\n -i Prompt before overwrite" \
519 "\n -R,-r Recurse directories" \
520 "\n -l,-s Create (sym)links" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000521
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000522#define cpio_trivial_usage \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000523 "-[dim" USE_FEATURE_CPIO_O("o") "tuv][F cpiofile]" \
Denis Vlasenko1f228982008-04-22 00:16:29 +0000524 USE_FEATURE_CPIO_O( "[H newc]" )
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000525#define cpio_full_usage "\n\n" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000526 "Extract or list files from a cpio archive" \
527 USE_FEATURE_CPIO_O( ", or create a cpio archive" ) \
528 "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000529 "Main operation mode:" \
530 "\n d Make leading directories" \
531 "\n i Extract" \
532 "\n m Preserve mtime" \
Denis Vlasenko261f2372008-04-05 00:07:46 +0000533 USE_FEATURE_CPIO_O( \
534 "\n o Create" \
535 "\n H newc Define format" \
536 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000537 "\n t List" \
538 "\n v Verbose" \
539 "\n u Unconditional overwrite" \
540 "\n F Input from file" \
Tim Riker7b253f82003-12-28 05:02:40 +0000541
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000542#define crond_trivial_usage \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000543 "-fbS -l N " USE_DEBUG_CROND_OPTION("-d N ") "-L LOGFILE -c DIR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000544#define crond_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000545 " -f Foreground" \
546 "\n -b Background (default)" \
547 "\n -S Log to syslog (default)" \
548 "\n -l Set log level. 0 is the most verbose, default 8" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000549 USE_DEBUG_CROND_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000550 "\n -d Set log level, log to stderr" \
Denis Vlasenko4e6c8122008-03-12 22:10:25 +0000551 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000552 "\n -L Log to file" \
553 "\n -c Working dir" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000554
555#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000556 "[-c DIR] [-u USER] [-ler]|[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000557#define crontab_full_usage "\n\n" \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000558 " -c Crontab directory" \
559 "\n -u User" \
560 "\n -l List crontab" \
561 "\n -e Edit crontab" \
562 "\n -r Delete crontab" \
563 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000564
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000565#define cryptpw_trivial_usage \
566 "[-a des|md5] [string]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000567#define cryptpw_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000568 "Output crypted string.\n" \
569 "If string isn't supplied on cmdline, read it from stdin.\n" \
570 "\nOptions:" \
571 "\n -a Algorithm to use (default: md5)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000572
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000573#define cttyhack_trivial_usage NOUSAGE_STR
574#define cttyhack_full_usage ""
575
Eric Andersen7e9276b2001-02-22 01:15:47 +0000576#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000577 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000578#define cut_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000579 "Print selected fields from each input FILE to standard output\n" \
580 "\nOptions:" \
581 "\n -b LIST Output only bytes from LIST" \
582 "\n -c LIST Output only characters from LIST" \
583 "\n -d CHAR Use CHAR instead of tab as the field delimiter" \
584 "\n -s Output only the lines containing delimiter" \
585 "\n -f N Print only these fields" \
586 "\n -n Ignored" \
587
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000588#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000589 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
590 "Hello\n" \
591 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
592 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000593
Eric Andersen7e9276b2001-02-22 01:15:47 +0000594#define date_trivial_usage \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000595 "[OPTION]... [+FMT] [TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000596#define date_full_usage "\n\n" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000597 "Display time (using +FMT), or set time\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000598 "\nOptions:" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000599 "\n -u Work in UTC (don't convert to local time)" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000600 "\n -R Output RFC-822 compliant date string" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000601 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000602 "\n -I[SPEC] Output ISO-8601 compliant date string" \
603 "\n SPEC='date' (default) for date only," \
Denis Vlasenko397de612008-03-17 08:55:44 +0000604 "\n 'hours', 'minutes', or 'seconds' for date and" \
605 "\n time to the indicated precision" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000606 ) \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000607 "\n -d TIME Display TIME, not 'now'" \
608 "\n -r FILE Display last modification time of FILE" \
609 "\n [-s] TIME Set time to TIME" \
610 USE_FEATURE_DATE_ISOFMT( \
611 "\n -D FMT Use FMT for str->date conversion" \
612 ) \
613 "\n" \
614 "\nRecognized formats for TIME:" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000615 "\n hh:mm[:ss]" \
Denis Vlasenkofa076d42008-03-25 02:49:11 +0000616 "\n [YYYY.]MM.DD-hh:mm[:ss]" \
Denis Vlasenko4d89a8b2008-04-25 02:14:07 +0000617 "\n YYYY-MM-DD hh:mm[:ss]" \
Denis Vlasenko9ce4ae82008-03-25 02:43:34 +0000618 "\n MMDDhhmm[[YY]YY][.ss]" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000619
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000620#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000621 "$ date\n" \
622 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000623
Eric Andersen7e9276b2001-02-22 01:15:47 +0000624#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000625 "expression..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000626#define dc_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +0000627 "Tiny RPN calculator. Operations:\n" \
628 "+, add, -, sub, *, mul, /, div, %, mod, **, exp, and, or, not, eor,\n" \
629 "p - print top of the stack (without altering the stack),\n" \
630 "f - print entire stack, o - pop the value and set output radix\n" \
631 "(value must be 10 or 16).\n" \
632 "Examples: 'dc 2 2 add' -> 4, 'dc 8 8 * 2 2 + /' -> 16.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000633
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000634#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000635 "$ dc 2 2 + p\n" \
636 "4\n" \
637 "$ dc 8 8 \\* 2 2 + / p\n" \
638 "16\n" \
639 "$ dc 0 1 and p\n" \
640 "0\n" \
641 "$ dc 0 1 or p\n" \
642 "1\n" \
643 "$ echo 72 9 div 8 mul p | dc\n" \
644 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000645
Eric Andersen7e9276b2001-02-22 01:15:47 +0000646#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000647 "[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 +0000648 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync|fsync]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000649#define dd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000650 "Copy a file with converting and formatting\n" \
651 "\nOptions:" \
652 "\n if=FILE Read from FILE instead of stdin" \
653 "\n of=FILE Write to FILE instead of stdout" \
654 "\n bs=N Read and write N bytes at a time" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000655 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000656 "\n ibs=N Read N bytes at a time" \
657 ) \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000658 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000659 "\n obs=N Write N bytes at a time" \
660 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000661 "\n count=N Copy only N input blocks" \
662 "\n skip=N Skip N input blocks" \
663 "\n seek=N Skip N output blocks" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000664 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000665 "\n conv=notrunc Don't truncate output file" \
666 "\n conv=noerror Continue after read errors" \
Denis Vlasenko643dcf02008-04-07 21:11:23 +0000667 "\n conv=sync Pad blocks with zeros" \
668 "\n conv=fsync Physically write data out before finishing" \
669 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000670 "\n" \
671 "\nNumbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024)," \
672 "\nMD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" \
673
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000674#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000675 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
676 "4+0 records in\n" \
677 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000678
Eric Andersen7e9276b2001-02-22 01:15:47 +0000679#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000680 "[N]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000681#define deallocvt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000682 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000683
Eric Andersenf349e972001-08-21 16:18:59 +0000684#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000685 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000686#define delgroup_full_usage "\n\n" \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000687 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000688 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000689
690#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000691 "USER"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000692#define deluser_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000693 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000694
Bernhard Reutner-Fischer55e547e2008-05-26 12:01:49 +0000695#define depmod_trivial_usage \
696 ""
697#define depmod_full_usage \
698 "\n" \
699 "\n"
700
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000701#define devfsd_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +0000702 "mntpnt [-v]" USE_DEVFSD_FG_NP("[-fg][-np]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000703#define devfsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000704 "Manage devfs permissions and old device name symlinks\n" \
705 "\nOptions:" \
706 "\n mntpnt The mount point where devfs is mounted" \
707 "\n -v Print the protocol version numbers for devfsd" \
708 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000709 USE_DEVFSD_FG_NP( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000710 "\n -fg Run in foreground" \
711 "\n -np Exit after parsing the configuration file" \
712 "\n and processing synthetic REGISTER events," \
713 "\n do not poll for events" \
714 )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000715
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000716/* -k is accepted but ignored for !HUMAN_READABLE,
717 * but we won't mention this (unimportant) */
718#if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
719#define DF_HAS_OPTIONS(x) x
720#else
721#define DF_HAS_OPTIONS(x)
722#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000723#define df_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000724 DF_HAS_OPTIONS("[-") \
725 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
726 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000727#define df_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000728 "Print filesystem usage statistics\n" \
729 DF_HAS_OPTIONS("\nOptions:") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000730 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000731 "\n -h Human readable (e.g. 1K 243M 2G)" \
732 "\n -m 1024*1024 blocks" \
733 "\n -k 1024 blocks" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000734 ) \
735 USE_FEATURE_DF_INODE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000736 "\n -i Inodes" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000737 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000738#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000739 "$ df\n" \
740 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
741 "/dev/sda3 8690864 8553540 137324 98% /\n" \
742 "/dev/sda1 64216 36364 27852 57% /boot\n" \
743 "$ df /dev/sda3\n" \
744 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
745 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000746
Denis Vlasenko736230e2006-11-20 19:40:36 +0000747#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000748 "[client_device_list] [server_device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000749#define dhcprelay_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000750 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000751
752#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000753 "[client_device_list] [server_device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000754#define dhcprelay_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000755 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000756
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000757#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000758 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000759#define diff_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000760 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000761 "This implementation supports unified diffs only.\n" \
762 "\nOptions:" \
763 "\n -a Treat all files as text" \
764 "\n -b Ignore changes in the amount of whitespace" \
765 "\n -d Try hard to find a smaller set of changes" \
766 "\n -i Ignore case differences" \
767 "\n -L Use LABEL instead of the filename in the unified header" \
768 "\n -N Treat absent files as empty" \
769 "\n -q Output only whether files differ" \
770 "\n -r Recursively compare subdirectories" \
771 "\n -S Start with FILE when comparing directories" \
772 "\n -T Make tabs line up by prefixing a tab when necessary" \
773 "\n -s Report when two files are the same" \
774 "\n -t Expand tabs to spaces in output" \
775 "\n -U Output LINES lines of context" \
776 "\n -w Ignore all whitespace" \
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000777
Eric Andersen7e9276b2001-02-22 01:15:47 +0000778#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000779 "FILENAME"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000780#define dirname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000781 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000782#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000783 "$ dirname /tmp/foo\n" \
784 "/tmp\n" \
785 "$ dirname /tmp/foo/\n" \
786 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000787
Eric Andersen7e9276b2001-02-22 01:15:47 +0000788#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000789 "[-c] [-n LEVEL] [-s SIZE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000790#define dmesg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000791 "Print or control the kernel ring buffer\n" \
792 "\nOptions:" \
793 "\n -c Clear ring buffer after printing" \
794 "\n -n LEVEL Set console logging level" \
795 "\n -s SIZE Buffer size" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000796
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000797#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000798 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000799#define dnsd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000800 "Small static DNS server daemon\n" \
801 "\nOptions:" \
802 "\n -c Config filename" \
803 "\n -t TTL in seconds" \
804 "\n -p Listening port" \
805 "\n -i Listening ip (default all)" \
806 "\n -d Daemonize" \
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000807
Eric Andersen7e9276b2001-02-22 01:15:47 +0000808#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000809 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000810#define dos2unix_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000811 "Convert FILE from dos to unix format.\n" \
812 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +0000813 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +0000814 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000815 "\n -d unix2dos" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000816
Eric Andersen7e9276b2001-02-22 01:15:47 +0000817#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000818 "[-ilCPru] [-F option] package_name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000819#define dpkg_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000820 "Install, remove and manage Debian packages\n" \
821 "\nOptions:" \
822 "\n -i Install the package" \
823 "\n -l List of installed packages" \
824 "\n -C Configure an unpackaged package" \
825 "\n -F depends Ignore dependency problems" \
826 "\n -P Purge all files of a package" \
827 "\n -r Remove all but the configuration files for a package" \
828 "\n -u Unpack a package, but don't configure it" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000829
Eric Andersen7e9276b2001-02-22 01:15:47 +0000830#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000831 "[-cefxX] FILE [argument]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000832#define dpkg_deb_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000833 "Perform actions on Debian packages (.debs)\n" \
834 "\nOptions:" \
835 "\n -c List contents of filesystem tree" \
836 "\n -e Extract control files to [argument] directory" \
837 "\n -f Display control field name starting with [argument]" \
838 "\n -x Extract packages filesystem tree to directory" \
839 "\n -X Verbose extract" \
840
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000841#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000842 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000843
Eric Andersen7e9276b2001-02-22 01:15:47 +0000844#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000845 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000846#define du_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000847 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000848 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000849 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
850 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko397de612008-03-17 08:55:44 +0000851 " bytes.\n" \
852 "\nOptions:" \
853 "\n -a Show file sizes too" \
854 "\n -H Follow symlinks on command line" \
855 "\n -L Follow all symlinks" \
856 "\n -d N Limit output to directories (and files with -a) of depth < N" \
857 "\n -c Show grand total" \
858 "\n -l Count sizes many times if hard linked" \
859 "\n -s Display only a total for each argument" \
860 "\n -x Skip directories on different filesystems" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000861 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000862 "\n -h Sizes in human readable format (e.g., 1K 243M 2G )" \
863 "\n -m Sizes in megabytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000864 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +0000865 "\n -k Sizes in kilobytes" \
866 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)") \
867
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000868#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000869 "$ du\n" \
870 "16 ./CVS\n" \
871 "12 ./kernel-patches/CVS\n" \
872 "80 ./kernel-patches\n" \
873 "12 ./tests/CVS\n" \
874 "36 ./tests\n" \
875 "12 ./scripts/CVS\n" \
876 "16 ./scripts\n" \
877 "12 ./docs/CVS\n" \
878 "104 ./docs\n" \
879 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000880
Eric Andersen7e9276b2001-02-22 01:15:47 +0000881#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000882 "> keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000883#define dumpkmap_full_usage "\n\n" \
Bernhard Reutner-Fischerae4342c2008-05-19 08:18:50 +0000884 "Print a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000885#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000886 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000887
Russ Dill61fb4892002-10-14 21:41:28 +0000888#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000889 "[-r|-a] [-f LEASEFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000890#define dumpleases_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000891 "Display DHCP leases granted by udhcpd\n" \
892 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000893 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000894 "\n -f,--file=FILE Leases file to load" \
895 "\n -r,--remaining Interpret lease times as time remaining" \
896 "\n -a,--absolute Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000897 ) \
898 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000899 "\n -f FILE Leases file to load" \
900 "\n -r Interpret lease times as time remaining" \
901 "\n -a Interpret lease times as expire time" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000902 )
Russ Dill61fb4892002-10-14 21:41:28 +0000903
Mike Frysinger51a43b42005-09-24 07:11:16 +0000904#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000905 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
906 "[-I inode_buffer_blocks] [-P process_inode_size] " \
907 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
908 "[-E extended-options] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000909#define e2fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000910 "Check ext2/ext3 file system\n" \
911 "\nOptions:" \
912 "\n -p Automatic repair (no questions)" \
913 "\n -n Make no changes to the filesystem" \
914 "\n -y Assume 'yes' to all questions" \
915 "\n -c Check for bad blocks and add them to the badblock list" \
916 "\n -f Force checking even if filesystem is marked clean" \
917 "\n -v Verbose" \
918 "\n -b superblock Use alternative superblock" \
919 "\n -B blocksize Force blocksize when looking for superblock" \
920 "\n -j journal Set location of the external journal" \
921 "\n -l file Add to badblocks list" \
922 "\n -L file Set badblocks list" \
Mike Frysinger51a43b42005-09-24 07:11:16 +0000923
Eric Andersen7e9276b2001-02-22 01:15:47 +0000924#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000925 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000926#define echo_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000927 "Print the specified ARGs to stdout" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000928 USE_FEATURE_FANCY_ECHO( "\n" \
929 "\nOptions:" \
930 "\n -n Suppress trailing newline" \
931 "\n -e Interpret backslash-escaped characters (i.e., \\t=tab)" \
932 "\n -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000933 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000934#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000935 "$ echo \"Erik is cool\"\n" \
936 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000937 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000938 "Erik\n" \
939 "is\n" \
940 "cool\n" \
941 "$ echo \"Erik\\nis\\ncool\"\n" \
942 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000943
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000944#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000945 "[-t] [-T] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000946#define eject_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000947 "Eject specified DEVICE (or default /dev/cdrom)\n" \
948 "\nOptions:" \
949 USE_FEATURE_EJECT_SCSI( \
950 "\n -s SCSI device" \
951 ) \
952 "\n -t Close tray" \
953 "\n -T Open/close tray (toggle)" \
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000954
Rob Landley3b890392006-05-04 20:56:43 +0000955#define ed_trivial_usage ""
956#define ed_full_usage ""
957
Eric Andersen84e229c2001-03-29 22:48:33 +0000958#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000959 "[-iu] [-] [name=value]... [command]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000960#define env_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000961 "Print the current environment or run a program after setting\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000962 "up the specified environment\n" \
963 "\nOptions:" \
964 "\n -, -i Start with an empty environment" \
965 "\n -u Remove variable from the environment" \
Eric Andersen84e229c2001-03-29 22:48:33 +0000966
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000967#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000968 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000969#define ether_wake_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000970 "Send a magic packet to wake up sleeping machines.\n" \
971 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000972 "a hostname with a known 'ethers' entry.\n" \
973 "\nOptions:" \
974 "\n -b Send wake-up packet to the broadcast address" \
975 "\n -i iface Interface to use (default eth0)" \
976 "\n -p pass Append four or six byte password PW to the packet" \
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000977
Denis Vlasenko3952f202007-08-13 14:10:24 +0000978#define expand_trivial_usage \
979 "[-i] [-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000980#define expand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000981 "Convert tabs to spaces, writing to standard output.\n" \
982 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000983 USE_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000984 "\n -i,--initial Do not convert tabs after non blanks" \
985 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000986 ) \
987 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +0000988 "\n -i Do not convert tabs after non blanks" \
989 "\n -t Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000990 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000991
Eric Andersen7e9276b2001-02-22 01:15:47 +0000992#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000993 "EXPRESSION"
Denis Vlasenko4f98e192008-04-13 22:12:19 +0000994#define expr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +0000995 "Print the value of EXPRESSION to standard output.\n" \
996 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000997 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000998 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
999 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
1000 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
1001 " ARG1 <= ARG2\n" \
1002 " ARG1 = ARG2\n" \
1003 " ARG1 != ARG2\n" \
1004 " ARG1 >= ARG2\n" \
1005 " ARG1 > ARG2\n" \
1006 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
1007 " ARG1 - ARG2\n" \
1008 " ARG1 * ARG2\n" \
1009 " ARG1 / ARG2\n" \
1010 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001011 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
1012 " match STRING REGEXP Same as STRING : REGEXP\n" \
1013 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
1014 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
1015 " length STRING Length of STRING\n" \
1016 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001017 " it is a keyword like 'match' or an\n" \
1018 " operator like '/'\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001019 " (EXPRESSION) Value of EXPRESSION\n" \
1020 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001021 "Beware that many operators need to be escaped or quoted for shells.\n" \
1022 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001023 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001024 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
1025 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001026
Mike Frysingerfa69f112005-04-17 07:24:19 +00001027#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +00001028 "[-fiw] [-b ADDR] [STRING]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001029#define fakeidentd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001030 "Provide fake ident (auth) service\n" \
1031 "\nOptions:" \
1032 "\n -f Run in foreground" \
1033 "\n -i Inetd mode" \
1034 "\n -w Inetd 'wait' mode" \
1035 "\n -b ADDR Bind to specified address" \
1036 "\n STRING Ident answer string (default is 'nobody')" \
Mike Frysingerfa69f112005-04-17 07:24:19 +00001037
Eric Andersen7e9276b2001-02-22 01:15:47 +00001038#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001039 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001040#define false_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001041 "Return an exit code of FALSE (1)"
Denis Vlasenko85c24712008-03-17 09:04:04 +00001042
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001043#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001044 "$ false\n" \
1045 "$ echo $?\n" \
1046 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001047
1048#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001049 "[options] [mode]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001050#define fbset_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001051 "Show and modify frame buffer settings"
Denis Vlasenko397de612008-03-17 08:55:44 +00001052
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001053#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001054 "$ fbset\n" \
1055 "mode \"1024x768-76\"\n" \
1056 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
1057 " geometry 1024 768 1024 768 16\n" \
1058 " timings 12714 128 32 16 4 128 4\n" \
1059 " accel false\n" \
1060 " rgba 5/11,6/5,5/0,0/0\n" \
1061 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001062
Eric Andersen7e9276b2001-02-22 01:15:47 +00001063#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001064 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001065#define fdflush_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001066 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001067
Eric Andersen01c3d402003-07-05 07:51:31 +00001068#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001069 "[-n] DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001070#define fdformat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001071 "Format floppy disk\n" \
1072 "\nOptions:" \
1073 "\n -n Don't verify after format" \
Eric Andersen01c3d402003-07-05 07:51:31 +00001074
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001075/* Looks like someone forgot to add this to config system */
1076#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
1077# define ENABLE_FEATURE_FDISK_BLKSIZE 0
1078# define USE_FEATURE_FDISK_BLKSIZE(a)
1079#endif
1080
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001081#define fdisk_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001082 "[-ul" USE_FEATURE_FDISK_BLKSIZE("s") "] " \
1083 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001084#define fdisk_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001085 "Change partition table\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001086 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001087 "\n -u Start and End are in sectors (instead of cylinders)" \
1088 "\n -l Show partition table for each DISK, then exit" \
1089 USE_FEATURE_FDISK_BLKSIZE( \
1090 "\n -s Show partition sizes in kb for each DISK, then exit" \
1091 ) \
1092 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
1093 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
1094 "\n -H HEADS\n" \
1095 "\n -S SECTORS" \
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001096
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001097#define fetchmail_trivial_usage \
Denis Vlasenko17db1a92008-02-26 21:13:17 +00001098 "[-w timeout] [-U user] -P password [-X] [-t] [-z] server[:port] maildir [prog]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001099#define fetchmail_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001100 "Fetch content of remote mailbox to local Maildir.\n" \
1101 "\nOptions:" \
1102 "\n -w timeout Set timeout on network operations" \
1103 "\n -U username Authenticate with specified username/password" \
1104 "\n -P password" \
1105 "\n -X Use openssl connection helper for secured servers" \
1106 "\n -t Get only headers" \
1107 "\n -z Delete messages on server" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00001108 "\n prog Run prog <message_file> on message delivery" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001109
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001110#define findfs_trivial_usage \
1111 "LABEL=label or UUID=uuid"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001112#define findfs_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001113 "Find a filesystem device based on a label or UUID."
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001114#define findfs_example_usage \
1115 "$ findfs LABEL=MyDevice"
1116
Eric Andersen7e9276b2001-02-22 01:15:47 +00001117#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001118 "[PATH...] [EXPRESSION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001119#define find_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001120 "Search for files. The default PATH is the current directory,\n" \
1121 "default EXPRESSION is '-print'\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001122 "\nEXPRESSION may consist of:" \
1123 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001124 USE_FEATURE_FIND_XDEV( \
1125 "\n -xdev Don't descend directories on other filesystems") \
1126 USE_FEATURE_FIND_MAXDEPTH( \
1127 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1128 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001129 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001130 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001131 USE_FEATURE_FIND_PATH( \
1132 "\n -path PATTERN Path matches PATTERN") \
1133 USE_FEATURE_FIND_REGEX( \
1134 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001135 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001136 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001137 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001138 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001139 "\n or exactly (NNN)") \
1140 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001141 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001142 "\n or exactly (N) days") \
1143 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001144 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001145 "\n or exactly (N) minutes") \
1146 USE_FEATURE_FIND_NEWER( \
1147 "\n -newer FILE Modified time is more recent than FILE's") \
1148 USE_FEATURE_FIND_INUM( \
1149 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001150 USE_FEATURE_FIND_USER( \
1151 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1152 USE_FEATURE_FIND_GROUP( \
1153 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1154 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001155 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001156 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001157 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1158 "\n +/-N: file size is bigger/smaller than N") \
1159 "\n -print Print (default and assumed)" \
1160 USE_FEATURE_FIND_PRINT0( \
1161 "\n -print0 Delimit output with null characters rather than" \
1162 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001163 USE_FEATURE_FIND_CONTEXT ( \
1164 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001165 USE_FEATURE_FIND_EXEC( \
1166 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1167 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001168 USE_FEATURE_FIND_PRUNE( \
1169 "\n -prune Stop traversing current subtree") \
1170 USE_FEATURE_FIND_DELETE( \
1171 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001172 USE_FEATURE_FIND_PAREN( \
1173 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001174
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001175#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001176 "$ find / -name passwd\n" \
1177 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001178
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001179#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001180 "[-bs] [-w WIDTH] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001181#define fold_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001182 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001183 "standard output\n" \
1184 "\nOptions:" \
1185 "\n -b Count bytes rather than columns" \
1186 "\n -s Break at spaces" \
1187 "\n -w Use WIDTH columns instead of 80" \
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001188
Eric Andersen7e9276b2001-02-22 01:15:47 +00001189#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001190 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001191#define free_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001192 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001193#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001194 "$ free\n" \
1195 " total used free shared buffers\n" \
1196 " Mem: 257628 248724 8904 59644 93124\n" \
1197 " Swap: 128516 8404 120112\n" \
1198 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001199
Eric Andersen7e9276b2001-02-22 01:15:47 +00001200#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001201 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001202#define freeramdisk_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001203 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001204#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001205 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001206
Mike Frysinger51a43b42005-09-24 07:11:16 +00001207#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001208 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001209#define fsck_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001210 "Check and repair filesystems\n" \
1211 "\nOptions:" \
1212 "\n -A Walk /etc/fstab and check all filesystems" \
1213 "\n -N Don't execute, just show what would be done" \
1214 "\n -P With -A, check filesystems in parallel" \
1215 "\n -R With -A, skip the root filesystem" \
1216 "\n -T Don't show title on startup" \
1217 "\n -V Verbose" \
1218 "\n -C n Write status information to specified filedescriptor" \
1219 "\n -t type List of filesystem types to check" \
Mike Frysinger51a43b42005-09-24 07:11:16 +00001220
Eric Andersen7e9276b2001-02-22 01:15:47 +00001221#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001222 "[-larvsmf] /dev/name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001223#define fsck_minix_full_usage "\n\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001224 "Check MINIX filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001225 "\nOptions:" \
1226 "\n -l List all filenames" \
1227 "\n -r Perform interactive repairs" \
1228 "\n -a Perform automatic repairs" \
1229 "\n -v Verbose" \
1230 "\n -s Output super-block information" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001231 "\n -m Show \"mode not cleared\" warnings" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001232 "\n -f Force file system check" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00001233
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001234#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001235 "[options] remote-host local-file remote-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001236#define ftpget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001237 "Retrieve a remote file via FTP\n" \
1238 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001239 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001240 "\n -c,--continue Continue previous transfer" \
1241 "\n -v,--verbose Verbose" \
1242 "\n -u,--username Username" \
1243 "\n -p,--password Password" \
1244 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001245 ) \
1246 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001247 "\n -c Continue previous transfer" \
1248 "\n -v Verbose" \
1249 "\n -u Username" \
1250 "\n -p Password" \
1251 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001252 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001253
1254#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001255 "[options] remote-host remote-file local-file"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001256#define ftpput_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001257 "Store a local file on a remote machine via FTP\n" \
1258 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001259 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001260 "\n -v,--verbose Verbose" \
1261 "\n -u,--username Username" \
1262 "\n -p,--password Password" \
1263 "\n -P,--port Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001264 ) \
1265 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001266 "\n -v Verbose" \
1267 "\n -u Username" \
1268 "\n -p Password" \
1269 "\n -P Port number" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001270 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001271
Rob Landleyaa872762005-10-28 13:05:12 +00001272#define fuser_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001273 "[options] FILE or PORT/PROTO"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001274#define fuser_full_usage "\n\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00001275 "Find processes which use FILEs or PORTs\n" \
1276 "\nOptions:" \
1277 "\n -m Find processes which use same fs as FILEs" \
1278 "\n -4 Search only IPv4 space" \
1279 "\n -6 Search only IPv6 space" \
1280 "\n -s Silent: just exit with 0 if any processes are found" \
1281 "\n -k Kill found processes (otherwise display PIDs)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001282 "\n -SIGNAL Signal to send (default: TERM)" \
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001283
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00001284#define getenforce_trivial_usage NOUSAGE_STR
1285#define getenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001286
Eric Andersen7e9276b2001-02-22 01:15:47 +00001287#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001288 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001289#define getopt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001290 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001291 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001292 "\n -a,--alternative Allow long options starting with single -" \
1293 "\n -l,--longoptions=longopts Long options to be recognized" \
1294 "\n -n,--name=progname The name under which errors are reported" \
1295 "\n -o,--options=optstring Short options to be recognized" \
1296 "\n -q,--quiet Disable error reporting by getopt(3)" \
1297 "\n -Q,--quiet-output No normal output" \
1298 "\n -s,--shell=shell Set shell quoting conventions" \
1299 "\n -T,--test Test for getopt(1) version" \
1300 "\n -u,--unquoted Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001301 ) \
1302 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001303 "\n -a Allow long options starting with single -" \
1304 "\n -l longopts Long options to be recognized" \
1305 "\n -n progname The name under which errors are reported" \
1306 "\n -o optstring Short options to be recognized" \
1307 "\n -q Disable error reporting by getopt(3)" \
1308 "\n -Q No normal output" \
1309 "\n -s shell Set shell quoting conventions" \
1310 "\n -T Test for getopt(1) version" \
1311 "\n -u Don't quote the output" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001312 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001313#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001314 "$ cat getopt.test\n" \
1315 "#!/bin/sh\n" \
1316 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1317 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001318 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001319 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001320 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001321 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001322 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1323 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001324 " -c|--c-long)\n" \
1325 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001326 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1327 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1328 " esac;;\n" \
1329 " --) shift; break;;\n" \
1330 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001331 " esac\n" \
1332 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001333
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001334#define getsebool_trivial_usage \
1335 "-a or getsebool boolean..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001336#define getsebool_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001337 " -a Show all SELinux booleans"
1338
Eric Andersenf349e972001-08-21 16:18:59 +00001339#define getty_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001340 "[OPTIONS] BAUD_RATE TTY [TERMTYPE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001341#define getty_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001342 "Open a tty, prompt for a login name, then invoke /bin/login\n" \
1343 "\nOptions:" \
1344 "\n -h Enable hardware (RTS/CTS) flow control" \
1345 "\n -i Do not display /etc/issue before running login" \
1346 "\n -L Local line, do not do carrier detect" \
1347 "\n -m Get baud rate from modem's CONNECT status message" \
1348 "\n -w Wait for a CR or LF before sending /etc/issue" \
1349 "\n -n Do not prompt the user for a login name" \
1350 "\n -f issue_file Display issue_file instead of /etc/issue" \
1351 "\n -l login_app Invoke login_app instead of /bin/login" \
1352 "\n -t timeout Terminate after timeout if no username is read" \
1353 "\n -I initstring Init string to send before anything else" \
1354 "\n -H login_host Log login_host into the utmp file as the hostname" \
Eric Andersenf349e972001-08-21 16:18:59 +00001355
Eric Andersen7e9276b2001-02-22 01:15:47 +00001356#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001357 "[-HhrilLnqvso" \
1358 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001359 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001360 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1361 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001362 "] PATTERN [FILEs...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001363#define grep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001364 "Search for PATTERN in each FILE or standard input\n" \
1365 "\nOptions:" \
1366 "\n -H Prefix output lines with filename where match was found" \
1367 "\n -h Suppress the prefixing filename on output" \
1368 "\n -r Recurse subdirectories" \
1369 "\n -i Ignore case distinctions" \
1370 "\n -l List names of files that match" \
1371 "\n -L List names of files that do not match" \
1372 "\n -n Print line number with output lines" \
1373 "\n -q Quiet. Return 0 if PATTERN is found, 1 otherwise" \
1374 "\n -v Select non-matching lines" \
1375 "\n -s Suppress file open/read error messages" \
1376 "\n -c Only print count of matching lines" \
1377 "\n -o Show only the part of a line that matches PATTERN" \
1378 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001379 USE_DESKTOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001380 "\n -w Match whole words only") \
1381 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001382 USE_FEATURE_GREP_EGREP_ALIAS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001383 "\n -E PATTERN is an extended regular expression") \
1384 "\n -e PTRN Pattern to match" \
1385 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001386 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001387 "\n -A Print NUM lines of trailing context" \
1388 "\n -B Print NUM lines of leading context" \
1389 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001390
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001391#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001392 "$ grep root /etc/passwd\n" \
1393 "root:x:0:0:root:/root:/bin/bash\n" \
1394 "$ grep ^[rR]oo. /etc/passwd\n" \
1395 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001396
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001397#define egrep_trivial_usage NOUSAGE_STR
1398#define egrep_full_usage ""
1399
1400#define fgrep_trivial_usage NOUSAGE_STR
1401#define fgrep_full_usage ""
1402
Eric Andersen7e9276b2001-02-22 01:15:47 +00001403#define gunzip_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001404 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001405#define gunzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001406 "Uncompress FILEs (or standard input)\n" \
1407 "\nOptions:" \
1408 "\n -c Write to standard output" \
1409 "\n -f Force" \
1410 "\n -t Test file integrity" \
1411
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001412#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001413 "$ ls -la /tmp/BusyBox*\n" \
1414 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1415 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1416 "$ ls -la /tmp/BusyBox*\n" \
1417 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001418
1419#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001420 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001421#define gzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001422 "Compress FILEs (or standard input)\n" \
1423 "\nOptions:" \
1424 "\n -c Write to standard output" \
1425 "\n -d Decompress" \
1426 "\n -f Force" \
1427
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001428#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001429 "$ ls -la /tmp/busybox*\n" \
1430 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1431 "$ gzip /tmp/busybox.tar\n" \
1432 "$ ls -la /tmp/busybox*\n" \
1433 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001434
1435#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001436 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001437#define halt_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001438 "Halt the system\n" \
1439 "\nOptions:" \
1440 "\n -d Delay interval for halting" \
1441 "\n -n No call to sync()" \
1442 "\n -f Force halt (don't go through init)" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001443 USE_FEATURE_WTMP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001444 "\n -w Only write a wtmp record" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001445 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001446
Eric Andersen3443bd72003-07-22 07:30:36 +00001447#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001448 "[options] [device] .."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001449#define hdparm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001450 "Options:" \
1451 "\n -a Get/set fs readahead" \
1452 "\n -A Set drive read-lookahead flag (0/1)" \
1453 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
1454 "\n -B Set Advanced Power Management setting (1-255)" \
1455 "\n -c Get/set IDE 32-bit IO setting" \
1456 "\n -C Check IDE power mode status" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001457 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001458 "\n -d Get/set using_dma flag") \
1459 "\n -D Enable/disable drive defect-mgmt" \
1460 "\n -f Flush buffer cache for device on exit" \
1461 "\n -g Display drive geometry" \
1462 "\n -h Display terse usage information" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001463 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001464 "\n -i Display drive identification") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001465 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001466 "\n -I Detailed/current information directly from drive") \
1467 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
1468 "\n -K Set drive keep_features_over_reset flag (0/1)" \
1469 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
1470 "\n -m Get/set multiple sector count" \
1471 "\n -n Get/set ignore-write-errors flag (0/1)" \
1472 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
1473 "\n -P Set drive prefetch count" \
Denis Vlasenko3c96d022008-03-20 13:44:50 +00001474/* "\n -q Change next setting quietly" - not supported ib bbox */ \
Denis Vlasenko397de612008-03-17 08:55:44 +00001475 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
1476 "\n -r Get/set readonly flag (DANGEROUS to set)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001477 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001478 "\n -R Register an IDE interface (DANGEROUS)") \
1479 "\n -S Set standby (spindown) timeout" \
1480 "\n -t Perform device read timings" \
1481 "\n -T Perform cache read timings" \
1482 "\n -u Get/set unmaskirq flag (0/1)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001483 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001484 "\n -U Un-register an IDE interface (DANGEROUS)") \
1485 "\n -v Defaults; same as -mcudkrag for IDE drives" \
1486 "\n -V Display program version and exit immediately" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001487 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001488 "\n -w Perform device reset (DANGEROUS)") \
1489 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001490 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001491 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
1492 "\n -X Set IDE xfer mode (DANGEROUS)" \
1493 "\n -y Put IDE drive in standby mode" \
1494 "\n -Y Put IDE drive to sleep" \
1495 "\n -Z Disable Seagate auto-powersaving mode" \
1496 "\n -z Re-read partition table" \
Eric Andersen3443bd72003-07-22 07:30:36 +00001497
Eric Andersen7e9276b2001-02-22 01:15:47 +00001498#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001499 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001500#define head_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001501 "Print first 10 lines of each FILE to standard output.\n" \
1502 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001503 "file name. With no FILE, or when FILE is -, read standard input.\n" \
1504 "\nOptions:" \
1505 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001506 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001507 "\n -c NUM Output the first NUM bytes" \
1508 "\n -q Never output headers giving file names" \
1509 "\n -v Always output headers giving file names") \
1510
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001511#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001512 "$ head -n 2 /etc/passwd\n" \
1513 "root:x:0:0:root:/root:/bin/bash\n" \
1514 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001515
Glenn L McGrath60281112001-11-02 11:39:46 +00001516#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001517 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001518#define hexdump_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001519 "Display file(s) or standard input in a user specified format\n" \
1520 "\nOptions:" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001521 "\n -b One-byte octal display" \
1522 "\n -c One-byte character display" \
1523 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1524 "\n -d Two-byte decimal display" \
1525 "\n -e FORMAT STRING" \
1526 "\n -f FORMAT FILE" \
1527 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1528 "\n -o Two-byte octal display" \
1529 "\n -s OFFSET Skip OFFSET bytes" \
1530 "\n -v Display all input data" \
1531 "\n -x Two-byte hexadecimal display" \
1532 USE_FEATURE_HEXDUMP_REVERSE( \
1533 "\n -R Reverse of 'hexdump -Cv'") \
1534
1535#define hd_trivial_usage \
1536 "FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001537#define hd_full_usage "\n\n" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001538 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001539
Eric Andersen7e9276b2001-02-22 01:15:47 +00001540#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001541 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001542#define hostid_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001543 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001544
1545#define hostname_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001546 "[OPTION] [hostname | -F FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001547#define hostname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001548 "Get or set hostname or DNS domain name\n" \
1549 "\nOptions:" \
1550 "\n -s Short" \
1551 "\n -i Addresses for the hostname" \
1552 "\n -d DNS domain name" \
1553 "\n -f Fully qualified domain name" \
1554 "\n -F FILE Use the contents of FILE to specify the hostname" \
1555
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001556#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001557 "$ hostname\n" \
1558 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001559
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001560#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001561 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001562 " [-p [ip:]port]" \
1563 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001564 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001565 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001566 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001567 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001568 " [-d/-e string]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001569#define httpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001570 "Listen for incoming HTTP requests\n" \
1571 "\nOptions:" \
1572 "\n -c FILE Configuration file (default httpd.conf)" \
1573 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1574 "\n -i Inetd mode" \
1575 "\n -f Do not daemonize" \
1576 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001577 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001578 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001579 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001580 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001581 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001582 "\n -m PASS Crypt PASS with md5 algorithm") \
1583 "\n -h HOME Home directory (default .)" \
1584 "\n -e STRING HTML encode STRING" \
1585 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001586
Robert Griebl1cd04452002-07-21 16:50:49 +00001587#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001588 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001589 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1590 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001591 " [-f FILE]" \
1592 ) \
1593 SKIP_GETOPT_LONG( \
1594 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1595 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001596#define hwclock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001597 "Query and set hardware clock (RTC)\n" \
1598 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00001599 "\n -r Show hardware clock time" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001600 "\n -s Set system time from hardware clock" \
1601 "\n -w Set hardware clock to system time" \
1602 "\n -u Hardware clock is in UTC" \
1603 "\n -l Hardware clock is in local time" \
1604 "\n -f FILE Use specified device (e.g. /dev/rtc2)" \
Robert Griebl1cd04452002-07-21 16:50:49 +00001605
Eric Andersen7e9276b2001-02-22 01:15:47 +00001606#define id_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001607 "[OPTIONS]... [USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001608#define id_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001609 "Print information about USER or the current user\n" \
1610 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001611 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001612 "\n -Z Print the security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001613 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001614 "\n -g Print group ID" \
1615 "\n -u Print user ID" \
1616 "\n -n Print name instead of a number" \
1617 "\n -r Print real user ID instead of effective ID" \
1618
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001619#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001620 "$ id\n" \
1621 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001622
Eric Andersen7e9276b2001-02-22 01:15:47 +00001623#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001624 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001625#define ifconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001626 "Configure a network interface\n" \
1627 "\nOptions:" \
1628 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001629 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001630 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001631 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001632 " [del ADDRESS[/PREFIXLEN]]\n") \
1633 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1634 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001635 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001636 " [outfill NN] [keepalive NN]\n") \
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001637 " " USE_FEATURE_IFCONFIG_HW("[hw ether" USE_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001638 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001639 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001640 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001641 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001642 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001643
Denis Vlasenko06aed432008-02-26 18:25:24 +00001644#define ifenslave_trivial_usage \
1645 "[-cdf] master-iface <slave-iface...>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001646#define ifenslave_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001647 "Configure network interfaces for parallel routing\n" \
1648 "\nOptions:" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001649 "\n -c, --change-active Change active slave" \
1650 "\n -d, --detach Remove slave interface from bonding device" \
1651 "\n -f, --force Force, even if interface is not Ethernet" \
1652/* "\n -r, --receive-slave Create a receive-only slave" */
Denis Vlasenko397de612008-03-17 08:55:44 +00001653
Denis Vlasenko06aed432008-02-26 18:25:24 +00001654#define ifenslave_example_usage \
1655 "To create a bond device, simply follow these three steps :\n" \
1656 "- ensure that the required drivers are properly loaded :\n" \
1657 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
1658 "- assign an IP address to the bond device :\n" \
1659 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
1660 "- attach all the interfaces you need to the bond device :\n" \
1661 " # ifenslave bond0 eth0 eth1 eth2\n" \
1662 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
1663 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
1664 " To detach a dead interface without setting the bond device down :\n" \
1665 " # ifenslave -d bond0 eth1\n\n" \
1666 " To set the bond device down and automatically release all the slaves :\n" \
1667 " # ifconfig bond0 down\n\n" \
1668 " To change active slave :\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001669 " # ifenslave -c bond0 eth0\n" \
Denis Vlasenko06aed432008-02-26 18:25:24 +00001670
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001671#define ifup_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001672 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001673#define ifup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001674 "Options:" \
1675 "\n -a De/configure all interfaces automatically" \
1676 "\n -i FILE Use FILE for interface definitions" \
1677 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001678 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001679 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001680 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001681 ) \
1682 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001683 "\n -f Force de/configuration" \
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001684
1685#define ifdown_trivial_usage \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001686 "[-ain"USE_FEATURE_IFUPDOWN_MAPPING("m")"vf] ifaces..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001687#define ifdown_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001688 "Options:" \
1689 "\n -a De/configure all interfaces automatically" \
1690 "\n -i FILE Use FILE for interface definitions" \
1691 "\n -n Print out what would happen, but don't do it" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001692 USE_FEATURE_IFUPDOWN_MAPPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001693 "\n (note: doesn't disable mappings)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001694 "\n -m Don't run any mappings" \
Bernhard Reutner-Fischer6e38d522008-05-08 10:40:34 +00001695 ) \
1696 "\n -v Print out what would happen before doing it" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001697 "\n -f Force de/configuration" \
Tim Riker7b253f82003-12-28 05:02:40 +00001698
Glenn L McGrath06e95652003-02-09 06:51:14 +00001699#define inetd_trivial_usage \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001700 "[-fe] [-q N] [-R N] [CONFFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001701#define inetd_full_usage "\n\n" \
Denis Vlasenko4e6d5112008-03-12 22:14:34 +00001702 "Listen for network connections and launch programs\n" \
1703 "\nOptions:" \
1704 "\n -f Run in foreground" \
1705 "\n -e Log to stderr" \
1706 "\n -q N Socket listen queue (default: 128)" \
1707 "\n -R N Pause services after N connects/min" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001708 "\n (default: 0 - disabled)" \
Glenn L McGrath06e95652003-02-09 06:51:14 +00001709
Eric Andersen7e9276b2001-02-22 01:15:47 +00001710#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001711 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001712#define init_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001713 "Init is the parent of all processes"
Denis Vlasenko397de612008-03-17 08:55:44 +00001714
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001715#define init_notes_usage \
1716"This version of init is designed to be run only by the kernel.\n" \
1717"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001718"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001719"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001720"runlevels, use sysvinit.\n" \
1721"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001722"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001723"it has the following default behavior:\n" \
1724"\n" \
1725" ::sysinit:/etc/init.d/rcS\n" \
1726" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001727" ::ctrlaltdel:/sbin/reboot\n" \
1728" ::shutdown:/sbin/swapoff -a\n" \
1729" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001730" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001731"\n" \
1732"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1733"\n" \
1734" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001735" tty3::askfirst:/bin/sh\n" \
1736" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001737"\n" \
1738"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1739"\n" \
1740" <id>:<runlevels>:<action>:<process>\n" \
1741"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001742" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001743"\n" \
1744" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1745" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001746" the specified process to run on. The contents of this field are\n" \
1747" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1748" be unique, although if it isn't you may have strange results. If this\n" \
1749" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001750" note that if BusyBox detects that a serial console is in use, then only\n" \
1751" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001752" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001753" stinkin' utmp.\n" \
1754"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001755" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001756"\n" \
1757" The runlevels field is completely ignored.\n" \
1758"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001759" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001760"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001761" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001762" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001763"\n" \
1764" The available actions can be classified into two groups: actions\n" \
1765" that are run only once, and actions that are re-run when the specified\n" \
1766" process exits.\n" \
1767"\n" \
1768" Run only-once actions:\n" \
1769"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001770" 'sysinit' is the first item run on boot. init waits until all\n" \
1771" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001772" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001773" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001774" the specified task completes. 'once' actions are asynchronous,\n" \
1775" therefore, init does not wait for them to complete. 'restart' is\n" \
1776" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001777" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001778" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001779" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001780" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001781" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001782" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001783" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001784" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001785"\n" \
1786" Run repeatedly actions:\n" \
1787"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001788" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001789" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001790" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1791" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001792" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001793" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001794" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001795" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001796"\n" \
1797" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001798" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001799" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001800"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001801" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001802"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001803" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001804"\n" \
1805"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001806"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001807" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001808" #\n" \
1809" ::sysinit:/etc/init.d/rcS\n" \
1810" \n" \
1811" # /bin/sh invocations on selected ttys\n" \
1812" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001813" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001814" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001815" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001816" tty2::askfirst:-/bin/sh\n" \
1817" tty3::askfirst:-/bin/sh\n" \
1818" tty4::askfirst:-/bin/sh\n" \
1819" \n" \
1820" # /sbin/getty invocations for selected ttys\n" \
1821" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001822" tty4::respawn:/sbin/getty 38400 tty4\n" \
1823" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001824" \n" \
1825" \n" \
1826" # Example of how to put a getty on a serial line (for a terminal)\n" \
1827" #\n" \
1828" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1829" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1830" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001831" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001832" #::respawn:/sbin/getty 57600 ttyS2\n" \
1833" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001834" # Stuff to do when restarting the init process\n" \
1835" ::restart:/sbin/init\n" \
1836" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001837" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001838" ::ctrlaltdel:/sbin/reboot\n" \
1839" ::shutdown:/bin/umount -a -r\n" \
1840" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001841
Denis Vlasenko8e2c9e12008-05-24 20:47:18 +00001842#define inotifyd_trivial_usage \
1843 "/user/space/agent dir/or/file/being/watched[:mask] ..."
1844#define inotifyd_full_usage "\n\n" \
1845 "Spawn userspace agent on filesystem changes." \
1846 "\nWhen a filesystem event matching the mask occurs" \
1847 "\non specified file/directory an userspace agent is spawned" \
1848 "\nwith the parameters:" \
1849 "\n1. actual event(s)" \
1850 "\n2. file/directory name" \
1851 "\n3. name of subfile (if any), in case of watching a directory" \
1852 "\n" \
1853 "\n a File is accessed" \
1854 "\n c File is modified" \
1855 "\n e Metadata changed" \
1856 "\n w Writtable file is closed" \
1857 "\n 0 Unwrittable file is closed" \
1858 "\n r File is opened" \
1859 "\n m File is moved from X" \
1860 "\n y File is moved to Y" \
1861 "\n n Subfile is created" \
1862 "\n d Subfile is deleted" \
1863 "\n D Self is deleted" \
1864 "\n M Self is moved" \
1865
Eric Andersen7e9276b2001-02-22 01:15:47 +00001866#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001867 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001868#define insmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001869 "Load the specified kernel modules into the kernel" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001870 USE_FEATURE_2_4_MODULES( "\n" \
1871 "\nOptions:" \
1872 "\n -f Force module to load into the wrong kernel version" \
1873 "\n -k Make module autoclean-able" \
1874 "\n -v Verbose" \
1875 "\n -q Quiet" \
1876 "\n -L Lock to prevent simultaneous loads of a module" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001877 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001878 "\n -m Output load map to stdout" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001879 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00001880 "\n -o NAME Set internal module name to NAME" \
1881 "\n -x Do not export externs" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001882 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001883
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001884#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001885 "[-cgmops] [sources] dest|directory"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001886#define install_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001887 "Copy files and set attributes\n" \
1888 "\nOptions:" \
1889 "\n -c Copy the file, default" \
1890 "\n -d Create directories" \
1891 "\n -g Set group ownership" \
1892 "\n -m Set permissions" \
1893 "\n -o Set ownership" \
1894 "\n -p Preserve date" \
1895 "\n -s Strip symbol tables" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001896 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001897 "\n -Z Set security context of copy" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001898 )
Denis Vlasenko397de612008-03-17 08:55:44 +00001899
1900/* would need to make the " | " optional depending on more than one selected: */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001901#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001902 "[OPTIONS] {" \
1903 USE_FEATURE_IP_ADDRESS("address | ") \
1904 USE_FEATURE_IP_ROUTE("route | ") \
1905 USE_FEATURE_IP_LINK("link | ") \
1906 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1907 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001908 "} {COMMAND}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001909#define ip_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001910 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001911 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001912 USE_FEATURE_IP_ADDRESS("address | ") \
1913 USE_FEATURE_IP_ROUTE("route | ") \
1914 USE_FEATURE_IP_LINK("link | ") \
1915 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1916 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001917 "}\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001918 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001919
1920#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001921 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001922 " [dev STRING] [to PREFIX] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001923#define ipaddr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001924 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001925 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1926 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001927 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001928 " [broadcast ADDR] [anycast ADDR]\n" \
1929 " [label STRING] [scope SCOPE-ID]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001930 " SCOPE-ID := [host | link | global | NUMBER]" \
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001931
Eric Andersende4f07e2003-12-11 01:18:07 +00001932#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001933 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001934#define ipcalc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001935 "Calculate IP network settings from a IP address\n" \
1936 "\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001937 USE_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001938 "\n -b,--broadcast Display calculated broadcast address" \
1939 "\n -n,--network Display calculated network address" \
1940 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001941 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001942 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1943 "\n -h,--hostname Display first resolved host name" \
1944 "\n -s,--silent Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001945 ) \
1946 ) \
1947 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001948 "\n -b Display calculated broadcast address" \
1949 "\n -n Display calculated network address" \
1950 "\n -m Display default netmask for IP" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001951 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00001952 "\n -p Display the prefix for IP/NETMASK" \
1953 "\n -h Display first resolved host name" \
1954 "\n -s Don't ever display error messages" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001955 ) \
1956 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001957
Rob Landley6eb1e412005-06-20 04:30:36 +00001958#define ipcrm_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00001959 "[-MQS key] [-mqs id]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001960#define ipcrm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001961 "Upper-case options MQS remove an object by shmkey value.\n" \
1962 "Lower-case options remove an object by shmid value.\n" \
1963 "\nOptions:" \
1964 "\n -mM Remove memory segment after last detach" \
1965 "\n -qQ Remove message queue" \
1966 "\n -sS Remove semaphore" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001967
1968#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001969 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001970#define ipcs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001971 " -i Show specific resource" \
1972 "\nResource specification:" \
1973 "\n -m Shared memory segments" \
1974 "\n -q Message queues" \
1975 "\n -s Semaphore arrays" \
1976 "\n -a All (default)" \
1977 "\nOutput format:" \
1978 "\n -t Time" \
1979 "\n -c Creator" \
1980 "\n -p Pid" \
1981 "\n -l Limits" \
1982 "\n -u Summary" \
Rob Landley6eb1e412005-06-20 04:30:36 +00001983
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001984#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001985 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001986#define iplink_full_usage "\n\n" \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001987 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001988 " dynamic { on | off } |\n" \
1989 " mtu MTU }\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00001990 "iplink show [DEVICE]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001991
1992#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001993 "{ list | flush | { add | del | change | append |\n" \
1994 " replace | monitor } ROUTE }"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00001995#define iproute_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001996 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001997 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1998 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001999 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002000 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002001 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002002
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002003#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002004 "{[list | add | del] RULE}"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002005#define iprule_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002006 "iprule [list | add | del] SELECTOR ACTION\n" \
2007 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
2008 " [dev STRING] [pref NUMBER]\n" \
2009 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
2010 " [prohibit | reject | unreachable]\n" \
2011 " [realms [SRCREALM/]DSTREALM]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002012 " TABLE_ID := [local | main | default | NUMBER]" \
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00002013
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002014#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002015 "{ add | change | del | show } [NAME]\n" \
2016 " [mode { ipip | gre | sit }]\n" \
2017 " [remote ADDR] [local ADDR] [ttl TTL]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002018#define iptunnel_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002019 "iptunnel { add | change | del | show } [NAME]\n" \
2020 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
2021 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002022 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
Glenn L McGrathf112daa2002-12-01 23:04:06 +00002023
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002024#define kbd_mode_trivial_usage \
2025 "[-a|k|s|u]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002026#define kbd_mode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002027 "Report or set the keyboard mode\n" \
2028 "\nOptions set mode:" \
2029 "\n -a Default (ASCII)" \
2030 "\n -k Medium-raw (keyboard)" \
2031 "\n -s Raw (scancode)" \
2032 "\n -u Unicode (utf-8)" \
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00002033
Eric Andersen7e9276b2001-02-22 01:15:47 +00002034#define kill_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002035 "[-l] [-signal] process-id..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002036#define kill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002037 "Send a signal (default is TERM) to the specified process(es)\n" \
2038 "\nOptions:" \
2039 "\n -l List all signal names and numbers" \
2040
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002041#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002042 "$ ps | grep apache\n" \
2043 "252 root root S [apache]\n" \
2044 "263 www-data www-data S [apache]\n" \
2045 "264 www-data www-data S [apache]\n" \
2046 "265 www-data www-data S [apache]\n" \
2047 "266 www-data www-data S [apache]\n" \
2048 "267 www-data www-data S [apache]\n" \
2049 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002050
2051#define killall_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00002052 "[-l] [-q] [-signal] process-name..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002053#define killall_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002054 "Send a signal (default is TERM) to the specified process(es)\n" \
2055 "\nOptions:" \
2056 "\n -l List all signal names and numbers" \
2057 "\n -q Do not complain if no processes were killed" \
2058
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002059#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002060 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002061
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002062#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002063 "[-l] [-signal]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002064#define killall5_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002065 "Send a signal (default is TERM) to all processes outside current session\n" \
2066 "\nOptions:" \
2067 "\n -l List all signal names and numbers" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00002068
Mark Whitley6317c4b2001-03-12 22:51:50 +00002069#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002070 "[-c n] [-n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002071#define klogd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002072 "Kernel logger\n" \
2073 "\nOptions:" \
2074 "\n -c n Set the default log level of console messages to n" \
2075 "\n -n Run in foreground" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002076
Eric Andersen7e9276b2001-02-22 01:15:47 +00002077#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002078 "STRING"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002079#define length_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002080 "Print STRING's length"
2081
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002082#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002083 "$ length Hello\n" \
2084 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002085
Rob Landley9200e792005-09-15 19:26:59 +00002086#define less_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002087 "[-EMNmh~?] [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002088#define less_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002089 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002090 "changed, and files can be manipulated in various ways.\n" \
2091 "\nOptions:" \
2092 "\n -E Quit once the end of a file is reached" \
2093 "\n -M,-m Display a status line containing the line numbers" \
2094 "\n and percentage through the file" \
2095 "\n -N Prefix line numbers to each line" \
2096 "\n -~ Suppress ~s displayed past the end of the file" \
Rob Landley9200e792005-09-15 19:26:59 +00002097
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002098#define linux32_trivial_usage NOUSAGE_STR
2099#define linux32_full_usage ""
2100#define linux64_trivial_usage NOUSAGE_STR
2101#define linux64_full_usage ""
2102
2103#define linuxrc_trivial_usage NOUSAGE_STR
2104#define linuxrc_full_usage ""
2105
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002106#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002107 "personality program [args...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002108#define setarch_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002109 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002110 " linux32 Set 32bit uname emulation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002111 " linux64 Set 64bit uname emulation" \
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00002112
Eric Andersen7e9276b2001-02-22 01:15:47 +00002113#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002114 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002115#define ln_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002116 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002117 "Use '--' to indicate that all following arguments are non-options.\n" \
2118 "\nOptions:" \
2119 "\n -s Make symlinks instead of hardlinks" \
2120 "\n -f Remove existing destination files" \
2121 "\n -n Don't dereference symlinks - treat like normal file" \
2122 "\n -b Make a backup of the target (if exists) before link operation" \
2123 "\n -S suf Use suffix instead of ~ when making backup files" \
2124
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002125#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002126 "$ ln -s BusyBox /tmp/ls\n" \
2127 "$ ls -l /tmp/ls\n" \
2128 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002129
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002130#define load_policy_trivial_usage NOUSAGE_STR
Denis Vlasenkob042bd92007-09-26 18:01:32 +00002131
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00002132#define load_policy_full_usage ""
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00002133
Eric Andersen7e9276b2001-02-22 01:15:47 +00002134#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002135 "< font"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002136#define loadfont_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002137 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002138#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002139 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002140
2141#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002142 "< keymap"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002143#define loadkmap_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002144 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002145#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002146 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002147
2148#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002149 "[OPTION]... [MESSAGE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002150#define logger_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002151 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n" \
2152 "\nOptions:" \
2153 "\n -s Log to stderr as well as the system log" \
2154 "\n -t TAG Log using the specified tag (defaults to user name)" \
2155 "\n -p PRIO Priority (numeric or facility.level pair)" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002156
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002157#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002158 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002159
Robert Griebl1fca5582002-06-04 20:45:46 +00002160#define login_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002161 "[-p] [-h HOST] [[-f] USER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002162#define login_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002163 "Begin a new session on the system\n" \
2164 "\nOptions:" \
2165 "\n -f Do not authenticate (user already authenticated)" \
2166 "\n -h Name of the remote host" \
2167 "\n -p Preserve environment" \
Robert Griebl1fca5582002-06-04 20:45:46 +00002168
Eric Andersen7e9276b2001-02-22 01:15:47 +00002169#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002170 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002171#define logname_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002172 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002173#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002174 "$ logname\n" \
2175 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002176
Mark Whitley6317c4b2001-03-12 22:51:50 +00002177#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002178 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002179#define logread_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002180 "Show messages in syslogd's circular buffer\n" \
2181 "\nOptions:" \
2182 "\n -f Output data as log grows" \
Mark Whitley6317c4b2001-03-12 22:51:50 +00002183
Matt Kraai83788da2002-03-20 17:38:37 +00002184#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002185 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2186 " losetup -d LOOPDEV - disassociate\n" \
2187 " losetup [-f] - show"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002188#define losetup_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002189 "Options:" \
2190 "\n -o OFS Start OFS bytes into FILE" \
2191 "\n -f Show first free loop device" \
2192
Rob Landley1d589b22005-11-29 23:47:10 +00002193#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002194 "No arguments will display all current associations.\n" \
2195 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002196 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002197 "and filename of the file the loop device is currently bound to.\n\n" \
2198 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002199 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2200 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002201
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002202#define lpd_trivial_usage \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002203 "SPOOLDIR [HELPER [ARGS...]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002204#define lpd_full_usage "\n\n" \
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002205 "Example:" \
Denis Vlasenkoa7942892008-03-23 23:40:18 +00002206 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print"
Denis Vlasenkof99afb52008-02-24 23:32:36 +00002207
Denis Vlasenko68444b92008-02-22 22:24:48 +00002208#define lpq_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002209 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID...] [-fs]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002210#define lpq_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002211 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002212 "\n -P lp service to connect to (else uses $PRINTER)" \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002213 "\n -d Delete jobs" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002214 "\n -f Force any waiting job to be printed" \
2215 "\n -s Short display" \
2216
2217#define lpr_trivial_usage \
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002218 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE...]"
2219/* -C CLASS exists too, not shown.
2220 * CLASS is supposed to be printed on banner page, if one is requested */
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002221#define lpr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002222 "Options:" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002223 "\n -P lp service to connect to (else uses $PRINTER)"\
Denis Vlasenko4f82bdb2008-02-24 18:44:20 +00002224 "\n -m Send mail on completion" \
2225 "\n -h Print banner page too" \
Denis Vlasenko68444b92008-02-22 22:24:48 +00002226 "\n -V Verbose" \
2227
Eric Andersen7e9276b2001-02-22 01:15:47 +00002228#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002229 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002230 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002231 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2232 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2233 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2234 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2235 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2236 USE_SELINUX("K") "] [filenames...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002237#define ls_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002238 "List directory contents\n" \
2239 "\nOptions:" \
2240 "\n -1 List files in a single column" \
2241 "\n -A Do not list implied . and .." \
2242 "\n -a Do not hide entries starting with ." \
2243 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002244 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002245 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002246 USE_FEATURE_LS_COLOR( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002247 "\n --color[={always,never,auto}] Control coloring") \
2248 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002249 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002250 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002251 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002252 "\n -F Append indicator (one of */=@|) to entries") \
2253 "\n -i List the i-node for each file" \
2254 "\n -l Use a long listing format" \
2255 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002256 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002257 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002258 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002259 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002260 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002261 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002262 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002263 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002264 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002265 "\n -S Sort the listing by file size") \
2266 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002267 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002268 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002269 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002270 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002271 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002272 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002273 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002274 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002275 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002276 "\n -w NUM Assume the terminal is NUM columns wide") \
2277 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002278 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002279 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002280 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002281 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002282 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002283 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002284 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002285 "\n -K Print security context in long format") \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002286 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002287 "\n -Z Print security context and permission") \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002288
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002289#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002290 "[-Radlv] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002291#define lsattr_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002292 "List file attributes on an ext2 fs\n" \
2293 "\nOptions:" \
2294 "\n -R Recursively list subdirectories" \
2295 "\n -a Do not hide entries starting with ." \
2296 "\n -d List directory entries instead of contents" \
2297 "\n -l Print long flag names" \
2298 "\n -v List the file's version/generation number" \
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002299
Eric Andersen7e9276b2001-02-22 01:15:47 +00002300#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002301 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002302#define lsmod_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002303 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002304
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002305#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002306#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002307 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002308#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002309 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002310 "TYPEs include:\n" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00002311 " b Make a block device\n" \
2312 " c or u Make a character device\n" \
2313 " p Make a named pipe. MAJOR and MINOR are ignored\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002314 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002315 "FIRST specifies the number appended to NAME to create the first device.\n" \
2316 "LAST specifies the number of the last item that should be created\n" \
2317 "If 's' is the last argument, the base device is created as well.\n\n" \
2318 "For example:\n" \
2319 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2320 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002321#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002322 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2323 "[creates ttyS2-ttyS63]\n" \
2324 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2325 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002326#endif
2327
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002328#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002329#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002330 "[-d device_table] rootdir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002331#define makedevs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002332 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002333 "Device table entries take the form of:\n" \
2334 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002335 "Where name is the file name, type can be one of:\n" \
2336 " f A regular file\n" \
2337 " d Directory\n" \
2338 " c Character special device file\n" \
2339 " b Block special device file\n" \
2340 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002341 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002342 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2343 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002344#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002345 "For example:\n" \
2346 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2347 "/dev d 755 0 0 - - - - -\n" \
2348 "/dev/console c 666 0 0 5 1 - - -\n" \
2349 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2350 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2351 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2352 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2353 "Will Produce:\n" \
2354 "/dev\n" \
2355 "/dev/console\n" \
2356 "/dev/null\n" \
2357 "/dev/zero\n" \
2358 "/dev/hda\n" \
2359 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002360#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002361
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002362#define man_trivial_usage \
2363 "[OPTION]... [MANPAGE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002364#define man_full_usage "\n\n" \
Denis Vlasenkoffa44992008-04-13 08:20:00 +00002365 "Format and display manual page\n" \
2366 "\nOptions:" \
2367 "\n -a Display all pages" \
2368 "\n -w Show page locations" \
2369
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002370#define matchpathcon_trivial_usage \
2371 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002372#define matchpathcon_full_usage "\n\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002373 " -n Do not display path" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002374 "\n -N Do not use translations" \
2375 "\n -f Use alternate file_context file" \
2376 "\n -p Use prefix to speed translations" \
2377 "\n -V Verify file context on disk matches defaults" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002378
Eric Andersen7e9276b2001-02-22 01:15:47 +00002379#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002380 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002381 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002382#define md5sum_full_usage "\n\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002383 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002384 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
2385 "\nOptions:" \
2386 "\n -c Check MD5 sums against given list" \
2387 "\n -s Don't output anything, status code shows success" \
2388 "\n -w Warn about improperly formatted MD5 checksum lines") \
2389
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002390#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002391 "$ md5sum < busybox\n" \
2392 "6fd11e98b98a58f64ff3398d7b324003\n" \
2393 "$ md5sum busybox\n" \
2394 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2395 "$ md5sum -c -\n" \
2396 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2397 "busybox: OK\n" \
2398 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002399
Rob Landley70f7ef72005-12-13 08:21:33 +00002400#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002401 "[-s]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002402#define mdev_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002403 " -s Scan /sys and populate /dev during system boot\n" \
2404 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002405 "Called with no options (via hotplug) it uses environment variables\n" \
2406 "to determine which device to add/remove."
Denis Vlasenko397de612008-03-17 08:55:44 +00002407
Rob Landleyef10d522006-06-26 14:11:33 +00002408#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002409 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002410 "The mdev config file contains lines that look like:\n" \
2411 " hd[a-z][0-9]* 0:3 660\n\n" \
2412 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002413 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002414 "Optionally, that can be followed (on the same line) by a special character\n" \
2415 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002416 "device(s). The environment variable $MDEV indicates the active device node\n" \
2417 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002418 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2419 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002420 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002421 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002422 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002423 "Config file parsing stops on the first matching line. If no config\n" \
2424 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002425 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002426 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002427
Glenn L McGrath061c9002002-09-16 04:21:46 +00002428#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002429 "[y|n]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002430#define mesg_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002431 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002432 " y Allow write access to your terminal\n" \
2433 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002434
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002435#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002436 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002437#define microcom_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002438 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
2439 "\nOptions:" \
2440 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2441 "\n next byte to it" \
2442 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2443 "\n -s Set serial line to SPEED" \
2444 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002445
Eric Andersen7e9276b2001-02-22 01:15:47 +00002446#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002447 "[OPTION] DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002448#define mkdir_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002449 "Create DIRECTORY\n" \
2450 "\nOptions:" \
2451 "\n -m Set permission mode (as in chmod), not rwxrwxrwx - umask" \
2452 "\n -p No error if existing, make parent directories as needed" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002453 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002454 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002455 )
2456
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002457#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002458 "$ mkdir /tmp/foo\n" \
2459 "$ mkdir /tmp/foo\n" \
2460 "/tmp/foo: File exists\n" \
2461 "$ mkdir /tmp/foo/bar/baz\n" \
2462 "/tmp/foo/bar/baz: No such file or directory\n" \
2463 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002464
Mike Frysinger6447ac02005-06-11 05:29:40 +00002465#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002466 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2467 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2468 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2469 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2470 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2471 "device [blocks-count]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002472#define mke2fs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002473 " -b size Block size in bytes" \
2474 "\n -c Check for bad blocks before creating" \
2475 "\n -E opts Set extended options" \
2476 "\n -f size Fragment size in bytes" \
2477 "\n -F Force (ignore sanity checks)" \
2478 "\n -g num Number of blocks in a block group" \
2479 "\n -i ratio The bytes/inode ratio" \
2480 "\n -j Create a journal (ext3)" \
2481 "\n -J opts Set journal options (size/device)" \
2482 "\n -l file Read bad blocks list from file" \
2483 "\n -L lbl Set the volume label" \
2484 "\n -m percent Percent of fs blocks to reserve for admin" \
2485 "\n -M dir Set last mounted directory" \
2486 "\n -n Do not actually create anything" \
2487 "\n -N num Number of inodes to create" \
2488 "\n -o os Set the 'creator os' field" \
2489 "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" \
2490 "\n -q Quiet" \
2491 "\n -r rev Set filesystem revision" \
2492 "\n -S Write superblock and group descriptors only" \
2493 "\n -T fs-type Set usage type (news/largefile/largefile4)" \
2494 "\n -v Verbose" \
Mike Frysinger6447ac02005-06-11 05:29:40 +00002495
Eric Andersen7e9276b2001-02-22 01:15:47 +00002496#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002497 "[OPTIONS] name"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002498#define mkfifo_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002499 "Create named pipe (identical to 'mknod name p')\n" \
2500 "\nOptions:" \
2501 "\n -m MODE Mode (default a=rw)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002502 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002503 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002504 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002505
Eric Andersen7e9276b2001-02-22 01:15:47 +00002506#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002507 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002508#define mkfs_minix_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002509 "Make a MINIX filesystem\n" \
2510 "\nOptions:" \
2511 "\n -c Check device for bad blocks" \
2512 "\n -n [14|30] Maximum length of filenames" \
2513 "\n -i INODES Number of inodes for the filesystem" \
2514 "\n -l FILENAME Read bad blocks list from FILENAME" \
2515 "\n -v Make version 2 filesystem" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002516
Eric Andersen7e9276b2001-02-22 01:15:47 +00002517#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002518 "[OPTIONS] NAME TYPE MAJOR MINOR"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002519#define mknod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002520 "Create a special file (block, character, or pipe)\n" \
2521 "\nOptions:" \
2522 "\n -m Create the special file using the specified mode (default a=rw)" \
2523 "\nTYPEs include:" \
2524 "\n b: Make a block device" \
2525 "\n c or u: Make a character device" \
2526 "\n p: Make a named pipe (MAJOR and MINOR are ignored)" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002527 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002528 "\n -Z Set security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002529 )
2530
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002531#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002532 "$ mknod /dev/fd0 b 2 0\n" \
2533 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002534
Eric Andersen7e9276b2001-02-22 01:15:47 +00002535#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002536 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002537#define mkswap_full_usage "\n\n" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002538 "Prepare block device to be used as swap partition"
2539#if 0
2540 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
Denis Vlasenko397de612008-03-17 08:55:44 +00002541 "\nOptions:"
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002542 "\n -c Check for readability"
2543 "\n -v0 Make swap version 0 (max 128M)"
2544 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2545 "\n BLOCKS Number of blocks to use (default is entire partition)"
2546#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002547
Eric Andersen7e9276b2001-02-22 01:15:47 +00002548#define mktemp_trivial_usage \
Denis Vlasenko761e1d12008-02-09 06:29:32 +00002549 "[-dt] [-p DIR] TEMPLATE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002550#define mktemp_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002551 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002552 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX).\n" \
2553 "\nOptions:" \
2554 "\n -d Make a directory instead of a file" \
2555/* "\n -q Fail silently if an error occurs" - we ignore it */ \
2556 "\n -t Generate a path rooted in temporary directory" \
2557 "\n -p DIR Use DIR as a temporary directory (implies -t)" \
2558 "\n" \
2559 "\n" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002560 "For -t or -p, directory is chosen as follows:\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002561 "$TMPDIR if set, else -p DIR, else /tmp" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002562
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002563#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002564 "$ mktemp /tmp/temp.XXXXXX\n" \
2565 "/tmp/temp.mWiLjM\n" \
2566 "$ ls -la /tmp/temp.mWiLjM\n" \
2567 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002568
Eric Andersen8d79ce82001-07-22 23:00:15 +00002569#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002570 "[-knqrsv] MODULE [symbol=value...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002571#define modprobe_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002572 "Options:" \
2573 "\n -k Make module autoclean-able" \
2574 "\n -n Dry run" \
2575 "\n -q Quiet" \
2576 "\n -r Remove module (stacks) or do autoclean" \
2577 "\n -s Report via syslog instead of stderr" \
2578 "\n -v Verbose" \
2579
Rob Landley9c32a152005-12-11 20:12:24 +00002580#define modprobe_notes_usage \
2581"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2582"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2583"pass each module it loads.\n" \
2584"\n" \
2585"The configuration file is searched (in order) amongst:\n" \
2586"\n" \
2587" /etc/modprobe.conf (2.6 only)\n" \
2588" /etc/modules.conf\n" \
2589" /etc/conf.modules (deprecated)\n" \
2590"\n" \
2591"They all have the same syntax (see below). If none is present, it is\n" \
2592"_not_ an error; each loaded module is then expected to load without\n" \
2593"options. Once a file is found, the others are tested for.\n" \
2594"\n" \
2595"/etc/modules.conf entry format:\n" \
2596"\n" \
2597" alias <alias_name> <mod_name>\n" \
2598" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002599" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002600" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2601" This makes it also possible to use a different set of options (below) for\n" \
2602" the module and the alias.\n" \
2603" A module can be aliased more than once.\n" \
2604"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002605" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002606" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2607" the \"symbol=value\" pairs as option to that module.\n" \
2608"\n" \
2609"Sample /etc/modules.conf file:\n" \
2610"\n" \
2611" options tulip irq=3\n" \
2612" alias tulip tulip2\n" \
2613" options tulip2 irq=4 io=0x308\n" \
2614"\n" \
2615"Other functionality offered by 'classic' modprobe is not available in\n" \
2616"this implementation.\n" \
2617"\n" \
2618"If module options are present both in the config file, and on the command line,\n" \
2619"then the options from the command line will be passed to the module _after_\n" \
2620"the options from the config file. That way, you can have defaults in the config\n" \
2621"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002622#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002623 "(with the above /etc/modules.conf):\n\n" \
2624 "$ modprobe tulip\n" \
2625 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2626 "$ modprobe tulip irq=5\n" \
2627 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2628 "$ modprobe tulip2\n" \
2629 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2630 " which are the default for alias 'tulip2'\n\n" \
2631 "$ modprobe tulip2 irq=8\n" \
2632 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2633 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2634 " from the command line\n\n" \
2635 "$ modprobe tulip2 irq=2 io=0x210\n" \
2636 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2637 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2638 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002639
Eric Andersen7e9276b2001-02-22 01:15:47 +00002640#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002641 "[FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002642#define more_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002643 "View FILE or standard input one screenful at a time"
Denis Vlasenko397de612008-03-17 08:55:44 +00002644
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002645#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002646 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002647
Eric Andersen7e9276b2001-02-22 01:15:47 +00002648#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002649 "[flags] DEVICE NODE [-o options,more-options]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002650#define mount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002651 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n" \
2652 "\nOptions:" \
2653 "\n -a Mount all filesystems in fstab" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002654 USE_FEATURE_MOUNT_FAKE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002655 "\n -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002656 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002657 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002658 "\n -n Don't update /etc/mtab" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002659 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002660 "\n -r Read-only mount" \
2661 "\n -t fs-type Filesystem type" \
2662 "\n -w Read-write mount (default)" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002663 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002664 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002665 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002666 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002667 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002668 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002669 " [a]sync Writes are asynchronous / synchronous\n" \
2670 " [no]atime Disable / enable updates to inode access times\n" \
2671 " [no]diratime Disable / enable atime updates to directories\n" \
2672 " [no]dev Allow use of special device files / disallow them\n" \
2673 " [no]exec Allow use of executable files / disallow them\n" \
2674 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2675 " [r]shared Convert [recursively] to a shared subtree\n" \
2676 " [r]slave Convert [recursively] to a slave subtree\n" \
2677 " [r]private Convert [recursively] to a private subtree\n" \
2678 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2679 " bind Bind a directory to an additional location\n" \
2680 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002681 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002682 " remount Remount a mounted filesystem, changing its flags\n" \
2683 " ro/rw Mount for read-only / read-write\n" \
2684 "\n" \
2685 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002686 "You'll have to see the written documentation for those filesystems" \
2687
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002688#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002689 "$ mount\n" \
2690 "/dev/hda3 on / type minix (rw)\n" \
2691 "proc on /proc type proc (rw)\n" \
2692 "devpts on /dev/pts type devpts (rw)\n" \
2693 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2694 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2695 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002696#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002697 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002698
Rob Landleyd00b3a52005-08-20 05:07:08 +00002699#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002700 "[-q] <[-d] DIR | -x DEVICE>"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002701#define mountpoint_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002702 "mountpoint checks if the directory is a mountpoint\n" \
2703 "\nOptions:" \
2704 "\n -q Quiet" \
2705 "\n -d Print major/minor device number of the filesystem" \
2706 "\n -x Print major/minor device number of the blockdevice" \
2707
Rob Landleyd00b3a52005-08-20 05:07:08 +00002708#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002709 "$ mountpoint /proc\n" \
2710 "/proc is not a mountpoint\n" \
2711 "$ mountpoint /sys\n" \
2712 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002713
Eric Andersen7e9276b2001-02-22 01:15:47 +00002714#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002715 "[-f device] opcode value"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002716#define mt_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002717 "Control magnetic tape drive operation\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002718 "\n" \
2719 "Available Opcodes:\n" \
2720 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002721 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2722 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2723 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002724 "setpart tell unload unlock weof wset" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002725
Eric Andersen7e9276b2001-02-22 01:15:47 +00002726#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002727 "[OPTION]... SOURCE DEST\n" \
2728 "or: mv [OPTION]... SOURCE... DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002729#define mv_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002730 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY\n" \
2731 "\nOptions:" \
2732 "\n -f Don't prompt before overwriting" \
2733 "\n -i Interactive, prompt before overwrite" \
2734
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002735#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002736 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002737
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002738#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002739 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002740#define nameif_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002741 "Rename network interface while it in the down state\n" \
2742 "\nOptions:" \
2743 "\n -c FILE Use configuration file (default is /etc/mactab)" \
2744 "\n -s Use syslog (LOCAL0 facility)" \
2745 "\n IFNAME MACADDR new_interface_name interface_mac_address" \
2746
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002747#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002748 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2749 " or\n" \
2750 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002751
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002752#if !ENABLE_DESKTOP
2753
Rob Landley1cca9482006-07-10 19:45:20 +00002754#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002755#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002756#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002757#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002758#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002759
Eric Andersen7e9276b2001-02-22 01:15:47 +00002760#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002761 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002762 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002763#define nc_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002764 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002765 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002766 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002767 "\n -e Exec rest of command line after connect" \
2768 "\n -i SECS Delay interval for lines sent" \
2769 "\n -w SECS Timeout for connect" \
2770 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002771 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002772 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002773 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002774 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002775 "\n (use -l twice with -e for persistent server)") \
2776 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002777 )
2778
Rob Landley1cca9482006-07-10 19:45:20 +00002779#define nc_notes_usage "" \
2780 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002781 "To use netcat as a terminal emulator on a serial port:\n\n" \
2782 "$ stty 115200 -F /dev/ttyS0\n" \
2783 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2784 )
Rob Landley1cca9482006-07-10 19:45:20 +00002785
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002786#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002787 "$ nc foobar.somedomain.com 25\n" \
2788 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2789 "help\n" \
2790 "214-Commands supported:\n" \
2791 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2792 "214 NOOP QUIT RSET HELP\n" \
2793 "quit\n" \
2794 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002795
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002796#else /* DESKTOP nc - much more compatible with nc 1.10 */
2797
2798#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002799 "[-options] hostname port - connect" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002800 USE_NC_SERVER("\n" \
2801 "nc [-options] -l -p port [hostname] [port] - listen")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002802#define nc_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002803 "Options:" \
2804 "\n -e prog [args] Program to exec after connect (must be last)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002805 USE_NC_SERVER( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002806 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002807 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002808 "\n -n Don't do DNS resolution" \
2809 "\n -s addr Local address" \
2810 "\n -p port Local port" \
2811 "\n -u UDP mode" \
2812 "\n -v Verbose (cumulative: -vv)" \
2813 "\n -w secs Timeout for connects and final net reads" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002814 USE_NC_EXTRA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002815 "\n -i sec Delay interval for lines sent" /* ", ports scanned" */ \
2816 "\n -o file Hex dump of traffic" \
2817 "\n -z Zero-I/O mode (scanning)" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002818 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00002819/* "\n -r Randomize local and remote ports" */
2820/* "\n -g gateway Source-routing hop point[s], up to 8" */
2821/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002822/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2823
2824#endif
2825
Eric Andersen1552ff72001-10-31 11:07:12 +00002826#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002827 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002828#define netstat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002829 "Display networking information\n" \
2830 "\nOptions:" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002831 "\n -l Display listening server sockets" \
2832 "\n -a Display all sockets (default: connected)" \
2833 "\n -e Display other/more information" \
2834 "\n -n Don't resolve names" \
2835 "\n -t Tcp sockets" \
2836 "\n -u Udp sockets" \
2837 "\n -w Raw sockets" \
2838 "\n -x Unix sockets" \
2839 "\n -r Display routing table" \
2840 USE_FEATURE_NETSTAT_WIDE( \
2841 "\n -W Display with no column truncation" \
2842 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002843
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002844#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002845 "[-n ADJUST] [COMMAND [ARG]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002846#define nice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002847 "Run a program with modified scheduling priority\n" \
2848 "\nOptions:" \
2849 "\n -n ADJUST Adjust the scheduling priority by ADJUST" \
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002850
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002851#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002852 "format_string"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002853#define nmeter_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002854 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002855 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002856 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002857 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002858 "%[niface] Monitor network interface 'iface'\n" \
2859 "%m Monitor allocated memory\n" \
2860 "%[mf] Monitor free memory\n" \
2861 "%[mt] Monitor total memory\n" \
2862 "%s Monitor allocated swap\n" \
2863 "%f Monitor number of used file descriptors\n" \
2864 "%Ni Monitor total/specific IRQ rate\n" \
2865 "%x Monitor context switch rate\n" \
2866 "%p Monitor forks\n" \
2867 "%[pn] Monitor # of processes\n" \
2868 "%b Monitor block io\n" \
2869 "%Nt Show time (with N decimal points)\n" \
2870 "%Nd Milliseconds between updates (default=1000)\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002871 "%r Print <cr> instead of <lf> at EOL" \
2872
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002873#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002874 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002875
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002876#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002877 "COMMAND [ARGS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002878#define nohup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002879 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002880#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002881 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002882
Eric Andersen7e9276b2001-02-22 01:15:47 +00002883#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002884 "[HOST] [SERVER]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002885#define nslookup_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002886 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002887 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002888#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002889 "$ nslookup localhost\n" \
2890 "Server: default\n" \
2891 "Address: default\n" \
2892 "\n" \
2893 "Name: debian\n" \
2894 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002895
Glenn L McGrath60281112001-11-02 11:39:46 +00002896#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002897 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002898#define od_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002899 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002900 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002901
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002902#define openvt_trivial_usage \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002903 "[-c NUM] [-sw] [COMMAND [ARGS]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002904#define openvt_full_usage "\n\n" \
Denis Vlasenko95891fc2008-03-27 16:26:35 +00002905 "Start COMMAND on a new virtual terminal\n" \
2906 "\nOptions:" \
2907 "\n -c Use specified VT" \
2908 "\n -s Switch to the VT" \
2909/* "\n -l Run COMMAND as login shell (by prepending '-')" */ \
2910 "\n -w Wait for COMMAND to exit" \
2911
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002912#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002913 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002914
Eric Andersen27f64e12002-06-23 04:24:25 +00002915#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002916 "[OPTION] [name]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002917#define passwd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002918 "Change user's password. If no name is specified,\n" \
2919 "changes the password for the current user.\n" \
2920 "\nOptions:" \
2921 "\n -a Algorithm to use for password (choices: des, md5)" /* ", sha1)" */ \
2922 "\n -d Delete password for the account" \
2923 "\n -l Lock (disable) account" \
2924 "\n -u Unlock (re-enable) account" \
Eric Andersen27f64e12002-06-23 04:24:25 +00002925
Denis Vlasenko21d10142007-07-20 21:28:41 +00002926#define chpasswd_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002927 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002928#define chpasswd_full_usage "\n\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002929 "Read user:password information from stdin\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002930 "and update /etc/passwd accordingly.\n" \
2931 "\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002932 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002933 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2934 "\n -m,--md5 Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002935 ) \
2936 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00002937 "\n -e Supplied passwords are in encrypted form" \
2938 "\n -m Use MD5 encryption instead of DES" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002939 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002940
Glenn L McGrath655d8142003-06-22 15:32:41 +00002941#define patch_trivial_usage \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002942 "[-p NUM] [-i DIFF] [-R]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002943#define patch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002944 " -p NUM Strip NUM leading components from file names" \
2945 "\n -i DIFF Read DIFF instead of stdin" \
Denis Vlasenko08ec67b2008-03-26 13:32:30 +00002946 "\n -R Reverse patch" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002947
Glenn L McGrath655d8142003-06-22 15:32:41 +00002948#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002949 "$ patch -p1 < example.diff\n" \
2950 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002951
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002952#define pgrep_trivial_usage \
2953 "[-flnovx] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002954#define pgrep_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002955 "Display process(es) selected by regex pattern\n" \
2956 "\nOptions:" \
2957 "\n -l Show command name too" \
2958 "\n -f Match against entire command line" \
2959 "\n -n Show the newest process only" \
2960 "\n -o Show the oldest process only" \
2961 "\n -v Negate the matching" \
2962 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002963
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002964#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
Eric Andersen221b2ea2001-07-31 19:06:07 +00002965#define pidof_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002966 "[OPTION] [NAME...]"
2967#define USAGE_PIDOF "\n\nOptions:"
2968#else
2969#define pidof_trivial_usage \
2970 "[NAME...]"
2971#define USAGE_PIDOF /* none */
2972#endif
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002973#define pidof_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002974 "List PIDs of all processes with names that match NAMEs" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002975 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002976 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002977 "\n -s Show only one PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002978 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00002979 "\n -o PID Omit given pid" \
Denis Vlasenko397de612008-03-17 08:55:44 +00002980 "\n Use %PPID to omit pid of pidof's parent") \
2981
Eric Andersen221b2ea2001-07-31 19:06:07 +00002982#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002983 "$ pidof init\n" \
2984 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002985 USE_FEATURE_PIDOF_OMIT( \
2986 "$ pidof /bin/sh\n20351 5973 5950\n") \
2987 USE_FEATURE_PIDOF_OMIT( \
2988 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002989
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002990#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002991#define ping_trivial_usage \
2992 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002993#define ping_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002994 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002995#define ping6_trivial_usage \
2996 "host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00002997#define ping6_full_usage "\n\n" \
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002998 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002999#else
3000#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003001 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003002#define ping_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003003 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3004 "\nOptions:" \
3005 "\n -4, -6 Force IPv4 or IPv6 hostname resolution" \
3006 "\n -c CNT Send only CNT pings" \
3007 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3008 "\n -I iface/IP Use interface or IP address as source" \
Denis Vlasenko90c31b32008-04-07 00:46:29 +00003009 "\n -W timeout Seconds to wait for the first response (default:10)" \
3010 "\n (after all -c CNT packets are sent)" \
3011 "\n -w deadline Seconds until ping exits (default:infinite)" \
3012 "\n (can exit earlier with -c CNT)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003013 "\n -q Quiet, only displays output at start" \
3014 "\n and when finished" \
3015
Eric Andersen51b8bd62002-07-03 11:46:38 +00003016#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003017 "[OPTION]... host"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003018#define ping6_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003019 "Send ICMP ECHO_REQUEST packets to network hosts\n" \
3020 "\nOptions:" \
3021 "\n -c CNT Send only CNT pings" \
3022 "\n -s SIZE Send SIZE data bytes in packets (default=56)" \
3023 "\n -I iface/IP Use interface or IP address as source" \
3024 "\n -q Quiet, only displays output at start" \
3025 "\n and when finished" \
3026
Eric Andersen51b8bd62002-07-03 11:46:38 +00003027#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00003028#define ping_example_usage \
3029 "$ ping localhost\n" \
3030 "PING slag (127.0.0.1): 56 data bytes\n" \
3031 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
3032 "\n" \
3033 "--- debian ping statistics ---\n" \
3034 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3035 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003036#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003037 "$ ping6 ip6-localhost\n" \
3038 "PING ip6-localhost (::1): 56 data bytes\n" \
3039 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
3040 "\n" \
3041 "--- ip6-localhost ping statistics ---\n" \
3042 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
3043 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00003044
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003045#define pipe_progress_trivial_usage NOUSAGE_STR
3046#define pipe_progress_full_usage ""
3047
Eric Andersen7e9276b2001-02-22 01:15:47 +00003048#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003049 "NEW_ROOT PUT_OLD"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003050#define pivot_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003051 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003052 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003053
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003054#define pkill_trivial_usage \
3055 "[-l] | [-fnovx] [-signal] pattern"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003056#define pkill_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003057 "Send a signal to process(es) selected by regex pattern\n" \
3058 "\nOptions:" \
3059 "\n -l List all signals" \
3060 "\n -f Match against entire command line" \
3061 "\n -n Signal the newest process only" \
3062 "\n -o Signal the oldest process only" \
3063 "\n -v Negate the matching" \
3064 "\n -x Match whole name (not substring)" \
Denis Vlasenko72e1c892007-09-29 22:26:01 +00003065
Eric Andersen7e9276b2001-02-22 01:15:47 +00003066#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003067 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003068#define poweroff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003069 "Halt and shut off power\n" \
3070 "\nOptions:" \
3071 "\n -d Delay interval for halting" \
3072 "\n -n No call to sync()" \
3073 "\n -f Force power off (don't go through init)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003074
Mike Frysinger95d3c452005-04-21 23:29:24 +00003075#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003076 "[VARIABLES...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003077#define printenv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003078 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003079 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00003080
Eric Andersen7e9276b2001-02-22 01:15:47 +00003081#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003082 "FORMAT [ARGUMENT...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003083#define printf_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003084 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003085 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003086#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003087 "$ printf \"Val=%d\\n\" 5\n" \
3088 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003089
Denis Vlasenko94949192006-11-05 00:45:47 +00003090
3091#if ENABLE_DESKTOP
3092
3093#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003094 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003095#define ps_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003096 "Report process status\n" \
3097 "\nOptions:" \
3098 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00003099
3100#else /* !ENABLE_DESKTOP */
3101
Denis Vlasenko397de612008-03-17 08:55:44 +00003102#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003103#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00003104#else
3105#define USAGE_PS "\nOptions:"
3106#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00003107
Eric Andersen7e9276b2001-02-22 01:15:47 +00003108#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003109 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003110#define ps_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003111 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00003112 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003113 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003114 "\n -Z Show SE Linux context" \
3115 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003116 USE_FEATURE_PS_WIDE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003117 "\n w Wide output" \
3118 )
Rob Landley6eb1e412005-06-20 04:30:36 +00003119
Denis Vlasenko94949192006-11-05 00:45:47 +00003120#endif /* ENABLE_DESKTOP */
3121
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003122#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003123 "$ ps\n" \
3124 " PID Uid Gid State Command\n" \
3125 " 1 root root S init\n" \
3126 " 2 root root S [kflushd]\n" \
3127 " 3 root root S [kupdate]\n" \
3128 " 4 root root S [kpiod]\n" \
3129 " 5 root root S [kswapd]\n" \
3130 " 742 andersen andersen S [bash]\n" \
3131 " 743 andersen andersen S -bash\n" \
3132 " 745 root root S [getty]\n" \
3133 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003134
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003135#define pscan_trivial_usage \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003136 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003137#define pscan_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003138 "Scan a host, print all open ports\n" \
3139 "\nOptions:" \
Denis Vlasenko715c16a2008-03-23 14:46:14 +00003140 "\n -c Show closed ports too" \
Denis Vlasenko324d26f2008-03-23 18:44:59 +00003141 "\n -b Show blocked ports too" \
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00003142 "\n -p Scan from this port (default 1)" \
3143 "\n -P Scan up to this port (default 1024)" \
3144 "\n -t Timeout (default 5000 ms)" \
3145 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
3146
Eric Andersen7e9276b2001-02-22 01:15:47 +00003147#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003148 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003149#define pwd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003150 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003151#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003152 "$ pwd\n" \
3153 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003154
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003155#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003156 "DEVICE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003157#define raidautorun_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003158 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003159#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003160 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00003161
Eric Andersen7e9276b2001-02-22 01:15:47 +00003162#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003163 "[-sp] HOST"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003164#define rdate_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003165 "Get and possibly set the system date and time from a remote HOST\n" \
3166 "\nOptions:" \
3167 "\n -s Set the system date and time (default)" \
3168 "\n -p Print the date and time" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003169
Rob Landley0e4690d2006-08-20 22:12:18 +00003170#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003171 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003172#define readahead_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003173 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
3174 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00003175
Eric Andersen7e9276b2001-02-22 01:15:47 +00003176#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003177 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003178#define readlink_full_usage "\n\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003179 "Display the value of a symlink" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003180 USE_FEATURE_READLINK_FOLLOW( "\n" \
3181 "\nOptions:" \
3182 "\n -f Canonicalize by following all symlinks") \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003183
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003184#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003185 "[OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003186#define readprofile_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003187 "Options:" \
3188 "\n -m mapfile (Default: /boot/System.map)" \
3189 "\n -p profile (Default: /proc/profile)" \
3190 "\n -M mult Set the profiling multiplier to mult" \
3191 "\n -i Print only info about the sampling step" \
3192 "\n -v Verbose" \
3193 "\n -a Print all symbols, even if count is 0" \
3194 "\n -b Print individual histogram-bin counts" \
3195 "\n -s Print individual counters within functions" \
3196 "\n -r Reset all the counters (root only)" \
3197 "\n -n Disable byte order auto-detection" \
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003198
Glenn L McGrath62fae302002-12-10 00:14:33 +00003199#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003200 "pathname..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003201#define realpath_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003202 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003203
Eric Andersen7e9276b2001-02-22 01:15:47 +00003204#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003205 "[-d delay] [-n] [-f]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003206#define reboot_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003207 "Reboot the system\n" \
3208 "\nOptions:" \
3209 "\n -d Delay interval for rebooting" \
3210 "\n -n No call to sync()" \
3211 "\n -f Force reboot (don't go through init)" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00003212
3213#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003214 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003215#define renice_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003216 "Change priority of running processes\n" \
3217 "\nOptions:" \
3218 "\n -n Adjust current nice value (smaller is faster)" \
3219 "\n -p Process id(s) (default)" \
3220 "\n -g Process group id(s)" \
3221 "\n -u Process user name(s) and/or id(s)" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003222
Eric Andersen7e9276b2001-02-22 01:15:47 +00003223#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003224 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003225#define reset_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003226 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003227
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003228#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003229 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003230#define resize_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003231 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003232
Denis Vlasenko397137b2007-07-23 14:03:30 +00003233#define restorecon_trivial_usage \
3234 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003235#define restorecon_full_usage "\n\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003236 "Reset security contexts of files in pathname\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003237 "\n -i Ignore files that do not exist" \
3238 "\n -f file File with list of files to process. Use - for stdin" \
3239 "\n -e directory Directory to exclude" \
3240 "\n -R,-r Recurse directories" \
3241 "\n -n Don't change any file labels" \
3242 "\n -o file Save list of files with incorrect context" \
3243 "\n -v Verbose" \
3244 "\n -vv Show changed labels" \
3245 "\n -F Force reset of context to match file_context" \
3246 "\n for customizable files, or the user section," \
3247 "\n if it has changed" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003248
Eric Andersen7e9276b2001-02-22 01:15:47 +00003249#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003250 "[OPTION]... FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003251#define rm_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003252 "Remove (unlink) the FILE(s). Use '--' to\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003253 "indicate that all following arguments are non-options.\n" \
3254 "\nOptions:" \
3255 "\n -i Always prompt before removing" \
3256 "\n -f Never prompt" \
3257 "\n -r,-R Remove directories recursively" \
3258
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003259#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003260 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003261
Eric Andersen7e9276b2001-02-22 01:15:47 +00003262#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003263 "[OPTION]... DIRECTORY..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003264#define rmdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003265 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003266#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003267 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003268
Eric Andersen7e9276b2001-02-22 01:15:47 +00003269#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003270 "[OPTION]... [MODULE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003271#define rmmod_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003272 "Unload the specified kernel modules from the kernel\n" \
3273 "\nOptions:" \
3274 "\n -a Remove all unused modules (recursively)" \
3275
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003276#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003277 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003278
Eric Andersen7e9276b2001-02-22 01:15:47 +00003279#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003280 "[{add|del|delete}]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003281#define route_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003282 "Edit the kernel's routing tables\n" \
3283 "\nOptions:" \
Denis Vlasenko68e5e2b2008-03-25 03:17:04 +00003284 "\n -n Don't resolve names" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003285 "\n -e Display other/more information" \
3286 "\n -A inet" USE_FEATURE_IPV6("{6}") " Select address family" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003287
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003288#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003289 "-i -q[ildc]p package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003290#define rpm_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003291 "Manipulate RPM packages\n" \
3292 "\nOptions:" \
3293 "\n -i Install package" \
3294 "\n -q Query package" \
3295 "\n -p Query uninstalled package" \
3296 "\n -i Show information" \
3297 "\n -l List contents" \
3298 "\n -d List documents" \
3299 "\n -c List config files" \
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003300
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003301#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003302 "package.rpm"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003303#define rpm2cpio_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003304 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003305
Mike Frysinger6b160e42008-02-15 02:27:19 +00003306#define rtcwake_trivial_usage \
3307 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003308#define rtcwake_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003309 "Enter a system sleep state until specified wakeup time\n" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003310 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003311 "\n -a,--auto Read clock mode from adjtime" \
3312 "\n -l,--local Clock is set to local time" \
3313 "\n -u,--utc Clock is set to UTC time" \
3314 "\n -d,--device=DEV Specify the RTC device" \
3315 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
3316 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
3317 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003318 ) \
3319 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003320 "\n -a Read clock mode from adjtime" \
3321 "\n -l Clock is set to local time" \
3322 "\n -u Clock is set to UTC time" \
3323 "\n -d DEV Specify the RTC device" \
3324 "\n -m MODE Set the sleep state (default: standby)" \
3325 "\n -s SEC Set the timeout in SEC seconds from now" \
3326 "\n -t TIME Set the timeout to TIME seconds from epoch" \
Mike Frysinger6b160e42008-02-15 02:27:19 +00003327 )
3328
Denis Vlasenko49622d72007-03-10 16:58:49 +00003329#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003330 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3331 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003332#define runcon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003333 "Run a program in a different security context\n" \
3334 "\n CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003335 USE_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003336 "\n -c,--compute Compute process transition context before modifying" \
3337 "\n -t,--type=TYPE Type (for same role as parent)" \
3338 "\n -u,--user=USER User identity" \
3339 "\n -r,--role=ROLE Role" \
3340 "\n -l,--range=RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003341 ) \
3342 SKIP_GETOPT_LONG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003343 "\n -c Compute process transition context before modifying" \
3344 "\n -t TYPE Type (for same role as parent)" \
3345 "\n -u USER User identity" \
3346 "\n -r ROLE Role" \
3347 "\n -l RNG Levelrange" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003348 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003349
Eric Andersen6cf47a72001-10-31 10:24:36 +00003350#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003351 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003352#define run_parts_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00003353 "Run a bunch of scripts in a directory\n" \
3354 "\nOptions:" \
3355 "\n -t Print what would be run, but don't actually run anything" \
3356 "\n -a ARG Pass ARG as argument for every program" \
3357 "\n -u MASK Set the umask to MASK before running every program" \
3358 USE_FEATURE_RUN_PARTS_FANCY( \
3359 "\n -l Print names of all matching files even if they are not executable" \
3360 )
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003361
3362#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003363 "$ run-parts -a start /etc/init.d\n" \
3364 "$ run-parts -a stop=now /etc/init.d\n\n" \
3365 "Let's assume you have a script foo/dosomething:\n" \
3366 "#!/bin/sh\n" \
3367 "for i in $*; do eval $i; done; unset i\n" \
3368 "case \"$1\" in\n" \
3369 "start*) echo starting something;;\n" \
3370 "stop*) set -x; shutdown -h $stop;;\n" \
3371 "esac\n\n" \
3372 "Running this yields:\n" \
3373 "$run-parts -a stop=+4m foo/\n" \
3374 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003375
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003376#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003377 "[utmp]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003378#define runlevel_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003379 "Find the current and previous system runlevel.\n\n" \
3380 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003381 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003382#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003383 "$ runlevel /var/run/utmp\n" \
3384 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003385
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003386#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003387 "dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003388#define runsv_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003389 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003390
3391#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003392 "[-P] dir"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003393#define runsvdir_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003394 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003395
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003396#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003397 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003398#define rx_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003399 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003400#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003401 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003402
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003403#define script_trivial_usage \
3404 "[-afq] [-c COMMAND] [OUTFILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003405#define script_full_usage "\n\n" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003406 "Options:" \
3407 "\n -a Append output" \
3408 "\n -c Run COMMAND, not shell" \
3409 "\n -f Flush output after each write" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003410 "\n -q Quiet" \
Denis Vlasenko5014dad2008-02-27 11:54:59 +00003411
Eric Andersen7e9276b2001-02-22 01:15:47 +00003412#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003413 "[-efinr] pattern [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003414#define sed_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003415 "Options:" \
3416 "\n -e script Add the script to the commands to be executed" \
3417 "\n -f scriptfile Add scriptfile contents to the" \
3418 "\n commands to be executed" \
3419 "\n -i Edit files in-place" \
3420 "\n -n Suppress automatic printing of pattern space" \
3421 "\n -r Use extended regular expression syntax" \
3422 "\n" \
3423 "\nIf no -e or -f is given, the first non-option argument is taken as the sed" \
3424 "\nscript to interpret. All remaining arguments are names of input files; if no" \
3425 "\ninput files are specified, then the standard input is read. Source files" \
3426 "\nwill not be modified unless -i option is given." \
Eric Andersenf802ff72004-04-12 15:12:06 +00003427
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003428#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003429 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3430 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003431
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003432#define selinuxenabled_trivial_usage NOUSAGE_STR
3433#define selinuxenabled_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003434
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003435#define sendmail_trivial_usage \
Denis Vlasenko17db1a92008-02-26 21:13:17 +00003436 "[-w timeout] [-U user] [-P password] [-X]\n" \
3437 "-t to [-t to]... [-n] [-s subject] [-c charset] server[:port] from [body] [attachment ...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003438#define sendmail_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003439 "Send an email.\n" \
3440 "\nOptions:" \
3441 "\n -w timeout Set timeout on network operations" \
3442 "\n -U username Authenticate with specified username/password" \
3443 "\n -P password" \
3444 "\n -t address Recipient(s). May be repeated" \
3445 "\n -X Use openssl connection helper for secured servers" \
3446 "\n -n Request delivery notification to sender" \
3447 "\n -s subject Subject" \
3448 "\n -c charset Assumed charset for body and subject [utf-8]" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003449
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003450#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003451 "[first [increment]] last"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003452#define seq_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003453 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003454 "FIRST, INCREMENT default to 1" \
3455 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003456 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003457 " FIRST LAST\n" \
3458 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003459
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003460#define sestatus_trivial_usage \
3461 "[-vb]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003462#define sestatus_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003463 " -v Verbose" \
3464 "\n -b Display current state of booleans" \
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003465
Paul Foxfc2256a2005-08-01 18:12:30 +00003466#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003467 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003468#define setconsole_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003469 "Redirect system console output to DEVICE (default: /dev/tty)\n" \
3470 "\nOptions:" \
3471 "\n -r Reset output to /dev/console" \
Paul Foxfc2256a2005-08-01 18:12:30 +00003472
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003473#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003474 "[Enforcing | Permissive | 1 | 0]"
Bernhard Reutner-Fischer62538802008-05-08 12:21:44 +00003475#define setenforce_full_usage ""
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003476
Denis Vlasenko397137b2007-07-23 14:03:30 +00003477#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003478 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003479 USE_FEATURE_SETFILES_CHECK_OPTION( \
3480 " [-c policyfile] spec_file" \
3481 ) \
3482 " pathname"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003483#define setfiles_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003484 "Reset file contexts under pathname according to spec_file\n" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003485 USE_FEATURE_SETFILES_CHECK_OPTION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003486 "\n -c file Check the validity of the contexts against the specified binary policy" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003487 ) \
Denis Vlasenko397de612008-03-17 08:55:44 +00003488 "\n -d Show which specification matched each file" \
3489 "\n -l Log changes in file labels to syslog" \
3490 "\n -n Don't change any file labels" \
3491 "\n -q Suppress warnings" \
3492 "\n -r dir Use an altenate root path" \
3493 "\n -e dir Exclude directory" \
3494 "\n -F Force reset of context to match file_context for customizable files" \
3495 "\n -o file Save list of files with incorrect context" \
3496 "\n -s Take a list of files from standard input (instead of command line)" \
3497 "\n -v Show changes in file labels, if type or role are changing" \
3498 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3499 "\n -W Display warnings about entries that had no matching files" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003500
Eric Andersen7e9276b2001-02-22 01:15:47 +00003501#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003502 "SCANCODE KEYCODE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003503#define setkeycodes_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003504 "Set entries into the kernel's scancode-to-keycode map,\n" \
3505 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3506 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003507 "and KEYCODE is given in decimal" \
3508
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003509#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003510 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003511
Rob Landley87848d92006-03-27 23:23:43 +00003512#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003513 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003514#define setlogcons_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003515 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003516
Denis Vlasenkobe039372007-10-14 04:48:44 +00003517#define setsebool_trivial_usage \
3518 "boolean value"
3519
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003520#define setsebool_full_usage "\n\n" \
Denis Vlasenkobe039372007-10-14 04:48:44 +00003521 "Change boolean setting"
3522
Paul Fox42403642005-08-01 22:52:09 +00003523#define setsid_trivial_usage \
Denis Vlasenko397de612008-03-17 08:55:44 +00003524 "PROG [ARG...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003525#define setsid_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003526 "Run PROG in a new session. PROG will have no controlling terminal\n" \
3527 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
3528 "See setsid(2) for details." \
Paul Fox42403642005-08-01 22:52:09 +00003529
Matt Kraai2d91deb2001-08-01 17:21:35 +00003530#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003531 "[FILE]...\n" \
3532 "or: sh -c command [args]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003533#define lash_full_usage "\n\n" \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003534 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003535
Eric Andersen2e9c2572003-08-08 22:26:06 +00003536#define last_trivial_usage \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003537 ""USE_FEATURE_LAST_FANCY("[-HW] [-f file]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003538#define last_full_usage "\n\n" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003539 "Show listing of the last users that logged into the system" \
3540 USE_FEATURE_LAST_FANCY( "\n" \
3541 "\nOptions:" \
Denis Vlasenkob22a8052008-05-22 02:10:50 +00003542/* "\n -H Show header line" */ \
3543 "\n -W Display with no host column truncation" \
3544 "\n -f file Read from file instead of /var/log/wtmp" \
Denis Vlasenko869d3d32008-05-22 02:07:58 +00003545 )
Eric Andersen2e9c2572003-08-08 22:26:06 +00003546
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003547#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003548 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003549 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003550#define sha1sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003551 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums." \
3552 USE_FEATURE_MD5_SHA1_SUM_CHECK( "\n" \
3553 "\nOptions:" \
3554 "\n -c Check SHA1 sums against given list" \
3555 "\n -s Don't output anything, status code shows success" \
3556 "\n -w Warn about improperly formatted SHA1 checksum lines" \
3557 )
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003558
Denis Vlasenko14923db2007-06-20 15:23:03 +00003559#define slattach_trivial_usage \
3560 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003561#define slattach_full_usage "\n\n" \
Denis Vlasenko14923db2007-06-20 15:23:03 +00003562 "Attach network interface(s) to serial line(s)\n" \
3563 "\nOptions:" \
3564 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3565 "\n -s Set line speed" \
3566 "\n -e Exit after initializing device" \
3567 "\n -h Exit when the carrier is lost" \
3568 "\n -c Execute a command when the line is hung up" \
3569 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3570 "\n -L Enable 3-wire operation" \
3571 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003572
Eric Andersen7e9276b2001-02-22 01:15:47 +00003573#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003574 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003575#define sleep_full_usage "\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003576 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003577 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003578 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003579 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003580#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003581 "$ sleep 2\n" \
3582 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003583 USE_FEATURE_FANCY_SLEEP( \
3584 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003585 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003586
Eric Andersen7e9276b2001-02-22 01:15:47 +00003587#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003588 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003589 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003590 "] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003591#define sort_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003592 "Sort lines of text\n" \
3593 "\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003594 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003595 "\n -b Ignore leading blanks" \
3596 "\n -c Check whether input is sorted" \
3597 "\n -d Dictionary order (blank or alphanumeric only)" \
3598 "\n -f Ignore case" \
3599 "\n -g General numerical sort" \
3600 "\n -i Ignore unprintable characters" \
3601 "\n -k Sort key" \
3602 "\n -M Sort month" \
3603 ) \
3604 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003605 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003606 "\n -o Output to file" \
3607 "\n -k Sort by key" \
3608 "\n -t CHAR Key separator" \
3609 ) \
3610 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003611 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003612 "\n -s Stable (don't sort ties alphabetically)" \
3613 ) \
3614 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003615 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003616 "\n -z Lines are terminated by NUL, not newline" \
3617 "\n -mST Ignored for GNU compatibility") \
3618
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003619#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003620 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3621 "a\n" \
3622 "b\n" \
3623 "c\n" \
3624 "d\n" \
3625 "e\n" \
3626 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003627 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003628 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3629 "d 2\n" \
3630 "b 2\n" \
3631 "c 3\n" \
3632 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003633 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003634
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003635#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003636 "[OPTION] [INPUT [PREFIX]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003637#define split_full_usage "\n\n" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003638 "Options:" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003639 "\n -b n[k|m] Split by bytes" \
3640 "\n -l n Split by lines" \
3641 "\n -a n Use n letters as suffix" \
3642
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003643#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003644 "$ split TODO foo\n" \
3645 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003646
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003647#define start_stop_daemon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003648 "[OPTIONS] [" \
3649 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3650 "] ... [-- arguments...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003651#define start_stop_daemon_full_usage "\n\n" \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003652 "Search for matching processes, and then\n" \
3653 "-S: stop all matching processes.\n" \
3654 "-K: start a process unless a matching process is found.\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003655 USE_GETOPT_LONG( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003656 "\nProcess matching:" \
3657 "\n -u,--user USERNAME|UID Match only this user's processes" \
3658 "\n -n,--name NAME Match processes with NAME" \
3659 "\n in comm field in /proc/PID/stat" \
3660 "\n -x,--exec EXECUTABLE Match processes with this command" \
3661 "\n in /proc/PID/cmdline" \
3662 "\n -p,--pidfile FILE Match a process with PID from the file" \
3663 "\n All specified conditions must match" \
3664 "\n-K only:" \
3665 "\n -x,--exec EXECUTABLE Program to run" \
3666 "\n -a,--startas NAME Zeroth argument" \
3667 "\n -b,--background Background" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003668 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003669 "\n -N,--nicelevel N Change nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003670 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003671 "\n -c,--chuid USER[:[GRP]] Change to user/group" \
3672 "\n -m,--make-pidfile Write PID to the pidfile specified by -p" \
3673 "\n-S only:" \
3674 "\n -s,--signal SIG Signal to send" \
3675 "\n -t,--test Match only, exit with 0 if a process is found" \
3676 "\nOther:" \
3677 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3678 "\n -o,--oknodo Exit with status 0 if nothing is done" \
3679 "\n -q,--quiet Quiet" \
3680 ) \
3681 "\n -v,--verbose Verbose" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003682 ) \
3683 SKIP_GETOPT_LONG( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003684 "\nProcess matching:" \
3685 "\n -u USERNAME|UID Match only this user's processes" \
3686 "\n -n NAME Match processes with NAME" \
3687 "\n in comm field in /proc/PID/stat" \
3688 "\n -x EXECUTABLE Match processes with this command" \
3689 "\n command in /proc/PID/cmdline" \
3690 "\n -p FILE Match a process with PID from the file" \
3691 "\n All specified conditions must match" \
3692 "\n-K only:" \
3693 "\n -x EXECUTABLE Program to run" \
3694 "\n -a NAME Zeroth argument" \
3695 "\n -b Background" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003696 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003697 "\n -N N Change nice level" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003698 ) \
Denis Vlasenkoe125a682008-05-18 21:17:52 +00003699 "\n -c USER[:[GRP]] Change to user/group" \
3700 "\n -m Write PID to the pidfile specified by -p" \
3701 "\n-S only:" \
3702 "\n -s SIG Signal to send" \
3703 "\n -t Match only, exit with 0 if a process is found" \
3704 "\nOther:" \
3705 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3706 "\n -o Exit with status 0 if nothing is done" \
3707 "\n -q Quiet" \
3708 ) \
3709 "\n -v Verbose" \
3710 ) \
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003711
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003712#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003713 "[OPTION] FILE..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003714#define stat_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003715 "Display file (default) or filesystem status\n" \
3716 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003717 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003718 "\n -c fmt Use the specified format" \
3719 ) \
3720 "\n -f Display filesystem status" \
3721 "\n -L Dereference links" \
3722 "\n -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003723 USE_SELINUX( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003724 "\n -Z Print security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003725 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003726 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003727 "\n\nValid format sequences for files:\n" \
3728 " %a Access rights in octal\n" \
3729 " %A Access rights in human readable form\n" \
3730 " %b Number of blocks allocated (see %B)\n" \
3731 " %B The size in bytes of each block reported by %b\n" \
3732 " %d Device number in decimal\n" \
3733 " %D Device number in hex\n" \
3734 " %f Raw mode in hex\n" \
3735 " %F File type\n" \
3736 " %g Group ID of owner\n" \
3737 " %G Group name of owner\n" \
3738 " %h Number of hard links\n" \
3739 " %i Inode number\n" \
3740 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003741 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003742 " %o I/O block size\n" \
3743 " %s Total size, in bytes\n" \
3744 " %t Major device type in hex\n" \
3745 " %T Minor device type in hex\n" \
3746 " %u User ID of owner\n" \
3747 " %U User name of owner\n" \
3748 " %x Time of last access\n" \
3749 " %X Time of last access as seconds since Epoch\n" \
3750 " %y Time of last modification\n" \
3751 " %Y Time of last modification as seconds since Epoch\n" \
3752 " %z Time of last change\n" \
3753 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003754 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003755 " %a Free blocks available to non-superuser\n" \
3756 " %b Total data blocks in file system\n" \
3757 " %c Total file nodes in file system\n" \
3758 " %d Free file nodes in file system\n" \
3759 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003760 USE_SELINUX( \
3761 " %C Security context in SELinux\n" \
3762 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003763 " %i File System ID in hex\n" \
3764 " %l Maximum length of filenames\n" \
3765 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003766 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003767 " %S Fundamental block size (for block counts)\n" \
3768 " %t Type in hex\n" \
3769 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003770 )
3771
Eric Andersenef5e8f82002-11-07 02:09:37 +00003772#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003773 "[-afo] [-n length] [file...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003774#define strings_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003775 "Display printable strings in a binary file\n" \
3776 "\nOptions:" \
3777 "\n -a Scan whole file (default)" \
3778 "\n -f Precede strings with filenames" \
3779 "\n -n N At least N characters form a string (default 4)" \
3780 "\n -o Precede strings with decimal offsets" \
Eric Andersenef5e8f82002-11-07 02:09:37 +00003781
Eric Andersen7e9276b2001-02-22 01:15:47 +00003782#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003783 "[-a|g] [-F DEVICE] [SETTING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003784#define stty_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003785 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003786 "and deviations from stty sane\n" \
3787 "\nOptions:" \
3788 "\n -F DEVICE Open device instead of stdin" \
3789 "\n -a Print all current settings in human-readable form" \
3790 "\n -g Print in stty-readable form" \
3791 "\n [SETTING] See manpage" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003792
Robert Griebl1fca5582002-06-04 20:45:46 +00003793#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003794 "[OPTION]... [-] [username]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003795#define su_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003796 "Change user id or become root\n" \
3797 "\nOptions:" \
3798 "\n -p, -m Preserve environment" \
3799 "\n -c Command to pass to 'sh -c'" \
3800 "\n -s Shell to use instead of default shell" \
Robert Griebl1fca5582002-06-04 20:45:46 +00003801
Eric Andersen27f64e12002-06-23 04:24:25 +00003802#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003803 "[OPTION]... [tty-device]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003804#define sulogin_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003805 "Single user login\n" \
3806 "\nOptions:" \
3807 "\n -t Timeout" \
Eric Andersen27f64e12002-06-23 04:24:25 +00003808
Mike Frysinger95d3c452005-04-21 23:29:24 +00003809#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003810 "[rs] [files...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003811#define sum_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003812 "Checksum and count the blocks in a file\n" \
3813 "\nOptions:" \
3814 "\n -r Use BSD sum algorithm (1K blocks)" \
3815 "\n -s Use System V sum algorithm (512byte blocks)" \
Mike Frysinger95d3c452005-04-21 23:29:24 +00003816
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003817#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003818 "[-v] [-w sec] command service..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003819#define sv_full_usage "\n\n" \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003820 "Control services monitored by runsv supervisor.\n" \
3821 "Commands (only first character is enough):\n" \
3822 "\n" \
3823 "status: query service status\n" \
3824 "up: if service isn't running, start it. If service stops, restart it\n" \
3825 "once: like 'up', but if service stops, don't restart it\n" \
3826 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3827 " if it exists. After it stops, do not restart service\n" \
3828 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3829 " runsv exits too\n" \
3830 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003831 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003832
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003833#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003834 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003835#define svlogd_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003836 "Continuously read log data from standard input, optionally " \
3837 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko397de612008-03-17 08:55:44 +00003838 "rotated logs" \
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003839
Eric Andersen7e9276b2001-02-22 01:15:47 +00003840#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003841 "[-a] [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003842#define swapoff_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003843 "Stop swapping on DEVICE\n" \
3844 "\nOptions:" \
3845 "\n -a Stop swapping on all swap devices" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003846
Eric Andersen7e9276b2001-02-22 01:15:47 +00003847#define swapon_trivial_usage \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00003848 "[-a]" USE_FEATURE_SWAPON_PRI(" [-p pri]") " [DEVICE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003849#define swapon_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003850 "Start swapping on DEVICE\n" \
3851 "\nOptions:" \
3852 "\n -a Start swapping on all swap devices" \
Denis Vlasenkoee56e012008-05-18 23:05:34 +00003853 USE_FEATURE_SWAPON_PRI( \
3854 "\n -p pri Set swap device priority" \
3855 ) \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003856
Rob Landley0f34a822005-10-27 22:55:50 +00003857#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003858 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003859#define switch_root_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003860 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003861 "and exec NEW_INIT\n" \
3862 "\nOptions:" \
3863 "\n -c Redirect console to device on new root" \
Rob Landley0f34a822005-10-27 22:55:50 +00003864
Eric Andersen7e9276b2001-02-22 01:15:47 +00003865#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003866 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003867#define sync_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003868 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003869
Eric Andersenb9050282003-12-24 06:02:11 +00003870#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003871 "[OPTIONS]... [VALUE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003872#define sysctl_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003873 "Configure kernel parameters at runtime\n" \
3874 "\nOptions:" \
3875 "\n -n Disable printing of key names" \
3876 "\n -e Don't warn about unknown keys" \
3877 "\n -w Change sysctl setting" \
3878 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
3879 "\n -a Display all values" \
3880 "\n -A Display all values in table form" \
3881
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003882#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003883 "sysctl [-n] [-e] variable...\n" \
3884 "sysctl [-n] [-e] -w variable=value...\n" \
3885 "sysctl [-n] [-e] -a\n" \
3886 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3887 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003888
Eric Andersen7e9276b2001-02-22 01:15:47 +00003889#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003890 "[OPTION]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003891#define syslogd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003892 "System logging utility.\n" \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003893 "Note that this version of syslogd ignores /etc/syslog.conf.\n" \
3894 "\nOptions:" \
3895 "\n -n Run in foreground" \
3896 "\n -O FILE Log to given file (default=/var/log/messages)" \
3897 "\n -l n Set local log level" \
3898 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003899 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003900 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3901 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003902 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003903 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3904 "\n -L Log locally and via network (default is network only if -R)") \
3905 USE_FEATURE_SYSLOGD_DUP( \
3906 "\n -D Drop duplicates") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003907 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003908 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003909 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkobe048f22008-02-26 20:13:52 +00003910/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Denis Vlasenko397de612008-03-17 08:55:44 +00003911
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003912#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003913 "$ syslogd -R masterlog:514\n" \
3914 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003915
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003916#define tac_trivial_usage \
3917 "[FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003918#define tac_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003919 "Concatenate FILE(s) and print them in reverse"
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003920
Eric Andersen7e9276b2001-02-22 01:15:47 +00003921#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003922 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003923#define tail_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003924 "Print last 10 lines of each FILE to standard output.\n" \
3925 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003926 "file name. With no FILE, or when FILE is -, read standard input.\n" \
3927 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003928 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003929 "\n -c N[kbm] Output the last N bytes") \
3930 "\n -n N[kbm] Print last N lines instead of last 10" \
3931 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003932 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003933 "\n -q Never output headers giving file names" \
3934 "\n -s SEC Wait SEC seconds between reads with -f" \
3935 "\n -v Always output headers giving file names" \
3936 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003937 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3938 "the Nth item from the start of each file, otherwise, print the last N items\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003939 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) \
3940
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003941#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003942 "$ tail -n 1 /etc/resolv.conf\n" \
3943 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003944
Eric Andersen7e9276b2001-02-22 01:15:47 +00003945#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003946 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003947 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3948 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003949 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003950 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003951#define tar_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003952 "Create, extract, or list files from a tar file\n" \
3953 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003954 USE_FEATURE_TAR_CREATE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003955 "\n c Create") \
3956 "\n x Extract" \
3957 "\n t List" \
3958 "\nArchive format selection:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003959 USE_FEATURE_TAR_GZIP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003960 "\n z Filter the archive through gzip" \
3961 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003962 USE_FEATURE_TAR_BZIP2( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003963 "\n j Filter the archive through bzip2" \
3964 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003965 USE_FEATURE_TAR_LZMA( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003966 "\n a Filter the archive through lzma" \
3967 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003968 USE_FEATURE_TAR_COMPRESS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003969 "\n Z Filter the archive through compress" \
3970 ) \
3971 "\nFile selection:" \
3972 "\n f Name of TARFILE or \"-\" for stdin" \
3973 "\n O Extract to stdout" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003974 USE_FEATURE_TAR_FROM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00003975 "\n exclude File to exclude" \
3976 "\n X File with names to exclude" \
3977 ) \
3978 "\n C Change to directory DIR before operation" \
3979 "\n v Verbose" \
3980
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003981#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003982 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3983 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003984
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003985#define taskset_trivial_usage \
Denis Vlasenkob44c7902008-03-17 09:29:43 +00003986 "[-p] [mask] [pid | command [arg]...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00003987#define taskset_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00003988 "Set or get CPU affinity\n" \
3989 "\nOptions:" \
3990 "\n -p Operate on an existing PID" \
3991
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003992#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003993 "$ taskset 0x7 ./dgemm_test&\n" \
3994 "$ taskset -p 0x1 $!\n" \
3995 "pid 4790's current affinity mask: 7\n" \
3996 "pid 4790's new affinity mask: 1\n" \
3997 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3998 "pid 6671's current affinity mask: 1\n" \
3999 "pid 6671's new affinity mask: 1\n" \
4000 "$ taskset -p 1\n" \
4001 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00004002
Eric Andersen7e9276b2001-02-22 01:15:47 +00004003#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004004 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004005#define tee_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004006 "Copy standard input to each FILE, and also to standard output\n" \
4007 "\nOptions:" \
4008 "\n -a Append to the given FILEs, do not overwrite" \
4009 "\n -i Ignore interrupt signals (SIGINT)" \
4010
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004011#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004012 "$ echo \"Hello\" | tee /tmp/foo\n" \
4013 "$ cat /tmp/foo\n" \
4014 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004015
Denis Vlasenkoe3241842007-08-13 10:36:25 +00004016#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00004017#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004018 "[-a] [-l USER] HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004019#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004020 "Connect to telnet server\n" \
4021 "\nOptions:" \
4022 "\n -a Attempt an automatic login with USER variable" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004023 "\n -l USER Attempt an automatic login with USER argument" \
4024
Eric Andersen539ffc92004-02-22 12:25:47 +00004025#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00004026#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004027 "HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004028#define telnet_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004029 "Connect to telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00004030#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004031
Eric Andersen08a72202002-09-30 20:52:10 +00004032#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004033 "[OPTION]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004034#define telnetd_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004035 "Handle incoming telnet connections" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004036 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
4037 "\nOptions:" \
4038 "\n -l LOGIN Exec LOGIN on connect" \
4039 "\n -f issue_file Display issue_file instead of /etc/issue" \
4040 "\n -K Close connection as soon as login exits" \
4041 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004042 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004043 "\n -p PORT Port to listen on" \
4044 "\n -b ADDR Address to bind to" \
4045 "\n -F Run in foreground" \
4046 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004047 )
Eric Andersen08a72202002-09-30 20:52:10 +00004048
Eric Andersen7e9276b2001-02-22 01:15:47 +00004049#define test_trivial_usage \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004050 "EXPRESSION\n" \
4051 " or [ EXPRESSION ]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004052#define test_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004053 "Check file types and compares values returning an exit code\n" \
4054 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004055#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004056 "$ test 1 -eq 2\n" \
4057 "$ echo $?\n" \
4058 "1\n" \
4059 "$ test 1 -eq 1\n" \
4060 "$ echo $?\n" \
4061 "0\n" \
4062 "$ [ -d /etc ]\n" \
4063 "$ echo $?\n" \
4064 "0\n" \
4065 "$ [ -d /junk ]\n" \
4066 "$ echo $?\n" \
4067 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004068
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004069#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004070 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004071/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004072/* "[-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 +00004073#define tcpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004074 "Create TCP socket, bind it to ip:port and listen\n" \
4075 "for incoming connection. Run PROG for each connection.\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004076 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004077 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004078 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004079 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4080 "\n-u user[:group] Change to user/group after bind" \
4081 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004082 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00004083 "\n-C n[:msg] Allow only up to n connections from the same IP" \
4084 "\n New connections from this IP address are closed" \
4085 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004086 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004087 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004088 "\n-v Verbose" \
Denis Vlasenko2856dab2007-04-01 01:18:20 +00004089
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004090#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00004091 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004092#define udpsvd_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004093 "Create UDP socket, bind it to ip:port and wait\n" \
4094 "for incoming packets. Run PROG for each packet,\n" \
4095 "redirecting all further packets with same peer ip:port to it\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004096 "\nip IP to listen on. '0' = all" \
4097 "\nport Port to listen on" \
4098 "\nprog [arg] Program to run" \
4099 "\n-l name Local hostname (else looks up local hostname in DNS)" \
4100 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00004101 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00004102 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004103 "\n-E Do not set up environment variables" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004104 "\n-v Verbose" \
Denis Vlasenko60fadac2007-04-01 19:10:36 +00004105
Mark Whitley450736c2001-03-02 19:08:50 +00004106#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004107 "[OPTION]... HOST [PORT]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004108#define tftp_full_usage "\n\n" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004109 "Transfer a file from/to tftp server\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004110 "\nOptions:" \
4111 "\n -l FILE Local FILE" \
4112 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004113 USE_FEATURE_TFTP_GET( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004114 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00004115 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004116 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004117 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00004118 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00004119 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004120 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00004121 )
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004122
4123#define tftpd_trivial_usage \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004124 "[-cr] [-u USER] [DIR]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004125#define tftpd_full_usage "\n\n" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004126 "Transfer a file on tftp client's request.\n" \
Denis Vlasenkod7e6af22008-03-18 01:13:11 +00004127 "\nOptions:" \
4128 "\n -r Prohibit upload" \
Denis Vlasenko403a5a22008-03-19 13:07:00 +00004129 "\n -c Allow file creation via upload" \
4130 "\n -u Access files as USER" \
Denis Vlasenkoaa9b1822008-03-17 09:10:39 +00004131
Eric Andersenc3657422001-11-30 07:54:32 +00004132#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004133 "[OPTION]... COMMAND [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004134#define time_full_usage "\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004135 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004136 "COMMAND's resource usage information is displayed.\n" \
4137 "\nOptions:" \
4138 "\n -v Verbose" \
Mark Whitley450736c2001-03-02 19:08:50 +00004139
Eric Andersen420b2082002-09-17 22:14:58 +00004140#define top_trivial_usage \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004141 "[-b] [-n COUNT] [-d SECONDS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004142#define top_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004143 "Provide a view of process activity in real time.\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004144 "Read the status of all processes from /proc each SECONDS\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004145 "and show the status for however many processes will fit on the screen." \
Eric Andersen420b2082002-09-17 22:14:58 +00004146
Eric Andersen7e9276b2001-02-22 01:15:47 +00004147#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004148 "[-c] FILE [FILE...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004149#define touch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004150 "Update the last-modified date on the given FILE[s]\n" \
4151 "\nOptions:" \
4152 "\n -c Do not create any files" \
4153
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004154#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004155 "$ ls -l /tmp/foo\n" \
4156 "/bin/ls: /tmp/foo: No such file or directory\n" \
4157 "$ touch /tmp/foo\n" \
4158 "$ ls -l /tmp/foo\n" \
4159 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004160
4161#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004162 "[-cds] STRING1 [STRING2]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004163#define tr_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004164 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004165 "standard input, writing to standard output\n" \
4166 "\nOptions:" \
4167 "\n -c Take complement of STRING1" \
4168 "\n -d Delete input characters coded STRING1" \
4169 "\n -s Squeeze multiple output characters of STRING2 into one character" \
4170
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004171#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004172 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
4173 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004174
Eric Andersen5c58d282001-07-10 16:29:00 +00004175#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004176 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
4177 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004178 " [-z pausemsecs] HOST [data size]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004179#define traceroute_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004180 "Trace the route to HOST\n" \
4181 "\nOptions:" \
4182 "\n -F Set the don't fragment bit" \
4183 "\n -I Use ICMP ECHO instead of UDP datagrams" \
4184 "\n -l Display the ttl value of the returned packet" \
4185 "\n -d Set SO_DEBUG options to socket" \
4186 "\n -n Print hop addresses numerically rather than symbolically" \
4187 "\n -r Bypass the normal routing tables and send directly to a host" \
4188 "\n -v Verbose" \
4189 "\n -m max_ttl Max time-to-live (max number of hops)" \
4190 "\n -p port# Base UDP port number used in probes" \
4191 "\n (default is 33434)" \
4192 "\n -q nqueries Number of probes per 'ttl' (default 3)" \
4193 "\n -s src_addr IP address to use as the source address" \
4194 "\n -t tos Type-of-service in probe packets (default 0)" \
4195 "\n -w wait Time in seconds to wait for a response" \
4196 "\n (default 3 sec)" \
4197 "\n -g Loose source route gateway (8 max)" \
Eric Andersen5c58d282001-07-10 16:29:00 +00004198
Eric Andersen7e9276b2001-02-22 01:15:47 +00004199#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004200 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004201#define true_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004202 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004203#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004204 "$ true\n" \
4205 "$ echo $?\n" \
4206 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004207
Eric Andersen7e9276b2001-02-22 01:15:47 +00004208#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004209 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004210#define tty_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004211 "Print file name of standard input's terminal" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004212 USE_INCLUDE_SUSv2( "\n" \
4213 "\nOptions:" \
4214 "\n -s Print nothing, only return exit status" \
4215 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004216#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004217 "$ tty\n" \
4218 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004219
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004220#define ttysize_trivial_usage \
4221 "[w] [h]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004222#define ttysize_full_usage "\n\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00004223 "Print dimension(s) of standard input's terminal, on error return 80x25"
4224
Mike Frysinger174808c2005-06-11 01:14:09 +00004225#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004226 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
4227 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
4228 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
4229 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
4230 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
4231 "[-T last-check-time] [-U UUID] device"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004232#define tune2fs_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004233 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00004234
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004235#define udhcpc_trivial_usage \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004236 "[-Cfbnqtvo] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004237 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004238#define udhcpc_full_usage "\n\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004239 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004240 " -V,--vendorclass=CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004241 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
4242 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
4243 "\n -c,--clientid=CLIENTID Client identifier" \
4244 "\n -C,--clientid-none Suppress default client identifier" \
4245 "\n -p,--pidfile=file Create pidfile" \
4246 "\n -r,--request=IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004247 "\n -s,--script=file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004248 "\n -t,--retries=N Send up to N request packets" \
4249 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
4250 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004251 "\n -O,--request-option=OPT Request DHCP option OPT (cumulative)" \
4252 "\n -o,--no-default-options Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004253 "\n -f,--foreground Run in foreground" \
4254 "\n -b,--background Background if lease is not immediately obtained" \
4255 "\n -S,--syslog Log to syslog too" \
4256 "\n -n,--now Exit with failure if lease is not immediately obtained" \
4257 "\n -q,--quit Quit after obtaining lease" \
4258 "\n -R,--release Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004259 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004260 "\n -P,--client-port N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004261 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004262 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004263 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004264 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004265 ) \
4266 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004267 " -V CLASSID Vendor class identifier" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004268 "\n -i INTERFACE Interface to use (default: eth0)" \
4269 "\n -H,-h HOSTNAME Client hostname" \
4270 "\n -c CLIENTID Client identifier" \
4271 "\n -C Suppress default client identifier" \
4272 "\n -p file Create pidfile" \
4273 "\n -r IP IP address to request" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004274 "\n -s file Run file at DHCP events (default "CONFIG_DHCPC_DEFAULT_SCRIPT")" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004275 "\n -t N Send up to N request packets" \
4276 "\n -T N Try to get a lease for N seconds (default 3)" \
4277 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko2e4c3c42008-04-02 13:04:19 +00004278 "\n -O OPT Request DHCP option OPT (cumulative)" \
4279 "\n -o Do not request any options (unless -O is also given)" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004280 "\n -f Run in foreground" \
4281 "\n -b Background if lease is not immediately obtained" \
4282 "\n -S Log to syslog too" \
4283 "\n -n Exit with failure if lease is not immediately obtained" \
4284 "\n -q Quit after obtaining lease" \
4285 "\n -R Release IP on quit" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004286 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004287 "\n -P N Use port N instead of default 68" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004288 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004289 USE_FEATURE_UDHCPC_ARPING( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004290 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004291 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004292 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004293
Russ Dill61fb4892002-10-14 21:41:28 +00004294#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004295 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004296
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004297#define udhcpd_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004298 "DHCP server\n" \
4299 "\n -f Run in foreground" \
4300 "\n -S Log to syslog too" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004301 USE_FEATURE_UDHCP_PORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004302 "\n -P N Use port N instead of default 67" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004303 )
Russ Dill61fb4892002-10-14 21:41:28 +00004304
Eric Andersen7e9276b2001-02-22 01:15:47 +00004305#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004306 "[flags] FILESYSTEM|DIRECTORY"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004307#define umount_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004308 "Unmount file systems\n" \
4309 "\nOptions:" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004310 USE_FEATURE_UMOUNT_ALL( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004311 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
4312 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004313 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004314 "\n -n Don't erase /etc/mtab entries" \
4315 ) \
4316 "\n -r Try to remount devices as read-only if mount is busy" \
4317 "\n -l Lazy umount (detach filesystem)" \
4318 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004319 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004320 "\n -d Free loop device if it has been used" \
4321 )
4322
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004323#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004324 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004325
4326#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004327 "[-amnrspv]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004328#define uname_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004329 "Print system information.\n" \
4330 "\nOptions:" \
4331 "\n -a Print all" \
4332 "\n -m The machine (hardware) type" \
4333 "\n -n Hostname" \
4334 "\n -r OS release" \
4335 "\n -s OS name (default)" \
4336 "\n -p Processor type" \
4337 "\n -v OS version" \
4338
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004339#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004340 "$ uname -a\n" \
4341 "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 +00004342
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004343#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004344 "[-c] [-f] [name...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004345#define uncompress_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004346 "Uncompress .Z file[s]\n" \
4347 "\nOptions:" \
4348 "\n -c Extract to stdout" \
4349 "\n -f Overwrite an existing file" \
Tim Riker7b253f82003-12-28 05:02:40 +00004350
Denis Vlasenko3952f202007-08-13 14:10:24 +00004351#define unexpand_trivial_usage \
4352 "[-f][-a][-t NUM] [FILE|-]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004353#define unexpand_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004354 "Convert spaces to tabs, writing to standard output.\n" \
4355 "\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004356 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004357 "\n -a,--all Convert all blanks" \
4358 "\n -f,--first-only Convert only leading blanks" \
4359 "\n -t,--tabs=N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004360 ) \
4361 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004362 "\n -a Convert all blanks" \
4363 "\n -f Convert only leading blanks" \
4364 "\n -t N Tabstops every N chars" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004365 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004366
Eric Andersen7e9276b2001-02-22 01:15:47 +00004367#define uniq_trivial_usage \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004368 "[-fscduw]... [INPUT [OUTPUT]]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004369#define uniq_full_usage "\n\n" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004370 "Discard duplicate lines\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004371 "\nOptions:" \
4372 "\n -c Prefix lines by the number of occurrences" \
4373 "\n -d Only print duplicate lines" \
4374 "\n -u Only print unique lines" \
Denis Vlasenko96b99b82008-05-03 07:21:27 +00004375 "\n -f N Skip first N fields" \
4376 "\n -s N Skip first N chars (after any skipped fields)" \
4377 "\n -w N Compare N characters in line" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004378
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004379#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004380 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4381 "a\n" \
4382 "b\n" \
4383 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004384
4385#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004386 "[option] [FILE]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004387#define unix2dos_full_usage "\n\n" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004388 "Convert FILE from unix to dos format.\n" \
4389 "When no file is given, use stdin/stdout.\n" \
Denis Vlasenkoafc41132008-03-17 08:44:58 +00004390 "\nOptions:" \
Denis Vlasenkocdf62772008-03-17 08:42:43 +00004391 "\n -u dos2unix" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004392 "\n -d unix2dos" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004393
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004394#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004395 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004396#define unzip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004397 "Extract files from ZIP archives\n" \
4398 "\nOptions:" \
4399 "\n -l List archive contents (with -q for short form)" \
4400 "\n -n Never overwrite existing files (default)" \
4401 "\n -o Overwrite files without prompting" \
4402 "\n -p Send output to stdout" \
4403 "\n -q Quiet" \
4404 "\n -x Exclude these files" \
4405 "\n -d Extract files into this directory" \
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004406
Eric Andersen7e9276b2001-02-22 01:15:47 +00004407#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004408 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004409#define uptime_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004410 "Display the time since the last boot"
Denis Vlasenko397de612008-03-17 08:55:44 +00004411
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004412#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004413 "$ uptime\n" \
4414 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004415
4416#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004417 "N"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004418#define usleep_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004419 "Pause for N microseconds"
Denis Vlasenko397de612008-03-17 08:55:44 +00004420
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004421#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004422 "$ usleep 1000000\n" \
4423 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004424
4425#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004426 "[-o outfile] [infile]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004427#define uudecode_full_usage "\n\n" \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004428 "Uudecode a file\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004429 "Finds outfile name in uuencoded source unless -o is given"
4430
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004431#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004432 "$ uudecode -o busybox busybox.uu\n" \
4433 "$ ls -l busybox\n" \
4434 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004435
4436#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004437 "[-m] [infile] stored_filename"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004438#define uuencode_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004439 "Uuencode a file to stdout\n" \
4440 "\nOptions:" \
4441 "\n -m Use base64 encoding per RFC1521" \
4442
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004443#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004444 "$ uuencode busybox busybox\n" \
4445 "begin 755 busybox\n" \
4446 "<encoded file snipped>\n" \
4447 "$ uudecode busybox busybox > busybox.uu\n" \
4448 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004449
Eric Andersen853c4942003-01-23 05:59:32 +00004450#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004451 "COMMAND [OPTIONS]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004452#define vconfig_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004453 "Create and remove virtual ethernet devices\n" \
4454 "\nOptions:" \
4455 "\n add [interface-name] [vlan_id]" \
4456 "\n rem [vlan-name]" \
4457 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
4458 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
4459 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
4460 "\n set_name_type [name-type]" \
Eric Andersen853c4942003-01-23 05:59:32 +00004461
Eric Andersen3f980402001-04-04 17:31:15 +00004462#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004463 "[OPTION] [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004464#define vi_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004465 "Edit FILE\n" \
4466 "\nOptions:" \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004467 USE_FEATURE_VI_COLON( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004468 "\n -c Initial command to run ($EXINIT also available)") \
Paul Fox35e9c5d2008-03-06 16:26:12 +00004469 USE_FEATURE_VI_READONLY( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004470 "\n -R Read-only - do not write to the file") \
4471 "\n -H Short help regarding available features" \
Eric Andersen3f980402001-04-04 17:31:15 +00004472
Eric Andersen27f64e12002-06-23 04:24:25 +00004473#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004474 "[OPTIONS]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004475#define vlock_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004476 "Lock a virtual terminal. A password is required to unlock.\n" \
4477 "\nOptions:" \
Denis Vlasenkod1277c62008-03-17 09:37:24 +00004478 "\n -a Lock all VTs" \
Eric Andersen27f64e12002-06-23 04:24:25 +00004479
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004480#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004481 "[-n seconds] [-t] COMMAND..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004482#define watch_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004483 "Execute a program periodically\n" \
4484 "\nOptions:" \
4485 "\n -n Loop period in seconds (default 2)" \
4486 "\n -t Don't print header" \
4487
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004488#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004489 "$ watch date\n" \
4490 "Mon Dec 17 10:31:40 GMT 2000\n" \
4491 "Mon Dec 17 10:31:42 GMT 2000\n" \
4492 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004493
Eric Andersen7e9276b2001-02-22 01:15:47 +00004494#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004495 "[-t N[ms]] [-F] DEV"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004496#define watchdog_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004497 "Periodically write to watchdog device DEV\n" \
4498 "\nOptions:" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004499 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004500 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004501 "\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004502 "\nUse -t 500ms to specify period in milliseconds" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004503
4504#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004505 "[OPTION]... [FILE]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004506#define wc_full_usage "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004507 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004508 "more than one FILE is specified. With no FILE, read standard input.\n" \
4509 "\nOptions:" \
4510 "\n -c Print the byte counts" \
4511 "\n -l Print the newline counts" \
4512 "\n -L Print the length of the longest line" \
4513 "\n -w Print the word counts" \
4514
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004515#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004516 "$ wc /etc/passwd\n" \
4517 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004518
4519#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004520 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004521 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004522 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4523 " [-U|--user-agent agent] url" \
4524 ) \
4525 SKIP_GETOPT_LONG( \
4526 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4527 )
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004528#define wget_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004529 "Retrieve files via HTTP or FTP\n" \
4530 "\nOptions:" \
4531 "\n -s Spider mode - only check file existence" \
4532 "\n -c Continue retrieval of aborted transfer" \
4533 "\n -q Quiet" \
4534 "\n -P Set directory prefix to DIR" \
4535 "\n -O Save to filename ('-' for stdout)" \
4536 "\n -U Adjust 'User-Agent' field" \
4537 "\n -Y Use proxy ('on' or 'off')" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004538
4539#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004540 "[COMMAND...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004541#define which_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004542 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004543#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004544 "$ which login\n" \
4545 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004546
Eric Andersen00a6a752002-04-26 23:53:10 +00004547#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004548 "[-a]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004549#define who_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004550 "Show who is logged on\n" \
4551 "\nOptions:" \
4552 "\n -a show all" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00004553
4554#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004555 ""
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004556#define whoami_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004557 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004558
4559#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004560 "[OPTIONS] [COMMAND] [ARGS...]"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004561#define xargs_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004562 "Execute COMMAND on every item given by standard input\n" \
4563 "\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004564 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004565 "\n -p Prompt the user about whether to run each command") \
4566 "\n -r Do not run command for empty read lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004567 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004568 "\n -x Exit if the size is exceeded") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004569 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
Denis Vlasenko397de612008-03-17 08:55:44 +00004570 "\n -0 Input filenames are terminated by a null character") \
4571 "\n -t Print the command line on stderr before executing it" \
4572
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004573#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004574 "$ ls | xargs gzip\n" \
4575 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004576
4577#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004578 "[OPTION]... [STRING]..."
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004579#define yes_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004580 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004581
Eric Andersen7e9276b2001-02-22 01:15:47 +00004582#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004583 "FILE"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004584#define zcat_full_usage "\n\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004585 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004586
Rob Landleyad8071f2005-04-30 03:49:37 +00004587#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004588 "[OPTIONS] ifname script"
Denis Vlasenko4f98e192008-04-13 22:12:19 +00004589#define zcip_full_usage "\n\n" \
Denis Vlasenko397de612008-03-17 08:55:44 +00004590 "Manage a ZeroConf IPv4 link-local address\n" \
4591 "\nOptions:" \
4592 "\n -f Run in foreground" \
4593 "\n -q Quit after address (no daemon)" \
4594 "\n -r 169.254.x.x Request this address first" \
4595 "\n -v Verbose" \
Rob Landleyad8071f2005-04-30 03:49:37 +00004596
Eric Andersen178de172004-04-06 16:36:20 +00004597#endif /* __BB_USAGE_H__ */