blob: cb8bd2a8df635fefc40524a4f33890ef3ec67803 [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 Vlasenkoe2d3ded2006-11-27 23:43:28 +00009 */
10
Eric Andersen178de172004-04-06 16:36:20 +000011#ifndef __BB_USAGE_H__
12#define __BB_USAGE_H__
13
Eric Andersenf349e972001-08-21 16:18:59 +000014#define addgroup_trivial_usage \
Bernhard Reutner-Fischer00c2c482007-04-05 13:16:39 +000015 "[-g GID]"USE_FEATURE_ADDUSER_TO_GROUP(" [user_name]")" group_name"
Eric Andersenf349e972001-08-21 16:18:59 +000016#define addgroup_full_usage \
Bernhard Reutner-Fischer00c2c482007-04-05 13:16:39 +000017 "Add a group to the system"USE_FEATURE_ADDUSER_TO_GROUP(" or add an user to a group") \
Denis Vlasenko765996a2006-12-24 16:59:27 +000018 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +000019 " -g GID Group id"
Eric Andersenf349e972001-08-21 16:18:59 +000020
21#define adduser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000022 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000023#define adduser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +000024 "Add a user to the system" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000025 "\n\nOptions:\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +000026 " -h DIR Home directory\n" \
27 " -g GECOS GECOS field\n" \
28 " -s SHELL Login shell\n" \
29 " -G GROUP Add user to existing group\n" \
Denis Vlasenko15ca51e2007-10-29 19:25:45 +000030 " -S Create a system user\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +000031 " -D Do not assign a password\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +000032 " -H Do not create home directory"
Eric Andersenf349e972001-08-21 16:18:59 +000033
Mark Whitley6f932772001-03-20 19:18:10 +000034#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000035 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Mark Whitley6f932772001-03-20 19:18:10 +000036#define adjtimex_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +000037 "Read and optionally set system timebase parameters.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000038 "See adjtimex(2)." \
39 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +000040 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000041 " -o offset Time offset, microseconds\n" \
42 " -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +000043 " (positive values make clock run faster)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000044 " -t tick Microseconds per tick, usually 10000\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000045 " -p timeconstant"
Mark Whitley6f932772001-03-20 19:18:10 +000046
Eric Andersen7e9276b2001-02-22 01:15:47 +000047#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000048 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000049#define ar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +000050 "Extract or list FILES from an ar archive" \
51 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000052 " -o Preserve original dates\n" \
53 " -p Extract to stdout\n" \
54 " -t List\n" \
55 " -x Extract\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +000056 " -v Verbose"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000057
Denis Vlasenkofa85b862007-01-07 01:24:12 +000058#define arp_trivial_usage \
59 "\n" \
60 "[-vn] [-H type] [-i if] -a [hostname]\n" \
61 "[-v] [-i if] -d hostname [pub]\n" \
62 "[-v] [-H type] [-i if] -s hostname hw_addr [temp]\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +000063 "[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub\n" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000064 "[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub\n"
65#define arp_full_usage \
66 "Manipulate the system ARP cache" \
67 "\n\nOptions:" \
68 "\n -a Display (all) hosts" \
69 "\n -s Set a new ARP entry" \
70 "\n -d Delete a specified entry" \
71 "\n -v Verbose" \
72 "\n -n Don't resolve names" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +000073 "\n -i if Network interface (e.g. eth0)" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000074 "\n -D Read <hwaddr> from given device" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +000075 "\n -A, -p Protocol family" \
76 "\n -H hwtype Hardware address type"
Denis Vlasenkofa85b862007-01-07 01:24:12 +000077
Glenn L McGrath9e598412003-01-09 10:06:01 +000078#define arping_trivial_usage \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +000079 "[-fqbDUA] [-c count] [-w timeout] [-I dev] [-s sender] target"
Glenn L McGrath9e598412003-01-09 10:06:01 +000080#define arping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +000081 "Ping hosts by ARP requests/replies" \
82 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000083 " -f Quit on first ARP reply\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +000084 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000085 " -b Keep broadcasting, don't go unicast\n" \
86 " -D Duplicated address detection mode\n" \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +000087 " -U Unsolicited ARP mode, update your neighbors\n" \
88 " -A ARP answer mode, update your neighbors\n" \
89 " -c N Stop after sending N ARP requests\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000090 " -w timeout Time to wait for ARP reply, in seconds\n" \
Denis Vlasenkof23c3f92007-11-23 09:27:05 +000091 " -I dev Interface to use (default eth0)\n" \
92 " -s sender Sender IP address\n" \
93 " target Target IP address"
Glenn L McGrath9e598412003-01-09 10:06:01 +000094
Eric Andersen08f59e32004-03-12 22:07:10 +000095#define ash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000096 "[FILE]...\n" \
97 "or: ash -c command [args]..."
Eric Andersen08f59e32004-03-12 22:07:10 +000098#define ash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000099 "The ash shell (command interpreter)"
Eric Andersen08f59e32004-03-12 22:07:10 +0000100
101#define awk_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000102 "[OPTION]... [program-text] [FILE...]"
Eric Andersen08f59e32004-03-12 22:07:10 +0000103#define awk_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000104 "Options:\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000105 " -v var=val Set variable\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000106 " -F sep Use sep as field separator\n" \
Denis Vlasenkod898b862007-10-14 07:57:26 +0000107 " -f file Read program from file"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000108
Eric Andersen7e9276b2001-02-22 01:15:47 +0000109#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000110 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000111#define basename_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000112 "Strip directory path and suffixes from FILE.\n" \
113 "If specified, also remove any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000114#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000115 "$ basename /usr/local/bin/foo\n" \
116 "foo\n" \
117 "$ basename /usr/local/bin/\n" \
118 "bin\n" \
119 "$ basename /foo/bar.txt .txt\n" \
120 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000121
Bernhard Reutner-Fischerd27d9252008-01-13 15:23:27 +0000122#define brctl_trivial_usage \
123 "COMMAND [BRIDGE [INTERFACE]]"
124#define brctl_full_usage \
125 "Manage ethernet bridges." \
126 "\n\nCommands:\n" \
127 " addbr <bridge> Create <bridge>\n" \
128 " delbr <bridge> Delete <bridge>\n" \
129 " addif <bridge> <iface> Add <iface> to <bridge>\n" \
130 " delif <bridge> <iface> Delete <iface> from <bridge>"
131
Glenn L McGrath24e28332001-10-05 03:48:57 +0000132#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000133 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000134#define bunzip2_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000135 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
136 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000137 " -c Write output to standard output\n" \
138 " -f Force"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000139
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000140#define bzip2_trivial_usage \
141 "[OPTION]... [FILE]..."
142#define bzip2_full_usage \
143 "Compress FILE(s) with bzip2 algorithm.\n" \
144 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenkod898b862007-10-14 07:57:26 +0000145 "\n\nOptions:" \
146 "\n -c Write output to standard output instead of FILE.bz2" \
147 "\n -d Decompress" \
148 "\n -f Force" \
149 "\n -1..-9 Compression level"
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000150
Rob Landley6130b9b2006-01-23 21:10:38 +0000151#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000152 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000153
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000154#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000155 "FILE"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000156#define bzcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000157 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000158
Rob Landleyc1d69902006-01-20 18:28:50 +0000159#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000160 "[OPTION]... [FILE]"
Rob Landleyc1d69902006-01-20 18:28:50 +0000161#define unlzma_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000162 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
163 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000164 " -c Write output to standard output\n" \
165 " -f Force"
Rob Landleyc1d69902006-01-20 18:28:50 +0000166
167#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000168 "FILE"
Rob Landleyc1d69902006-01-20 18:28:50 +0000169#define lzmacat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000170 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000171
Eric Andersenc98c0622001-12-06 15:16:43 +0000172#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000173 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000174#define cal_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000175 "Display a calendar" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000176 "\n\nOptions:" \
177 "\n -j Use julian dates" \
178 "\n -y Display the entire year"
Eric Andersenc98c0622001-12-06 15:16:43 +0000179
Eric Andersen7e9276b2001-02-22 01:15:47 +0000180#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000181 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000182#define cat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000183 "Concatenate FILE(s) and print them to stdout" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000184 "\n\nOptions:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000185 "\n -u Use unbuffered i/o (ignored)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000186#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000187 "$ cat /proc/uptime\n" \
188 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000189
Rob Landley8abbee42006-05-31 19:36:04 +0000190#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000191 "[-etv] [FILE]..."
Rob Landley8abbee42006-05-31 19:36:04 +0000192#define catv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000193 "Display nonprinting characters as ^x or M-x" \
194 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000195 " -e End each line with $\n" \
196 " -t Show tabs as ^I\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000197 " -v Don't use ^x or M-x escapes"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000198#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000199 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000200#define chattr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000201 "Change file attributes on an ext2 fs\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000202 "Modifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000203 " - Remove attributes\n" \
204 " + Add attributes\n" \
205 " = Set attributes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000206 "Attributes:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000207 " A Don't track atime\n" \
208 " a Append mode only\n" \
209 " c Enable compress\n" \
210 " D Write dir contents synchronously\n" \
211 " d Do not backup with dump\n" \
212 " i Cannot be modified (immutable)\n" \
213 " j Write all data to journal first\n" \
214 " s Zero disk storage when deleted\n" \
215 " S Write file contents synchronously\n" \
216 " t Disable tail-merging of partial blocks with other files\n" \
217 " u Allow file to be undeleted\n" \
Denis Vlasenko5dd7ef02006-12-26 03:36:28 +0000218 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000219 " -R Recursively list subdirectories\n" \
220 " -v Set the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000221
Denis Vlasenko49622d72007-03-10 16:58:49 +0000222#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000223 "[OPTIONS] CONTEXT FILE..." \
224 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
225 USE_FEATURE_CHCON_LONG_OPTIONS( \
226 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
227 )
Denis Vlasenko49622d72007-03-10 16:58:49 +0000228#define chcon_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000229 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000230 USE_FEATURE_CHCON_LONG_OPTIONS( \
231 "\n -v,--verbose Verbose" \
232 "\n -c,--changes Report changes made" \
233 "\n -h,--no-dereference Affect symlinks instead of their targets" \
234 "\n -f,--silent,--quiet Suppress most error messages" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000235 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000236 "\n -u,--user=USER Set user USER in the target security context" \
237 "\n -r,--role=ROLE Set role ROLE in the target security context" \
238 "\n -t,--type=TYPE Set type TYPE in the target security context" \
239 "\n -l,--range=RANGE Set range RANGE in the target security context" \
240 "\n -R,--recursive Recurse subdirectories" \
241 ) \
242 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
243 "\n -v Verbose" \
244 "\n -c Report changes made" \
245 "\n -h Affect symlinks instead of their targets" \
246 "\n -f Suppress most error messages" \
247 "\n -u USER Set user USER in the target security context" \
248 "\n -r ROLE Set role ROLE in the target security context" \
249 "\n -t TYPE Set type TYPE in the target security context" \
250 "\n -l RNG Set range RNE in the target security context" \
251 "\n -R Recurse subdirectories" \
252 )
253
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000254
Eric Andersen7e9276b2001-02-22 01:15:47 +0000255#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000256 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000257#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000258 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000259 "symbols +-= and one or more of the letters rwxst" \
260 "\n\nOptions:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000261 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000262 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000263 "\n -c List changed files" \
264 "\n -v List all files" \
265 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000266 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000267#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000268 "$ ls -l /tmp/foo\n" \
269 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
270 "$ chmod u+x /tmp/foo\n" \
271 "$ ls -l /tmp/foo\n" \
272 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
273 "$ chmod 444 /tmp/foo\n" \
274 "$ ls -l /tmp/foo\n" \
275 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000276
Denis Vlasenko081ef792007-03-17 16:38:21 +0000277#define chgrp_trivial_usage \
278 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
279#define chgrp_full_usage \
280 "Change the group membership of each FILE to GROUP" \
281 "\n\nOptions:" \
282 "\n -R Recurse directories" \
283 "\n -h Affect symlinks instead of symlink targets" \
284 "\n -L Traverse all symlinks to directories" \
285 "\n -H Traverse symlinks on command line only" \
286 "\n -P Do not traverse symlinks (default)" \
287 USE_DESKTOP( \
288 "\n -c List changed files" \
289 "\n -v Verbose" \
290 "\n -f Hide errors" \
291 )
292#define chgrp_example_usage \
293 "$ ls -l /tmp/foo\n" \
294 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
295 "$ chgrp root /tmp/foo\n" \
296 "$ ls -l /tmp/foo\n" \
297 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
298
Eric Andersen7e9276b2001-02-22 01:15:47 +0000299#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000300 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000301#define chown_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000302 "Change the owner and/or group of each FILE to OWNER and/or GROUP" \
303 "\n\nOptions:" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000304 "\n -R Recurse directories" \
305 "\n -h Affect symlinks instead of symlink targets" \
306 "\n -L Traverse all symlinks to directories" \
307 "\n -H Traverse symlinks on command line only" \
308 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000309 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000310 "\n -c List changed files" \
311 "\n -v List all files" \
312 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000313 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000314#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000315 "$ ls -l /tmp/foo\n" \
316 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
317 "$ chown root /tmp/foo\n" \
318 "$ ls -l /tmp/foo\n" \
319 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
320 "$ chown root.root /tmp/foo\n" \
321 "ls -l /tmp/foo\n" \
322 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000323
Denis Vlasenkofe544582006-10-03 15:57:40 +0000324#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000325 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
326 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
327 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000328#define chpst_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000329 "Change the process state and run specified program" \
330 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000331 " -u user[:grp] Set uid and gid\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +0000332 " -U user[:grp] Set environment variables UID and GID\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000333 " -e dir Set environment variables as specified by files\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000334 " in the directory: file=1st_line_of_file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000335 " -/ dir Chroot to dir\n" \
336 " -n inc Add inc to nice value\n" \
337 " -m bytes Limit data segment, stack segment, locked physical pages,\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000338 " and total of all segment per process to bytes bytes each\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000339 " -d bytes Limit data segment\n" \
340 " -o n Limit the number of open file descriptors per process to n\n" \
341 " -p n Limit number of processes per uid to n\n" \
342 " -f bytes Limit output file size to bytes bytes\n" \
343 " -c bytes Limit core file size to bytes bytes\n" \
344 " -v Verbose\n" \
345 " -P Run prog in a new process group\n" \
346 " -0 Close standard input\n" \
347 " -1 Close standard output\n" \
348 " -2 Close standard error"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000349#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000350 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000351#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000352 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
353 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000354#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000355 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000356#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000357 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000358#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000359 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000360#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000361 "Set various environment variables as specified by files\n" \
362 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000363#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000364 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
365 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
366 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000367#define softlimit_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000368 "Set soft resource limits, then run prog" \
369 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000370 " -m n Same as -d n -s n -l n -a n\n" \
371 " -d n Limit the data segment per process to n bytes\n" \
372 " -s n Limit the stack segment per process to n bytes\n" \
373 " -l n Limit the locked physical pages per process to n bytes\n" \
374 " -a n Limit the total of all segments per process to n bytes\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000375 " -o n Limit the number of open file descriptors per process to n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000376 " -p n Limit the number of processes per uid to n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000377 "Options controlling file sizes:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000378 " -f n Limit output file sizes to n bytes\n" \
379 " -c n Limit core file sizes to n bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000380 "Efficiency opts:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000381 " -r n Limit the resident set size to n bytes. This limit is not\n" \
382 " enforced unless physical memory is full\n" \
383 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
384 " except that the process receives a SIGXCPU signal after n seconds\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000385 "\n" \
386 "Some options may have no effect on some operating systems\n" \
387 "n may be =, indicating that soft limit should be set equal to hard limit"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000388
Eric Andersen7e9276b2001-02-22 01:15:47 +0000389#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000390 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000391#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000392 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000393#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000394 "$ ls -l /bin/ls\n" \
395 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
396 "# mount /dev/hdc1 /mnt -t minix\n" \
397 "# chroot /mnt\n" \
398 "# ls -l /bin/ls\n" \
399 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000400
Eric Andersen7e9276b2001-02-22 01:15:47 +0000401#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000402 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000403#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000404 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000405
Rob Landley856489b2006-04-18 20:57:28 +0000406#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000407 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000408#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000409 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000410
Eric Andersen7e9276b2001-02-22 01:15:47 +0000411#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000412 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000413#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000414 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000415
Eric Andersen7e9276b2001-02-22 01:15:47 +0000416#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000417 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000418#define cmp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000419 "Compares FILE1 vs stdin if FILE2 is not specified" \
420 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000421 " -l Write the byte numbers (decimal) and values (octal)\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000422 " for all differing bytes\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000423 " -s Quiet"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000424
Rob Landley2acfd7b2005-05-11 23:12:49 +0000425#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000426 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000427#define comm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000428 "Compare FILE1 to FILE2, or to stdin if - is specified" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000429 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000430 " -1 Suppress lines unique to FILE1\n" \
431 " -2 Suppress lines unique to FILE2\n" \
432 " -3 Suppress lines common to both files"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000433
Paul Fox79c142d2005-08-01 16:04:40 +0000434#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000435 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000436#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000437 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000438
Rob Landley69674942006-09-11 00:34:01 +0000439#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000440 "[FILE]...\n" \
441 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000442#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000443 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000444
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000445#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000446 "[OPTION]... [prio] [pid | command [arg]...]"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000447#define chrt_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000448 "manipulate real-time attributes of a process" \
449 "\n\nOptions:\n" \
450 " -p operate on pid\n" \
451 " -r set scheduling policy to SCHED_RR\n" \
452 " -f set scheduling policy to SCHED_FIFO\n" \
453 " -o set scheduling policy to SCHED_OTHER\n" \
454 " -m show min and max priorities"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000455
456#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000457 "$ chrt -r 4 sleep 900; x=$!\n" \
458 "$ chrt -f -p 3 $x\n" \
459 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000460
Eric Andersen7e9276b2001-02-22 01:15:47 +0000461#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000462 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000463#define cp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000464 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000465 "\n\nOptions:" \
466 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000467 USE_SELINUX( \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000468 "\n -c Preserves security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000469 ) \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000470 "\n -d,-P Preserve links" \
471 "\n -H,-L Dereference all symlinks (default)" \
472 "\n -p Preserve file attributes if possible" \
473 "\n -f Force overwrite" \
474 "\n -i Prompt before overwrite" \
475 "\n -R,-r Recurse directories" \
476 "\n -l,-s Create (sym)links"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000477
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000478#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000479 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000480#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000481 "Extract or list files from a cpio archive\n" \
482 "Main operation mode:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000483 " d Make leading directories\n" \
484 " i Extract\n" \
485 " m Preserve mtime\n" \
486 " t List\n" \
487 " v Verbose\n" \
488 " u Unconditional overwrite\n" \
489 " F Input from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000490
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000491#define crond_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +0000492 "-d[#] -c crondir -f -b"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000493#define crond_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000494 " -d [#] -l [#] -S -L logfile -f -b -c dir\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000495 " -d num Debug level\n" \
496 " -l num Log level (8 - default)\n" \
Denis Vlasenko88ce2742007-10-09 18:08:04 +0000497 " -S Log to syslog (default)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000498 " -L file Log to file\n" \
499 " -f Run in foreground\n" \
500 " -b Run in background (default)\n" \
501 " -c dir Working dir"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000502
503#define crontab_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000504 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000505#define crontab_full_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +0000506 " file [opts] Replace crontab from file\n" \
507 " - [opts] Replace crontab from stdin\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000508 " -u user User\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000509 " -l [user] List crontab for user\n" \
510 " -e [user] Edit crontab for user\n" \
511 " -d [user] Delete crontab for user\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000512 " -c dir Crontab directory"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000513
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000514#define cryptpw_trivial_usage \
515 "[-a des|md5] [string]"
516#define cryptpw_full_usage \
517 "Outputs crypted string.\n" \
518 "If string isn't supplied on cmdline, reads it from stdin.\n" \
519 "\nOptions:" \
520 "\n -a Algorithm to use (default: md5)"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000521
Eric Andersen7e9276b2001-02-22 01:15:47 +0000522#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000523 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000524#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000525 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000526 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000527 " -b LIST Output only bytes from LIST\n" \
528 " -c LIST Output only characters from LIST\n" \
529 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
530 " -s Output only the lines containing delimiter\n" \
531 " -f N Print only these fields\n" \
532 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000533#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000534 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
535 "Hello\n" \
536 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
537 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000538
Eric Andersen7e9276b2001-02-22 01:15:47 +0000539#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000540 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000541#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000542 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000543 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000544 " -R Outputs RFC-822 compliant date string\n" \
545 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000546 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000547 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
548 " TIMESPEC='date' (or missing) for date only,\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000549 " 'hours', 'minutes', or 'seconds' for date and\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000550 " time to the indicated precision\n" \
551 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000552 ) \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000553 " -s STRING Sets time described by STRING\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000554 " -r FILE Displays the last modification time of FILE\n" \
555 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000556#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000557 "$ date\n" \
558 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000559
Eric Andersen7e9276b2001-02-22 01:15:47 +0000560#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000561 "expression..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000562#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000563 "This is a Tiny RPN calculator that understands the\n" \
564 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
565 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000566 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
567 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000568 "p - Prints the value on the top of the stack, without altering the stack\n" \
569 "f - Prints the entire contents of the stack without altering anything\n" \
570 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
571 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000572#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000573 "$ dc 2 2 + p\n" \
574 "4\n" \
575 "$ dc 8 8 \\* 2 2 + / p\n" \
576 "16\n" \
577 "$ dc 0 1 and p\n" \
578 "0\n" \
579 "$ dc 0 1 or p\n" \
580 "1\n" \
581 "$ echo 72 9 div 8 mul p | dc\n" \
582 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000583
Eric Andersen7e9276b2001-02-22 01:15:47 +0000584#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000585 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000586 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000587#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000588 "Copy a file with converting and formatting" \
589 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000590 " if=FILE Read from FILE instead of stdin\n" \
591 " of=FILE Write to FILE instead of stdout\n" \
592 " bs=N Read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000593 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000594 " ibs=N Read N bytes at a time\n") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000595 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000596 " obs=N Write N bytes at a time\n") \
597 " count=N Copy only N input blocks\n" \
598 " skip=N Skip N input blocks\n" \
599 " seek=N Skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000600 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000601 " conv=notrunc Don't truncate output file\n" \
602 " conv=noerror Continue after read errors\n" \
603 " conv=sync Pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000604 "\n" \
605 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
606 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000607#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000608 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
609 "4+0 records in\n" \
610 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000611
Eric Andersen7e9276b2001-02-22 01:15:47 +0000612#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000613 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000614#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000615 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000616
Eric Andersenf349e972001-08-21 16:18:59 +0000617#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000618 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000619#define delgroup_full_usage \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000620 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000621 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000622
623#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000624 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000625#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000626 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000627
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000628#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000629 "mntpnt [-v]" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000630 USE_DEVFSD_FG_NP("[-fg][-np]")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000631#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000632 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000633 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000634 "\n mntpnt The mount point where devfs is mounted" \
635 "\n -v Print the protocol version numbers for devfsd" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000636 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000637 USE_DEVFSD_FG_NP( \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000638 "\n -fg Run in foreground" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000639 "\n -np Exit after parsing the configuration file" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000640 "\n and processing synthetic REGISTER events," \
641 "\n do not poll for events")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000642
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000643/* -k is accepted but ignored for !HUMAN_READABLE,
644 * but we won't mention this (unimportant) */
645#if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
646#define DF_HAS_OPTIONS(x) x
647#else
648#define DF_HAS_OPTIONS(x)
649#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000650#define df_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000651 DF_HAS_OPTIONS("[-") \
652 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
653 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000654#define df_full_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000655 "Print filesystem usage statistics" \
656 DF_HAS_OPTIONS("\n\nOptions:") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000657 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko08294db2007-08-13 12:27:49 +0000658 "\n -h Human readable (e.g. 1K 243M 2G)" \
659 "\n -m 1024*1024 blocks" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000660 "\n -k 1024 blocks" \
661 ) \
662 USE_FEATURE_DF_INODE( \
663 "\n -i Inodes" \
664 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000665#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000666 "$ df\n" \
667 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
668 "/dev/sda3 8690864 8553540 137324 98% /\n" \
669 "/dev/sda1 64216 36364 27852 57% /boot\n" \
670 "$ df /dev/sda3\n" \
671 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
672 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000673
Denis Vlasenko736230e2006-11-20 19:40:36 +0000674#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000675 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000676#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000677 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000678
679#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000680 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000681#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000682 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000683
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000684#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000685 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000686#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000687 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000688 "This diff implementation only supports unified diffs." \
689 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000690 " -a Treat all files as text\n" \
691 " -b Ignore changes in the amount of whitespace\n" \
692 " -d Try hard to find a smaller set of changes\n" \
693 " -i Ignore case differences\n" \
694 " -L Use LABEL instead of the filename in the unified header\n" \
695 " -N Treat absent files as empty\n" \
696 " -q Output only whether files differ\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +0000697 " -r Recursively compare subdirectories\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000698 " -S Start with FILE when comparing directories\n" \
699 " -T Make tabs line up by prefixing a tab when necessary\n" \
700 " -s Report when two files are the same\n" \
701 " -t Expand tabs to spaces in output\n" \
702 " -U Output LINES lines of context\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000703 " -w Ignore all whitespace"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000704
Eric Andersen7e9276b2001-02-22 01:15:47 +0000705#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000706 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000707#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000708 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000709#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000710 "$ dirname /tmp/foo\n" \
711 "/tmp\n" \
712 "$ dirname /tmp/foo/\n" \
713 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000714
Eric Andersen7e9276b2001-02-22 01:15:47 +0000715#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000716 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000717#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000718 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000719 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000720 " -c Clear ring buffer after printing\n" \
721 " -n LEVEL Set console logging level\n" \
722 " -s SIZE Buffer size"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000723
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000724#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000725 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000726#define dnsd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000727 "Small and static DNS server daemon" \
728 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000729 " -c Config filename\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000730 " -t TTL in seconds\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000731 " -p Listening port\n" \
Denis Vlasenkod3bac032007-03-24 12:13:04 +0000732 " -i Listening ip (default all)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000733 " -d Daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000734
Eric Andersen7e9276b2001-02-22 01:15:47 +0000735#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000736 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000737#define dos2unix_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000738 "Convert FILE from dos format to unix format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000739 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000740 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000741 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000742 " -u Output will be in UNIX format\n" \
743 " -d Output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000744
Eric Andersen7e9276b2001-02-22 01:15:47 +0000745#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000746 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000747#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000748 "Install, remove and manage Debian packages" \
749 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000750 " -i Install the package\n" \
751 " -l List of installed packages\n" \
752 " -C Configure an unpackaged package\n" \
753 " -F depends Ignore dependency problems\n" \
754 " -P Purge all files of a package\n" \
755 " -r Remove all but the configuration files for a package\n" \
756 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000757
Eric Andersen7e9276b2001-02-22 01:15:47 +0000758#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000759 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000760#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000761 "Perform actions on Debian packages (.debs)" \
762 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000763 " -c List contents of filesystem tree\n" \
764 " -e Extract control files to [argument] directory\n" \
765 " -f Display control field name starting with [argument]\n" \
766 " -x Extract packages filesystem tree to directory\n" \
767 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000768#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000769 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000770
Eric Andersen7e9276b2001-02-22 01:15:47 +0000771#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000772 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000773#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000774 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000775 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000776 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
777 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000778 " bytes." \
779 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000780 " -a Show sizes of files in addition to directories\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000781 " -H Follow symlinks that are FILE command line args\n" \
782 " -L Follow all symlinks encountered\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000783 " -d N Limit output to directories (and files with -a) of depth < N\n" \
784 " -c Output a grand total\n" \
785 " -l Count sizes many times if hard linked\n" \
786 " -s Display only a total for each argument\n" \
787 " -x Skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000788 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000789 " -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
790 " -m Print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000791 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000792 " -k Print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000793 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000794#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000795 "$ du\n" \
796 "16 ./CVS\n" \
797 "12 ./kernel-patches/CVS\n" \
798 "80 ./kernel-patches\n" \
799 "12 ./tests/CVS\n" \
800 "36 ./tests\n" \
801 "12 ./scripts/CVS\n" \
802 "16 ./scripts\n" \
803 "12 ./docs/CVS\n" \
804 "104 ./docs\n" \
805 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000806
Eric Andersen7e9276b2001-02-22 01:15:47 +0000807#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000808 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000809#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000810 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000811#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000812 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000813
Russ Dill61fb4892002-10-14 21:41:28 +0000814#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000815 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000816#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000817 "Display DHCP leases granted by udhcpd" \
818 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000819 USE_GETOPT_LONG( \
820 " -f,--file=FILE Leases file to load\n" \
821 " -r,--remaining Interpret lease times as time remaining\n" \
822 " -a,--absolute Interpret lease times as expire time" \
823 ) \
824 SKIP_GETOPT_LONG( \
825 " -f FILE Leases file to load\n" \
826 " -r Interpret lease times as time remaining\n" \
827 " -a Interpret lease times as expire time" \
828 )
Russ Dill61fb4892002-10-14 21:41:28 +0000829
Mike Frysinger51a43b42005-09-24 07:11:16 +0000830#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000831 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
832 "[-I inode_buffer_blocks] [-P process_inode_size] " \
833 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
834 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000835#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000836 "Check ext2/ext3 file system" \
837 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000838 " -p Automatic repair (no questions)\n" \
839 " -n Make no changes to the filesystem\n" \
840 " -y Assume 'yes' to all questions\n" \
841 " -c Check for bad blocks and add them to the badblock list\n" \
842 " -f Force checking even if filesystem is marked clean\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000843 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000844 " -b superblock Use alternative superblock\n" \
845 " -B blocksize Force blocksize when looking for superblock\n" \
846 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000847 " -l file Add to badblocks list\n" \
848 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000849
Eric Andersen7e9276b2001-02-22 01:15:47 +0000850#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000851 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000852#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000853 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000854 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000855 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000856 " -n Suppress trailing newline\n" \
857 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
858 " -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000859 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000860#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000861 "$ echo \"Erik is cool\"\n" \
862 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000863 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000864 "Erik\n" \
865 "is\n" \
866 "cool\n" \
867 "$ echo \"Erik\\nis\\ncool\"\n" \
868 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000869
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000870#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000871 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000872#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000873 "Eject specified DEVICE (or default /dev/cdrom)" \
874 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000875 " -t Close tray\n" \
876 " -T Open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000877
Rob Landley3b890392006-05-04 20:56:43 +0000878#define ed_trivial_usage ""
879#define ed_full_usage ""
880
Eric Andersen84e229c2001-03-29 22:48:33 +0000881#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000882 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000883#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000884 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000885 "up the specified environment" \
886 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000887 " -, -i Start with an empty environment\n" \
888 " -u Remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000889
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000890#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000891 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000892#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000893 "Send a magic packet to wake up sleeping machines.\n" \
894 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000895 "a hostname with a known 'ethers' entry." \
896 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000897 " -b Send wake-up packet to the broadcast address\n" \
898 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000899 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000900
Denis Vlasenko3952f202007-08-13 14:10:24 +0000901#define expand_trivial_usage \
902 "[-i] [-t NUM] [FILE|-]"
903#define expand_full_usage \
904 "Convert tabs to spaces, writing to standard output." \
905 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000906 USE_FEATURE_EXPAND_LONG_OPTIONS( \
907 "\n -i,--initial Do not convert tabs after non blanks" \
908 "\n -t,--tabs=N Tabstops every N chars" \
909 ) \
910 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
911 "\n -i Do not convert tabs after non blanks" \
912 "\n -t Tabstops every N chars" \
913 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000914
Eric Andersen7e9276b2001-02-22 01:15:47 +0000915#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000916 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000917#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000918 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000919 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000920 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
921 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
922 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
923 " ARG1 <= ARG2\n" \
924 " ARG1 = ARG2\n" \
925 " ARG1 != ARG2\n" \
926 " ARG1 >= ARG2\n" \
927 " ARG1 > ARG2\n" \
928 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
929 " ARG1 - ARG2\n" \
930 " ARG1 * ARG2\n" \
931 " ARG1 / ARG2\n" \
932 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000933 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
934 " match STRING REGEXP Same as STRING : REGEXP\n" \
935 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
936 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
937 " length STRING Length of STRING\n" \
938 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000939 " it is a keyword like 'match' or an\n" \
940 " operator like '/'\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000941 " (EXPRESSION) Value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000942 "Beware that many operators need to be escaped or quoted for shells.\n" \
943 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000944 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000945 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
946 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000947
Mike Frysingerfa69f112005-04-17 07:24:19 +0000948#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000949 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000950#define fakeidentd_full_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000951 "Provide fake ident (auth) service" \
952 "\n\nOptions:" \
953 "\n -f Run in foreground" \
954 "\n -i Inetd mode" \
955 "\n -w Inetd 'wait' mode" \
956 "\n -b ADDR Bind to specified address" \
957 "\n STRING Ident answer string (default is 'nobody')"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000958
Eric Andersen7e9276b2001-02-22 01:15:47 +0000959#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000960 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000961#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000962 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000963#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000964 "$ false\n" \
965 "$ echo $?\n" \
966 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000967
968#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000969 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000970#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000971 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000972#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000973 "$ fbset\n" \
974 "mode \"1024x768-76\"\n" \
975 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
976 " geometry 1024 768 1024 768 16\n" \
977 " timings 12714 128 32 16 4 128 4\n" \
978 " accel false\n" \
979 " rgba 5/11,6/5,5/0,0/0\n" \
980 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000981
Eric Andersen7e9276b2001-02-22 01:15:47 +0000982#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000983 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000984#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000985 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000986
Eric Andersen01c3d402003-07-05 07:51:31 +0000987#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000988 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +0000989#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000990 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000991 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000992 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +0000993
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000994#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000995 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000996#define fdisk_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000997 "Change partition table" \
998 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000999 " -l List partition table(s)\n" \
1000 " -u Give Start and End in sector (instead of cylinder) units\n" \
1001 " -s PARTITION Give partition size(s) in blocks\n" \
1002 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
1003 " -C CYLINDERS Set the number of cylinders\n" \
1004 " -H HEADS Set the number of heads\n" \
1005 " -S SECTORS Set the number of sectors\n" \
1006 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001007
Eric Andersen7e9276b2001-02-22 01:15:47 +00001008#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001009 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001010#define find_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001011 "Search for files in a directory hierarchy. The default PATH is\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001012 "the current directory, default EXPRESSION is '-print'\n" \
1013 "\nEXPRESSION may consist of:" \
1014 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001015 USE_FEATURE_FIND_XDEV( \
1016 "\n -xdev Don't descend directories on other filesystems") \
1017 USE_FEATURE_FIND_MAXDEPTH( \
1018 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1019 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001020 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001021 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001022 USE_FEATURE_FIND_PATH( \
1023 "\n -path PATTERN Path matches PATTERN") \
1024 USE_FEATURE_FIND_REGEX( \
1025 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001026 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001027 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001028 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001029 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001030 "\n or exactly (NNN)") \
1031 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001032 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001033 "\n or exactly (N) days") \
1034 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001035 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001036 "\n or exactly (N) minutes") \
1037 USE_FEATURE_FIND_NEWER( \
1038 "\n -newer FILE Modified time is more recent than FILE's") \
1039 USE_FEATURE_FIND_INUM( \
1040 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001041 USE_FEATURE_FIND_USER( \
1042 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1043 USE_FEATURE_FIND_GROUP( \
1044 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1045 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001046 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001047 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001048 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1049 "\n +/-N: file size is bigger/smaller than N") \
1050 "\n -print Print (default and assumed)" \
1051 USE_FEATURE_FIND_PRINT0( \
1052 "\n -print0 Delimit output with null characters rather than" \
1053 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001054 USE_FEATURE_FIND_CONTEXT ( \
1055 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001056 USE_FEATURE_FIND_EXEC( \
1057 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1058 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001059 USE_FEATURE_FIND_PRUNE( \
1060 "\n -prune Stop traversing current subtree") \
1061 USE_FEATURE_FIND_DELETE( \
1062 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001063 USE_FEATURE_FIND_PAREN( \
1064 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001065
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001066#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001067 "$ find / -name passwd\n" \
1068 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001069
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001070#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001071 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001072#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001073 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001074 "standard output" \
1075 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001076 " -b Count bytes rather than columns\n" \
1077 " -s Break at spaces\n" \
1078 " -w Use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001079
Eric Andersen7e9276b2001-02-22 01:15:47 +00001080#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001081 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001082#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001083 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001084#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001085 "$ free\n" \
1086 " total used free shared buffers\n" \
1087 " Mem: 257628 248724 8904 59644 93124\n" \
1088 " Swap: 128516 8404 120112\n" \
1089 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001090
Eric Andersen7e9276b2001-02-22 01:15:47 +00001091#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001092 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001093#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001094 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001095#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001096 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001097
Mike Frysinger51a43b42005-09-24 07:11:16 +00001098#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001099 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001100#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001101 "Check and repair filesystems" \
1102 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001103 " -A Walk /etc/fstab and check all filesystems\n" \
1104 " -N Don't execute, just show what would be done\n" \
1105 " -P When using -A, check filesystems in parallel\n" \
1106 " -R When using -A, skip the root filesystem\n" \
1107 " -T Don't show title on startup\n" \
Denis Vlasenko0de93752006-12-26 02:51:29 +00001108 " -V Verbose\n" \
1109 " -C n Write status information to specified filedescriptor\n" \
1110 " -t type List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001111
Eric Andersen7e9276b2001-02-22 01:15:47 +00001112#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001113 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001114#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001115 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001116 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001117 " -l List all filenames\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001118 " -r Perform interactive repairs\n" \
1119 " -a Perform automatic repairs\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001120 " -v Verbose\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001121 " -s Output super-block information\n" \
1122 " -m Activate MINIX-like \"mode not cleared\" warnings\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001123 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001124
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001125#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001126 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001127#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001128 "Retrieve a remote file via FTP" \
1129 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001130 USE_GETOPT_LONG( \
1131 " -c,--continue Continue previous transfer\n" \
1132 " -v,--verbose Verbose\n" \
1133 " -u,--username Username\n" \
1134 " -p,--password Password\n" \
1135 " -P,--port Port number" \
1136 ) \
1137 SKIP_GETOPT_LONG( \
1138 " -c Continue previous transfer\n" \
1139 " -v Verbose\n" \
1140 " -u Username\n" \
1141 " -p Password\n" \
1142 " -P Port number" \
1143 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001144
1145#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001146 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001147#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001148 "Store a local file on a remote machine via FTP" \
1149 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001150 USE_GETOPT_LONG( \
1151 " -v,--verbose Verbose\n" \
1152 " -u,--username Username\n" \
1153 " -p,--password Password\n" \
1154 " -P,--port Port number" \
1155 ) \
1156 SKIP_GETOPT_LONG( \
1157 " -v Verbose\n" \
1158 " -u Username\n" \
1159 " -p Password\n" \
1160 " -P Port number" \
1161 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001162
Rob Landleyaa872762005-10-28 13:05:12 +00001163#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001164 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +00001165#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001166 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001167 " -m Show all processes on the same mounted fs\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001168 " -k Kill all processes that match\n" \
1169 " -s Don't print or kill anything\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001170 " -4 When using port/proto only search IPv4 space\n" \
1171 " -6 When using port/proto only search IPv6 space\n" \
1172 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001173
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001174#define getenforce_trivial_usage
1175#define getenforce_full_usage
1176
Eric Andersen7e9276b2001-02-22 01:15:47 +00001177#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001178 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001179#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001180 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001181 USE_GETOPT_LONG( \
1182 " -a,--alternative Allow long options starting with single -\n" \
1183 " -l,--longoptions=longopts Long options to be recognized\n" \
1184 " -n,--name=progname The name under which errors are reported\n" \
1185 " -o,--options=optstring Short options to be recognized\n" \
1186 " -q,--quiet Disable error reporting by getopt(3)\n" \
1187 " -Q,--quiet-output No normal output\n" \
1188 " -s,--shell=shell Set shell quoting conventions\n" \
1189 " -T,--test Test for getopt(1) version\n" \
1190 " -u,--unquoted Don't quote the output" \
1191 ) \
1192 SKIP_GETOPT_LONG( \
1193 " -a Allow long options starting with single -\n" \
1194 " -l longopts Long options to be recognized\n" \
1195 " -n progname The name under which errors are reported\n" \
1196 " -o optstring Short options to be recognized\n" \
1197 " -q Disable error reporting by getopt(3)\n" \
1198 " -Q No normal output\n" \
1199 " -s shell Set shell quoting conventions\n" \
1200 " -T Test for getopt(1) version\n" \
1201 " -u Don't quote the output" \
1202 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001203#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001204 "$ cat getopt.test\n" \
1205 "#!/bin/sh\n" \
1206 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1207 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001208 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001209 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001210 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001211 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001212 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1213 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001214 " -c|--c-long)\n" \
1215 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001216 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1217 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1218 " esac;;\n" \
1219 " --) shift; break;;\n" \
1220 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001221 " esac\n" \
1222 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001223
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001224#define getsebool_trivial_usage \
1225 "-a or getsebool boolean..."
1226#define getsebool_full_usage \
1227 " -a Show all SELinux booleans"
1228
Eric Andersenf349e972001-08-21 16:18:59 +00001229#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001230 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001231#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001232 "Open a tty, prompt for a login name, then invoke /bin/login" \
1233 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001234 " -h Enable hardware (RTS/CTS) flow control\n" \
1235 " -i Do not display /etc/issue before running login\n" \
1236 " -L Local line, so do not do carrier detect\n" \
1237 " -m Get baud rate from modem's CONNECT status message\n" \
1238 " -w Wait for a CR or LF before sending /etc/issue\n" \
1239 " -n Do not prompt the user for a login name\n" \
1240 " -f issue_file Display issue_file instead of /etc/issue\n" \
1241 " -l login_app Invoke login_app instead of /bin/login\n" \
1242 " -t timeout Terminate after timeout if no username is read\n" \
1243 " -I initstring Sets the init string to send before anything else\n" \
1244 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001245
Eric Andersen7e9276b2001-02-22 01:15:47 +00001246#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001247 "[-HhrilLnqvso" \
1248 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001249 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001250 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1251 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001252 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001253#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001254 "Search for PATTERN in each FILE or standard input" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001255 "\n\nOptions:" \
1256 "\n -H Prefix output lines with filename where match was found" \
1257 "\n -h Suppress the prefixing filename on output" \
1258 "\n -r Recurse subdirectories" \
1259 "\n -i Ignore case distinctions" \
1260 "\n -l List names of files that match" \
1261 "\n -L List names of files that do not match" \
1262 "\n -n Print line number with output lines" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001263 "\n -q Quiet. Returns 0 if PATTERN was found, 1 otherwise" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001264 "\n -v Select non-matching lines" \
1265 "\n -s Suppress file open/read error messages" \
1266 "\n -c Only print count of matching lines" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001267 "\n -o Show only the part of a line that matches PATTERN" \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001268 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001269 USE_DESKTOP( \
1270 "\n -w Match whole words only") \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001271 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001272 USE_FEATURE_GREP_EGREP_ALIAS( \
1273 "\n -E PATTERN is an extended regular expression") \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001274 "\n -e PTRN Pattern to match" \
1275 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001276 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001277 "\n -A Print NUM lines of trailing context" \
1278 "\n -B Print NUM lines of leading context" \
1279 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001280
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001281#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001282 "$ grep root /etc/passwd\n" \
1283 "root:x:0:0:root:/root:/bin/bash\n" \
1284 "$ grep ^[rR]oo. /etc/passwd\n" \
1285 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001286
Eric Andersen7e9276b2001-02-22 01:15:47 +00001287#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001288 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001289#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001290 "Uncompress FILE (or standard input if FILE is '-')" \
1291 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001292 " -c Write output to standard output\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001293 " -f Force\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001294 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001295#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001296 "$ ls -la /tmp/BusyBox*\n" \
1297 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1298 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1299 "$ ls -la /tmp/BusyBox*\n" \
1300 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001301
1302#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001303 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001304#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001305 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001306 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001307 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001308 " -c Write output to standard output instead of FILE.gz\n" \
1309 " -d Decompress\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001310 " -f Force"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001311#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001312 "$ ls -la /tmp/busybox*\n" \
1313 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1314 "$ gzip /tmp/busybox.tar\n" \
1315 "$ ls -la /tmp/busybox*\n" \
1316 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001317
1318#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001319 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001320#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001321 "Halt the system" \
1322 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001323 " -d Delay interval for halting\n" \
1324 " -n No call to sync()\n" \
1325 " -f Force halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001326
Eric Andersen3443bd72003-07-22 07:30:36 +00001327#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001328 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001329#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001330 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001331 "If no device name is specified try to read from stdin.\n\n") \
1332 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001333 " -a Get/set fs readahead\n" \
1334 " -A Set drive read-lookahead flag (0/1)\n" \
1335 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1336 " -B Set Advanced Power Management setting (1-255)\n" \
1337 " -c Get/set IDE 32-bit IO setting\n" \
1338 " -C Check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001339 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001340 " -d Get/set using_dma flag\n") \
1341 " -D Enable/disable drive defect-mgmt\n" \
1342 " -f Flush buffer cache for device on exit\n" \
1343 " -g Display drive geometry\n" \
1344 " -h Display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001345 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001346 " -i Display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001347 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001348 " -I Detailed/current information directly from drive\n") \
1349 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1350 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1351 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1352 " -m Get/set multiple sector count\n" \
1353 " -n Get/set ignore-write-errors flag (0/1)\n" \
1354 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1355 " -P Set drive prefetch count\n" \
1356 " -q Change next setting quietly\n" \
1357 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1358 " -r Get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001359 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001360 " -R Register an IDE interface (DANGEROUS)\n") \
1361 " -S Set standby (spindown) timeout\n" \
1362 " -t Perform device read timings\n" \
1363 " -T Perform cache read timings\n" \
1364 " -u Get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001365 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001366 " -U Un-register an IDE interface (DANGEROUS)\n") \
1367 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1368 " -V Display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001369 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001370 " -w Perform device reset (DANGEROUS)\n") \
1371 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001372 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001373 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1374 " -X Set IDE xfer mode (DANGEROUS)\n" \
1375 " -y Put IDE drive in standby mode\n" \
1376 " -Y Put IDE drive to sleep\n" \
1377 " -Z Disable Seagate auto-powersaving mode\n" \
1378 " -z Re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001379
Eric Andersen7e9276b2001-02-22 01:15:47 +00001380#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001381 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001382#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001383 "Print first 10 lines of each FILE to standard output.\n" \
1384 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001385 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001386 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001387 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001388 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001389 "\n -c NUM Output the first NUM bytes" \
1390 "\n -q Never output headers giving file names" \
1391 "\n -v Always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001392#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001393 "$ head -n 2 /etc/passwd\n" \
1394 "root:x:0:0:root:/root:/bin/bash\n" \
1395 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001396
Glenn L McGrath60281112001-11-02 11:39:46 +00001397#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001398 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Glenn L McGrath60281112001-11-02 11:39:46 +00001399#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001400 "Display file(s) or standard input in a user specified format" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001401 "\n\nOptions:" \
1402 "\n -b One-byte octal display" \
1403 "\n -c One-byte character display" \
1404 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1405 "\n -d Two-byte decimal display" \
1406 "\n -e FORMAT STRING" \
1407 "\n -f FORMAT FILE" \
1408 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1409 "\n -o Two-byte octal display" \
1410 "\n -s OFFSET Skip OFFSET bytes" \
1411 "\n -v Display all input data" \
1412 "\n -x Two-byte hexadecimal display" \
1413 USE_FEATURE_HEXDUMP_REVERSE( \
1414 "\n -R Reverse of 'hexdump -Cv'") \
1415
1416#define hd_trivial_usage \
1417 "FILE..."
1418#define hd_full_usage \
1419 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001420
Eric Andersen7e9276b2001-02-22 01:15:47 +00001421#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001422 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001424 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001425
1426#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001427 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001428#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001429 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001430 "(or FILE with the -F parameter), the host name will be set." \
1431 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001432 " -s Short\n" \
1433 " -i Addresses for the hostname\n" \
1434 " -d DNS domain name\n" \
1435 " -f Fully qualified domain name\n" \
1436 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001437#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001438 "$ hostname\n" \
1439 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001440
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001441#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001442 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001443 " [-p [ip:]port]" \
1444 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001445 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001446 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001447 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001448 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001449 " [-d/-e string]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001450#define httpd_full_usage \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001451 "Listen for incoming HTTP requests" \
1452 "\n\nOptions:" \
1453 "\n -c FILE Configuration file (default httpd.conf)" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001454 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001455 "\n -i Inetd mode" \
1456 "\n -f Do not daemonize" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001457 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001458 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001459 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001460 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001461 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001462 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001463 "\n -m PASS Crypt PASS with md5 algorithm") \
1464 "\n -h HOME Home directory (default .)" \
1465 "\n -e STRING HTML encode STRING" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001466 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001467
Robert Griebl1cd04452002-07-21 16:50:49 +00001468#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001469 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001470 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1471 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001472 " [-f FILE]" \
1473 ) \
1474 SKIP_GETOPT_LONG( \
1475 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1476 )
Robert Griebl1cd04452002-07-21 16:50:49 +00001477#define hwclock_full_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001478 "Query and set a hardware clock (RTC)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001479 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001480 " -r Read hardware clock and print result\n" \
1481 " -s Set the system time from the hardware clock\n" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001482 " -w Set the hardware clock to the system time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001483 " -u The hardware clock is kept in coordinated universal time\n" \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001484 " -l The hardware clock is kept in local time\n" \
1485 " -f FILE Use the specified clock (e.g. /dev/rtc2)"
Robert Griebl1cd04452002-07-21 16:50:49 +00001486
Eric Andersen7e9276b2001-02-22 01:15:47 +00001487#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001488 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001489#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001490 "Print information for USERNAME or the current user" \
1491 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001492 USE_SELINUX( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001493 " -Z Prints only the security context\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001494 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001495 " -g Prints only the group ID\n" \
1496 " -u Prints only the user ID\n" \
1497 " -n Print a name instead of a number\n" \
1498 " -r Prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001499#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001500 "$ id\n" \
1501 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001502
Eric Andersen7e9276b2001-02-22 01:15:47 +00001503#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001504 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001505#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001506 "Configure a network interface" \
1507 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001508 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001509 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001510 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001511 " [del ADDRESS[/PREFIXLEN]]\n") \
1512 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1513 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001514 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001515 " [outfill NN] [keepalive NN]\n") \
1516 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001517 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001518 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001519 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001520 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001521 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001522
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001523#define ifup_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001524 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001525#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001526 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001527 " -a De/configure all interfaces automatically\n" \
1528 " -i FILE Use FILE for interface definitions\n" \
1529 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001530 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001531 " -v Print out what would happen before doing it\n" \
1532 " -m Don't run any mappings\n" \
1533 " -f Force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001534
1535#define ifdown_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001536 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001537#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001538 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001539 " -a De/configure all interfaces automatically\n" \
1540 " -i FILE Use FILE for interface definitions\n" \
1541 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001542 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001543 " -v Print out what would happen before doing it\n" \
1544 " -m Don't run any mappings\n" \
1545 " -f Force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001546
Glenn L McGrath06e95652003-02-09 06:51:14 +00001547#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001548 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001549#define inetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001550 "Listen for network connections and launch programs" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001551 "\n\nOptions:\n" \
Denis Vlasenko886bb0d2007-01-09 23:48:46 +00001552 " -f Run in foreground\n" \
1553 " -q N Set the size of the socket listen queue to N\n" \
1554 " (default: 128)"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001555
Eric Andersen7e9276b2001-02-22 01:15:47 +00001556#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001557 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001558#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001559 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001560#define init_notes_usage \
1561"This version of init is designed to be run only by the kernel.\n" \
1562"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001563"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001564"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001565"runlevels, use sysvinit.\n" \
1566"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001567"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001568"it has the following default behavior:\n" \
1569"\n" \
1570" ::sysinit:/etc/init.d/rcS\n" \
1571" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001572" ::ctrlaltdel:/sbin/reboot\n" \
1573" ::shutdown:/sbin/swapoff -a\n" \
1574" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001575" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001576"\n" \
1577"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1578"\n" \
1579" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001580" tty3::askfirst:/bin/sh\n" \
1581" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001582"\n" \
1583"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1584"\n" \
1585" <id>:<runlevels>:<action>:<process>\n" \
1586"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001587" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001588"\n" \
1589" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1590" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001591" the specified process to run on. The contents of this field are\n" \
1592" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1593" be unique, although if it isn't you may have strange results. If this\n" \
1594" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001595" note that if BusyBox detects that a serial console is in use, then only\n" \
1596" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001597" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001598" stinkin' utmp.\n" \
1599"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001600" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001601"\n" \
1602" The runlevels field is completely ignored.\n" \
1603"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001604" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001605"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001606" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001607" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001608"\n" \
1609" The available actions can be classified into two groups: actions\n" \
1610" that are run only once, and actions that are re-run when the specified\n" \
1611" process exits.\n" \
1612"\n" \
1613" Run only-once actions:\n" \
1614"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001615" 'sysinit' is the first item run on boot. init waits until all\n" \
1616" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001617" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001618" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001619" the specified task completes. 'once' actions are asynchronous,\n" \
1620" therefore, init does not wait for them to complete. 'restart' is\n" \
1621" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001622" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001623" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001624" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001625" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001626" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001627" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001628" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001629" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001630"\n" \
1631" Run repeatedly actions:\n" \
1632"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001633" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001634" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001635" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1636" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001637" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001638" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001639" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001640" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001641"\n" \
1642" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001643" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001644" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001645"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001646" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001647"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001648" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001649"\n" \
1650"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001651"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001652" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001653" #\n" \
1654" ::sysinit:/etc/init.d/rcS\n" \
1655" \n" \
1656" # /bin/sh invocations on selected ttys\n" \
1657" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001658" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001659" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001660" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001661" tty2::askfirst:-/bin/sh\n" \
1662" tty3::askfirst:-/bin/sh\n" \
1663" tty4::askfirst:-/bin/sh\n" \
1664" \n" \
1665" # /sbin/getty invocations for selected ttys\n" \
1666" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001667" tty4::respawn:/sbin/getty 38400 tty4\n" \
1668" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001669" \n" \
1670" \n" \
1671" # Example of how to put a getty on a serial line (for a terminal)\n" \
1672" #\n" \
1673" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1674" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1675" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001676" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001677" #::respawn:/sbin/getty 57600 ttyS2\n" \
1678" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001679" # Stuff to do when restarting the init process\n" \
1680" ::restart:/sbin/init\n" \
1681" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001682" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001683" ::ctrlaltdel:/sbin/reboot\n" \
1684" ::shutdown:/bin/umount -a -r\n" \
1685" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001686
1687#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001688 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001689#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001690 "Load the specified kernel modules into the kernel" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001691 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001692 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001693 " -f Force module to load into the wrong kernel version\n" \
1694 " -k Make module autoclean-able\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001695 " -v Verbose\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001696 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001697 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001698 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001699 " -m Output load map to stdout\n" \
1700 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001701 " -o NAME Set internal module name to NAME\n" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001702 " -x Do not export externs" \
1703 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001704
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001705#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001706 "[-cgmops] [sources] dest|directory"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001707#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001708 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001709 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001710 " -c Copy the file, default\n" \
1711 " -d Create directories\n" \
1712 " -g Set group ownership\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001713 " -m Set permissions\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001714 " -o Set ownership\n" \
1715 " -p Preserve date\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001716 " -s Strip symbol tables" \
1717 USE_SELINUX( \
1718 "\n -Z Set security context of copy" \
1719 )
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001720/* would need to make the " | " optional depending on more than one selected */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001721#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001722 "[OPTIONS] {" \
1723 USE_FEATURE_IP_ADDRESS("address | ") \
1724 USE_FEATURE_IP_ROUTE("route | ") \
1725 USE_FEATURE_IP_LINK("link | ") \
1726 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1727 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001728 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001729#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001730 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001731 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001732 USE_FEATURE_IP_ADDRESS("address | ") \
1733 USE_FEATURE_IP_ROUTE("route | ") \
1734 USE_FEATURE_IP_LINK("link | ") \
1735 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1736 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001737 "}\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001738 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001739
1740#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001741 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001742 " [dev STRING] [to PREFIX] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001743#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001744 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001745 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1746 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001747 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001748 " [broadcast ADDR] [anycast ADDR]\n" \
1749 " [label STRING] [scope SCOPE-ID]\n" \
1750 " SCOPE-ID := [host | link | global | NUMBER]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001751
Eric Andersende4f07e2003-12-11 01:18:07 +00001752#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001753 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001754#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001755 "Calculate IP network settings from a IP address" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001756 "\n\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001757 USE_FEATURE_IPCALC_LONG_OPTIONS( \
1758 "\n -b,--broadcast Display calculated broadcast address" \
1759 "\n -n,--network Display calculated network address" \
1760 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001761 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko03630782007-10-18 11:11:12 +00001762 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1763 "\n -h,--hostname Display first resolved host name" \
1764 "\n -s,--silent Don't ever display error messages" \
1765 ) \
1766 ) \
1767 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
1768 "\n -b Display calculated broadcast address" \
1769 "\n -n Display calculated network address" \
1770 "\n -m Display default netmask for IP" \
1771 USE_FEATURE_IPCALC_FANCY( \
1772 "\n -p Display the prefix for IP/NETMASK" \
1773 "\n -h Display first resolved host name" \
1774 "\n -s Don't ever display error messages" \
1775 ) \
1776 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001777
Rob Landley6eb1e412005-06-20 04:30:36 +00001778#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001779 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001780#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001781 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1782 "segment by a shmkey value. The lower-case options mqs are used\n" \
1783 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001784 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001785 " -[mM] Remove the memory segment after the last detach\n" \
1786 " -[qQ] Remove the message queue\n" \
1787 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001788
1789#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001790 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001791#define ipcs_full_usage \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001792 " -i Show a specific resource\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001793 "Resource specification:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001794 " -m Shared memory segments\n" \
1795 " -q Message queues\n" \
1796 " -s Semaphore arrays\n" \
1797 " -a All (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001798 "Output format:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001799 " -t Time\n" \
1800 " -c Creator\n" \
1801 " -p Pid\n" \
1802 " -l Limits\n" \
1803 " -u Summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001804
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001805#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001806 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001807#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001808 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001809 " dynamic { on | off } |\n" \
1810 " mtu MTU }\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001811 "iplink show [DEVICE]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001812
1813#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001814 "{ list | flush | { add | del | change | append |\n" \
1815 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001816#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001817 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001818 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1819 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001820 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001821 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
1822 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001823
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001824#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001825 "{[list | add | del] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001826#define iprule_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001827 "iprule [list | add | del] SELECTOR ACTION\n" \
1828 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1829 " [dev STRING] [pref NUMBER]\n" \
1830 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1831 " [prohibit | reject | unreachable]\n" \
1832 " [realms [SRCREALM/]DSTREALM]\n" \
1833 " TABLE_ID := [local | main | default | NUMBER]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001834
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001835#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001836 "{ add | change | del | show } [NAME]\n" \
1837 " [mode { ipip | gre | sit }]\n" \
1838 " [remote ADDR] [local ADDR] [ttl TTL]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001839#define iptunnel_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001840 "iptunnel { add | change | del | show } [NAME]\n" \
1841 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1842 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
1843 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001844
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001845#define kbd_mode_trivial_usage \
1846 "[-a|k|s|u]"
1847#define kbd_mode_full_usage \
1848 "Report or set the keyboard mode" \
1849 "\n\nOptions set mode:\n" \
1850 " -a Default (ASCII)\n" \
1851 " -k Medium-raw (keyboard)\n" \
1852 " -s Raw (scancode)\n" \
1853 " -u Unicode (utf-8)"
1854
Eric Andersen7e9276b2001-02-22 01:15:47 +00001855#define kill_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001856 "[-l] [-signal] process-id [process-id...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001857#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001858 "Send a signal (default is TERM) to the specified process(es)" \
1859 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001860 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001861#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001862 "$ ps | grep apache\n" \
1863 "252 root root S [apache]\n" \
1864 "263 www-data www-data S [apache]\n" \
1865 "264 www-data www-data S [apache]\n" \
1866 "265 www-data www-data S [apache]\n" \
1867 "266 www-data www-data S [apache]\n" \
1868 "267 www-data www-data S [apache]\n" \
1869 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001870
1871#define killall_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001872 "[-l] [-q] [-signal] process-name [process-name...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001873#define killall_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001874 "Send a signal (default is TERM) to the specified process(es)" \
1875 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001876 " -l List all signal names and numbers\n" \
1877 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001878#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001879 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001880
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001881#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001882 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001883#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001884 "Send a signal (default is TERM) to all processes outside current session" \
1885 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001886 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001887
Mark Whitley6317c4b2001-03-12 22:51:50 +00001888#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001889 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001890#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001891 "Kernel logger" \
1892 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001893 " -c n Sets the default log level of console messages to n\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001894 " -n Run in foreground"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001895
Eric Andersen7e9276b2001-02-22 01:15:47 +00001896#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001897 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001898#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001899 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001900#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001901 "$ length Hello\n" \
1902 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001903
Rob Landley9200e792005-09-15 19:26:59 +00001904#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001905 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001906#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001907 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001908 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001909 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001910 " -E Quit once the end of a file is reached\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001911 " -M,-m Display a status line containing the current line numbers\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001912 " and the percentage through the file\n" \
1913 " -N Prefix line numbers to each line\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001914 " -~ Suppress ~s displayed when input past the end of the file is\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001915 " reached"
Rob Landley9200e792005-09-15 19:26:59 +00001916
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001917#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001918 "personality program [args...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001919#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001920 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001921 " linux32 Set 32bit uname emulation\n" \
1922 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001923
Eric Andersen7e9276b2001-02-22 01:15:47 +00001924#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001925 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001926#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001927 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1928 "You may use '--' to indicate that all following arguments are non-options." \
1929 "\n\nOptions:\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00001930 " -s Make symlinks instead of hardlinks\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001931 " -f Remove existing destination files\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001932 " -n Don't dereference symlinks - treat like normal file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001933 " -b Make a backup of the target (if exists) before link operation\n" \
1934 " -S suf Use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001935#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001936 "$ ln -s BusyBox /tmp/ls\n" \
1937 "$ ls -l /tmp/ls\n" \
1938 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001939
Denis Vlasenkob042bd92007-09-26 18:01:32 +00001940#define load_policy_trivial_usage
1941
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00001942#define load_policy_full_usage
1943
Eric Andersen7e9276b2001-02-22 01:15:47 +00001944#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001945 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001946#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001947 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001948#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001949 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001950
1951#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001952 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001953#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001954 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001955#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001956 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001957
1958#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001959 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001960#define logger_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001961 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001962 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001963 " -s Log to stderr as well as the system log\n" \
1964 " -t TAG Log using the specified tag (defaults to user name)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001965 " -p PRIO Enter the message with the specified priority.\n" \
1966 " This may be numerical or a 'facility.level' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001967#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001968 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001969
Robert Griebl1fca5582002-06-04 20:45:46 +00001970#define login_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001971 "[OPTION]... [username] [ENV=VAR...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00001972#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001973 "Begin a new session on the system" \
1974 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001975 " -f Do not authenticate (user already authenticated)\n" \
1976 " -h Name of the remote host for this login\n" \
1977 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001978
Eric Andersen7e9276b2001-02-22 01:15:47 +00001979#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001980 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001981#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001982 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001983#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001984 "$ logname\n" \
1985 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001986
Mark Whitley6317c4b2001-03-12 22:51:50 +00001987#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001988 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001989#define logread_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001990 "Show the messages from syslogd (using circular buffer)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001991 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001992 " -f Output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001993
Matt Kraai83788da2002-03-20 17:38:37 +00001994#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00001995 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
1996 " losetup -d LOOPDEV - disassociate\n" \
1997 " losetup [-f] - show"
Matt Kraai83788da2002-03-20 17:38:37 +00001998#define losetup_full_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00001999 "Options:\n" \
2000 " -o OFS Start OFS bytes into FILE\n" \
2001 " -f Show first free loop device"
Rob Landley1d589b22005-11-29 23:47:10 +00002002#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002003 "No arguments will display all current associations.\n" \
2004 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002005 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002006 "and filename of the file the loop device is currently bound to.\n\n" \
2007 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002008 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2009 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002010
Eric Andersen7e9276b2001-02-22 01:15:47 +00002011#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002012 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002013 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002014 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2015 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2016 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2017 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2018 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2019 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002020#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002021 "List directory contents" \
2022 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002023 "\n -1 List files in a single column" \
2024 "\n -A Do not list implied . and .." \
2025 "\n -a Do not hide entries starting with ." \
2026 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002027 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002028 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002029 USE_FEATURE_LS_COLOR( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002030 "\n --color[={always,never,auto}] Control coloring") \
2031 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002032 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002033 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002034 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002035 "\n -F Append indicator (one of */=@|) to entries") \
2036 "\n -i List the i-node for each file" \
2037 "\n -l Use a long listing format" \
2038 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002039 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002040 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002041 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002042 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002043 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002044 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002045 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002046 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002047 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002048 "\n -S Sort the listing by file size") \
2049 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002050 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002051 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002052 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002053 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002054 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002055 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002056 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002057 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002058 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002059 "\n -w NUM Assume the terminal is NUM columns wide") \
2060 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002061 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002062 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002063 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002064 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002065 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002066 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002067 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002068 "\n -K Print security context in long format") \
2069 USE_SELINUX( \
2070 "\n -Z Print security context and permission")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002071
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002072#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002073 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002074#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002075 "List file attributes on an ext2 fs" \
2076 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002077 " -R Recursively list subdirectories\n" \
2078 " -a Do not hide entries starting with .\n" \
2079 " -d List directory entries instead of contents\n" \
2080 " -l Print long flag names\n" \
2081 " -v List the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002082
Eric Andersen7e9276b2001-02-22 01:15:47 +00002083#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002084 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002085#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002086 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002087
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002088#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002089#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002090 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002091#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002092 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002093 "TYPEs include:\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002094 " b: Make a block (buffered) device\n" \
2095 " c or u: Make a character (un-buffered) device\n" \
2096 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
2097 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002098 "FIRST specifies the number appended to NAME to create the first device.\n" \
2099 "LAST specifies the number of the last item that should be created\n" \
2100 "If 's' is the last argument, the base device is created as well.\n\n" \
2101 "For example:\n" \
2102 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2103 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002104#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002105 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2106 "[creates ttyS2-ttyS63]\n" \
2107 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2108 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002109#endif
2110
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002111#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002112#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002113 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00002114#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002115 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002116 "Device table entries take the form of:\n" \
2117 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002118 "Where name is the file name, type can be one of:\n" \
2119 " f A regular file\n" \
2120 " d Directory\n" \
2121 " c Character special device file\n" \
2122 " b Block special device file\n" \
2123 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002124 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002125 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2126 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002127#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002128 "For example:\n" \
2129 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2130 "/dev d 755 0 0 - - - - -\n" \
2131 "/dev/console c 666 0 0 5 1 - - -\n" \
2132 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2133 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2134 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2135 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2136 "Will Produce:\n" \
2137 "/dev\n" \
2138 "/dev/console\n" \
2139 "/dev/null\n" \
2140 "/dev/zero\n" \
2141 "/dev/hda\n" \
2142 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002143#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002144
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002145#define matchpathcon_trivial_usage \
2146 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2147#define matchpathcon_full_usage \
2148 " -n Do not display path" \
2149 "\n -N Do not use translations" \
2150 "\n -f Use alternate file_context file" \
2151 "\n -p Use prefix to speed translations" \
2152 "\n -V Verify file context on disk matches defaults"
2153
Eric Andersen7e9276b2001-02-22 01:15:47 +00002154#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002155 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002156 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002157#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002158 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2159 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002160 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002161 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002162 " -c Check MD5 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002163 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002164 " -s Don't output anything, status code shows success\n" \
2165 " -w Warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002166#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002167 "$ md5sum < busybox\n" \
2168 "6fd11e98b98a58f64ff3398d7b324003\n" \
2169 "$ md5sum busybox\n" \
2170 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2171 "$ md5sum -c -\n" \
2172 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2173 "busybox: OK\n" \
2174 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002175
Rob Landley70f7ef72005-12-13 08:21:33 +00002176#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002177 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002178#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002179 " -s Scan /sys and populate /dev during system boot\n\n" \
2180 "Called with no options (via hotplug) it uses environment variables\n" \
2181 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00002182#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002183 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002184 "The mdev config file contains lines that look like:\n" \
2185 " hd[a-z][0-9]* 0:3 660\n\n" \
2186 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002187 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002188 "Optionally, that can be followed (on the same line) by a special character\n" \
2189 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002190 "device(s). The environment variable $MDEV indicates the active device node\n" \
2191 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002192 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2193 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002194 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002195 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002196 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002197 "Config file parsing stops on the first matching line. If no config\n" \
2198 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002199 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002200 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002201
Glenn L McGrath061c9002002-09-16 04:21:46 +00002202#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002203 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002204#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002205 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002206 " y Allow write access to your terminal\n" \
2207 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002208
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002209#define microcom_trivial_usage \
2210 "[-s speed] tty-name"
2211#define microcom_full_usage \
2212 ""
2213
Eric Andersen7e9276b2001-02-22 01:15:47 +00002214#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002215 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002216#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002217 "Create the DIRECTORY(ies) if they do not already exist" \
2218 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002219 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002220 " -p No error if existing, make parent directories as needed" \
2221 USE_SELINUX( \
2222 "\n -Z Set security context" \
2223 )
2224
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002225#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002226 "$ mkdir /tmp/foo\n" \
2227 "$ mkdir /tmp/foo\n" \
2228 "/tmp/foo: File exists\n" \
2229 "$ mkdir /tmp/foo/bar/baz\n" \
2230 "/tmp/foo/bar/baz: No such file or directory\n" \
2231 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002232
Mike Frysinger6447ac02005-06-11 05:29:40 +00002233#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002234 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2235 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2236 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2237 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2238 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2239 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002240#define mke2fs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002241 " -b size Block size in bytes\n" \
2242 " -c Check for bad blocks before creating\n" \
2243 " -E opts Set extended options\n" \
2244 " -f size Fragment size in bytes\n" \
2245 " -F Force (ignore sanity checks)\n" \
2246 " -g num Number of blocks in a block group\n" \
2247 " -i ratio The bytes/inode ratio\n" \
2248 " -j Create a journal (ext3)\n" \
2249 " -J opts Set journal options (size/device)\n" \
2250 " -l file Read bad blocks list from file\n" \
2251 " -L lbl Set the volume label\n" \
2252 " -m percent Percent of fs blocks to reserve for admin\n" \
2253 " -M dir Set last mounted directory\n" \
2254 " -n Do not actually create anything\n" \
2255 " -N num Number of inodes to create\n" \
2256 " -o os Set the 'creator os' field\n" \
2257 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002258 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002259 " -r rev Set filesystem revision\n" \
2260 " -S Write superblock and group descriptors only\n" \
2261 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002262 " -v Verbose"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002263
Eric Andersen7e9276b2001-02-22 01:15:47 +00002264#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002265 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002266#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002267 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002268 "\n\nOptions:\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002269 " -m Create the pipe using the specified mode (default a=rw)" \
2270 USE_SELINUX( \
2271 "\n -Z Set security context" \
2272 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002273
Eric Andersen7e9276b2001-02-22 01:15:47 +00002274#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002275 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002276#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002277 "Make a MINIX filesystem" \
2278 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002279 " -c Check device for bad blocks\n" \
2280 " -n [14|30] Maximum length of filenames\n" \
2281 " -i INODES Number of inodes for the filesystem\n" \
2282 " -l FILENAME Read bad blocks list from FILENAME\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002283 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002284
Eric Andersen7e9276b2001-02-22 01:15:47 +00002285#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002286 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002287#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002288 "Create a special file (block, character, or pipe)" \
2289 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002290 " -m Create the special file using the specified mode (default a=rw)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002291 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002292 " b: Make a block (buffered) device\n" \
2293 " c or u: Make a character (un-buffered) device\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002294 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes" \
2295 USE_SELINUX( \
2296 "\n -Z Set security context" \
2297 )
2298
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002299#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002300 "$ mknod /dev/fd0 b 2 0\n" \
2301 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002302
Eric Andersen7e9276b2001-02-22 01:15:47 +00002303#define mkswap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002304 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002305#define mkswap_full_usage \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00002306 "Prepare a disk partition to be used as swap partition" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002307 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002308 " -c Check for read-ability\n" \
2309 " -v0 Make version 0 swap [max 128 Megs]\n" \
2310 " -v1 Make version 1 swap [big!] (default for kernels > 2.1.117)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002311 " block-count Number of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002312
Eric Andersen7e9276b2001-02-22 01:15:47 +00002313#define mktemp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002314 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002315#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002316 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002317 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2318 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002319 " -d Make a directory instead of a file\n" \
2320 " -q Fail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002321#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002322 "$ mktemp /tmp/temp.XXXXXX\n" \
2323 "/tmp/temp.mWiLjM\n" \
2324 "$ ls -la /tmp/temp.mWiLjM\n" \
2325 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002326
Eric Andersen8d79ce82001-07-22 23:00:15 +00002327#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002328 "[-knqrsv] MODULE [symbol=value...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002329#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002330 "Options:\n" \
2331 " -k Make module autoclean-able\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002332 " -n Dry run\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002333 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002334 " -r Remove module (stacks) or do autoclean\n" \
2335 " -s Report via syslog instead of stderr\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002336 " -v Verbose"
Rob Landley9c32a152005-12-11 20:12:24 +00002337#define modprobe_notes_usage \
2338"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2339"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2340"pass each module it loads.\n" \
2341"\n" \
2342"The configuration file is searched (in order) amongst:\n" \
2343"\n" \
2344" /etc/modprobe.conf (2.6 only)\n" \
2345" /etc/modules.conf\n" \
2346" /etc/conf.modules (deprecated)\n" \
2347"\n" \
2348"They all have the same syntax (see below). If none is present, it is\n" \
2349"_not_ an error; each loaded module is then expected to load without\n" \
2350"options. Once a file is found, the others are tested for.\n" \
2351"\n" \
2352"/etc/modules.conf entry format:\n" \
2353"\n" \
2354" alias <alias_name> <mod_name>\n" \
2355" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002356" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002357" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2358" This makes it also possible to use a different set of options (below) for\n" \
2359" the module and the alias.\n" \
2360" A module can be aliased more than once.\n" \
2361"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002362" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002363" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2364" the \"symbol=value\" pairs as option to that module.\n" \
2365"\n" \
2366"Sample /etc/modules.conf file:\n" \
2367"\n" \
2368" options tulip irq=3\n" \
2369" alias tulip tulip2\n" \
2370" options tulip2 irq=4 io=0x308\n" \
2371"\n" \
2372"Other functionality offered by 'classic' modprobe is not available in\n" \
2373"this implementation.\n" \
2374"\n" \
2375"If module options are present both in the config file, and on the command line,\n" \
2376"then the options from the command line will be passed to the module _after_\n" \
2377"the options from the config file. That way, you can have defaults in the config\n" \
2378"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002379#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002380 "(with the above /etc/modules.conf):\n\n" \
2381 "$ modprobe tulip\n" \
2382 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2383 "$ modprobe tulip irq=5\n" \
2384 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2385 "$ modprobe tulip2\n" \
2386 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2387 " which are the default for alias 'tulip2'\n\n" \
2388 "$ modprobe tulip2 irq=8\n" \
2389 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2390 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2391 " from the command line\n\n" \
2392 "$ modprobe tulip2 irq=2 io=0x210\n" \
2393 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2394 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2395 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002396
Eric Andersen7e9276b2001-02-22 01:15:47 +00002397#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002398 "[FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002399#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002400 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002401#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002402 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002403
Eric Andersen7e9276b2001-02-22 01:15:47 +00002404#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002405 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002406#define mount_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002407 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2408 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002409 " -a Mount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002410 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002411 " -f Update /etc/mtab, but don't mount\n" \
2412 " -n Don't update /etc/mtab\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002413 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002414 " -r Read-only mount\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002415 " -t fs-type Filesystem type\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002416 " -w Read-write mount (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002417 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002418 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002419 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002420 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002421 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002422 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002423 " [a]sync Writes are asynchronous / synchronous\n" \
2424 " [no]atime Disable / enable updates to inode access times\n" \
2425 " [no]diratime Disable / enable atime updates to directories\n" \
2426 " [no]dev Allow use of special device files / disallow them\n" \
2427 " [no]exec Allow use of executable files / disallow them\n" \
2428 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2429 " [r]shared Convert [recursively] to a shared subtree\n" \
2430 " [r]slave Convert [recursively] to a slave subtree\n" \
2431 " [r]private Convert [recursively] to a private subtree\n" \
2432 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2433 " bind Bind a directory to an additional location\n" \
2434 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002435 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002436 " remount Remount a mounted filesystem, changing its flags\n" \
2437 " ro/rw Mount for read-only / read-write\n" \
2438 "\n" \
2439 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002440 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002441#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002442 "$ mount\n" \
2443 "/dev/hda3 on / type minix (rw)\n" \
2444 "proc on /proc type proc (rw)\n" \
2445 "devpts on /dev/pts type devpts (rw)\n" \
2446 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2447 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2448 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002449#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002450 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002451
Rob Landleyd00b3a52005-08-20 05:07:08 +00002452#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002453 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002454#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002455 "mountpoint checks if the directory is a mountpoint" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002456 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002457 " -q Quiet\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002458 " -d Print major/minor device number of the filesystem\n" \
2459 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002460#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002461 "$ mountpoint /proc\n" \
2462 "/proc is not a mountpoint\n" \
2463 "$ mountpoint /sys\n" \
2464 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002465
Eric Andersen7e9276b2001-02-22 01:15:47 +00002466#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002467 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002468#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002469 "Control magnetic tape drive operation\n" \
2470 "\nAvailable Opcodes:\n\n" \
2471 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2472 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2473 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2474 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002475
Eric Andersen7e9276b2001-02-22 01:15:47 +00002476#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002477 "[OPTION]... SOURCE DEST\n" \
2478 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002479#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002480 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2481 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002482 " -f Don't prompt before overwriting\n" \
2483 " -i Interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002484#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002485 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002486
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002487#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002488 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002489#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002490 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002491 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002492 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2493 " -s Use syslog (LOCAL0 facility)\n" \
2494 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002495#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002496 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2497 " or\n" \
2498 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002499
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002500#if !ENABLE_DESKTOP
2501
Rob Landley1cca9482006-07-10 19:45:20 +00002502#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002503#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002504#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002505#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002506#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002507
Eric Andersen7e9276b2001-02-22 01:15:47 +00002508#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002509 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002510 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002511#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002512 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002513 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002514 USE_NC_EXTRA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002515 "\n -e Exec rest of command line after connect" \
2516 "\n -i SECS Delay interval for lines sent" \
2517 "\n -w SECS Timeout for connect" \
Denis Vlasenko5d687242007-01-12 20:59:31 +00002518 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002519 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002520 USE_NC_SERVER( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002521 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002522 USE_NC_EXTRA( \
2523 "\n (use -l twice with -e for persistent server)") \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002524 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002525 )
2526
Rob Landley1cca9482006-07-10 19:45:20 +00002527#define nc_notes_usage "" \
2528 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002529 "To use netcat as a terminal emulator on a serial port:\n\n" \
2530 "$ stty 115200 -F /dev/ttyS0\n" \
2531 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2532 )
Rob Landley1cca9482006-07-10 19:45:20 +00002533
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002534#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002535 "$ nc foobar.somedomain.com 25\n" \
2536 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2537 "help\n" \
2538 "214-Commands supported:\n" \
2539 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2540 "214 NOOP QUIT RSET HELP\n" \
2541 "quit\n" \
2542 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002543
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002544#else /* DESKTOP nc - much more compatible with nc 1.10 */
2545
2546#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002547 "[-options] hostname port - connect" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002548 USE_NC_SERVER("\nnc [-options] -l -p port [hostname] [port] - listen")
2549#define nc_full_usage \
2550 USE_NC_SERVER( \
2551 "-l Listen mode, for inbound connects\n" \
2552 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002553 "-n Don't do DNS resolution" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002554 "\n-s addr Local address" \
2555 "\n-p port Local port" \
2556 "\n-u UDP mode" \
2557 "\n-v Verbose (cumulative: -vv)" \
2558 "\n-w secs Timeout for connects and final net reads" \
2559 USE_NC_EXTRA( \
2560 "\n-i sec Delay interval for lines sent" /* ", ports scanned" */ \
2561 "\n-o file Hex dump of traffic" \
2562 "\n-z Zero-I/O mode (scanning)" \
2563 ) \
2564 "\n-e prog [args] Program to exec after connect (must be last)" \
2565/* "\n-r Randomize local and remote ports" */
2566/* "\n-g gateway Source-routing hop point[s], up to 8" */
2567/* "\n-G num Source-routing pointer: 4, 8, 12, ..." */
2568/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2569
2570#endif
2571
Eric Andersen1552ff72001-10-31 11:07:12 +00002572#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002573 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002574#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002575 "Display networking information" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002576 "\n\nOptions:" \
2577 "\n -l Display listening server sockets" \
2578 "\n -a Display all sockets (default: connected)" \
2579 "\n -e Display other/more information" \
2580 "\n -n Don't resolve names" \
2581 "\n -t Tcp sockets" \
2582 "\n -u Udp sockets" \
2583 "\n -w Raw sockets" \
2584 "\n -x Unix sockets" \
2585 "\n -r Display routing table" \
2586 USE_FEATURE_NETSTAT_WIDE( \
2587 "\n -W Display with no column truncation" \
2588 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002589
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002590#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002591 "[-n ADJUST] [COMMAND [ARG]...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002592#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002593 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002594 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002595 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002596
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002597#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002598 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002599#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002600 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002601 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002602 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002603 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002604 "%[niface] Monitor network interface 'iface'\n" \
2605 "%m Monitor allocated memory\n" \
2606 "%[mf] Monitor free memory\n" \
2607 "%[mt] Monitor total memory\n" \
2608 "%s Monitor allocated swap\n" \
2609 "%f Monitor number of used file descriptors\n" \
2610 "%Ni Monitor total/specific IRQ rate\n" \
2611 "%x Monitor context switch rate\n" \
2612 "%p Monitor forks\n" \
2613 "%[pn] Monitor # of processes\n" \
2614 "%b Monitor block io\n" \
2615 "%Nt Show time (with N decimal points)\n" \
2616 "%Nd Milliseconds between updates (default=1000)\n" \
2617 "%r Print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002618#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002619 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002620
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002621#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002622 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002623#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002624 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002625#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002626 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002627
Eric Andersen7e9276b2001-02-22 01:15:47 +00002628#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002629 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002630#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002631 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002632 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002633#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002634 "$ nslookup localhost\n" \
2635 "Server: default\n" \
2636 "Address: default\n" \
2637 "\n" \
2638 "Name: debian\n" \
2639 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002640
Glenn L McGrath60281112001-11-02 11:39:46 +00002641#define od_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002642 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002643#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002644 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002645 "to standard output. With no FILE, or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002646
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002647#define openvt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002648 "VTNUM COMMAND [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002649#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002650 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002651#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002652 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002653
Eric Andersen27f64e12002-06-23 04:24:25 +00002654#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002655 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002656#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002657 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002658 "changes the password for the current user." \
2659 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002660 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002661 " (choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002662 " -d Delete the password for the specified user account\n" \
2663 " -l Locks (disables) the specified user account\n" \
2664 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002665
Denis Vlasenko21d10142007-07-20 21:28:41 +00002666#define chpasswd_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002667 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko21d10142007-07-20 21:28:41 +00002668#define chpasswd_full_usage \
2669 "Read user:password information from stdin\n" \
2670 "and update /etc/passwd accordingly." \
2671 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002672 USE_GETOPT_LONG( \
2673 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2674 "\n -m,--md5 Use MD5 encryption instead of DES" \
2675 ) \
2676 SKIP_GETOPT_LONG( \
2677 "\n -e Supplied passwords are in encrypted form" \
2678 "\n -m Use MD5 encryption instead of DES" \
2679 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002680
Glenn L McGrath655d8142003-06-22 15:32:41 +00002681#define patch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002682 "[-p num] [-i diff]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002683#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002684 " -p NUM Strip NUM leading components from file names\n" \
2685 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002686#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002687 "$ patch -p1 < example.diff\n" \
2688 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002689
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002690#define pgrep_trivial_usage \
2691 "[-flnovx] pattern"
2692#define pgrep_full_usage \
2693 "Display process(es) selected by regex pattern" \
2694 "\n\nOptions:\n" \
2695 " -l Show command name too\n" \
2696 " -f Match against entire command line\n" \
2697 " -n Signal the newest process only\n" \
2698 " -o Signal the oldest process only\n" \
2699 " -v Negate the matching\n" \
2700 " -x Match whole name (not substring)"
2701
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002702#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2703#define USAGE_PIDOF "Options:"
2704#else
Denis Vlasenko765996a2006-12-24 16:59:27 +00002705#define USAGE_PIDOF "\nThis version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002706#endif
2707
Eric Andersen221b2ea2001-07-31 19:06:07 +00002708#define pidof_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002709 "process-name [OPTION] [process-name...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002710
Eric Andersen221b2ea2001-07-31 19:06:07 +00002711#define pidof_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002712 "List the PIDs of all processes with names that match the\n" \
2713 "names on the command line\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002714 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002715 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002716 "\n -s Display only a single PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002717 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenko198bada2007-06-23 14:56:43 +00002718 "\n -o PID Omit given pid") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002719 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002720 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002721#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002722 "$ pidof init\n" \
2723 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002724 USE_FEATURE_PIDOF_OMIT( \
2725 "$ pidof /bin/sh\n20351 5973 5950\n") \
2726 USE_FEATURE_PIDOF_OMIT( \
2727 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002728
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002729#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002730#define ping_trivial_usage \
2731 "host"
2732#define ping_full_usage \
2733 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002734#define ping6_trivial_usage \
2735 "host"
2736#define ping6_full_usage \
2737 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002738#else
2739#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002740 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002741#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002742 "Send ICMP ECHO_REQUEST packets to network hosts" \
2743 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002744 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2745 " -c CNT Send only CNT pings\n" \
2746 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2747 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002748 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002749 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002750#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002751 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002752#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002753 "Send ICMP ECHO_REQUEST packets to network hosts" \
2754 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002755 " -c CNT Send only CNT pings\n" \
2756 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2757 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002758 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002759 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002760#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002761#define ping_example_usage \
2762 "$ ping localhost\n" \
2763 "PING slag (127.0.0.1): 56 data bytes\n" \
2764 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2765 "\n" \
2766 "--- debian ping statistics ---\n" \
2767 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2768 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002769#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002770 "$ ping6 ip6-localhost\n" \
2771 "PING ip6-localhost (::1): 56 data bytes\n" \
2772 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2773 "\n" \
2774 "--- ip6-localhost ping statistics ---\n" \
2775 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2776 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002777
Eric Andersen7e9276b2001-02-22 01:15:47 +00002778#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002779 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002780#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002781 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002782 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002783
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002784#define pkill_trivial_usage \
2785 "[-l] | [-fnovx] [-signal] pattern"
2786#define pkill_full_usage \
2787 "Send a signal to process(es) selected by regex pattern" \
2788 "\n\nOptions:\n" \
2789 " -l List all signals\n" \
2790 " -f Match against entire command line\n" \
2791 " -n Signal the newest process only\n" \
2792 " -o Signal the oldest process only\n" \
2793 " -v Negate the matching\n" \
2794 " -x Match whole name (not substring)"
2795
Eric Andersen7e9276b2001-02-22 01:15:47 +00002796#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002797 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002798#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002799 "Halt and shut off power" \
2800 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002801 " -d Delay interval for halting\n" \
2802 " -n No call to sync()\n" \
2803 " -f Force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002804
Mike Frysinger95d3c452005-04-21 23:29:24 +00002805#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002806 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002807#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002808 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002809 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002810
Eric Andersen7e9276b2001-02-22 01:15:47 +00002811#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002812 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002813#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002814 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002815 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002816#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002817 "$ printf \"Val=%d\\n\" 5\n" \
2818 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002819
Denis Vlasenko94949192006-11-05 00:45:47 +00002820
2821#if ENABLE_DESKTOP
2822
2823#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002824 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002825#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002826 "Report process status" \
2827 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002828 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002829
2830#else /* !ENABLE_DESKTOP */
2831
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002832#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002833#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002834#else
2835#define USAGE_PS "\nOptions:"
2836#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002837
Eric Andersen7e9276b2001-02-22 01:15:47 +00002838#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002839 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002840#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002841 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002842 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002843 USE_SELINUX( \
Bernhard Reutner-Fischer26a80162007-03-14 08:52:28 +00002844 "\n -Z Show SE Linux context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002845 USE_FEATURE_PS_WIDE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002846 "\n w Wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002847
Denis Vlasenko94949192006-11-05 00:45:47 +00002848#endif /* ENABLE_DESKTOP */
2849
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002850#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002851 "$ ps\n" \
2852 " PID Uid Gid State Command\n" \
2853 " 1 root root S init\n" \
2854 " 2 root root S [kflushd]\n" \
2855 " 3 root root S [kupdate]\n" \
2856 " 4 root root S [kpiod]\n" \
2857 " 5 root root S [kswapd]\n" \
2858 " 742 andersen andersen S [bash]\n" \
2859 " 743 andersen andersen S -bash\n" \
2860 " 745 root root S [getty]\n" \
2861 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002862
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00002863#define pscan_trivial_usage \
2864 "[-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
2865#define pscan_full_usage \
2866 "Scan a host, print all open ports" \
2867 "\n\nOptions:" \
2868 "\n -p Scan from this port (default 1)" \
2869 "\n -P Scan up to this port (default 1024)" \
2870 "\n -t Timeout (default 5000 ms)" \
2871 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
2872
Eric Andersen7e9276b2001-02-22 01:15:47 +00002873#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002874 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002875#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002876 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002877#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002878 "$ pwd\n" \
2879 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002880
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002881#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002882 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002883#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002884 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002885#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002886 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002887
Eric Andersen7e9276b2001-02-22 01:15:47 +00002888#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002889 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002890#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002891 "Get and possibly set the system date and time from a remote HOST" \
2892 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002893 " -s Set the system date and time (default)\n" \
2894 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002895
Rob Landley0e4690d2006-08-20 22:12:18 +00002896#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002897 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002898#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002899 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2900 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00002901
Eric Andersen7e9276b2001-02-22 01:15:47 +00002902#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002903 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002904#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002905 "Display the value of a symlink" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002906 USE_FEATURE_READLINK_FOLLOW( \
2907 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002908 " -f Canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002909
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002910#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002911 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002912#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002913 "Options:\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002914 " -m mapfile (Default: /boot/System.map)\n" \
2915 " -p profile (Default: /proc/profile)\n" \
2916 " -M mult Set the profiling multiplier to mult\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002917 " -i Print only info about the sampling step\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002918 " -v Verbose\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002919 " -a Print all symbols, even if count is 0\n" \
2920 " -b Print individual histogram-bin counts\n" \
2921 " -s Print individual counters within functions\n" \
2922 " -r Reset all the counters (root only)\n" \
2923 " -n Disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002924
Glenn L McGrath62fae302002-12-10 00:14:33 +00002925#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002926 "pathname..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00002927#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002928 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00002929
Eric Andersen7e9276b2001-02-22 01:15:47 +00002930#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002931 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002932#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002933 "Reboot the system" \
2934 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002935 " -d Delay interval for rebooting\n" \
2936 " -n No call to sync()\n" \
2937 " -f Force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002938
2939#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002940 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002941#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002942 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002943 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002944 " -n Adjust current nice value (smaller is faster)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002945 " -p Process id(s) (default)\n" \
2946 " -g Process group id(s)\n" \
2947 " -u Process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002948
Eric Andersen7e9276b2001-02-22 01:15:47 +00002949#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002950 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002951#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002952 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002953
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002954#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002955 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002956#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002957 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002958
Denis Vlasenko397137b2007-07-23 14:03:30 +00002959#define restorecon_trivial_usage \
2960 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
2961#define restorecon_full_usage \
2962 "Reset security contexts of files in pathname\n" \
2963 "\n -i Ignore files that do not exist" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00002964 "\n -f file File with list of files to process. Use - for stdin" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00002965 "\n -e directory Directory to exclude" \
2966 "\n -R,-r Recurse directories" \
2967 "\n -n Don't change any file labels" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00002968 "\n -o file Save list of files with incorrect context" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00002969 "\n -v Verbose" \
2970 "\n -vv Show changed labels" \
2971 "\n -F Force reset of context to match file_context" \
2972 "\n for customizable files, or the user section," \
2973 "\n if it has changed"
2974
Eric Andersen7e9276b2001-02-22 01:15:47 +00002975#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002976 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002977#define rm_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002978 "Remove (unlink) the FILE(s). You may use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002979 "indicate that all following arguments are non-options." \
2980 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002981 " -i Always prompt before removing each destination\n" \
2982 " -f Remove existing destinations, never prompt\n" \
2983 " -r,-R Remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002984#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002985 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002986
Eric Andersen7e9276b2001-02-22 01:15:47 +00002987#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002988 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002989#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002990 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002991#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002992 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002993
Eric Andersen7e9276b2001-02-22 01:15:47 +00002994#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002995 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002996#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002997 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002998 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002999 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003000#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003001 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003002
Eric Andersen7e9276b2001-02-22 01:15:47 +00003003#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003004 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003005#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003006 "Edit the kernel's routing tables" \
3007 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003008 " -n Dont resolve names\n" \
3009 " -e Display other/more information\n" \
3010 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003011
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003012#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003013 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003014#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003015 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003016 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003017 "\n -i Install package" \
3018 "\n -q Query package" \
3019 "\n -p Query uninstalled package" \
3020 "\n -i Show information" \
3021 "\n -l List contents" \
3022 "\n -d List documents" \
3023 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003024
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003025#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003026 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003027#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003028 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003029
Denis Vlasenko49622d72007-03-10 16:58:49 +00003030#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003031 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3032 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko49622d72007-03-10 16:58:49 +00003033#define runcon_full_usage \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003034 "Run a program in a different security context\n\n" \
3035 " CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003036 USE_GETOPT_LONG( \
3037 " -c,--compute Compute process transition context before modifying\n" \
3038 " -t,--type=TYPE Type (for same role as parent)\n" \
3039 " -u,--user=USER User identity\n" \
3040 " -r,--role=ROLE Role\n" \
3041 " -l,--range=RNG Levelrange" \
3042 ) \
3043 SKIP_GETOPT_LONG( \
3044 " -c Compute process transition context before modifying\n" \
3045 " -t TYPE Type (for same role as parent)\n" \
3046 " -u USER User identity\n" \
3047 " -r ROLE Role\n" \
3048 " -l RNG Levelrange" \
3049 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003050
Eric Andersen6cf47a72001-10-31 10:24:36 +00003051#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003052 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003053#define run_parts_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003054 "Run a bunch of scripts in a directory" \
3055 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003056 " -t Prints what would be run, but does not actually run anything\n" \
3057 " -a ARG Pass ARG as an argument for every program invoked\n" \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003058 " -u MASK Set the umask to MASK before executing every program" \
3059USE_FEATURE_RUN_PARTS_FANCY("\n -l Prints names of all matching files even when they are not executable")
3060
3061#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003062 "$ run-parts -a start /etc/init.d\n" \
3063 "$ run-parts -a stop=now /etc/init.d\n\n" \
3064 "Let's assume you have a script foo/dosomething:\n" \
3065 "#!/bin/sh\n" \
3066 "for i in $*; do eval $i; done; unset i\n" \
3067 "case \"$1\" in\n" \
3068 "start*) echo starting something;;\n" \
3069 "stop*) set -x; shutdown -h $stop;;\n" \
3070 "esac\n\n" \
3071 "Running this yields:\n" \
3072 "$run-parts -a stop=+4m foo/\n" \
3073 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003074
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003075#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003076 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003077#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003078 "Find the current and previous system runlevel.\n\n" \
3079 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003080 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003081#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003082 "$ runlevel /var/run/utmp\n" \
3083 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003084
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003085#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003086 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003087#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003088 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003089
3090#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003091 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003092#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003093 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003094
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003095#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003096 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003097#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003098 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003099#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003100 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003101
Eric Andersen7e9276b2001-02-22 01:15:47 +00003102#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003103 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003104#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003105 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003106 " -e script Add the script to the commands to be executed\n" \
3107 " -f scriptfile Add script-file contents to the\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003108 " commands to be executed\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003109 " -i Edit files in-place\n" \
3110 " -n Suppress automatic printing of pattern space\n" \
3111 " -r Use extended regular expression syntax\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003112 "\n" \
3113 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
3114 "script to interpret. All remaining arguments are names of input files; if no\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003115 "input files are specified, then the standard input is read. Source files\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003116 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00003117
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003118#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003119 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3120 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003121
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003122#define selinuxenabled_trivial_usage
3123#define selinuxenabled_full_usage
3124
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003125#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003126 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003127#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003128 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003129 "FIRST, INCREMENT default to 1" \
3130 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003131 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003132 " FIRST LAST\n" \
3133 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003134
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003135#define sestatus_trivial_usage \
3136 "[-vb]"
3137#define sestatus_full_usage \
3138 "-v Verbose\n" \
3139 "-b Display current state of booleans"
3140
Paul Foxfc2256a2005-08-01 18:12:30 +00003141#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003142 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00003143#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003144 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003145 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003146 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00003147
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003148#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003149 "[Enforcing | Permissive | 1 | 0]"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003150#define setenforce_full_usage
3151
Denis Vlasenko397137b2007-07-23 14:03:30 +00003152#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003153 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003154 USE_FEATURE_SETFILES_CHECK_OPTION( \
3155 " [-c policyfile] spec_file" \
3156 ) \
3157 " pathname"
3158
3159#define setfiles_full_usage \
3160 "Reset file contexts under pathname according to spec_file" \
3161 USE_FEATURE_SETFILES_CHECK_OPTION( \
3162 "\n -c file Check the validity of the contexts against the specified binary policy" \
3163 ) \
3164 "\n -d Show which specification matched each file" \
3165 "\n -l Log changes in file labels to syslog" \
3166 "\n -n Don't change any file labels" \
Denis Vlasenko1da77722007-07-24 06:17:43 +00003167 "\n -q Suppress warnings" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003168 "\n -r dir Use an altenate root path" \
3169 "\n -e dir Exclude directory" \
3170 "\n -F Force reset of context to match file_context for customizable files" \
3171 "\n -o file Save list of files with incorrect context" \
3172 "\n -s Take a list of files from standard input (instead of command line)" \
3173 "\n -v Show changes in file labels, if type or role are changing" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003174 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3175 "\n -W Display warnings about entries that had no matching files"
Denis Vlasenko397137b2007-07-23 14:03:30 +00003176
Eric Andersen7e9276b2001-02-22 01:15:47 +00003177#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003178 "SCANCODE KEYCODE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003179#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003180 "Set entries into the kernel's scancode-to-keycode map,\n" \
3181 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3182 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
3183 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003184#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003185 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003186
Rob Landley87848d92006-03-27 23:23:43 +00003187#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003188 "N"
Rob Landley87848d92006-03-27 23:23:43 +00003189#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003190 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003191
Denis Vlasenkobe039372007-10-14 04:48:44 +00003192#define setsebool_trivial_usage \
3193 "boolean value"
3194
3195#define setsebool_full_usage \
3196 "Change boolean setting"
3197
Paul Fox42403642005-08-01 22:52:09 +00003198#define setsid_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003199 "program [arg...]"
Paul Fox42403642005-08-01 22:52:09 +00003200#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003201 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003202 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00003203
Matt Kraai2d91deb2001-08-01 17:21:35 +00003204#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003205 "[FILE]...\n" \
3206 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00003207#define lash_full_usage \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003208 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003209
Eric Andersen2e9c2572003-08-08 22:26:06 +00003210#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003211 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00003212#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003213 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00003214
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003215#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003216 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003217 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003218#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003219 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003220 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003221 "\n\nOptions:\n" \
3222 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003223 " -c Check SHA1 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003224 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003225 " -s Don't output anything, status code shows success\n" \
3226 " -w Warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003227
Denis Vlasenko14923db2007-06-20 15:23:03 +00003228#define slattach_trivial_usage \
3229 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3230#define slattach_full_usage \
3231 "Attach network interface(s) to serial line(s)\n" \
3232 "\nOptions:" \
3233 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3234 "\n -s Set line speed" \
3235 "\n -e Exit after initializing device" \
3236 "\n -h Exit when the carrier is lost" \
3237 "\n -c Execute a command when the line is hung up" \
3238 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3239 "\n -L Enable 3-wire operation" \
3240 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003241
Eric Andersen7e9276b2001-02-22 01:15:47 +00003242#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003243 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003244#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003245 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003246 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003247 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003248 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003249#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003250 "$ sleep 2\n" \
3251 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003252 USE_FEATURE_FANCY_SLEEP( \
3253 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003254 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003255
Eric Andersen7e9276b2001-02-22 01:15:47 +00003256#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003257 "[-nru" \
3258 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") \
3259 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003260#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003261 "Sort lines of text in the specified files" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003262 "\n\nOptions:\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003263 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003264 " -b Ignore leading blanks\n" \
3265 " -c Check whether input is sorted\n" \
3266 " -d Dictionary order (blank or alphanumeric only)\n" \
3267 " -f Ignore case\n" \
3268 " -g General numerical sort\n" \
3269 " -i Ignore unprintable characters\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003270 " -k Sort key\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003271 " -M Sort month\n") \
3272 " -n Sort numbers\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003273 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003274 " -o Output to file\n" \
3275 " -k Sort by key\n" \
3276 " -t Use key separator other than whitespace\n") \
3277 " -r Reverse sort order\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003278 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003279 " -s Stable (don't sort ties alphabetically)\n") \
3280 " -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003281 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003282 "\n -z Input terminated by nulls, not newlines\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003283 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003284 " -mST Ignored for GNU compatibility") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003285 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003286#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003287 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3288 "a\n" \
3289 "b\n" \
3290 "c\n" \
3291 "d\n" \
3292 "e\n" \
3293 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003294 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003295 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3296 "d 2\n" \
3297 "b 2\n" \
3298 "c 3\n" \
3299 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003300 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003301
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003302#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003303 "[OPTION] [INPUT [PREFIX]]"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003304#define split_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003305 "Options:" \
3306 "\n -b n[k|m] Split by bytes" \
3307 "\n -l n Split by lines" \
3308 "\n -a n Use n letters as suffix"
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003309#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003310 "$ split TODO foo\n" \
3311 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003312
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003313#define start_stop_daemon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003314 "[OPTIONS] [" \
3315 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3316 "] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003317#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003318 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003319 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003320 USE_GETOPT_LONG( \
3321 "\n -S,--start Start" \
3322 "\n -K,--stop Stop" \
3323 "\n -a,--startas pathname Starts process specified by pathname" \
3324 "\n -b,--background Put process into background" \
3325 "\n -u,--user username|uid Stop this user's processes" \
3326 "\n -x,--exec executable Program to either start or check" \
3327 "\n -n,--name process-name Stop processes with this name" \
3328 "\n -p,--pidfile pid-file Save or load pid using a pid-file" \
3329 "\n -m,--make-pidfile Create the -p file and enter pid in it" \
3330 "\n -q,--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003331 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003332 "\n -o,--oknodo Exit status 0 if nothing done" \
3333 "\n -v,--verbose Verbose" \
3334 "\n -N,--nicelevel N Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003335 ) \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003336 "\n -s,--signal signal Signal to send (default TERM)" \
3337 "\n -c,--chuid user[:[grp]] Change to specified user/group" \
3338 ) \
3339 SKIP_GETOPT_LONG( \
3340 "\n -S Start" \
3341 "\n -K Stop" \
3342 "\n -a pathname Starts process specified by pathname" \
3343 "\n -b Put process into background" \
3344 "\n -u username|uid Stop this user's processes" \
3345 "\n -x executable Program to either start or check" \
3346 "\n -n process-name Stop processes with this name" \
3347 "\n -p pid-file Save or load pid using a pid-file" \
3348 "\n -m Create the -p file and enter pid in it" \
3349 "\n -q Quiet" \
3350 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3351 "\n -o Exit status 0 if nothing done" \
3352 "\n -v Verbose" \
3353 "\n -N N Add N to process's nice level" \
3354 ) \
3355 "\n -s signal Signal to send (default TERM)" \
3356 "\n -c user[:[grp]] Change to specified user/group" \
3357 )
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003358
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003359#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003360 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003361#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003362 "Display file (default) or filesystem status" \
3363 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003364 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003365 " -c fmt Use the specified format\n") \
3366 " -f Display filesystem status\n" \
3367 " -L,-l Dereference links\n" \
3368 " -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003369 USE_SELINUX( \
3370 "\n -Z Print security context" \
3371 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003372 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003373 "\n\nValid format sequences for files:\n" \
3374 " %a Access rights in octal\n" \
3375 " %A Access rights in human readable form\n" \
3376 " %b Number of blocks allocated (see %B)\n" \
3377 " %B The size in bytes of each block reported by %b\n" \
3378 " %d Device number in decimal\n" \
3379 " %D Device number in hex\n" \
3380 " %f Raw mode in hex\n" \
3381 " %F File type\n" \
3382 " %g Group ID of owner\n" \
3383 " %G Group name of owner\n" \
3384 " %h Number of hard links\n" \
3385 " %i Inode number\n" \
3386 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003387 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003388 " %o I/O block size\n" \
3389 " %s Total size, in bytes\n" \
3390 " %t Major device type in hex\n" \
3391 " %T Minor device type in hex\n" \
3392 " %u User ID of owner\n" \
3393 " %U User name of owner\n" \
3394 " %x Time of last access\n" \
3395 " %X Time of last access as seconds since Epoch\n" \
3396 " %y Time of last modification\n" \
3397 " %Y Time of last modification as seconds since Epoch\n" \
3398 " %z Time of last change\n" \
3399 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003400 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003401 " %a Free blocks available to non-superuser\n" \
3402 " %b Total data blocks in file system\n" \
3403 " %c Total file nodes in file system\n" \
3404 " %d Free file nodes in file system\n" \
3405 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003406 USE_SELINUX( \
3407 " %C Security context in SELinux\n" \
3408 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003409 " %i File System ID in hex\n" \
3410 " %l Maximum length of filenames\n" \
3411 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003412 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003413 " %S Fundamental block size (for block counts)\n" \
3414 " %t Type in hex\n" \
3415 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003416 )
3417
Eric Andersenef5e8f82002-11-07 02:09:37 +00003418#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003419 "[-afo] [-n length] [file...]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003420#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003421 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003422 "\n\nOptions:" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003423 "\n -a Scan whole file (default)" \
3424 "\n -f Precede strings with filenames" \
3425 "\n -n N At least N characters form a string (default 4)" \
3426 "\n -o Precede strings with decimal offsets"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003427
Eric Andersen7e9276b2001-02-22 01:15:47 +00003428#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003429 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003430#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003431 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003432 "and deviations from stty sane" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003433 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003434 "\n -F DEVICE Open device instead of stdin" \
3435 "\n -a Print all current settings in human-readable form" \
3436 "\n -g Print in stty-readable form" \
3437 "\n [SETTING] See manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003438
Robert Griebl1fca5582002-06-04 20:45:46 +00003439#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003440 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003441#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003442 "Change user id or become root" \
3443 "\n\nOptions:" \
3444 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003445 "\n -c Command to pass to 'sh -c'" \
3446 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00003447
Eric Andersen27f64e12002-06-23 04:24:25 +00003448#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003449 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003450#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003451 "Single user login" \
3452 "\n\nOptions:" \
3453 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00003454
Mike Frysinger95d3c452005-04-21 23:29:24 +00003455#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003456 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003457#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003458 "Checksum and count the blocks in a file" \
3459 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003460 " -r Use BSD sum algorithm (1K blocks)\n" \
3461 " -s Use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003462
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003463#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003464 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003465#define sv_full_usage \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003466 "Control services monitored by runsv supervisor.\n" \
3467 "Commands (only first character is enough):\n" \
3468 "\n" \
3469 "status: query service status\n" \
3470 "up: if service isn't running, start it. If service stops, restart it\n" \
3471 "once: like 'up', but if service stops, don't restart it\n" \
3472 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3473 " if it exists. After it stops, do not restart service\n" \
3474 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3475 " runsv exits too\n" \
3476 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
3477 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003478
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003479#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003480 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003481#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003482 "Continuously read log data from standard input, optionally " \
3483 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003484 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003485
Eric Andersen7e9276b2001-02-22 01:15:47 +00003486#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003487 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003488#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003489 "Stop swapping virtual memory pages on DEVICE" \
3490 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003491 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003492
Eric Andersen7e9276b2001-02-22 01:15:47 +00003493#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003494 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003495#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003496 "Start swapping virtual memory pages on DEVICE" \
3497 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003498 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003499
Rob Landley0f34a822005-10-27 22:55:50 +00003500#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003501 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003502#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003503 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003504 "and exec NEW_INIT" \
3505 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003506 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00003507
Eric Andersen7e9276b2001-02-22 01:15:47 +00003508#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003509 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003510#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003511 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003512
Eric Andersenb9050282003-12-24 06:02:11 +00003513#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003514 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003515#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003516 "Configure kernel parameters at runtime" \
3517 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003518 " -n Disable printing of key names\n" \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003519 " -e Don't warn about unknown keys\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003520 " -w Change sysctl setting\n" \
3521 " -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)\n" \
3522 " -a Display all values\n" \
3523 " -A Display all values in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003524#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003525 "sysctl [-n] [-e] variable...\n" \
3526 "sysctl [-n] [-e] -w variable=value...\n" \
3527 "sysctl [-n] [-e] -a\n" \
3528 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3529 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003530
Eric Andersen7e9276b2001-02-22 01:15:47 +00003531#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003532 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003533#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003534 "System logging utility.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003535 "Note that this version of syslogd ignores /etc/syslog.conf." \
3536 "\n\nOptions:" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003537 "\n -n Run in foreground" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003538 "\n -O FILE Log to given file (default=/var/log/messages)" \
3539 "\n -l n Set local log level" \
3540 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003541 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003542 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3543 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003544 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003545 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003546 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003547 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003548 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)")
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003549 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003550/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003551#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003552 "$ syslogd -R masterlog:514\n" \
3553 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003554
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003555#define tac_trivial_usage \
3556 "[FILE]..."
3557#define tac_full_usage \
3558 "Concatenates FILE(s) and prints them to stdout in reverse"
3559
Eric Andersen7e9276b2001-02-22 01:15:47 +00003560#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003561 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003562#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003563 "Print last 10 lines of each FILE to standard output.\n" \
3564 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003565 "file name. With no FILE, or when FILE is -, read standard input." \
3566 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003567 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003568 "\n -c N[kbm] Output the last N bytes") \
3569 "\n -n N[kbm] Print last N lines instead of last 10" \
3570 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003571 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003572 "\n -q Never output headers giving file names" \
3573 "\n -s SEC Wait SEC seconds between reads with -f" \
3574 "\n -v Always output headers giving file names" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003575 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003576 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3577 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3578 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003579#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003580 "$ tail -n 1 /etc/resolv.conf\n" \
3581 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003582
Eric Andersen7e9276b2001-02-22 01:15:47 +00003583#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003584 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003585 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3586 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003587 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003588 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003589#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003590 "Create, extract, or list files from a tar file" \
3591 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003592 USE_FEATURE_TAR_CREATE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003593 " c Create\n") \
3594 " x Extract\n" \
3595 " t List\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003596 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003597 USE_FEATURE_TAR_GZIP( \
3598 " z Filter the archive through gzip\n") \
3599 USE_FEATURE_TAR_BZIP2( \
3600 " j Filter the archive through bzip2\n") \
3601 USE_FEATURE_TAR_LZMA( \
3602 " a Filter the archive through lzma\n") \
3603 USE_FEATURE_TAR_COMPRESS( \
3604 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003605 "\nFile selection:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003606 " f Name of TARFILE or \"-\" for stdin\n" \
3607 " O Extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003608 USE_FEATURE_TAR_FROM( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003609 " exclude File to exclude\n" \
3610 " X File with names to exclude\n") \
3611 " C Change to directory DIR before operation\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003612 " v Verbose"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003613#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003614 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3615 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003616
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003617#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003618 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003619#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003620 "Set or get CPU affinity" \
3621 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003622 " -p Operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003623#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003624 "$ taskset 0x7 ./dgemm_test&\n" \
3625 "$ taskset -p 0x1 $!\n" \
3626 "pid 4790's current affinity mask: 7\n" \
3627 "pid 4790's new affinity mask: 1\n" \
3628 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3629 "pid 6671's current affinity mask: 1\n" \
3630 "pid 6671's new affinity mask: 1\n" \
3631 "$ taskset -p 1\n" \
3632 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003633
Eric Andersen7e9276b2001-02-22 01:15:47 +00003634#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003635 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003636#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003637 "Copy standard input to each FILE, and also to standard output" \
3638 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003639 " -a Append to the given FILEs, do not overwrite\n" \
3640 " -i Ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003641#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003642 "$ echo \"Hello\" | tee /tmp/foo\n" \
3643 "$ cat /tmp/foo\n" \
3644 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003645
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003646#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003647#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003648 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003649#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003650 "Connect to remote telnet server" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003651 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003652 " -a Attempt an automatic login with the USER variable\n" \
3653 " -l USER Attempt an automatic login with the USER argument\n" \
3654 " HOST The official name, alias or the IP address of the\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00003655 " remote host\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003656 " PORT The remote port number to connect to. If it is not\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003657 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003658#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003659#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003660 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003661#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003662 "Connect to remote telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003663#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003664
Eric Andersen08a72202002-09-30 20:52:10 +00003665#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003666 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003667#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003668 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003669 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3670 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003671 "\n -l LOGIN Exec LOGIN on connect" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003672 "\n -f issue_file Display issue_file instead of /etc/issue" \
Denis Vlasenko2450c452007-10-15 22:09:15 +00003673 "\n -K Close connection as soon as login exits" \
3674 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003675 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003676 "\n -p PORT Port to listen to" \
3677 "\n -b ADDR Address to bind to" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003678 "\n -F Run in foreground" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003679 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003680 )
Eric Andersen08a72202002-09-30 20:52:10 +00003681
Eric Andersen7e9276b2001-02-22 01:15:47 +00003682#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003683 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003684#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003685 "Check file types and compares values returning an exit code\n" \
3686 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003687#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003688 "$ test 1 -eq 2\n" \
3689 "$ echo $?\n" \
3690 "1\n" \
3691 "$ test 1 -eq 1\n" \
3692 "$ echo $?\n" \
3693 "0\n" \
3694 "$ [ -d /etc ]\n" \
3695 "$ echo $?\n" \
3696 "0\n" \
3697 "$ [ -d /junk ]\n" \
3698 "$ echo $?\n" \
3699 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003700
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003701#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003702 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003703/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003704/* "[-hpEvv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] [-i dir|-x cdb] [-t sec] ip port prog..." */
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003705#define tcpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003706 "Creates TCP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003707 "for incoming connections. For each connection it runs prog." \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003708 "\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003709 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003710 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003711 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003712 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3713 "\n-u user[:group] Change to user/group after bind" \
3714 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003715 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003716 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3717 "\n New connections from this IP address are closed" \
3718 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003719 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003720 "\n-E Do not set up environment variables" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003721 "\n-v Verbose"
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003722
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003723#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003724 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003725#define udpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003726 "Creates UDP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003727 "for incoming packets. For each packet it runs prog\n" \
3728 "(redirecting all further packets with same peer ip:port to it)." \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003729 "\n" \
3730 "\nip IP to listen on. '0' = all" \
3731 "\nport Port to listen on" \
3732 "\nprog [arg] Program to run" \
3733 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3734 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003735 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003736 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003737 "\n-E Do not set up environment variables" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003738 "\n-v Verbose"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003739
Mark Whitley450736c2001-03-02 19:08:50 +00003740#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003741 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003742#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003743 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003744 "\n\nOptions:" \
3745 "\n -l FILE Local FILE" \
3746 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003747 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003748 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003749 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003750 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003751 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003752 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003753 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003754 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003755 )
Eric Andersenc3657422001-11-30 07:54:32 +00003756#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003757 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003758#define time_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003759 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003760 "COMMAND's resource usage information is displayed." \
3761 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003762 " -v Verbose"
Mark Whitley450736c2001-03-02 19:08:50 +00003763
Eric Andersen420b2082002-09-17 22:14:58 +00003764#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003765 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003766#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003767 "Provide a view of process activity in real time.\n" \
3768 "Read the status of all processes from /proc each <seconds>\n" \
3769 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003770
Eric Andersen7e9276b2001-02-22 01:15:47 +00003771#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003772 "[-c] FILE [FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003773#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003774 "Update the last-modified date on the given FILE[s]" \
3775 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003776 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003777#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003778 "$ ls -l /tmp/foo\n" \
3779 "/bin/ls: /tmp/foo: No such file or directory\n" \
3780 "$ touch /tmp/foo\n" \
3781 "$ ls -l /tmp/foo\n" \
3782 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003783
3784#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003785 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003786#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003787 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003788 "standard input, writing to standard output" \
3789 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003790 " -c Take complement of STRING1\n" \
3791 " -d Delete input characters coded STRING1\n" \
3792 " -s Squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003793#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003794 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3795 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003796
Eric Andersen5c58d282001-07-10 16:29:00 +00003797#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003798 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3799 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3800 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003801#define traceroute_full_usage \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003802 "Trace the route to \"host\"" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003803 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003804 " -F Set the don't fragment bit\n" \
3805 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3806 " -l Display the ttl value of the returned packet\n" \
3807 " -d Set SO_DEBUG options to socket\n" \
3808 " -n Print hop addresses numerically rather than symbolically\n" \
3809 " -r Bypass the normal routing tables and send directly to a host\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003810 " -v Verbose\n" \
3811 " -m max_ttl Max time-to-live (max number of hops)\n" \
3812 " -p port# Base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003813 " (default is 33434)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003814 " -q nqueries Number of probes per 'ttl' (default 3)\n" \
3815 " -s src_addr IP address to use as the source address\n" \
3816 " -t tos Type-of-service in probe packets (default 0)\n" \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003817 " -w wait Time in seconds to wait for a response\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003818 " (default 3 sec)\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003819 " -g Loose source route gateway (8 max)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003820
Eric Andersen7e9276b2001-02-22 01:15:47 +00003821#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003822 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003823#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003824 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003825#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003826 "$ true\n" \
3827 "$ echo $?\n" \
3828 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003829
Eric Andersen7e9276b2001-02-22 01:15:47 +00003830#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003831 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003832#define tty_full_usage \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003833 "Print file name of standard input's terminal" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003834 USE_INCLUDE_SUSv2( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003835 "\n\nOptions:\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003836 " -s Print nothing, only return exit status")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003837#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003838 "$ tty\n" \
3839 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003840
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003841#define ttysize_trivial_usage \
3842 "[w] [h]"
3843#define ttysize_full_usage \
3844 "Print dimension(s) of standard input's terminal, on error return 80x25"
3845
Mike Frysinger174808c2005-06-11 01:14:09 +00003846#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003847 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3848 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3849 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3850 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3851 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3852 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003853#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003854 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00003855
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003856#define udhcpc_trivial_usage \
Denis Vlasenkoc82b5102007-07-01 17:05:57 +00003857 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenko19183682007-12-10 07:03:38 +00003858 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..."
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003859#define udhcpc_full_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00003860 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003861 " -V,--vendorclass=CLASSID Vendor class identifier" \
3862 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003863 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003864 "\n -c,--clientid=CLIENTID Client identifier" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003865 "\n -C,--clientid-none Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003866 "\n -p,--pidfile=file Create pidfile" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003867 "\n -r,--request=IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003868 "\n -s,--script=file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003869 "\n -t,--retries=N Send up to N request packets" \
3870 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003871 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003872 "\n -f,--foreground Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003873 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003874 "\n -S,--syslog Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003875 "\n -n,--now Exit with failure if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003876 "\n -q,--quit Quit after obtaining lease" \
3877 "\n -R,--release Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00003878 "\n -O,--request-option=OPT Request DHCP option OPT from server" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003879 USE_FEATURE_UDHCPC_ARPING( \
3880 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003881 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00003882 ) \
3883 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003884 " -V CLASSID Vendor class identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003885 "\n -i INTERFACE Interface to use (default: eth0)" \
3886 "\n -H,-h HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003887 "\n -c CLIENTID Client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003888 "\n -C Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003889 "\n -p file Create pidfile" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003890 "\n -r IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003891 "\n -s file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003892 "\n -t N Send up to N request packets" \
3893 "\n -T N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003894 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003895 "\n -f Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003896 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003897 "\n -S Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003898 "\n -n Exit with failure if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003899 "\n -q Quit after obtaining lease" \
3900 "\n -R Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00003901 "\n -O OPT Request DHCP option OPT from server" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003902 USE_FEATURE_UDHCPC_ARPING( \
3903 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003904 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00003905 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003906
Russ Dill61fb4892002-10-14 21:41:28 +00003907#define udhcpd_trivial_usage \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003908 "[-fS] [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00003909
3910#define udhcpd_full_usage \
Denis Vlasenko9f7b92a2007-08-15 20:03:36 +00003911 "DHCP server" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003912 "\n -f Run in foreground" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003913 "\n -S Log to syslog too"
Russ Dill61fb4892002-10-14 21:41:28 +00003914
Eric Andersen7e9276b2001-02-22 01:15:47 +00003915#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003916 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003917#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003918 "Unmount file systems" \
3919 "\n\nOptions:\n" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00003920 USE_FEATURE_UMOUNT_ALL( \
3921 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab")) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003922 USE_FEATURE_MTAB_SUPPORT( \
3923 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003924 "\n -r Try to remount devices as read-only if mount is busy" \
3925 "\n -l Lazy umount (detach filesystem)" \
3926 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003927 USE_FEATURE_MOUNT_LOOP( \
3928 "\n -D Do not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003929#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003930 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003931
3932#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003933 "[-amnrspv]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003934#define uname_full_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003935 "Print system information." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003936 "\n\nOptions:\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003937 " -a Print all\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003938 " -m The machine (hardware) type\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003939 " -n Hostname\n" \
3940 " -r OS release\n" \
3941 " -s OS name (default)\n" \
3942 " -p Processor type\n" \
3943 " -v OS version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003944#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003945 "$ uname -a\n" \
3946 "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 +00003947
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003948#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003949 "[-c] [-f] [name...]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003950#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003951 "Uncompress .Z file[s]" \
3952 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003953 " -c Extract to stdout\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003954 " -f Overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003955
Denis Vlasenko3952f202007-08-13 14:10:24 +00003956#define unexpand_trivial_usage \
3957 "[-f][-a][-t NUM] [FILE|-]"
3958#define unexpand_full_usage \
3959 "Convert spaces to tabs, writing to standard output." \
3960 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003961 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
3962 "\n -a,--all Convert all blanks" \
3963 "\n -f,--first-only Convert only leading blanks" \
3964 "\n -t,--tabs=N Tabstops every N chars" \
3965 ) \
3966 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
3967 "\n -a Convert all blanks" \
3968 "\n -f Convert only leading blanks" \
3969 "\n -t N Tabstops every N chars" \
3970 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00003971
Eric Andersen7e9276b2001-02-22 01:15:47 +00003972#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003973 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003974#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003975 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003976 "(or standard input), writing to OUTPUT (or standard output)" \
3977 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003978 " -c Prefix lines by the number of occurrences\n" \
3979 " -d Only print duplicate lines\n" \
3980 " -u Only print unique lines\n" \
3981 " -f N Skip the first N fields\n" \
3982 " -s N Skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003983#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003984 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3985 "a\n" \
3986 "b\n" \
3987 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003988
3989#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003990 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003991#define unix2dos_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003992 "Convert FILE from unix format to dos format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003993 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003994 "When no file is given, use stdin/stdout." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003995 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003996 " -u Output will be in UNIX format\n" \
3997 " -d Output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003998
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003999#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004000 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004001#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004002 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004003 "\n\nOptions:\n" \
Paul Fox9382b382007-09-07 20:28:25 +00004004 " -l List archive contents (with -q for short form)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004005 " -n Never overwrite existing files (default)\n" \
4006 " -o Overwrite files without prompting\n" \
4007 " -p Send output to stdout\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004008 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004009 " -x Exclude these files\n" \
4010 " -d Extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004011
Eric Andersen7e9276b2001-02-22 01:15:47 +00004012#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004013 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004014#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004015 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004016#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004017 "$ uptime\n" \
4018 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004019
4020#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004021 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004022#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004023 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004024#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004025 "$ usleep 1000000\n" \
4026 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004027
4028#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004029 "[-o outfile] [infile]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004030#define uudecode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004031 "Uudecode a file\n" \
4032 "NB: finds outfile name in uuencoded source unless -o is given"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004033#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004034 "$ uudecode -o busybox busybox.uu\n" \
4035 "$ ls -l busybox\n" \
4036 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004037
4038#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004039 "[-m] [infile] stored_filename"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004040#define uuencode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004041 "Uuencode a file to stdout" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004042 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004043 " -m Use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004044#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004045 "$ uuencode busybox busybox\n" \
4046 "begin 755 busybox\n" \
4047 "<encoded file snipped>\n" \
4048 "$ uudecode busybox busybox > busybox.uu\n" \
4049 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004050
Eric Andersen853c4942003-01-23 05:59:32 +00004051#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004052 "COMMAND [OPTIONS]..."
Eric Andersen853c4942003-01-23 05:59:32 +00004053#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004054 "Create and remove virtual ethernet devices" \
4055 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004056 " add [interface-name] [vlan_id]\n" \
4057 " rem [vlan-name]\n" \
4058 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
4059 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4060 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4061 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00004062
Eric Andersen3f980402001-04-04 17:31:15 +00004063#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004064 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00004065#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004066 "Edit FILE" \
4067 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004068 " -R Read-only - do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00004069
Eric Andersen27f64e12002-06-23 04:24:25 +00004070#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004071 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00004072#define vlock_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004073 "Lock a virtual terminal. A password is required to unlock." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004074 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004075 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00004076
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004077#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004078 "[-n seconds] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004079#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004080 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004081 "\n\nOptions:\n" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004082 " -n Loop period in seconds (default 2)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004083 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004084#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004085 "$ watch date\n" \
4086 "Mon Dec 17 10:31:40 GMT 2000\n" \
4087 "Mon Dec 17 10:31:42 GMT 2000\n" \
4088 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004089
Eric Andersen7e9276b2001-02-22 01:15:47 +00004090#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004091 "[-t N[ms]] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004092#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004093 "Periodically write to watchdog device DEV" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004094 "\n\nOptions:" \
4095 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004096 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004097 "\n" \
4098 "\nUse -t 500ms to specify period in milliseconds"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004099
4100#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004101 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004102#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004103 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004104 "more than one FILE is specified. With no FILE, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004105 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004106 " -c Print the byte counts\n" \
4107 " -l Print the newline counts\n" \
4108 " -L Print the length of the longest line\n" \
4109 " -w Print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004110#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004111 "$ wc /etc/passwd\n" \
4112 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004113
4114#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004115 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004116 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004117 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4118 " [-U|--user-agent agent] url" \
4119 ) \
4120 SKIP_GETOPT_LONG( \
4121 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4122 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00004123#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004124 "Retrieve files via HTTP or FTP" \
4125 "\n\nOptions:\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004126 " -s Spider mode - only check file existence\n" \
4127 " -c Continue retrieval of aborted transfer\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004128 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004129 " -P Set directory prefix to DIR\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004130 " -O Save to filename ('-' for stdout)\n" \
4131 " -U Adjust 'User-Agent' field\n" \
4132 " -Y Use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004133
4134#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004135 "[COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004136#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004137 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004138#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004139 "$ which login\n" \
4140 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004141
Eric Andersen00a6a752002-04-26 23:53:10 +00004142#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004143 "[-a]"
Eric Andersen00a6a752002-04-26 23:53:10 +00004144#define who_full_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004145 "Show who is logged on" \
4146 "\n\nOptions:\n" \
4147 " -a show all"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004148
4149#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004150 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004151#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004152 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004153
4154#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004155 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004156#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004157 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004158 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004159 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
4160 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004161 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004162 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4163 " -x Exit if the size is exceeded\n") \
4164 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
4165 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004166 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004167#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004168 "$ ls | xargs gzip\n" \
4169 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004170
4171#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004172 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004173#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004174 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004175
Eric Andersen7e9276b2001-02-22 01:15:47 +00004176#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004177 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004178#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004179 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004180
Rob Landleyad8071f2005-04-30 03:49:37 +00004181#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004182 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00004183#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004184 "Manage a ZeroConf IPv4 link-local address" \
4185 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004186 " -f Run in foreground\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004187 " -q Quit after address (no daemon)\n" \
4188 " -r 169.254.x.x Request this address first\n" \
4189 " -v Verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00004190
Eric Andersen178de172004-04-06 16:36:20 +00004191#endif /* __BB_USAGE_H__ */