blob: 11d3e3ad2fea470b75020c8e7dcb839b97e742a6 [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" \
Bernhard Reutner-Fischer1aac3ab2008-01-13 18:43:50 +0000130 " delif <bridge> <iface> Delete <iface> from <bridge>" \
131USE_FEATURE_BRCTL_FANCY("\n" \
132 " setageing <bridge <time> set ageing time\n" \
133 " setfd <bridge <time> set bridge forward delay\n" \
134 " sethello <bridge <time> set hello time\n" \
135 " setmaxage <bridge <time> set max message age\n" \
Bernhard Reutner-Fischer2b11fb42008-01-14 16:10:11 +0000136 " setpathcost <bridge <cost> set path cost\n" \
137 " setportprio <bridge <prio> set port priority\n" \
138 " setbridgeprio <bridge <prio> set bridge priority\n" \
139 " stp <bridge> [1|0] turn stp on/off\n" \
Bernhard Reutner-Fischer1aac3ab2008-01-13 18:43:50 +0000140)
Glenn L McGrath24e28332001-10-05 03:48:57 +0000141#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000142 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000143#define bunzip2_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000144 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
145 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000146 " -c Write output to standard output\n" \
147 " -f Force"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000148
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000149#define bzip2_trivial_usage \
150 "[OPTION]... [FILE]..."
151#define bzip2_full_usage \
152 "Compress FILE(s) with bzip2 algorithm.\n" \
153 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenkod898b862007-10-14 07:57:26 +0000154 "\n\nOptions:" \
155 "\n -c Write output to standard output instead of FILE.bz2" \
156 "\n -d Decompress" \
157 "\n -f Force" \
158 "\n -1..-9 Compression level"
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000159
Rob Landley6130b9b2006-01-23 21:10:38 +0000160#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000161 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000162
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000163#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000164 "FILE"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000165#define bzcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000166 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000167
Rob Landleyc1d69902006-01-20 18:28:50 +0000168#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000169 "[OPTION]... [FILE]"
Rob Landleyc1d69902006-01-20 18:28:50 +0000170#define unlzma_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000171 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
172 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000173 " -c Write output to standard output\n" \
174 " -f Force"
Rob Landleyc1d69902006-01-20 18:28:50 +0000175
176#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000177 "FILE"
Rob Landleyc1d69902006-01-20 18:28:50 +0000178#define lzmacat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000179 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000180
Eric Andersenc98c0622001-12-06 15:16:43 +0000181#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000182 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000183#define cal_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000184 "Display a calendar" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000185 "\n\nOptions:" \
186 "\n -j Use julian dates" \
187 "\n -y Display the entire year"
Eric Andersenc98c0622001-12-06 15:16:43 +0000188
Eric Andersen7e9276b2001-02-22 01:15:47 +0000189#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000190 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000191#define cat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000192 "Concatenate FILE(s) and print them to stdout" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000193 "\n\nOptions:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000194 "\n -u Use unbuffered i/o (ignored)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000195#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000196 "$ cat /proc/uptime\n" \
197 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000198
Rob Landley8abbee42006-05-31 19:36:04 +0000199#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000200 "[-etv] [FILE]..."
Rob Landley8abbee42006-05-31 19:36:04 +0000201#define catv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000202 "Display nonprinting characters as ^x or M-x" \
203 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000204 " -e End each line with $\n" \
205 " -t Show tabs as ^I\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000206 " -v Don't use ^x or M-x escapes"
Denis Vlasenko5233cd32008-02-18 23:24:46 +0000207
208#define chat_trivial_usage \
209 "EXPECT [SEND [EXPECT [SEND...]]]"
210#define chat_full_usage \
211 "Useful for interacting with a modem connected to stdin/stdout.\n" \
212 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
213 "each pair is a pair of arguments. Example:\n" \
214 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
215
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000216#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000217 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000218#define chattr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000219 "Change file attributes on an ext2 fs\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000220 "Modifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000221 " - Remove attributes\n" \
222 " + Add attributes\n" \
223 " = Set attributes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000224 "Attributes:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000225 " A Don't track atime\n" \
226 " a Append mode only\n" \
227 " c Enable compress\n" \
228 " D Write dir contents synchronously\n" \
229 " d Do not backup with dump\n" \
230 " i Cannot be modified (immutable)\n" \
231 " j Write all data to journal first\n" \
232 " s Zero disk storage when deleted\n" \
233 " S Write file contents synchronously\n" \
234 " t Disable tail-merging of partial blocks with other files\n" \
235 " u Allow file to be undeleted\n" \
Denis Vlasenko5dd7ef02006-12-26 03:36:28 +0000236 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000237 " -R Recursively list subdirectories\n" \
238 " -v Set the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000239
Denis Vlasenko49622d72007-03-10 16:58:49 +0000240#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000241 "[OPTIONS] CONTEXT FILE..." \
242 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
243 USE_FEATURE_CHCON_LONG_OPTIONS( \
244 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
245 )
Denis Vlasenko49622d72007-03-10 16:58:49 +0000246#define chcon_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000247 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000248 USE_FEATURE_CHCON_LONG_OPTIONS( \
249 "\n -v,--verbose Verbose" \
250 "\n -c,--changes Report changes made" \
251 "\n -h,--no-dereference Affect symlinks instead of their targets" \
252 "\n -f,--silent,--quiet Suppress most error messages" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000253 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000254 "\n -u,--user=USER Set user USER in the target security context" \
255 "\n -r,--role=ROLE Set role ROLE in the target security context" \
256 "\n -t,--type=TYPE Set type TYPE in the target security context" \
257 "\n -l,--range=RANGE Set range RANGE in the target security context" \
258 "\n -R,--recursive Recurse subdirectories" \
259 ) \
260 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
261 "\n -v Verbose" \
262 "\n -c Report changes made" \
263 "\n -h Affect symlinks instead of their targets" \
264 "\n -f Suppress most error messages" \
265 "\n -u USER Set user USER in the target security context" \
266 "\n -r ROLE Set role ROLE in the target security context" \
267 "\n -t TYPE Set type TYPE in the target security context" \
268 "\n -l RNG Set range RNE in the target security context" \
269 "\n -R Recurse subdirectories" \
270 )
271
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000272
Eric Andersen7e9276b2001-02-22 01:15:47 +0000273#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000274 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000275#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000276 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000277 "symbols +-= and one or more of the letters rwxst" \
278 "\n\nOptions:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000279 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000280 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000281 "\n -c List changed files" \
282 "\n -v List all files" \
283 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000284 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000285#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000286 "$ ls -l /tmp/foo\n" \
287 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
288 "$ chmod u+x /tmp/foo\n" \
289 "$ ls -l /tmp/foo\n" \
290 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
291 "$ chmod 444 /tmp/foo\n" \
292 "$ ls -l /tmp/foo\n" \
293 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000294
Denis Vlasenko081ef792007-03-17 16:38:21 +0000295#define chgrp_trivial_usage \
296 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
297#define chgrp_full_usage \
298 "Change the group membership of each FILE to GROUP" \
299 "\n\nOptions:" \
300 "\n -R Recurse directories" \
301 "\n -h Affect symlinks instead of symlink targets" \
302 "\n -L Traverse all symlinks to directories" \
303 "\n -H Traverse symlinks on command line only" \
304 "\n -P Do not traverse symlinks (default)" \
305 USE_DESKTOP( \
306 "\n -c List changed files" \
307 "\n -v Verbose" \
308 "\n -f Hide errors" \
309 )
310#define chgrp_example_usage \
311 "$ ls -l /tmp/foo\n" \
312 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
313 "$ chgrp root /tmp/foo\n" \
314 "$ ls -l /tmp/foo\n" \
315 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
316
Eric Andersen7e9276b2001-02-22 01:15:47 +0000317#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000318 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000319#define chown_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000320 "Change the owner and/or group of each FILE to OWNER and/or GROUP" \
321 "\n\nOptions:" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000322 "\n -R Recurse directories" \
323 "\n -h Affect symlinks instead of symlink targets" \
324 "\n -L Traverse all symlinks to directories" \
325 "\n -H Traverse symlinks on command line only" \
326 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000327 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000328 "\n -c List changed files" \
329 "\n -v List all files" \
330 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000331 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000332#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000333 "$ ls -l /tmp/foo\n" \
334 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
335 "$ chown root /tmp/foo\n" \
336 "$ ls -l /tmp/foo\n" \
337 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
338 "$ chown root.root /tmp/foo\n" \
339 "ls -l /tmp/foo\n" \
340 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000341
Denis Vlasenkofe544582006-10-03 15:57:40 +0000342#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000343 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
344 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
345 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000346#define chpst_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000347 "Change the process state and run specified program" \
348 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000349 " -u user[:grp] Set uid and gid\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +0000350 " -U user[:grp] Set environment variables UID and GID\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000351 " -e dir Set environment variables as specified by files\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000352 " in the directory: file=1st_line_of_file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000353 " -/ dir Chroot to dir\n" \
354 " -n inc Add inc to nice value\n" \
355 " -m bytes Limit data segment, stack segment, locked physical pages,\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000356 " and total of all segment per process to bytes bytes each\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000357 " -d bytes Limit data segment\n" \
358 " -o n Limit the number of open file descriptors per process to n\n" \
359 " -p n Limit number of processes per uid to n\n" \
360 " -f bytes Limit output file size to bytes bytes\n" \
361 " -c bytes Limit core file size to bytes bytes\n" \
362 " -v Verbose\n" \
363 " -P Run prog in a new process group\n" \
364 " -0 Close standard input\n" \
365 " -1 Close standard output\n" \
366 " -2 Close standard error"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000367#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000368 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000369#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000370 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
371 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000372#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000373 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000374#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000375 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000376#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000377 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000378#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000379 "Set various environment variables as specified by files\n" \
380 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000381#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000382 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
383 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
384 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000385#define softlimit_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000386 "Set soft resource limits, then run prog" \
387 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000388 " -m n Same as -d n -s n -l n -a n\n" \
389 " -d n Limit the data segment per process to n bytes\n" \
390 " -s n Limit the stack segment per process to n bytes\n" \
391 " -l n Limit the locked physical pages per process to n bytes\n" \
392 " -a n Limit the total of all segments per process to n bytes\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000393 " -o n Limit the number of open file descriptors per process to n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000394 " -p n Limit the number of processes per uid to n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000395 "Options controlling file sizes:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000396 " -f n Limit output file sizes to n bytes\n" \
397 " -c n Limit core file sizes to n bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000398 "Efficiency opts:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000399 " -r n Limit the resident set size to n bytes. This limit is not\n" \
400 " enforced unless physical memory is full\n" \
401 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
402 " except that the process receives a SIGXCPU signal after n seconds\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000403 "\n" \
404 "Some options may have no effect on some operating systems\n" \
405 "n may be =, indicating that soft limit should be set equal to hard limit"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000406
Eric Andersen7e9276b2001-02-22 01:15:47 +0000407#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000408 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000409#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000410 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000411#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000412 "$ ls -l /bin/ls\n" \
413 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
414 "# mount /dev/hdc1 /mnt -t minix\n" \
415 "# chroot /mnt\n" \
416 "# ls -l /bin/ls\n" \
417 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000418
Eric Andersen7e9276b2001-02-22 01:15:47 +0000419#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000420 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000421#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000422 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000423
Rob Landley856489b2006-04-18 20:57:28 +0000424#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000425 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000426#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000427 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000428
Eric Andersen7e9276b2001-02-22 01:15:47 +0000429#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000430 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000431#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000432 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000433
Eric Andersen7e9276b2001-02-22 01:15:47 +0000434#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000435 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000436#define cmp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000437 "Compares FILE1 vs stdin if FILE2 is not specified" \
438 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000439 " -l Write the byte numbers (decimal) and values (octal)\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000440 " for all differing bytes\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000441 " -s Quiet"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000442
Rob Landley2acfd7b2005-05-11 23:12:49 +0000443#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000444 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000445#define comm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000446 "Compare FILE1 to FILE2, or to stdin if - is specified" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000447 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000448 " -1 Suppress lines unique to FILE1\n" \
449 " -2 Suppress lines unique to FILE2\n" \
450 " -3 Suppress lines common to both files"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000451
Paul Fox79c142d2005-08-01 16:04:40 +0000452#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000453 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000454#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000455 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000456
Rob Landley69674942006-09-11 00:34:01 +0000457#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000458 "[FILE]...\n" \
459 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000460#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000461 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000462
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000463#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000464 "[OPTION]... [prio] [pid | command [arg]...]"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000465#define chrt_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000466 "manipulate real-time attributes of a process" \
467 "\n\nOptions:\n" \
468 " -p operate on pid\n" \
469 " -r set scheduling policy to SCHED_RR\n" \
470 " -f set scheduling policy to SCHED_FIFO\n" \
471 " -o set scheduling policy to SCHED_OTHER\n" \
472 " -m show min and max priorities"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000473
474#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000475 "$ chrt -r 4 sleep 900; x=$!\n" \
476 "$ chrt -f -p 3 $x\n" \
477 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000478
Eric Andersen7e9276b2001-02-22 01:15:47 +0000479#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000480 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000481#define cp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000482 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000483 "\n\nOptions:" \
484 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000485 USE_SELINUX( \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000486 "\n -c Preserves security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000487 ) \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000488 "\n -d,-P Preserve links" \
489 "\n -H,-L Dereference all symlinks (default)" \
490 "\n -p Preserve file attributes if possible" \
491 "\n -f Force overwrite" \
492 "\n -i Prompt before overwrite" \
493 "\n -R,-r Recurse directories" \
494 "\n -l,-s Create (sym)links"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000495
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000496#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000497 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000498#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000499 "Extract or list files from a cpio archive\n" \
500 "Main operation mode:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000501 " d Make leading directories\n" \
502 " i Extract\n" \
503 " m Preserve mtime\n" \
504 " t List\n" \
505 " v Verbose\n" \
506 " u Unconditional overwrite\n" \
507 " F Input from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000508
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000509#define crond_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +0000510 "-d[#] -c crondir -f -b"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000511#define crond_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000512 " -d [#] -l [#] -S -L logfile -f -b -c dir\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000513 " -d num Debug level\n" \
514 " -l num Log level (8 - default)\n" \
Denis Vlasenko88ce2742007-10-09 18:08:04 +0000515 " -S Log to syslog (default)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000516 " -L file Log to file\n" \
517 " -f Run in foreground\n" \
518 " -b Run in background (default)\n" \
519 " -c dir Working dir"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000520
521#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000522 "[-c DIR] [-u USER] [-ler]|[FILE]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000523#define crontab_full_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000524 " -c Crontab directory" \
525 "\n -u User" \
526 "\n -l List crontab" \
527 "\n -e Edit crontab" \
528 "\n -r Delete crontab" \
529 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000530
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000531#define cryptpw_trivial_usage \
532 "[-a des|md5] [string]"
533#define cryptpw_full_usage \
534 "Outputs crypted string.\n" \
535 "If string isn't supplied on cmdline, reads it from stdin.\n" \
536 "\nOptions:" \
537 "\n -a Algorithm to use (default: md5)"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000538
Eric Andersen7e9276b2001-02-22 01:15:47 +0000539#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000540 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000541#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000542 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000543 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000544 " -b LIST Output only bytes from LIST\n" \
545 " -c LIST Output only characters from LIST\n" \
546 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
547 " -s Output only the lines containing delimiter\n" \
548 " -f N Print only these fields\n" \
549 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000550#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000551 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
552 "Hello\n" \
553 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
554 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000555
Eric Andersen7e9276b2001-02-22 01:15:47 +0000556#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000557 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000558#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000559 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000560 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000561 " -R Outputs RFC-822 compliant date string\n" \
562 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000563 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000564 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
565 " TIMESPEC='date' (or missing) for date only,\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000566 " 'hours', 'minutes', or 'seconds' for date and\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000567 " time to the indicated precision\n" \
568 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000569 ) \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000570 " -s STRING Sets time described by STRING\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000571 " -r FILE Displays the last modification time of FILE\n" \
572 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000573#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000574 "$ date\n" \
575 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000576
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000578 "expression..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000579#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000580 "This is a Tiny RPN calculator that understands the\n" \
581 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
582 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000583 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
584 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000585 "p - Prints the value on the top of the stack, without altering the stack\n" \
586 "f - Prints the entire contents of the stack without altering anything\n" \
587 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
588 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000589#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000590 "$ dc 2 2 + p\n" \
591 "4\n" \
592 "$ dc 8 8 \\* 2 2 + / p\n" \
593 "16\n" \
594 "$ dc 0 1 and p\n" \
595 "0\n" \
596 "$ dc 0 1 or p\n" \
597 "1\n" \
598 "$ echo 72 9 div 8 mul p | dc\n" \
599 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000600
Eric Andersen7e9276b2001-02-22 01:15:47 +0000601#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000602 "[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 +0000603 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000604#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000605 "Copy a file with converting and formatting" \
606 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000607 " if=FILE Read from FILE instead of stdin\n" \
608 " of=FILE Write to FILE instead of stdout\n" \
609 " bs=N Read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000610 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000611 " ibs=N Read N bytes at a time\n") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000612 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000613 " obs=N Write N bytes at a time\n") \
614 " count=N Copy only N input blocks\n" \
615 " skip=N Skip N input blocks\n" \
616 " seek=N Skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000617 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000618 " conv=notrunc Don't truncate output file\n" \
619 " conv=noerror Continue after read errors\n" \
620 " conv=sync Pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000621 "\n" \
622 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
623 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000624#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000625 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
626 "4+0 records in\n" \
627 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000628
Eric Andersen7e9276b2001-02-22 01:15:47 +0000629#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000630 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000631#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000632 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000633
Eric Andersenf349e972001-08-21 16:18:59 +0000634#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000635 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000636#define delgroup_full_usage \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000637 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000638 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000639
640#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000641 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000642#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000643 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000644
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000645#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000646 "mntpnt [-v]" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000647 USE_DEVFSD_FG_NP("[-fg][-np]")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000648#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000649 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000650 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000651 "\n mntpnt The mount point where devfs is mounted" \
652 "\n -v Print the protocol version numbers for devfsd" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000653 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000654 USE_DEVFSD_FG_NP( \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000655 "\n -fg Run in foreground" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000656 "\n -np Exit after parsing the configuration file" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000657 "\n and processing synthetic REGISTER events," \
658 "\n do not poll for events")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000659
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000660/* -k is accepted but ignored for !HUMAN_READABLE,
661 * but we won't mention this (unimportant) */
662#if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
663#define DF_HAS_OPTIONS(x) x
664#else
665#define DF_HAS_OPTIONS(x)
666#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000667#define df_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000668 DF_HAS_OPTIONS("[-") \
669 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
670 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000671#define df_full_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000672 "Print filesystem usage statistics" \
673 DF_HAS_OPTIONS("\n\nOptions:") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000674 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko08294db2007-08-13 12:27:49 +0000675 "\n -h Human readable (e.g. 1K 243M 2G)" \
676 "\n -m 1024*1024 blocks" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000677 "\n -k 1024 blocks" \
678 ) \
679 USE_FEATURE_DF_INODE( \
680 "\n -i Inodes" \
681 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000682#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000683 "$ df\n" \
684 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
685 "/dev/sda3 8690864 8553540 137324 98% /\n" \
686 "/dev/sda1 64216 36364 27852 57% /boot\n" \
687 "$ df /dev/sda3\n" \
688 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
689 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000690
Denis Vlasenko736230e2006-11-20 19:40:36 +0000691#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000692 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000693#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000694 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000695
696#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000697 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000698#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000699 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000700
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000701#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000702 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000703#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000704 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000705 "This diff implementation only supports unified diffs." \
706 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000707 " -a Treat all files as text\n" \
708 " -b Ignore changes in the amount of whitespace\n" \
709 " -d Try hard to find a smaller set of changes\n" \
710 " -i Ignore case differences\n" \
711 " -L Use LABEL instead of the filename in the unified header\n" \
712 " -N Treat absent files as empty\n" \
713 " -q Output only whether files differ\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +0000714 " -r Recursively compare subdirectories\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000715 " -S Start with FILE when comparing directories\n" \
716 " -T Make tabs line up by prefixing a tab when necessary\n" \
717 " -s Report when two files are the same\n" \
718 " -t Expand tabs to spaces in output\n" \
719 " -U Output LINES lines of context\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000720 " -w Ignore all whitespace"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000721
Eric Andersen7e9276b2001-02-22 01:15:47 +0000722#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000723 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000724#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000725 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000726#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000727 "$ dirname /tmp/foo\n" \
728 "/tmp\n" \
729 "$ dirname /tmp/foo/\n" \
730 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000731
Eric Andersen7e9276b2001-02-22 01:15:47 +0000732#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000733 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000734#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000735 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000736 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000737 " -c Clear ring buffer after printing\n" \
738 " -n LEVEL Set console logging level\n" \
739 " -s SIZE Buffer size"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000740
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000741#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000742 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000743#define dnsd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000744 "Small and static DNS server daemon" \
745 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000746 " -c Config filename\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000747 " -t TTL in seconds\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000748 " -p Listening port\n" \
Denis Vlasenkod3bac032007-03-24 12:13:04 +0000749 " -i Listening ip (default all)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000750 " -d Daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000751
Eric Andersen7e9276b2001-02-22 01:15:47 +0000752#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000753 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000754#define dos2unix_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000755 "Convert FILE from dos format to unix format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000756 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000757 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000758 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000759 " -u Output will be in UNIX format\n" \
760 " -d Output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000761
Eric Andersen7e9276b2001-02-22 01:15:47 +0000762#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000763 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000764#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000765 "Install, remove and manage Debian packages" \
766 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000767 " -i Install the package\n" \
768 " -l List of installed packages\n" \
769 " -C Configure an unpackaged package\n" \
770 " -F depends Ignore dependency problems\n" \
771 " -P Purge all files of a package\n" \
772 " -r Remove all but the configuration files for a package\n" \
773 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000774
Eric Andersen7e9276b2001-02-22 01:15:47 +0000775#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000776 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000777#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000778 "Perform actions on Debian packages (.debs)" \
779 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000780 " -c List contents of filesystem tree\n" \
781 " -e Extract control files to [argument] directory\n" \
782 " -f Display control field name starting with [argument]\n" \
783 " -x Extract packages filesystem tree to directory\n" \
784 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000785#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000786 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000787
Eric Andersen7e9276b2001-02-22 01:15:47 +0000788#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000789 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000790#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000791 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000792 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000793 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
794 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000795 " bytes." \
796 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000797 " -a Show sizes of files in addition to directories\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000798 " -H Follow symlinks that are FILE command line args\n" \
799 " -L Follow all symlinks encountered\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000800 " -d N Limit output to directories (and files with -a) of depth < N\n" \
801 " -c Output a grand total\n" \
802 " -l Count sizes many times if hard linked\n" \
803 " -s Display only a total for each argument\n" \
804 " -x Skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000805 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000806 " -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
807 " -m Print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000808 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000809 " -k Print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000810 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000811#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000812 "$ du\n" \
813 "16 ./CVS\n" \
814 "12 ./kernel-patches/CVS\n" \
815 "80 ./kernel-patches\n" \
816 "12 ./tests/CVS\n" \
817 "36 ./tests\n" \
818 "12 ./scripts/CVS\n" \
819 "16 ./scripts\n" \
820 "12 ./docs/CVS\n" \
821 "104 ./docs\n" \
822 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000823
Eric Andersen7e9276b2001-02-22 01:15:47 +0000824#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000825 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000826#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000827 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000828#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000829 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000830
Russ Dill61fb4892002-10-14 21:41:28 +0000831#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000832 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000833#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000834 "Display DHCP leases granted by udhcpd" \
835 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000836 USE_GETOPT_LONG( \
837 " -f,--file=FILE Leases file to load\n" \
838 " -r,--remaining Interpret lease times as time remaining\n" \
839 " -a,--absolute Interpret lease times as expire time" \
840 ) \
841 SKIP_GETOPT_LONG( \
842 " -f FILE Leases file to load\n" \
843 " -r Interpret lease times as time remaining\n" \
844 " -a Interpret lease times as expire time" \
845 )
Russ Dill61fb4892002-10-14 21:41:28 +0000846
Mike Frysinger51a43b42005-09-24 07:11:16 +0000847#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000848 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
849 "[-I inode_buffer_blocks] [-P process_inode_size] " \
850 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
851 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000852#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000853 "Check ext2/ext3 file system" \
854 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000855 " -p Automatic repair (no questions)\n" \
856 " -n Make no changes to the filesystem\n" \
857 " -y Assume 'yes' to all questions\n" \
858 " -c Check for bad blocks and add them to the badblock list\n" \
859 " -f Force checking even if filesystem is marked clean\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000860 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000861 " -b superblock Use alternative superblock\n" \
862 " -B blocksize Force blocksize when looking for superblock\n" \
863 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000864 " -l file Add to badblocks list\n" \
865 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000866
Eric Andersen7e9276b2001-02-22 01:15:47 +0000867#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000868 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000869#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000870 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000871 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000872 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000873 " -n Suppress trailing newline\n" \
874 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
875 " -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000876 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000877#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000878 "$ echo \"Erik is cool\"\n" \
879 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000880 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000881 "Erik\n" \
882 "is\n" \
883 "cool\n" \
884 "$ echo \"Erik\\nis\\ncool\"\n" \
885 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000886
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000887#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000888 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000889#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000890 "Eject specified DEVICE (or default /dev/cdrom)" \
891 "\n\nOptions:\n" \
Bernhard Reutner-Fischerafdad652008-02-08 15:04:00 +0000892 USE_FEATURE_EJECT_SCSI( \
893 " -s scsi device\n" \
894 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000895 " -t Close tray\n" \
896 " -T Open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000897
Rob Landley3b890392006-05-04 20:56:43 +0000898#define ed_trivial_usage ""
899#define ed_full_usage ""
900
Eric Andersen84e229c2001-03-29 22:48:33 +0000901#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000902 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000903#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000904 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000905 "up the specified environment" \
906 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000907 " -, -i Start with an empty environment\n" \
908 " -u Remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000909
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000910#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000911 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000912#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000913 "Send a magic packet to wake up sleeping machines.\n" \
914 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000915 "a hostname with a known 'ethers' entry." \
916 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000917 " -b Send wake-up packet to the broadcast address\n" \
918 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000919 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000920
Denis Vlasenko3952f202007-08-13 14:10:24 +0000921#define expand_trivial_usage \
922 "[-i] [-t NUM] [FILE|-]"
923#define expand_full_usage \
924 "Convert tabs to spaces, writing to standard output." \
925 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000926 USE_FEATURE_EXPAND_LONG_OPTIONS( \
927 "\n -i,--initial Do not convert tabs after non blanks" \
928 "\n -t,--tabs=N Tabstops every N chars" \
929 ) \
930 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
931 "\n -i Do not convert tabs after non blanks" \
932 "\n -t Tabstops every N chars" \
933 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000934
Eric Andersen7e9276b2001-02-22 01:15:47 +0000935#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000936 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000937#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000938 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000939 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000940 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
941 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
942 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
943 " ARG1 <= ARG2\n" \
944 " ARG1 = ARG2\n" \
945 " ARG1 != ARG2\n" \
946 " ARG1 >= ARG2\n" \
947 " ARG1 > ARG2\n" \
948 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
949 " ARG1 - ARG2\n" \
950 " ARG1 * ARG2\n" \
951 " ARG1 / ARG2\n" \
952 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000953 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
954 " match STRING REGEXP Same as STRING : REGEXP\n" \
955 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
956 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
957 " length STRING Length of STRING\n" \
958 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000959 " it is a keyword like 'match' or an\n" \
960 " operator like '/'\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000961 " (EXPRESSION) Value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000962 "Beware that many operators need to be escaped or quoted for shells.\n" \
963 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000964 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000965 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
966 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000967
Mike Frysingerfa69f112005-04-17 07:24:19 +0000968#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000969 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000970#define fakeidentd_full_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000971 "Provide fake ident (auth) service" \
972 "\n\nOptions:" \
973 "\n -f Run in foreground" \
974 "\n -i Inetd mode" \
975 "\n -w Inetd 'wait' mode" \
976 "\n -b ADDR Bind to specified address" \
977 "\n STRING Ident answer string (default is 'nobody')"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000978
Eric Andersen7e9276b2001-02-22 01:15:47 +0000979#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000980 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000981#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000982 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000983#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000984 "$ false\n" \
985 "$ echo $?\n" \
986 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000987
988#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000989 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000990#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000991 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000992#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000993 "$ fbset\n" \
994 "mode \"1024x768-76\"\n" \
995 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
996 " geometry 1024 768 1024 768 16\n" \
997 " timings 12714 128 32 16 4 128 4\n" \
998 " accel false\n" \
999 " rgba 5/11,6/5,5/0,0/0\n" \
1000 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001001
Eric Andersen7e9276b2001-02-22 01:15:47 +00001002#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001003 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001004#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001005 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001006
Eric Andersen01c3d402003-07-05 07:51:31 +00001007#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001008 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +00001009#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001010 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001011 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001012 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +00001013
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001014#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001015 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001016#define fdisk_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001017 "Change partition table" \
1018 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001019 " -l List partition table(s)\n" \
1020 " -u Give Start and End in sector (instead of cylinder) units\n" \
1021 " -s PARTITION Give partition size(s) in blocks\n" \
1022 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
1023 " -C CYLINDERS Set the number of cylinders\n" \
1024 " -H HEADS Set the number of heads\n" \
1025 " -S SECTORS Set the number of sectors\n" \
1026 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001027
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001028#define fetchmail_trivial_usage \
1029 "[-C dir] [-w timeout] [-U user] -P password [-X] [-t] [-z] server[:port]"
1030#define fetchmail_full_usage \
1031 "Fetch content of remote mailbox to local Maildir." \
1032 "\n\nOptions:\n" \
1033 " -C dir Set Maildir location\n" \
1034 " -w timeout Set timeout on network operations\n" \
1035 " -U username Authenticate with specified username\n" \
1036 " -P password Authenticate with specified password\n" \
1037 " -X Use openssl connection helper for secured servers\n" \
1038 " -t Get only headers\n" \
1039 " -z Delete messages on server"
1040
Denis Vlasenkode7684a2008-02-18 21:08:49 +00001041#define findfs_trivial_usage \
1042 "LABEL=label or UUID=uuid"
1043#define findfs_full_usage \
1044 "Finds a filesystem device based on a label or UUID."
1045#define findfs_example_usage \
1046 "$ findfs LABEL=MyDevice"
1047
Eric Andersen7e9276b2001-02-22 01:15:47 +00001048#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001049 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001050#define find_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001051 "Search for files in a directory hierarchy. The default PATH is\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001052 "the current directory, default EXPRESSION is '-print'\n" \
1053 "\nEXPRESSION may consist of:" \
1054 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001055 USE_FEATURE_FIND_XDEV( \
1056 "\n -xdev Don't descend directories on other filesystems") \
1057 USE_FEATURE_FIND_MAXDEPTH( \
1058 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1059 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001060 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001061 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001062 USE_FEATURE_FIND_PATH( \
1063 "\n -path PATTERN Path matches PATTERN") \
1064 USE_FEATURE_FIND_REGEX( \
1065 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001066 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001067 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001068 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001069 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001070 "\n or exactly (NNN)") \
1071 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001072 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001073 "\n or exactly (N) days") \
1074 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001075 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001076 "\n or exactly (N) minutes") \
1077 USE_FEATURE_FIND_NEWER( \
1078 "\n -newer FILE Modified time is more recent than FILE's") \
1079 USE_FEATURE_FIND_INUM( \
1080 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001081 USE_FEATURE_FIND_USER( \
1082 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1083 USE_FEATURE_FIND_GROUP( \
1084 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1085 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001086 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001087 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001088 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1089 "\n +/-N: file size is bigger/smaller than N") \
1090 "\n -print Print (default and assumed)" \
1091 USE_FEATURE_FIND_PRINT0( \
1092 "\n -print0 Delimit output with null characters rather than" \
1093 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001094 USE_FEATURE_FIND_CONTEXT ( \
1095 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001096 USE_FEATURE_FIND_EXEC( \
1097 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1098 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001099 USE_FEATURE_FIND_PRUNE( \
1100 "\n -prune Stop traversing current subtree") \
1101 USE_FEATURE_FIND_DELETE( \
1102 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001103 USE_FEATURE_FIND_PAREN( \
1104 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001105
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001106#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001107 "$ find / -name passwd\n" \
1108 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001109
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001110#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001111 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001112#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001113 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001114 "standard output" \
1115 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001116 " -b Count bytes rather than columns\n" \
1117 " -s Break at spaces\n" \
1118 " -w Use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001119
Eric Andersen7e9276b2001-02-22 01:15:47 +00001120#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001121 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001122#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001123 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001124#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001125 "$ free\n" \
1126 " total used free shared buffers\n" \
1127 " Mem: 257628 248724 8904 59644 93124\n" \
1128 " Swap: 128516 8404 120112\n" \
1129 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001130
Eric Andersen7e9276b2001-02-22 01:15:47 +00001131#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001132 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001133#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001134 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001135#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001136 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001137
Mike Frysinger51a43b42005-09-24 07:11:16 +00001138#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001139 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001140#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001141 "Check and repair filesystems" \
1142 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001143 " -A Walk /etc/fstab and check all filesystems\n" \
1144 " -N Don't execute, just show what would be done\n" \
1145 " -P When using -A, check filesystems in parallel\n" \
1146 " -R When using -A, skip the root filesystem\n" \
1147 " -T Don't show title on startup\n" \
Denis Vlasenko0de93752006-12-26 02:51:29 +00001148 " -V Verbose\n" \
1149 " -C n Write status information to specified filedescriptor\n" \
1150 " -t type List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001151
Eric Andersen7e9276b2001-02-22 01:15:47 +00001152#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001153 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001154#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001155 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001156 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001157 " -l List all filenames\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001158 " -r Perform interactive repairs\n" \
1159 " -a Perform automatic repairs\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001160 " -v Verbose\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001161 " -s Output super-block information\n" \
1162 " -m Activate MINIX-like \"mode not cleared\" warnings\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001163 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001164
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001165#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001166 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001167#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001168 "Retrieve a remote file via FTP" \
1169 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001170 USE_GETOPT_LONG( \
1171 " -c,--continue Continue previous transfer\n" \
1172 " -v,--verbose Verbose\n" \
1173 " -u,--username Username\n" \
1174 " -p,--password Password\n" \
1175 " -P,--port Port number" \
1176 ) \
1177 SKIP_GETOPT_LONG( \
1178 " -c Continue previous transfer\n" \
1179 " -v Verbose\n" \
1180 " -u Username\n" \
1181 " -p Password\n" \
1182 " -P Port number" \
1183 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001184
1185#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001186 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001187#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001188 "Store a local file on a remote machine via FTP" \
1189 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001190 USE_GETOPT_LONG( \
1191 " -v,--verbose Verbose\n" \
1192 " -u,--username Username\n" \
1193 " -p,--password Password\n" \
1194 " -P,--port Port number" \
1195 ) \
1196 SKIP_GETOPT_LONG( \
1197 " -v Verbose\n" \
1198 " -u Username\n" \
1199 " -p Password\n" \
1200 " -P Port number" \
1201 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001202
Rob Landleyaa872762005-10-28 13:05:12 +00001203#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001204 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +00001205#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001206 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001207 " -m Show all processes on the same mounted fs\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001208 " -k Kill all processes that match\n" \
1209 " -s Don't print or kill anything\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001210 " -4 When using port/proto only search IPv4 space\n" \
1211 " -6 When using port/proto only search IPv6 space\n" \
1212 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001213
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001214#define getenforce_trivial_usage
1215#define getenforce_full_usage
1216
Eric Andersen7e9276b2001-02-22 01:15:47 +00001217#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001218 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001219#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001220 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001221 USE_GETOPT_LONG( \
1222 " -a,--alternative Allow long options starting with single -\n" \
1223 " -l,--longoptions=longopts Long options to be recognized\n" \
1224 " -n,--name=progname The name under which errors are reported\n" \
1225 " -o,--options=optstring Short options to be recognized\n" \
1226 " -q,--quiet Disable error reporting by getopt(3)\n" \
1227 " -Q,--quiet-output No normal output\n" \
1228 " -s,--shell=shell Set shell quoting conventions\n" \
1229 " -T,--test Test for getopt(1) version\n" \
1230 " -u,--unquoted Don't quote the output" \
1231 ) \
1232 SKIP_GETOPT_LONG( \
1233 " -a Allow long options starting with single -\n" \
1234 " -l longopts Long options to be recognized\n" \
1235 " -n progname The name under which errors are reported\n" \
1236 " -o optstring Short options to be recognized\n" \
1237 " -q Disable error reporting by getopt(3)\n" \
1238 " -Q No normal output\n" \
1239 " -s shell Set shell quoting conventions\n" \
1240 " -T Test for getopt(1) version\n" \
1241 " -u Don't quote the output" \
1242 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001243#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001244 "$ cat getopt.test\n" \
1245 "#!/bin/sh\n" \
1246 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1247 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001248 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001249 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001250 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001251 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001252 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1253 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001254 " -c|--c-long)\n" \
1255 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001256 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1257 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1258 " esac;;\n" \
1259 " --) shift; break;;\n" \
1260 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001261 " esac\n" \
1262 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001263
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001264#define getsebool_trivial_usage \
1265 "-a or getsebool boolean..."
1266#define getsebool_full_usage \
1267 " -a Show all SELinux booleans"
1268
Eric Andersenf349e972001-08-21 16:18:59 +00001269#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001270 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001271#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001272 "Open a tty, prompt for a login name, then invoke /bin/login" \
1273 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001274 " -h Enable hardware (RTS/CTS) flow control\n" \
1275 " -i Do not display /etc/issue before running login\n" \
1276 " -L Local line, so do not do carrier detect\n" \
1277 " -m Get baud rate from modem's CONNECT status message\n" \
1278 " -w Wait for a CR or LF before sending /etc/issue\n" \
1279 " -n Do not prompt the user for a login name\n" \
1280 " -f issue_file Display issue_file instead of /etc/issue\n" \
1281 " -l login_app Invoke login_app instead of /bin/login\n" \
1282 " -t timeout Terminate after timeout if no username is read\n" \
1283 " -I initstring Sets the init string to send before anything else\n" \
1284 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001285
Eric Andersen7e9276b2001-02-22 01:15:47 +00001286#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001287 "[-HhrilLnqvso" \
1288 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001289 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001290 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1291 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001292 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001293#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001294 "Search for PATTERN in each FILE or standard input" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001295 "\n\nOptions:" \
1296 "\n -H Prefix output lines with filename where match was found" \
1297 "\n -h Suppress the prefixing filename on output" \
1298 "\n -r Recurse subdirectories" \
1299 "\n -i Ignore case distinctions" \
1300 "\n -l List names of files that match" \
1301 "\n -L List names of files that do not match" \
1302 "\n -n Print line number with output lines" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001303 "\n -q Quiet. Returns 0 if PATTERN was found, 1 otherwise" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001304 "\n -v Select non-matching lines" \
1305 "\n -s Suppress file open/read error messages" \
1306 "\n -c Only print count of matching lines" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001307 "\n -o Show only the part of a line that matches PATTERN" \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001308 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001309 USE_DESKTOP( \
1310 "\n -w Match whole words only") \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001311 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001312 USE_FEATURE_GREP_EGREP_ALIAS( \
1313 "\n -E PATTERN is an extended regular expression") \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001314 "\n -e PTRN Pattern to match" \
1315 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001316 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001317 "\n -A Print NUM lines of trailing context" \
1318 "\n -B Print NUM lines of leading context" \
1319 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001320
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001321#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001322 "$ grep root /etc/passwd\n" \
1323 "root:x:0:0:root:/root:/bin/bash\n" \
1324 "$ grep ^[rR]oo. /etc/passwd\n" \
1325 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001326
Eric Andersen7e9276b2001-02-22 01:15:47 +00001327#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001328 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001329#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001330 "Uncompress FILE (or standard input if FILE is '-')" \
1331 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001332 " -c Write output to standard output\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001333 " -f Force\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001334 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001335#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001336 "$ ls -la /tmp/BusyBox*\n" \
1337 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1338 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1339 "$ ls -la /tmp/BusyBox*\n" \
1340 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001341
1342#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001343 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001344#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001345 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001346 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001347 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001348 " -c Write output to standard output instead of FILE.gz\n" \
1349 " -d Decompress\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001350 " -f Force"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001351#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001352 "$ ls -la /tmp/busybox*\n" \
1353 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1354 "$ gzip /tmp/busybox.tar\n" \
1355 "$ ls -la /tmp/busybox*\n" \
1356 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001357
1358#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001359 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001360#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001361 "Halt the system" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001362 "\n\nOptions:" \
1363 "\n -d Delay interval for halting" \
1364 "\n -n No call to sync()" \
1365 "\n -f Force halt (don't go through init)" \
1366 USE_FEATURE_WTMP( \
1367 "\n -w Only write a wtmp record" \
1368 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001369
Eric Andersen3443bd72003-07-22 07:30:36 +00001370#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001371 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001372#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001373 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001374 "If no device name is specified try to read from stdin.\n\n") \
1375 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001376 " -a Get/set fs readahead\n" \
1377 " -A Set drive read-lookahead flag (0/1)\n" \
1378 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1379 " -B Set Advanced Power Management setting (1-255)\n" \
1380 " -c Get/set IDE 32-bit IO setting\n" \
1381 " -C Check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001382 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001383 " -d Get/set using_dma flag\n") \
1384 " -D Enable/disable drive defect-mgmt\n" \
1385 " -f Flush buffer cache for device on exit\n" \
1386 " -g Display drive geometry\n" \
1387 " -h Display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001388 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001389 " -i Display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001390 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001391 " -I Detailed/current information directly from drive\n") \
1392 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1393 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1394 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1395 " -m Get/set multiple sector count\n" \
1396 " -n Get/set ignore-write-errors flag (0/1)\n" \
1397 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1398 " -P Set drive prefetch count\n" \
1399 " -q Change next setting quietly\n" \
1400 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1401 " -r Get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001402 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001403 " -R Register an IDE interface (DANGEROUS)\n") \
1404 " -S Set standby (spindown) timeout\n" \
1405 " -t Perform device read timings\n" \
1406 " -T Perform cache read timings\n" \
1407 " -u Get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001408 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001409 " -U Un-register an IDE interface (DANGEROUS)\n") \
1410 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1411 " -V Display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001412 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001413 " -w Perform device reset (DANGEROUS)\n") \
1414 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001415 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001416 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1417 " -X Set IDE xfer mode (DANGEROUS)\n" \
1418 " -y Put IDE drive in standby mode\n" \
1419 " -Y Put IDE drive to sleep\n" \
1420 " -Z Disable Seagate auto-powersaving mode\n" \
1421 " -z Re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001422
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001424 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001425#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001426 "Print first 10 lines of each FILE to standard output.\n" \
1427 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001428 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001429 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001430 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001431 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001432 "\n -c NUM Output the first NUM bytes" \
1433 "\n -q Never output headers giving file names" \
1434 "\n -v Always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001435#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001436 "$ head -n 2 /etc/passwd\n" \
1437 "root:x:0:0:root:/root:/bin/bash\n" \
1438 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001439
Glenn L McGrath60281112001-11-02 11:39:46 +00001440#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001441 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Glenn L McGrath60281112001-11-02 11:39:46 +00001442#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001443 "Display file(s) or standard input in a user specified format" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001444 "\n\nOptions:" \
1445 "\n -b One-byte octal display" \
1446 "\n -c One-byte character display" \
1447 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1448 "\n -d Two-byte decimal display" \
1449 "\n -e FORMAT STRING" \
1450 "\n -f FORMAT FILE" \
1451 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1452 "\n -o Two-byte octal display" \
1453 "\n -s OFFSET Skip OFFSET bytes" \
1454 "\n -v Display all input data" \
1455 "\n -x Two-byte hexadecimal display" \
1456 USE_FEATURE_HEXDUMP_REVERSE( \
1457 "\n -R Reverse of 'hexdump -Cv'") \
1458
1459#define hd_trivial_usage \
1460 "FILE..."
1461#define hd_full_usage \
1462 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001463
Eric Andersen7e9276b2001-02-22 01:15:47 +00001464#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001465 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001466#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001467 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001468
1469#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001470 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001471#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001472 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001473 "(or FILE with the -F parameter), the host name will be set." \
1474 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001475 " -s Short\n" \
1476 " -i Addresses for the hostname\n" \
1477 " -d DNS domain name\n" \
1478 " -f Fully qualified domain name\n" \
1479 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001480#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001481 "$ hostname\n" \
1482 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001483
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001484#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001485 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001486 " [-p [ip:]port]" \
1487 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001488 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001489 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001490 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001491 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001492 " [-d/-e string]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001493#define httpd_full_usage \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001494 "Listen for incoming HTTP requests" \
1495 "\n\nOptions:" \
1496 "\n -c FILE Configuration file (default httpd.conf)" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001497 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001498 "\n -i Inetd mode" \
1499 "\n -f Do not daemonize" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001500 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001501 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001502 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001503 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001504 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001505 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001506 "\n -m PASS Crypt PASS with md5 algorithm") \
1507 "\n -h HOME Home directory (default .)" \
1508 "\n -e STRING HTML encode STRING" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001509 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001510
Robert Griebl1cd04452002-07-21 16:50:49 +00001511#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001512 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001513 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1514 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001515 " [-f FILE]" \
1516 ) \
1517 SKIP_GETOPT_LONG( \
1518 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1519 )
Robert Griebl1cd04452002-07-21 16:50:49 +00001520#define hwclock_full_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001521 "Query and set a hardware clock (RTC)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001522 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001523 " -r Read hardware clock and print result\n" \
1524 " -s Set the system time from the hardware clock\n" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001525 " -w Set the hardware clock to the system time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001526 " -u The hardware clock is kept in coordinated universal time\n" \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001527 " -l The hardware clock is kept in local time\n" \
1528 " -f FILE Use the specified clock (e.g. /dev/rtc2)"
Robert Griebl1cd04452002-07-21 16:50:49 +00001529
Eric Andersen7e9276b2001-02-22 01:15:47 +00001530#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001531 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001532#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001533 "Print information for USERNAME or the current user" \
1534 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001535 USE_SELINUX( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001536 " -Z Prints only the security context\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001537 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001538 " -g Prints only the group ID\n" \
1539 " -u Prints only the user ID\n" \
1540 " -n Print a name instead of a number\n" \
1541 " -r Prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001542#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001543 "$ id\n" \
1544 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001545
Eric Andersen7e9276b2001-02-22 01:15:47 +00001546#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001547 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001548#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001549 "Configure a network interface" \
1550 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001551 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001552 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001553 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001554 " [del ADDRESS[/PREFIXLEN]]\n") \
1555 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1556 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001557 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001558 " [outfill NN] [keepalive NN]\n") \
1559 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001560 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001561 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001562 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001563 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001564 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001565
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001566#define ifup_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001567 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001568#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001569 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001570 " -a De/configure all interfaces automatically\n" \
1571 " -i FILE Use FILE for interface definitions\n" \
1572 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001573 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001574 " -v Print out what would happen before doing it\n" \
1575 " -m Don't run any mappings\n" \
1576 " -f Force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001577
1578#define ifdown_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001579 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001580#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001581 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001582 " -a De/configure all interfaces automatically\n" \
1583 " -i FILE Use FILE for interface definitions\n" \
1584 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001585 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001586 " -v Print out what would happen before doing it\n" \
1587 " -m Don't run any mappings\n" \
1588 " -f Force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001589
Glenn L McGrath06e95652003-02-09 06:51:14 +00001590#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001591 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001592#define inetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001593 "Listen for network connections and launch programs" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001594 "\n\nOptions:\n" \
Denis Vlasenko886bb0d2007-01-09 23:48:46 +00001595 " -f Run in foreground\n" \
1596 " -q N Set the size of the socket listen queue to N\n" \
1597 " (default: 128)"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001598
Eric Andersen7e9276b2001-02-22 01:15:47 +00001599#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001600 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001601#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001602 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001603#define init_notes_usage \
1604"This version of init is designed to be run only by the kernel.\n" \
1605"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001606"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001607"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001608"runlevels, use sysvinit.\n" \
1609"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001610"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001611"it has the following default behavior:\n" \
1612"\n" \
1613" ::sysinit:/etc/init.d/rcS\n" \
1614" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001615" ::ctrlaltdel:/sbin/reboot\n" \
1616" ::shutdown:/sbin/swapoff -a\n" \
1617" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001618" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001619"\n" \
1620"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1621"\n" \
1622" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001623" tty3::askfirst:/bin/sh\n" \
1624" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001625"\n" \
1626"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1627"\n" \
1628" <id>:<runlevels>:<action>:<process>\n" \
1629"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001630" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001631"\n" \
1632" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1633" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001634" the specified process to run on. The contents of this field are\n" \
1635" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1636" be unique, although if it isn't you may have strange results. If this\n" \
1637" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001638" note that if BusyBox detects that a serial console is in use, then only\n" \
1639" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001640" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001641" stinkin' utmp.\n" \
1642"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001643" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001644"\n" \
1645" The runlevels field is completely ignored.\n" \
1646"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001647" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001648"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001649" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001650" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001651"\n" \
1652" The available actions can be classified into two groups: actions\n" \
1653" that are run only once, and actions that are re-run when the specified\n" \
1654" process exits.\n" \
1655"\n" \
1656" Run only-once actions:\n" \
1657"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001658" 'sysinit' is the first item run on boot. init waits until all\n" \
1659" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001660" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001661" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001662" the specified task completes. 'once' actions are asynchronous,\n" \
1663" therefore, init does not wait for them to complete. 'restart' is\n" \
1664" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001665" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001666" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001667" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001668" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001669" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001670" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001671" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001672" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001673"\n" \
1674" Run repeatedly actions:\n" \
1675"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001676" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001677" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001678" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1679" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001680" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001681" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001682" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001683" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001684"\n" \
1685" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001686" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001687" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001688"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001689" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001690"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001691" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001692"\n" \
1693"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001694"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001695" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001696" #\n" \
1697" ::sysinit:/etc/init.d/rcS\n" \
1698" \n" \
1699" # /bin/sh invocations on selected ttys\n" \
1700" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001701" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001702" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001703" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001704" tty2::askfirst:-/bin/sh\n" \
1705" tty3::askfirst:-/bin/sh\n" \
1706" tty4::askfirst:-/bin/sh\n" \
1707" \n" \
1708" # /sbin/getty invocations for selected ttys\n" \
1709" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001710" tty4::respawn:/sbin/getty 38400 tty4\n" \
1711" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001712" \n" \
1713" \n" \
1714" # Example of how to put a getty on a serial line (for a terminal)\n" \
1715" #\n" \
1716" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1717" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1718" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001719" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001720" #::respawn:/sbin/getty 57600 ttyS2\n" \
1721" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001722" # Stuff to do when restarting the init process\n" \
1723" ::restart:/sbin/init\n" \
1724" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001725" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001726" ::ctrlaltdel:/sbin/reboot\n" \
1727" ::shutdown:/bin/umount -a -r\n" \
1728" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001729
1730#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001731 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001732#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001733 "Load the specified kernel modules into the kernel" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001734 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001735 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001736 " -f Force module to load into the wrong kernel version\n" \
1737 " -k Make module autoclean-able\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001738 " -v Verbose\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001739 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001740 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001741 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001742 " -m Output load map to stdout\n" \
1743 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001744 " -o NAME Set internal module name to NAME\n" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001745 " -x Do not export externs" \
1746 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001747
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001748#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001749 "[-cgmops] [sources] dest|directory"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001750#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001751 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001752 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001753 " -c Copy the file, default\n" \
1754 " -d Create directories\n" \
1755 " -g Set group ownership\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001756 " -m Set permissions\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001757 " -o Set ownership\n" \
1758 " -p Preserve date\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001759 " -s Strip symbol tables" \
1760 USE_SELINUX( \
1761 "\n -Z Set security context of copy" \
1762 )
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001763/* would need to make the " | " optional depending on more than one selected */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001764#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001765 "[OPTIONS] {" \
1766 USE_FEATURE_IP_ADDRESS("address | ") \
1767 USE_FEATURE_IP_ROUTE("route | ") \
1768 USE_FEATURE_IP_LINK("link | ") \
1769 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1770 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001771 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001772#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001773 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001774 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001775 USE_FEATURE_IP_ADDRESS("address | ") \
1776 USE_FEATURE_IP_ROUTE("route | ") \
1777 USE_FEATURE_IP_LINK("link | ") \
1778 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1779 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001780 "}\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001781 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001782
1783#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001784 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001785 " [dev STRING] [to PREFIX] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001786#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001787 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001788 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1789 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001790 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001791 " [broadcast ADDR] [anycast ADDR]\n" \
1792 " [label STRING] [scope SCOPE-ID]\n" \
1793 " SCOPE-ID := [host | link | global | NUMBER]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001794
Eric Andersende4f07e2003-12-11 01:18:07 +00001795#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001796 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001797#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001798 "Calculate IP network settings from a IP address" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001799 "\n\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001800 USE_FEATURE_IPCALC_LONG_OPTIONS( \
1801 "\n -b,--broadcast Display calculated broadcast address" \
1802 "\n -n,--network Display calculated network address" \
1803 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001804 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko03630782007-10-18 11:11:12 +00001805 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1806 "\n -h,--hostname Display first resolved host name" \
1807 "\n -s,--silent Don't ever display error messages" \
1808 ) \
1809 ) \
1810 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
1811 "\n -b Display calculated broadcast address" \
1812 "\n -n Display calculated network address" \
1813 "\n -m Display default netmask for IP" \
1814 USE_FEATURE_IPCALC_FANCY( \
1815 "\n -p Display the prefix for IP/NETMASK" \
1816 "\n -h Display first resolved host name" \
1817 "\n -s Don't ever display error messages" \
1818 ) \
1819 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001820
Rob Landley6eb1e412005-06-20 04:30:36 +00001821#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001822 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001823#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001824 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1825 "segment by a shmkey value. The lower-case options mqs are used\n" \
1826 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001827 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001828 " -[mM] Remove the memory segment after the last detach\n" \
1829 " -[qQ] Remove the message queue\n" \
1830 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001831
1832#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001833 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001834#define ipcs_full_usage \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001835 " -i Show a specific resource\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001836 "Resource specification:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001837 " -m Shared memory segments\n" \
1838 " -q Message queues\n" \
1839 " -s Semaphore arrays\n" \
1840 " -a All (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001841 "Output format:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001842 " -t Time\n" \
1843 " -c Creator\n" \
1844 " -p Pid\n" \
1845 " -l Limits\n" \
1846 " -u Summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001847
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001848#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001849 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001850#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001851 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001852 " dynamic { on | off } |\n" \
1853 " mtu MTU }\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001854 "iplink show [DEVICE]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001855
1856#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001857 "{ list | flush | { add | del | change | append |\n" \
1858 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001859#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001860 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001861 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1862 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001863 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001864 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
1865 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001866
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001867#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001868 "{[list | add | del] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001869#define iprule_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001870 "iprule [list | add | del] SELECTOR ACTION\n" \
1871 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1872 " [dev STRING] [pref NUMBER]\n" \
1873 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1874 " [prohibit | reject | unreachable]\n" \
1875 " [realms [SRCREALM/]DSTREALM]\n" \
1876 " TABLE_ID := [local | main | default | NUMBER]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001877
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001878#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001879 "{ add | change | del | show } [NAME]\n" \
1880 " [mode { ipip | gre | sit }]\n" \
1881 " [remote ADDR] [local ADDR] [ttl TTL]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001882#define iptunnel_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001883 "iptunnel { add | change | del | show } [NAME]\n" \
1884 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1885 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
1886 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001887
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001888#define kbd_mode_trivial_usage \
1889 "[-a|k|s|u]"
1890#define kbd_mode_full_usage \
1891 "Report or set the keyboard mode" \
1892 "\n\nOptions set mode:\n" \
1893 " -a Default (ASCII)\n" \
1894 " -k Medium-raw (keyboard)\n" \
1895 " -s Raw (scancode)\n" \
1896 " -u Unicode (utf-8)"
1897
Eric Andersen7e9276b2001-02-22 01:15:47 +00001898#define kill_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001899 "[-l] [-signal] process-id [process-id...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001900#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001901 "Send a signal (default is TERM) to the specified process(es)" \
1902 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001903 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001904#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001905 "$ ps | grep apache\n" \
1906 "252 root root S [apache]\n" \
1907 "263 www-data www-data S [apache]\n" \
1908 "264 www-data www-data S [apache]\n" \
1909 "265 www-data www-data S [apache]\n" \
1910 "266 www-data www-data S [apache]\n" \
1911 "267 www-data www-data S [apache]\n" \
1912 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001913
1914#define killall_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001915 "[-l] [-q] [-signal] process-name [process-name...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001916#define killall_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001917 "Send a signal (default is TERM) to the specified process(es)" \
1918 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001919 " -l List all signal names and numbers\n" \
1920 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001921#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001922 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001923
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001924#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001925 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001926#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001927 "Send a signal (default is TERM) to all processes outside current session" \
1928 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001929 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001930
Mark Whitley6317c4b2001-03-12 22:51:50 +00001931#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001932 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001933#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001934 "Kernel logger" \
1935 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001936 " -c n Sets the default log level of console messages to n\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001937 " -n Run in foreground"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001938
Eric Andersen7e9276b2001-02-22 01:15:47 +00001939#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001940 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001941#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001942 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001943#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001944 "$ length Hello\n" \
1945 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001946
Rob Landley9200e792005-09-15 19:26:59 +00001947#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001948 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001949#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001950 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001951 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001952 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001953 " -E Quit once the end of a file is reached\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001954 " -M,-m Display a status line containing the current line numbers\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001955 " and the percentage through the file\n" \
1956 " -N Prefix line numbers to each line\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001957 " -~ Suppress ~s displayed when input past the end of the file is\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001958 " reached"
Rob Landley9200e792005-09-15 19:26:59 +00001959
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001960#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001961 "personality program [args...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001962#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001963 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001964 " linux32 Set 32bit uname emulation\n" \
1965 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001966
Eric Andersen7e9276b2001-02-22 01:15:47 +00001967#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001968 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001969#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001970 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1971 "You may use '--' to indicate that all following arguments are non-options." \
1972 "\n\nOptions:\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00001973 " -s Make symlinks instead of hardlinks\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001974 " -f Remove existing destination files\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001975 " -n Don't dereference symlinks - treat like normal file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001976 " -b Make a backup of the target (if exists) before link operation\n" \
1977 " -S suf Use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001978#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001979 "$ ln -s BusyBox /tmp/ls\n" \
1980 "$ ls -l /tmp/ls\n" \
1981 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001982
Denis Vlasenkob042bd92007-09-26 18:01:32 +00001983#define load_policy_trivial_usage
1984
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00001985#define load_policy_full_usage
1986
Eric Andersen7e9276b2001-02-22 01:15:47 +00001987#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001988 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001989#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001990 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001991#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001992 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001993
1994#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001995 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001996#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001997 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001998#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001999 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002000
2001#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002002 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002003#define logger_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002004 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002005 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002006 " -s Log to stderr as well as the system log\n" \
2007 " -t TAG Log using the specified tag (defaults to user name)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002008 " -p PRIO Enter the message with the specified priority.\n" \
2009 " This may be numerical or a 'facility.level' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002010#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002011 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002012
Robert Griebl1fca5582002-06-04 20:45:46 +00002013#define login_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002014 "[OPTION]... [username] [ENV=VAR...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00002015#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002016 "Begin a new session on the system" \
2017 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002018 " -f Do not authenticate (user already authenticated)\n" \
2019 " -h Name of the remote host for this login\n" \
2020 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00002021
Eric Andersen7e9276b2001-02-22 01:15:47 +00002022#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002023 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002024#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002025 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002026#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002027 "$ logname\n" \
2028 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002029
Mark Whitley6317c4b2001-03-12 22:51:50 +00002030#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002031 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00002032#define logread_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002033 "Show the messages from syslogd (using circular buffer)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002034 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002035 " -f Output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00002036
Matt Kraai83788da2002-03-20 17:38:37 +00002037#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002038 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2039 " losetup -d LOOPDEV - disassociate\n" \
2040 " losetup [-f] - show"
Matt Kraai83788da2002-03-20 17:38:37 +00002041#define losetup_full_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002042 "Options:\n" \
2043 " -o OFS Start OFS bytes into FILE\n" \
2044 " -f Show first free loop device"
Rob Landley1d589b22005-11-29 23:47:10 +00002045#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002046 "No arguments will display all current associations.\n" \
2047 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002048 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002049 "and filename of the file the loop device is currently bound to.\n\n" \
2050 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002051 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2052 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002053
Denis Vlasenko68444b92008-02-22 22:24:48 +00002054#define lpq_trivial_usage \
2055 "[-P lp[@host[:port]]] [-t DELAY] [-d JOBID] [-fs]"
2056#define lpq_full_usage \
2057 "Options:" \
2058 "\n -P lp service to connect to (else uses $PRINTER)" \
2059 "\n -t Scan the queue every DELAY seconds" \
2060 "\n -d Delete job" \
2061 "\n -f Force any waiting job to be printed" \
2062 "\n -s Short display" \
2063
2064#define lpr_trivial_usage \
2065 "-P lp[@host[:port]] -U USERNAME -J TITLE -Vmh [filenames]"
2066#define lpr_full_usage \
2067 "Options:" \
2068 "\n -P lp service to connect to (else uses $PRINTER)"\
2069 "\n -m Send mail to LOGNAME@HOSTNAME" \
2070 "\n -h Banner or header for this job" \
2071 "\n -V Verbose" \
2072
Eric Andersen7e9276b2001-02-22 01:15:47 +00002073#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002074 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002075 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002076 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2077 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2078 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2079 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2080 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2081 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002082#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002083 "List directory contents" \
2084 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002085 "\n -1 List files in a single column" \
2086 "\n -A Do not list implied . and .." \
2087 "\n -a Do not hide entries starting with ." \
2088 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002089 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002090 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002091 USE_FEATURE_LS_COLOR( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002092 "\n --color[={always,never,auto}] Control coloring") \
2093 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002094 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002095 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002096 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002097 "\n -F Append indicator (one of */=@|) to entries") \
2098 "\n -i List the i-node for each file" \
2099 "\n -l Use a long listing format" \
2100 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002101 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002102 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002103 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002104 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002105 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002106 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002107 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002108 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002109 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002110 "\n -S Sort the listing by file size") \
2111 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002112 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002113 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002114 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002115 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002116 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002117 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002118 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002119 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002120 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002121 "\n -w NUM Assume the terminal is NUM columns wide") \
2122 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002123 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002124 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002125 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002126 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002127 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002128 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002129 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002130 "\n -K Print security context in long format") \
2131 USE_SELINUX( \
2132 "\n -Z Print security context and permission")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002133
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002134#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002135 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002136#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002137 "List file attributes on an ext2 fs" \
2138 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002139 " -R Recursively list subdirectories\n" \
2140 " -a Do not hide entries starting with .\n" \
2141 " -d List directory entries instead of contents\n" \
2142 " -l Print long flag names\n" \
2143 " -v List the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002144
Eric Andersen7e9276b2001-02-22 01:15:47 +00002145#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002146 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002147#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002148 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002149
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002150#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002151#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002152 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002153#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002154 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002155 "TYPEs include:\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002156 " b: Make a block (buffered) device\n" \
2157 " c or u: Make a character (un-buffered) device\n" \
2158 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
2159 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002160 "FIRST specifies the number appended to NAME to create the first device.\n" \
2161 "LAST specifies the number of the last item that should be created\n" \
2162 "If 's' is the last argument, the base device is created as well.\n\n" \
2163 "For example:\n" \
2164 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2165 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002166#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002167 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2168 "[creates ttyS2-ttyS63]\n" \
2169 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2170 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002171#endif
2172
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002173#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002174#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002175 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00002176#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002177 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002178 "Device table entries take the form of:\n" \
2179 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002180 "Where name is the file name, type can be one of:\n" \
2181 " f A regular file\n" \
2182 " d Directory\n" \
2183 " c Character special device file\n" \
2184 " b Block special device file\n" \
2185 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002186 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002187 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2188 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002189#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002190 "For example:\n" \
2191 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2192 "/dev d 755 0 0 - - - - -\n" \
2193 "/dev/console c 666 0 0 5 1 - - -\n" \
2194 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2195 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2196 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2197 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2198 "Will Produce:\n" \
2199 "/dev\n" \
2200 "/dev/console\n" \
2201 "/dev/null\n" \
2202 "/dev/zero\n" \
2203 "/dev/hda\n" \
2204 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002205#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002206
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002207#define matchpathcon_trivial_usage \
2208 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2209#define matchpathcon_full_usage \
2210 " -n Do not display path" \
2211 "\n -N Do not use translations" \
2212 "\n -f Use alternate file_context file" \
2213 "\n -p Use prefix to speed translations" \
2214 "\n -V Verify file context on disk matches defaults"
2215
Eric Andersen7e9276b2001-02-22 01:15:47 +00002216#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002217 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002218 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002219#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002220 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2221 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002222 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002223 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002224 " -c Check MD5 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002225 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002226 " -s Don't output anything, status code shows success\n" \
2227 " -w Warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002228#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002229 "$ md5sum < busybox\n" \
2230 "6fd11e98b98a58f64ff3398d7b324003\n" \
2231 "$ md5sum busybox\n" \
2232 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2233 "$ md5sum -c -\n" \
2234 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2235 "busybox: OK\n" \
2236 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002237
Rob Landley70f7ef72005-12-13 08:21:33 +00002238#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002239 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002240#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002241 " -s Scan /sys and populate /dev during system boot\n\n" \
2242 "Called with no options (via hotplug) it uses environment variables\n" \
2243 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00002244#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002245 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002246 "The mdev config file contains lines that look like:\n" \
2247 " hd[a-z][0-9]* 0:3 660\n\n" \
2248 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002249 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002250 "Optionally, that can be followed (on the same line) by a special character\n" \
2251 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002252 "device(s). The environment variable $MDEV indicates the active device node\n" \
2253 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002254 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2255 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002256 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002257 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002258 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002259 "Config file parsing stops on the first matching line. If no config\n" \
2260 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002261 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002262 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002263
Glenn L McGrath061c9002002-09-16 04:21:46 +00002264#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002265 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002266#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002267 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002268 " y Allow write access to your terminal\n" \
2269 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002270
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002271#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002272 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002273#define microcom_full_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002274 "Copy bytes for stdin to TTY and from TTY to stdout" \
2275 "\n\nOptions:" \
Mike Frysinger1e47c422008-02-15 01:34:14 +00002276 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2277 "\n next byte to it" \
2278 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2279 "\n -s Set serial line to SPEED" \
2280 "\n -X Disable special meaning of NUL and Ctrl-X from stdin"
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002281
Eric Andersen7e9276b2001-02-22 01:15:47 +00002282#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002283 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002284#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002285 "Create the DIRECTORY(ies) if they do not already exist" \
2286 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002287 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002288 " -p No error if existing, make parent directories as needed" \
2289 USE_SELINUX( \
2290 "\n -Z Set security context" \
2291 )
2292
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002293#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002294 "$ mkdir /tmp/foo\n" \
2295 "$ mkdir /tmp/foo\n" \
2296 "/tmp/foo: File exists\n" \
2297 "$ mkdir /tmp/foo/bar/baz\n" \
2298 "/tmp/foo/bar/baz: No such file or directory\n" \
2299 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002300
Mike Frysinger6447ac02005-06-11 05:29:40 +00002301#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002302 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2303 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2304 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2305 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2306 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2307 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002308#define mke2fs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002309 " -b size Block size in bytes\n" \
2310 " -c Check for bad blocks before creating\n" \
2311 " -E opts Set extended options\n" \
2312 " -f size Fragment size in bytes\n" \
2313 " -F Force (ignore sanity checks)\n" \
2314 " -g num Number of blocks in a block group\n" \
2315 " -i ratio The bytes/inode ratio\n" \
2316 " -j Create a journal (ext3)\n" \
2317 " -J opts Set journal options (size/device)\n" \
2318 " -l file Read bad blocks list from file\n" \
2319 " -L lbl Set the volume label\n" \
2320 " -m percent Percent of fs blocks to reserve for admin\n" \
2321 " -M dir Set last mounted directory\n" \
2322 " -n Do not actually create anything\n" \
2323 " -N num Number of inodes to create\n" \
2324 " -o os Set the 'creator os' field\n" \
2325 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002326 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002327 " -r rev Set filesystem revision\n" \
2328 " -S Write superblock and group descriptors only\n" \
2329 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002330 " -v Verbose"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002331
Eric Andersen7e9276b2001-02-22 01:15:47 +00002332#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002333 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002334#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002335 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002336 "\n\nOptions:\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002337 " -m Create the pipe using the specified mode (default a=rw)" \
2338 USE_SELINUX( \
2339 "\n -Z Set security context" \
2340 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002341
Eric Andersen7e9276b2001-02-22 01:15:47 +00002342#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002343 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002344#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002345 "Make a MINIX filesystem" \
2346 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002347 " -c Check device for bad blocks\n" \
2348 " -n [14|30] Maximum length of filenames\n" \
2349 " -i INODES Number of inodes for the filesystem\n" \
2350 " -l FILENAME Read bad blocks list from FILENAME\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002351 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002352
Eric Andersen7e9276b2001-02-22 01:15:47 +00002353#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002354 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002355#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002356 "Create a special file (block, character, or pipe)" \
2357 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002358 " -m Create the special file using the specified mode (default a=rw)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002359 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002360 " b: Make a block (buffered) device\n" \
2361 " c or u: Make a character (un-buffered) device\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002362 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes" \
2363 USE_SELINUX( \
2364 "\n -Z Set security context" \
2365 )
2366
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002367#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002368 "$ mknod /dev/fd0 b 2 0\n" \
2369 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002370
Eric Andersen7e9276b2001-02-22 01:15:47 +00002371#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002372 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002373#define mkswap_full_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002374 "Prepare block device to be used as swap partition"
2375#if 0
2376 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
2377 "\n\nOptions:"
2378 "\n -c Check for readability"
2379 "\n -v0 Make swap version 0 (max 128M)"
2380 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2381 "\n BLOCKS Number of blocks to use (default is entire partition)"
2382#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002383
Eric Andersen7e9276b2001-02-22 01:15:47 +00002384#define mktemp_trivial_usage \
Denis Vlasenko761e1d12008-02-09 06:29:32 +00002385 "[-dt] [-p DIR] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002386#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002387 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002388 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2389 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002390 " -d Make a directory instead of a file\n" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002391 /* " -q Fail silently if an error occurs\n" - we ignore it */ \
2392 " -t Generate a path rooted in temporary directory\n" \
2393 " -p DIR Use DIR as a temporary directory (implies -t)\n" \
2394 "\n" \
2395 "For -t or -p, directory is chosen as follows:\n" \
2396 "$TMPDIR if set, else -p DIR, else /tmp"
2397
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002398#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002399 "$ mktemp /tmp/temp.XXXXXX\n" \
2400 "/tmp/temp.mWiLjM\n" \
2401 "$ ls -la /tmp/temp.mWiLjM\n" \
2402 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002403
Eric Andersen8d79ce82001-07-22 23:00:15 +00002404#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002405 "[-knqrsv] MODULE [symbol=value...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002406#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002407 "Options:\n" \
2408 " -k Make module autoclean-able\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002409 " -n Dry run\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002410 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002411 " -r Remove module (stacks) or do autoclean\n" \
2412 " -s Report via syslog instead of stderr\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002413 " -v Verbose"
Rob Landley9c32a152005-12-11 20:12:24 +00002414#define modprobe_notes_usage \
2415"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2416"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2417"pass each module it loads.\n" \
2418"\n" \
2419"The configuration file is searched (in order) amongst:\n" \
2420"\n" \
2421" /etc/modprobe.conf (2.6 only)\n" \
2422" /etc/modules.conf\n" \
2423" /etc/conf.modules (deprecated)\n" \
2424"\n" \
2425"They all have the same syntax (see below). If none is present, it is\n" \
2426"_not_ an error; each loaded module is then expected to load without\n" \
2427"options. Once a file is found, the others are tested for.\n" \
2428"\n" \
2429"/etc/modules.conf entry format:\n" \
2430"\n" \
2431" alias <alias_name> <mod_name>\n" \
2432" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002433" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002434" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2435" This makes it also possible to use a different set of options (below) for\n" \
2436" the module and the alias.\n" \
2437" A module can be aliased more than once.\n" \
2438"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002439" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002440" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2441" the \"symbol=value\" pairs as option to that module.\n" \
2442"\n" \
2443"Sample /etc/modules.conf file:\n" \
2444"\n" \
2445" options tulip irq=3\n" \
2446" alias tulip tulip2\n" \
2447" options tulip2 irq=4 io=0x308\n" \
2448"\n" \
2449"Other functionality offered by 'classic' modprobe is not available in\n" \
2450"this implementation.\n" \
2451"\n" \
2452"If module options are present both in the config file, and on the command line,\n" \
2453"then the options from the command line will be passed to the module _after_\n" \
2454"the options from the config file. That way, you can have defaults in the config\n" \
2455"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002456#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002457 "(with the above /etc/modules.conf):\n\n" \
2458 "$ modprobe tulip\n" \
2459 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2460 "$ modprobe tulip irq=5\n" \
2461 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2462 "$ modprobe tulip2\n" \
2463 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2464 " which are the default for alias 'tulip2'\n\n" \
2465 "$ modprobe tulip2 irq=8\n" \
2466 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2467 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2468 " from the command line\n\n" \
2469 "$ modprobe tulip2 irq=2 io=0x210\n" \
2470 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2471 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2472 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002473
Eric Andersen7e9276b2001-02-22 01:15:47 +00002474#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002475 "[FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002476#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002477 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002478#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002479 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002480
Eric Andersen7e9276b2001-02-22 01:15:47 +00002481#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002482 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002483#define mount_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002484 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2485 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002486 " -a Mount all filesystems in fstab\n" \
Denis Vlasenkob1d8e7d2008-02-16 23:28:42 +00002487 USE_FEATURE_MOUNT_FAKE( \
2488 " -f "USE_FEATURE_MTAB_SUPPORT("Update /etc/mtab, but ")"don't mount\n" \
2489 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002490 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002491 " -n Don't update /etc/mtab\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002492 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002493 " -r Read-only mount\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002494 " -t fs-type Filesystem type\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002495 " -w Read-write mount (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002496 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002497 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002498 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002499 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002500 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002501 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002502 " [a]sync Writes are asynchronous / synchronous\n" \
2503 " [no]atime Disable / enable updates to inode access times\n" \
2504 " [no]diratime Disable / enable atime updates to directories\n" \
2505 " [no]dev Allow use of special device files / disallow them\n" \
2506 " [no]exec Allow use of executable files / disallow them\n" \
2507 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2508 " [r]shared Convert [recursively] to a shared subtree\n" \
2509 " [r]slave Convert [recursively] to a slave subtree\n" \
2510 " [r]private Convert [recursively] to a private subtree\n" \
2511 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2512 " bind Bind a directory to an additional location\n" \
2513 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002514 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002515 " remount Remount a mounted filesystem, changing its flags\n" \
2516 " ro/rw Mount for read-only / read-write\n" \
2517 "\n" \
2518 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002519 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002520#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002521 "$ mount\n" \
2522 "/dev/hda3 on / type minix (rw)\n" \
2523 "proc on /proc type proc (rw)\n" \
2524 "devpts on /dev/pts type devpts (rw)\n" \
2525 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2526 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2527 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002528#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002529 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002530
Rob Landleyd00b3a52005-08-20 05:07:08 +00002531#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002532 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002533#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002534 "mountpoint checks if the directory is a mountpoint" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002535 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002536 " -q Quiet\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002537 " -d Print major/minor device number of the filesystem\n" \
2538 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002539#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002540 "$ mountpoint /proc\n" \
2541 "/proc is not a mountpoint\n" \
2542 "$ mountpoint /sys\n" \
2543 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002544
Eric Andersen7e9276b2001-02-22 01:15:47 +00002545#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002546 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002547#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002548 "Control magnetic tape drive operation\n" \
2549 "\nAvailable Opcodes:\n\n" \
2550 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2551 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2552 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2553 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002554
Eric Andersen7e9276b2001-02-22 01:15:47 +00002555#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002556 "[OPTION]... SOURCE DEST\n" \
2557 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002558#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002559 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2560 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002561 " -f Don't prompt before overwriting\n" \
2562 " -i Interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002563#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002564 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002565
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002566#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002567 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002568#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002569 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002570 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002571 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2572 " -s Use syslog (LOCAL0 facility)\n" \
2573 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002574#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002575 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2576 " or\n" \
2577 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002578
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002579#if !ENABLE_DESKTOP
2580
Rob Landley1cca9482006-07-10 19:45:20 +00002581#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002582#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002583#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002584#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002585#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002586
Eric Andersen7e9276b2001-02-22 01:15:47 +00002587#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002588 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002589 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002590#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002591 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002592 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002593 USE_NC_EXTRA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002594 "\n -e Exec rest of command line after connect" \
2595 "\n -i SECS Delay interval for lines sent" \
2596 "\n -w SECS Timeout for connect" \
Denis Vlasenko5d687242007-01-12 20:59:31 +00002597 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002598 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002599 USE_NC_SERVER( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002600 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002601 USE_NC_EXTRA( \
2602 "\n (use -l twice with -e for persistent server)") \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002603 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002604 )
2605
Rob Landley1cca9482006-07-10 19:45:20 +00002606#define nc_notes_usage "" \
2607 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002608 "To use netcat as a terminal emulator on a serial port:\n\n" \
2609 "$ stty 115200 -F /dev/ttyS0\n" \
2610 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2611 )
Rob Landley1cca9482006-07-10 19:45:20 +00002612
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002613#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002614 "$ nc foobar.somedomain.com 25\n" \
2615 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2616 "help\n" \
2617 "214-Commands supported:\n" \
2618 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2619 "214 NOOP QUIT RSET HELP\n" \
2620 "quit\n" \
2621 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002622
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002623#else /* DESKTOP nc - much more compatible with nc 1.10 */
2624
2625#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002626 "[-options] hostname port - connect" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002627 USE_NC_SERVER("\nnc [-options] -l -p port [hostname] [port] - listen")
2628#define nc_full_usage \
2629 USE_NC_SERVER( \
2630 "-l Listen mode, for inbound connects\n" \
2631 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002632 "-n Don't do DNS resolution" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002633 "\n-s addr Local address" \
2634 "\n-p port Local port" \
2635 "\n-u UDP mode" \
2636 "\n-v Verbose (cumulative: -vv)" \
2637 "\n-w secs Timeout for connects and final net reads" \
2638 USE_NC_EXTRA( \
2639 "\n-i sec Delay interval for lines sent" /* ", ports scanned" */ \
2640 "\n-o file Hex dump of traffic" \
2641 "\n-z Zero-I/O mode (scanning)" \
2642 ) \
2643 "\n-e prog [args] Program to exec after connect (must be last)" \
2644/* "\n-r Randomize local and remote ports" */
2645/* "\n-g gateway Source-routing hop point[s], up to 8" */
2646/* "\n-G num Source-routing pointer: 4, 8, 12, ..." */
2647/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2648
2649#endif
2650
Eric Andersen1552ff72001-10-31 11:07:12 +00002651#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002652 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002653#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002654 "Display networking information" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002655 "\n\nOptions:" \
2656 "\n -l Display listening server sockets" \
2657 "\n -a Display all sockets (default: connected)" \
2658 "\n -e Display other/more information" \
2659 "\n -n Don't resolve names" \
2660 "\n -t Tcp sockets" \
2661 "\n -u Udp sockets" \
2662 "\n -w Raw sockets" \
2663 "\n -x Unix sockets" \
2664 "\n -r Display routing table" \
2665 USE_FEATURE_NETSTAT_WIDE( \
2666 "\n -W Display with no column truncation" \
2667 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002668
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002669#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002670 "[-n ADJUST] [COMMAND [ARG]...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002671#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002672 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002673 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002674 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002675
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002676#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002677 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002678#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002679 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002680 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002681 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002682 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002683 "%[niface] Monitor network interface 'iface'\n" \
2684 "%m Monitor allocated memory\n" \
2685 "%[mf] Monitor free memory\n" \
2686 "%[mt] Monitor total memory\n" \
2687 "%s Monitor allocated swap\n" \
2688 "%f Monitor number of used file descriptors\n" \
2689 "%Ni Monitor total/specific IRQ rate\n" \
2690 "%x Monitor context switch rate\n" \
2691 "%p Monitor forks\n" \
2692 "%[pn] Monitor # of processes\n" \
2693 "%b Monitor block io\n" \
2694 "%Nt Show time (with N decimal points)\n" \
2695 "%Nd Milliseconds between updates (default=1000)\n" \
2696 "%r Print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002697#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002698 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002699
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002700#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002701 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002702#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002703 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002704#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002705 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002706
Eric Andersen7e9276b2001-02-22 01:15:47 +00002707#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002708 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002709#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002710 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002711 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002712#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002713 "$ nslookup localhost\n" \
2714 "Server: default\n" \
2715 "Address: default\n" \
2716 "\n" \
2717 "Name: debian\n" \
2718 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002719
Glenn L McGrath60281112001-11-02 11:39:46 +00002720#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002721 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002722#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002723 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002724 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002725
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002726#define openvt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002727 "VTNUM COMMAND [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002728#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002729 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002730#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002731 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002732
Eric Andersen27f64e12002-06-23 04:24:25 +00002733#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002734 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002735#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002736 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002737 "changes the password for the current user." \
2738 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002739 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002740 " (choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002741 " -d Delete the password for the specified user account\n" \
2742 " -l Locks (disables) the specified user account\n" \
2743 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002744
Denis Vlasenko21d10142007-07-20 21:28:41 +00002745#define chpasswd_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002746 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko21d10142007-07-20 21:28:41 +00002747#define chpasswd_full_usage \
2748 "Read user:password information from stdin\n" \
2749 "and update /etc/passwd accordingly." \
2750 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002751 USE_GETOPT_LONG( \
2752 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2753 "\n -m,--md5 Use MD5 encryption instead of DES" \
2754 ) \
2755 SKIP_GETOPT_LONG( \
2756 "\n -e Supplied passwords are in encrypted form" \
2757 "\n -m Use MD5 encryption instead of DES" \
2758 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002759
Glenn L McGrath655d8142003-06-22 15:32:41 +00002760#define patch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002761 "[-p num] [-i diff]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002762#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002763 " -p NUM Strip NUM leading components from file names\n" \
2764 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002765#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002766 "$ patch -p1 < example.diff\n" \
2767 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002768
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002769#define pgrep_trivial_usage \
2770 "[-flnovx] pattern"
2771#define pgrep_full_usage \
2772 "Display process(es) selected by regex pattern" \
2773 "\n\nOptions:\n" \
2774 " -l Show command name too\n" \
2775 " -f Match against entire command line\n" \
2776 " -n Signal the newest process only\n" \
2777 " -o Signal the oldest process only\n" \
2778 " -v Negate the matching\n" \
2779 " -x Match whole name (not substring)"
2780
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002781#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2782#define USAGE_PIDOF "Options:"
2783#else
Denis Vlasenko765996a2006-12-24 16:59:27 +00002784#define USAGE_PIDOF "\nThis version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002785#endif
2786
Eric Andersen221b2ea2001-07-31 19:06:07 +00002787#define pidof_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002788 "process-name [OPTION] [process-name...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002789
Eric Andersen221b2ea2001-07-31 19:06:07 +00002790#define pidof_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002791 "List the PIDs of all processes with names that match the\n" \
2792 "names on the command line\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002793 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002794 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002795 "\n -s Display only a single PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002796 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenko198bada2007-06-23 14:56:43 +00002797 "\n -o PID Omit given pid") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002798 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002799 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002800#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002801 "$ pidof init\n" \
2802 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002803 USE_FEATURE_PIDOF_OMIT( \
2804 "$ pidof /bin/sh\n20351 5973 5950\n") \
2805 USE_FEATURE_PIDOF_OMIT( \
2806 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002807
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002808#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002809#define ping_trivial_usage \
2810 "host"
2811#define ping_full_usage \
2812 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002813#define ping6_trivial_usage \
2814 "host"
2815#define ping6_full_usage \
2816 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002817#else
2818#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002819 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002820#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002821 "Send ICMP ECHO_REQUEST packets to network hosts" \
2822 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002823 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2824 " -c CNT Send only CNT pings\n" \
2825 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2826 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002827 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002828 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002829#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002830 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002831#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002832 "Send ICMP ECHO_REQUEST packets to network hosts" \
2833 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002834 " -c CNT Send only CNT pings\n" \
2835 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2836 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002837 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002838 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002839#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002840#define ping_example_usage \
2841 "$ ping localhost\n" \
2842 "PING slag (127.0.0.1): 56 data bytes\n" \
2843 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2844 "\n" \
2845 "--- debian ping statistics ---\n" \
2846 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2847 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002848#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002849 "$ ping6 ip6-localhost\n" \
2850 "PING ip6-localhost (::1): 56 data bytes\n" \
2851 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2852 "\n" \
2853 "--- ip6-localhost ping statistics ---\n" \
2854 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2855 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002856
Eric Andersen7e9276b2001-02-22 01:15:47 +00002857#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002858 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002859#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002860 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002861 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002862
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002863#define pkill_trivial_usage \
2864 "[-l] | [-fnovx] [-signal] pattern"
2865#define pkill_full_usage \
2866 "Send a signal to process(es) selected by regex pattern" \
2867 "\n\nOptions:\n" \
2868 " -l List all signals\n" \
2869 " -f Match against entire command line\n" \
2870 " -n Signal the newest process only\n" \
2871 " -o Signal the oldest process only\n" \
2872 " -v Negate the matching\n" \
2873 " -x Match whole name (not substring)"
2874
Eric Andersen7e9276b2001-02-22 01:15:47 +00002875#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002876 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002877#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002878 "Halt and shut off power" \
2879 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002880 " -d Delay interval for halting\n" \
2881 " -n No call to sync()\n" \
2882 " -f Force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002883
Mike Frysinger95d3c452005-04-21 23:29:24 +00002884#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002885 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002886#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002887 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002888 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002889
Eric Andersen7e9276b2001-02-22 01:15:47 +00002890#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002891 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002892#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002893 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002894 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002895#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002896 "$ printf \"Val=%d\\n\" 5\n" \
2897 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002898
Denis Vlasenko94949192006-11-05 00:45:47 +00002899
2900#if ENABLE_DESKTOP
2901
2902#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002903 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002904#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002905 "Report process status" \
2906 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002907 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002908
2909#else /* !ENABLE_DESKTOP */
2910
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002911#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002912#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002913#else
2914#define USAGE_PS "\nOptions:"
2915#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002916
Eric Andersen7e9276b2001-02-22 01:15:47 +00002917#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002918 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002919#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002920 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002921 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002922 USE_SELINUX( \
Bernhard Reutner-Fischer26a80162007-03-14 08:52:28 +00002923 "\n -Z Show SE Linux context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002924 USE_FEATURE_PS_WIDE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002925 "\n w Wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002926
Denis Vlasenko94949192006-11-05 00:45:47 +00002927#endif /* ENABLE_DESKTOP */
2928
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002929#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002930 "$ ps\n" \
2931 " PID Uid Gid State Command\n" \
2932 " 1 root root S init\n" \
2933 " 2 root root S [kflushd]\n" \
2934 " 3 root root S [kupdate]\n" \
2935 " 4 root root S [kpiod]\n" \
2936 " 5 root root S [kswapd]\n" \
2937 " 742 andersen andersen S [bash]\n" \
2938 " 743 andersen andersen S -bash\n" \
2939 " 745 root root S [getty]\n" \
2940 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002941
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00002942#define pscan_trivial_usage \
2943 "[-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
2944#define pscan_full_usage \
2945 "Scan a host, print all open ports" \
2946 "\n\nOptions:" \
2947 "\n -p Scan from this port (default 1)" \
2948 "\n -P Scan up to this port (default 1024)" \
2949 "\n -t Timeout (default 5000 ms)" \
2950 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
2951
Eric Andersen7e9276b2001-02-22 01:15:47 +00002952#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002953 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002954#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002955 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002956#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002957 "$ pwd\n" \
2958 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002959
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002960#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002961 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002962#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002963 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002964#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002965 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002966
Eric Andersen7e9276b2001-02-22 01:15:47 +00002967#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002968 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002969#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002970 "Get and possibly set the system date and time from a remote HOST" \
2971 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002972 " -s Set the system date and time (default)\n" \
2973 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002974
Rob Landley0e4690d2006-08-20 22:12:18 +00002975#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002976 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002977#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002978 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2979 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00002980
Eric Andersen7e9276b2001-02-22 01:15:47 +00002981#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002982 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002983#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002984 "Display the value of a symlink" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002985 USE_FEATURE_READLINK_FOLLOW( \
2986 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002987 " -f Canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002988
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002989#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002990 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002991#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002992 "Options:\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002993 " -m mapfile (Default: /boot/System.map)\n" \
2994 " -p profile (Default: /proc/profile)\n" \
2995 " -M mult Set the profiling multiplier to mult\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002996 " -i Print only info about the sampling step\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002997 " -v Verbose\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002998 " -a Print all symbols, even if count is 0\n" \
2999 " -b Print individual histogram-bin counts\n" \
3000 " -s Print individual counters within functions\n" \
3001 " -r Reset all the counters (root only)\n" \
3002 " -n Disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00003003
Glenn L McGrath62fae302002-12-10 00:14:33 +00003004#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003005 "pathname..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00003006#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003007 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00003008
Eric Andersen7e9276b2001-02-22 01:15:47 +00003009#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003010 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003011#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003012 "Reboot the system" \
3013 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003014 " -d Delay interval for rebooting\n" \
3015 " -n No call to sync()\n" \
3016 " -f Force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003017
3018#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003019 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003020#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003021 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003022 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003023 " -n Adjust current nice value (smaller is faster)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003024 " -p Process id(s) (default)\n" \
3025 " -g Process group id(s)\n" \
3026 " -u Process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003027
Eric Andersen7e9276b2001-02-22 01:15:47 +00003028#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003029 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003030#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003031 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003032
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003033#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003034 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003035#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003036 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003037
Denis Vlasenko397137b2007-07-23 14:03:30 +00003038#define restorecon_trivial_usage \
3039 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
3040#define restorecon_full_usage \
3041 "Reset security contexts of files in pathname\n" \
3042 "\n -i Ignore files that do not exist" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003043 "\n -f file File with list of files to process. Use - for stdin" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003044 "\n -e directory Directory to exclude" \
3045 "\n -R,-r Recurse directories" \
3046 "\n -n Don't change any file labels" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003047 "\n -o file Save list of files with incorrect context" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003048 "\n -v Verbose" \
3049 "\n -vv Show changed labels" \
3050 "\n -F Force reset of context to match file_context" \
3051 "\n for customizable files, or the user section," \
3052 "\n if it has changed"
3053
Eric Andersen7e9276b2001-02-22 01:15:47 +00003054#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003055 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003056#define rm_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003057 "Remove (unlink) the FILE(s). You may use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003058 "indicate that all following arguments are non-options." \
3059 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003060 " -i Always prompt before removing each destination\n" \
3061 " -f Remove existing destinations, never prompt\n" \
3062 " -r,-R Remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003063#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003064 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003065
Eric Andersen7e9276b2001-02-22 01:15:47 +00003066#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003067 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003068#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003069 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003070#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003071 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003072
Eric Andersen7e9276b2001-02-22 01:15:47 +00003073#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003074 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003075#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003076 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003077 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003078 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003079#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003080 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003081
Eric Andersen7e9276b2001-02-22 01:15:47 +00003082#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003083 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003084#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003085 "Edit the kernel's routing tables" \
3086 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003087 " -n Dont resolve names\n" \
3088 " -e Display other/more information\n" \
3089 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003090
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003091#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003092 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003093#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003094 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003095 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003096 "\n -i Install package" \
3097 "\n -q Query package" \
3098 "\n -p Query uninstalled package" \
3099 "\n -i Show information" \
3100 "\n -l List contents" \
3101 "\n -d List documents" \
3102 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003103
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003104#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003105 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003106#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003107 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003108
Mike Frysinger6b160e42008-02-15 02:27:19 +00003109#define rtcwake_trivial_usage \
3110 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
3111#define rtcwake_full_usage \
3112 "enter a system sleep state until specified wakeup time\n\n" \
3113 USE_GETOPT_LONG( \
3114 " -a,--auto Read clock mode from adjtime\n" \
3115 " -l,--local Clock is set to local time\n" \
3116 " -u,--utc Clock is set to UTC time\n" \
3117 " -d,--device=DEV Specify the RTC device\n" \
3118 " -m,--mode=MODE Set the sleep state (default: standby)\n" \
3119 " -s,--seconds=SEC Set the timeout in SEC seconds from now\n" \
3120 " -t,--time=TIME Set the timeout to TIME seconds from epoch" \
3121 ) \
3122 SKIP_GETOPT_LONG( \
3123 " -a Read clock mode from adjtime\n" \
3124 " -l Clock is set to local time\n" \
3125 " -u Clock is set to UTC time\n" \
3126 " -d DEV Specify the RTC device\n" \
3127 " -m MODE Set the sleep state (default: standby)\n" \
3128 " -s SEC Set the timeout in SEC seconds from now\n" \
3129 " -t TIME Set the timeout to TIME seconds from epoch" \
3130 )
3131
Denis Vlasenko49622d72007-03-10 16:58:49 +00003132#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003133 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3134 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko49622d72007-03-10 16:58:49 +00003135#define runcon_full_usage \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003136 "Run a program in a different security context\n\n" \
3137 " CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003138 USE_GETOPT_LONG( \
3139 " -c,--compute Compute process transition context before modifying\n" \
3140 " -t,--type=TYPE Type (for same role as parent)\n" \
3141 " -u,--user=USER User identity\n" \
3142 " -r,--role=ROLE Role\n" \
3143 " -l,--range=RNG Levelrange" \
3144 ) \
3145 SKIP_GETOPT_LONG( \
3146 " -c Compute process transition context before modifying\n" \
3147 " -t TYPE Type (for same role as parent)\n" \
3148 " -u USER User identity\n" \
3149 " -r ROLE Role\n" \
3150 " -l RNG Levelrange" \
3151 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003152
Eric Andersen6cf47a72001-10-31 10:24:36 +00003153#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003154 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003155#define run_parts_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003156 "Run a bunch of scripts in a directory" \
3157 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003158 " -t Prints what would be run, but does not actually run anything\n" \
3159 " -a ARG Pass ARG as an argument for every program invoked\n" \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003160 " -u MASK Set the umask to MASK before executing every program" \
3161USE_FEATURE_RUN_PARTS_FANCY("\n -l Prints names of all matching files even when they are not executable")
3162
3163#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003164 "$ run-parts -a start /etc/init.d\n" \
3165 "$ run-parts -a stop=now /etc/init.d\n\n" \
3166 "Let's assume you have a script foo/dosomething:\n" \
3167 "#!/bin/sh\n" \
3168 "for i in $*; do eval $i; done; unset i\n" \
3169 "case \"$1\" in\n" \
3170 "start*) echo starting something;;\n" \
3171 "stop*) set -x; shutdown -h $stop;;\n" \
3172 "esac\n\n" \
3173 "Running this yields:\n" \
3174 "$run-parts -a stop=+4m foo/\n" \
3175 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003176
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003177#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003178 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003179#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003180 "Find the current and previous system runlevel.\n\n" \
3181 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003182 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003183#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003184 "$ runlevel /var/run/utmp\n" \
3185 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003186
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003187#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003188 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003189#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003190 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003191
3192#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003193 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003194#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003195 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003196
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003197#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003198 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003199#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003200 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003201#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003202 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003203
Eric Andersen7e9276b2001-02-22 01:15:47 +00003204#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003205 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003206#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003207 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003208 " -e script Add the script to the commands to be executed\n" \
3209 " -f scriptfile Add script-file contents to the\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003210 " commands to be executed\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003211 " -i Edit files in-place\n" \
3212 " -n Suppress automatic printing of pattern space\n" \
3213 " -r Use extended regular expression syntax\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003214 "\n" \
3215 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
3216 "script to interpret. All remaining arguments are names of input files; if no\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003217 "input files are specified, then the standard input is read. Source files\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003218 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00003219
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003220#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003221 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3222 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003223
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003224#define selinuxenabled_trivial_usage
3225#define selinuxenabled_full_usage
3226
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003227#define sendmail_trivial_usage \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003228 "[-C dir] [-w timeout] [-U user] [-P password] [-X]\n" \
3229 "-t to [-t to] -f from [-n] [-s subject] [-c charset] server[:port] [body] [attachment ...]"
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003230#define sendmail_full_usage \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003231 "Send an email with optional attachments." \
3232 "\n\nOptions:\n" \
3233 " -C dir Change current directory to dir\n" \
3234 " -w timeout Set timeout on network operations\n" \
3235 " -U username Authenticate with specified username\n" \
3236 " -P password Authenticate with specified password\n" \
3237 " -X Use openssl connection helper for secured servers\n" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003238 " -t to Recipient email. May be multiple\n" \
Denis Vlasenkoa2980c62008-02-02 17:54:35 +00003239 " -f from Sender address\n" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003240 " -n Request delivery notification to sender\n" \
3241 " -s subject Subject\n" \
3242 " -c charset Assumed charset for body and subject [utf-8]"
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003243
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003244#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003245 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003246#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003247 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003248 "FIRST, INCREMENT default to 1" \
3249 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003250 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003251 " FIRST LAST\n" \
3252 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003253
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003254#define sestatus_trivial_usage \
3255 "[-vb]"
3256#define sestatus_full_usage \
3257 "-v Verbose\n" \
3258 "-b Display current state of booleans"
3259
Paul Foxfc2256a2005-08-01 18:12:30 +00003260#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003261 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00003262#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003263 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003264 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003265 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00003266
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003267#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003268 "[Enforcing | Permissive | 1 | 0]"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003269#define setenforce_full_usage
3270
Denis Vlasenko397137b2007-07-23 14:03:30 +00003271#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003272 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003273 USE_FEATURE_SETFILES_CHECK_OPTION( \
3274 " [-c policyfile] spec_file" \
3275 ) \
3276 " pathname"
3277
3278#define setfiles_full_usage \
3279 "Reset file contexts under pathname according to spec_file" \
3280 USE_FEATURE_SETFILES_CHECK_OPTION( \
3281 "\n -c file Check the validity of the contexts against the specified binary policy" \
3282 ) \
3283 "\n -d Show which specification matched each file" \
3284 "\n -l Log changes in file labels to syslog" \
3285 "\n -n Don't change any file labels" \
Denis Vlasenko1da77722007-07-24 06:17:43 +00003286 "\n -q Suppress warnings" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003287 "\n -r dir Use an altenate root path" \
3288 "\n -e dir Exclude directory" \
3289 "\n -F Force reset of context to match file_context for customizable files" \
3290 "\n -o file Save list of files with incorrect context" \
3291 "\n -s Take a list of files from standard input (instead of command line)" \
3292 "\n -v Show changes in file labels, if type or role are changing" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003293 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3294 "\n -W Display warnings about entries that had no matching files"
Denis Vlasenko397137b2007-07-23 14:03:30 +00003295
Eric Andersen7e9276b2001-02-22 01:15:47 +00003296#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003297 "SCANCODE KEYCODE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003298#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003299 "Set entries into the kernel's scancode-to-keycode map,\n" \
3300 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3301 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
3302 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003303#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003304 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003305
Rob Landley87848d92006-03-27 23:23:43 +00003306#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003307 "N"
Rob Landley87848d92006-03-27 23:23:43 +00003308#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003309 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003310
Denis Vlasenkobe039372007-10-14 04:48:44 +00003311#define setsebool_trivial_usage \
3312 "boolean value"
3313
3314#define setsebool_full_usage \
3315 "Change boolean setting"
3316
Paul Fox42403642005-08-01 22:52:09 +00003317#define setsid_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003318 "program [arg...]"
Paul Fox42403642005-08-01 22:52:09 +00003319#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003320 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003321 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00003322
Matt Kraai2d91deb2001-08-01 17:21:35 +00003323#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003324 "[FILE]...\n" \
3325 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00003326#define lash_full_usage \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003327 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003328
Eric Andersen2e9c2572003-08-08 22:26:06 +00003329#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003330 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00003331#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003332 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00003333
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003334#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003335 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003336 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003337#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003338 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003339 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003340 "\n\nOptions:\n" \
3341 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003342 " -c Check SHA1 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003343 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003344 " -s Don't output anything, status code shows success\n" \
3345 " -w Warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003346
Denis Vlasenko14923db2007-06-20 15:23:03 +00003347#define slattach_trivial_usage \
3348 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3349#define slattach_full_usage \
3350 "Attach network interface(s) to serial line(s)\n" \
3351 "\nOptions:" \
3352 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3353 "\n -s Set line speed" \
3354 "\n -e Exit after initializing device" \
3355 "\n -h Exit when the carrier is lost" \
3356 "\n -c Execute a command when the line is hung up" \
3357 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3358 "\n -L Enable 3-wire operation" \
3359 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003360
Eric Andersen7e9276b2001-02-22 01:15:47 +00003361#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003362 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003363#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003364 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003365 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003366 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003367 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003368#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003369 "$ sleep 2\n" \
3370 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003371 USE_FEATURE_FANCY_SLEEP( \
3372 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003373 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003374
Eric Andersen7e9276b2001-02-22 01:15:47 +00003375#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003376 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003377 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003378 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003379#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003380 "Sort lines of text in the specified files" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003381 "\n\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003382 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003383 "\n -b Ignore leading blanks" \
3384 "\n -c Check whether input is sorted" \
3385 "\n -d Dictionary order (blank or alphanumeric only)" \
3386 "\n -f Ignore case" \
3387 "\n -g General numerical sort" \
3388 "\n -i Ignore unprintable characters" \
3389 "\n -k Sort key" \
3390 "\n -M Sort month" \
3391 ) \
3392 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003393 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003394 "\n -o Output to file" \
3395 "\n -k Sort by key" \
3396 "\n -t CHAR Key separator" \
3397 ) \
3398 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003399 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003400 "\n -s Stable (don't sort ties alphabetically)" \
3401 ) \
3402 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003403 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003404 "\n -z Lines are terminated by NUL, not newline" \
3405 "\n -mST Ignored for GNU compatibility") \
3406
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003407#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003408 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3409 "a\n" \
3410 "b\n" \
3411 "c\n" \
3412 "d\n" \
3413 "e\n" \
3414 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003415 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003416 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3417 "d 2\n" \
3418 "b 2\n" \
3419 "c 3\n" \
3420 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003421 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003422
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003423#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003424 "[OPTION] [INPUT [PREFIX]]"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003425#define split_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003426 "Options:" \
3427 "\n -b n[k|m] Split by bytes" \
3428 "\n -l n Split by lines" \
3429 "\n -a n Use n letters as suffix"
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003430#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003431 "$ split TODO foo\n" \
3432 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003433
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003434#define start_stop_daemon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003435 "[OPTIONS] [" \
3436 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3437 "] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003438#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003439 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003440 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003441 USE_GETOPT_LONG( \
3442 "\n -S,--start Start" \
3443 "\n -K,--stop Stop" \
3444 "\n -a,--startas pathname Starts process specified by pathname" \
3445 "\n -b,--background Put process into background" \
3446 "\n -u,--user username|uid Stop this user's processes" \
3447 "\n -x,--exec executable Program to either start or check" \
3448 "\n -n,--name process-name Stop processes with this name" \
3449 "\n -p,--pidfile pid-file Save or load pid using a pid-file" \
3450 "\n -m,--make-pidfile Create the -p file and enter pid in it" \
3451 "\n -q,--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003452 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003453 "\n -o,--oknodo Exit status 0 if nothing done" \
3454 "\n -v,--verbose Verbose" \
3455 "\n -N,--nicelevel N Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003456 ) \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003457 "\n -s,--signal signal Signal to send (default TERM)" \
3458 "\n -c,--chuid user[:[grp]] Change to specified user/group" \
3459 ) \
3460 SKIP_GETOPT_LONG( \
3461 "\n -S Start" \
3462 "\n -K Stop" \
3463 "\n -a pathname Starts process specified by pathname" \
3464 "\n -b Put process into background" \
3465 "\n -u username|uid Stop this user's processes" \
3466 "\n -x executable Program to either start or check" \
3467 "\n -n process-name Stop processes with this name" \
3468 "\n -p pid-file Save or load pid using a pid-file" \
3469 "\n -m Create the -p file and enter pid in it" \
3470 "\n -q Quiet" \
3471 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3472 "\n -o Exit status 0 if nothing done" \
3473 "\n -v Verbose" \
3474 "\n -N N Add N to process's nice level" \
3475 ) \
3476 "\n -s signal Signal to send (default TERM)" \
3477 "\n -c user[:[grp]] Change to specified user/group" \
3478 )
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003479
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003480#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003481 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003482#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003483 "Display file (default) or filesystem status" \
3484 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003485 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003486 " -c fmt Use the specified format\n") \
3487 " -f Display filesystem status\n" \
Bernhard Reutner-Fischer52432f22008-01-17 11:05:09 +00003488 " -L Dereference links\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003489 " -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003490 USE_SELINUX( \
3491 "\n -Z Print security context" \
3492 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003493 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003494 "\n\nValid format sequences for files:\n" \
3495 " %a Access rights in octal\n" \
3496 " %A Access rights in human readable form\n" \
3497 " %b Number of blocks allocated (see %B)\n" \
3498 " %B The size in bytes of each block reported by %b\n" \
3499 " %d Device number in decimal\n" \
3500 " %D Device number in hex\n" \
3501 " %f Raw mode in hex\n" \
3502 " %F File type\n" \
3503 " %g Group ID of owner\n" \
3504 " %G Group name of owner\n" \
3505 " %h Number of hard links\n" \
3506 " %i Inode number\n" \
3507 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003508 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003509 " %o I/O block size\n" \
3510 " %s Total size, in bytes\n" \
3511 " %t Major device type in hex\n" \
3512 " %T Minor device type in hex\n" \
3513 " %u User ID of owner\n" \
3514 " %U User name of owner\n" \
3515 " %x Time of last access\n" \
3516 " %X Time of last access as seconds since Epoch\n" \
3517 " %y Time of last modification\n" \
3518 " %Y Time of last modification as seconds since Epoch\n" \
3519 " %z Time of last change\n" \
3520 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003521 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003522 " %a Free blocks available to non-superuser\n" \
3523 " %b Total data blocks in file system\n" \
3524 " %c Total file nodes in file system\n" \
3525 " %d Free file nodes in file system\n" \
3526 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003527 USE_SELINUX( \
3528 " %C Security context in SELinux\n" \
3529 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003530 " %i File System ID in hex\n" \
3531 " %l Maximum length of filenames\n" \
3532 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003533 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003534 " %S Fundamental block size (for block counts)\n" \
3535 " %t Type in hex\n" \
3536 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003537 )
3538
Eric Andersenef5e8f82002-11-07 02:09:37 +00003539#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003540 "[-afo] [-n length] [file...]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003541#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003542 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003543 "\n\nOptions:" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003544 "\n -a Scan whole file (default)" \
3545 "\n -f Precede strings with filenames" \
3546 "\n -n N At least N characters form a string (default 4)" \
3547 "\n -o Precede strings with decimal offsets"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003548
Eric Andersen7e9276b2001-02-22 01:15:47 +00003549#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003550 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003551#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003552 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003553 "and deviations from stty sane" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003554 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003555 "\n -F DEVICE Open device instead of stdin" \
3556 "\n -a Print all current settings in human-readable form" \
3557 "\n -g Print in stty-readable form" \
3558 "\n [SETTING] See manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003559
Robert Griebl1fca5582002-06-04 20:45:46 +00003560#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003561 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003562#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003563 "Change user id or become root" \
3564 "\n\nOptions:" \
3565 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003566 "\n -c Command to pass to 'sh -c'" \
3567 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00003568
Eric Andersen27f64e12002-06-23 04:24:25 +00003569#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003570 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003571#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003572 "Single user login" \
3573 "\n\nOptions:" \
3574 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00003575
Mike Frysinger95d3c452005-04-21 23:29:24 +00003576#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003577 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003578#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003579 "Checksum and count the blocks in a file" \
3580 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003581 " -r Use BSD sum algorithm (1K blocks)\n" \
3582 " -s Use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003583
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003584#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003585 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003586#define sv_full_usage \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003587 "Control services monitored by runsv supervisor.\n" \
3588 "Commands (only first character is enough):\n" \
3589 "\n" \
3590 "status: query service status\n" \
3591 "up: if service isn't running, start it. If service stops, restart it\n" \
3592 "once: like 'up', but if service stops, don't restart it\n" \
3593 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3594 " if it exists. After it stops, do not restart service\n" \
3595 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3596 " runsv exits too\n" \
3597 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
3598 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003599
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003600#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003601 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003602#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003603 "Continuously read log data from standard input, optionally " \
3604 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003605 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003606
Eric Andersen7e9276b2001-02-22 01:15:47 +00003607#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003608 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003609#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003610 "Stop swapping virtual memory pages on DEVICE" \
3611 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003612 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003613
Eric Andersen7e9276b2001-02-22 01:15:47 +00003614#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003615 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003616#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003617 "Start swapping virtual memory pages on DEVICE" \
3618 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003619 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003620
Rob Landley0f34a822005-10-27 22:55:50 +00003621#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003622 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003623#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003624 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003625 "and exec NEW_INIT" \
3626 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003627 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00003628
Eric Andersen7e9276b2001-02-22 01:15:47 +00003629#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003630 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003631#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003632 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003633
Eric Andersenb9050282003-12-24 06:02:11 +00003634#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003635 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003636#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003637 "Configure kernel parameters at runtime" \
3638 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003639 " -n Disable printing of key names\n" \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003640 " -e Don't warn about unknown keys\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003641 " -w Change sysctl setting\n" \
3642 " -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)\n" \
3643 " -a Display all values\n" \
3644 " -A Display all values in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003645#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003646 "sysctl [-n] [-e] variable...\n" \
3647 "sysctl [-n] [-e] -w variable=value...\n" \
3648 "sysctl [-n] [-e] -a\n" \
3649 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3650 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003651
Eric Andersen7e9276b2001-02-22 01:15:47 +00003652#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003653 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003654#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003655 "System logging utility.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003656 "Note that this version of syslogd ignores /etc/syslog.conf." \
3657 "\n\nOptions:" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003658 "\n -n Run in foreground" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003659 "\n -O FILE Log to given file (default=/var/log/messages)" \
3660 "\n -l n Set local log level" \
3661 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003662 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003663 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3664 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003665 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003666 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003667 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003668 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003669 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)")
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003670 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003671/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003672#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003673 "$ syslogd -R masterlog:514\n" \
3674 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003675
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003676#define tac_trivial_usage \
3677 "[FILE]..."
3678#define tac_full_usage \
3679 "Concatenates FILE(s) and prints them to stdout in reverse"
3680
Eric Andersen7e9276b2001-02-22 01:15:47 +00003681#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003682 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003683#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003684 "Print last 10 lines of each FILE to standard output.\n" \
3685 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003686 "file name. With no FILE, or when FILE is -, read standard input." \
3687 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003688 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003689 "\n -c N[kbm] Output the last N bytes") \
3690 "\n -n N[kbm] Print last N lines instead of last 10" \
3691 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003692 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003693 "\n -q Never output headers giving file names" \
3694 "\n -s SEC Wait SEC seconds between reads with -f" \
3695 "\n -v Always output headers giving file names" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003696 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003697 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3698 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3699 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003700#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003701 "$ tail -n 1 /etc/resolv.conf\n" \
3702 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003703
Eric Andersen7e9276b2001-02-22 01:15:47 +00003704#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003705 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003706 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3707 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003708 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003709 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003710#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003711 "Create, extract, or list files from a tar file" \
3712 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003713 USE_FEATURE_TAR_CREATE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003714 " c Create\n") \
3715 " x Extract\n" \
3716 " t List\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003717 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003718 USE_FEATURE_TAR_GZIP( \
3719 " z Filter the archive through gzip\n") \
3720 USE_FEATURE_TAR_BZIP2( \
3721 " j Filter the archive through bzip2\n") \
3722 USE_FEATURE_TAR_LZMA( \
3723 " a Filter the archive through lzma\n") \
3724 USE_FEATURE_TAR_COMPRESS( \
3725 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003726 "\nFile selection:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003727 " f Name of TARFILE or \"-\" for stdin\n" \
3728 " O Extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003729 USE_FEATURE_TAR_FROM( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003730 " exclude File to exclude\n" \
3731 " X File with names to exclude\n") \
3732 " C Change to directory DIR before operation\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003733 " v Verbose"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003734#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003735 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3736 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003737
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003738#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003739 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003740#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003741 "Set or get CPU affinity" \
3742 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003743 " -p Operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003744#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003745 "$ taskset 0x7 ./dgemm_test&\n" \
3746 "$ taskset -p 0x1 $!\n" \
3747 "pid 4790's current affinity mask: 7\n" \
3748 "pid 4790's new affinity mask: 1\n" \
3749 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3750 "pid 6671's current affinity mask: 1\n" \
3751 "pid 6671's new affinity mask: 1\n" \
3752 "$ taskset -p 1\n" \
3753 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003754
Eric Andersen7e9276b2001-02-22 01:15:47 +00003755#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003756 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003757#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003758 "Copy standard input to each FILE, and also to standard output" \
3759 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003760 " -a Append to the given FILEs, do not overwrite\n" \
3761 " -i Ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003762#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003763 "$ echo \"Hello\" | tee /tmp/foo\n" \
3764 "$ cat /tmp/foo\n" \
3765 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003766
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003767#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003768#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003769 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003770#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003771 "Connect to remote telnet server" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003772 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003773 " -a Attempt an automatic login with the USER variable\n" \
3774 " -l USER Attempt an automatic login with the USER argument\n" \
3775 " HOST The official name, alias or the IP address of the\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00003776 " remote host\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003777 " PORT The remote port number to connect to. If it is not\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003778 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003779#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003780#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003781 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003782#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003783 "Connect to remote telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003784#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003785
Eric Andersen08a72202002-09-30 20:52:10 +00003786#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003787 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003788#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003789 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003790 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3791 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003792 "\n -l LOGIN Exec LOGIN on connect" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003793 "\n -f issue_file Display issue_file instead of /etc/issue" \
Denis Vlasenko2450c452007-10-15 22:09:15 +00003794 "\n -K Close connection as soon as login exits" \
3795 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003796 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003797 "\n -p PORT Port to listen to" \
3798 "\n -b ADDR Address to bind to" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003799 "\n -F Run in foreground" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003800 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003801 )
Eric Andersen08a72202002-09-30 20:52:10 +00003802
Eric Andersen7e9276b2001-02-22 01:15:47 +00003803#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003804 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003805#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003806 "Check file types and compares values returning an exit code\n" \
3807 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003808#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003809 "$ test 1 -eq 2\n" \
3810 "$ echo $?\n" \
3811 "1\n" \
3812 "$ test 1 -eq 1\n" \
3813 "$ echo $?\n" \
3814 "0\n" \
3815 "$ [ -d /etc ]\n" \
3816 "$ echo $?\n" \
3817 "0\n" \
3818 "$ [ -d /junk ]\n" \
3819 "$ echo $?\n" \
3820 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003821
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003822#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003823 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003824/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003825/* "[-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 +00003826#define tcpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003827 "Creates TCP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003828 "for incoming connections. For each connection it runs prog." \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003829 "\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003830 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003831 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003832 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003833 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3834 "\n-u user[:group] Change to user/group after bind" \
3835 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003836 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003837 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3838 "\n New connections from this IP address are closed" \
3839 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003840 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003841 "\n-E Do not set up environment variables" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003842 "\n-v Verbose"
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003843
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003844#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003845 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003846#define udpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003847 "Creates UDP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003848 "for incoming packets. For each packet it runs prog\n" \
3849 "(redirecting all further packets with same peer ip:port to it)." \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003850 "\n" \
3851 "\nip IP to listen on. '0' = all" \
3852 "\nport Port to listen on" \
3853 "\nprog [arg] Program to run" \
3854 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3855 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003856 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003857 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003858 "\n-E Do not set up environment variables" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003859 "\n-v Verbose"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003860
Mark Whitley450736c2001-03-02 19:08:50 +00003861#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003862 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003863#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003864 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003865 "\n\nOptions:" \
3866 "\n -l FILE Local FILE" \
3867 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003868 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003869 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003870 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003871 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003872 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003873 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003874 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003875 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003876 )
Eric Andersenc3657422001-11-30 07:54:32 +00003877#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003878 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003879#define time_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003880 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003881 "COMMAND's resource usage information is displayed." \
3882 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003883 " -v Verbose"
Mark Whitley450736c2001-03-02 19:08:50 +00003884
Eric Andersen420b2082002-09-17 22:14:58 +00003885#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003886 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003887#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003888 "Provide a view of process activity in real time.\n" \
3889 "Read the status of all processes from /proc each <seconds>\n" \
3890 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003891
Eric Andersen7e9276b2001-02-22 01:15:47 +00003892#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003893 "[-c] FILE [FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003894#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003895 "Update the last-modified date on the given FILE[s]" \
3896 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003897 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003898#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003899 "$ ls -l /tmp/foo\n" \
3900 "/bin/ls: /tmp/foo: No such file or directory\n" \
3901 "$ touch /tmp/foo\n" \
3902 "$ ls -l /tmp/foo\n" \
3903 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003904
3905#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003906 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003907#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003908 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003909 "standard input, writing to standard output" \
3910 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003911 " -c Take complement of STRING1\n" \
3912 " -d Delete input characters coded STRING1\n" \
3913 " -s Squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003914#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003915 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3916 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003917
Eric Andersen5c58d282001-07-10 16:29:00 +00003918#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003919 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3920 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3921 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003922#define traceroute_full_usage \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003923 "Trace the route to \"host\"" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003924 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003925 " -F Set the don't fragment bit\n" \
3926 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3927 " -l Display the ttl value of the returned packet\n" \
3928 " -d Set SO_DEBUG options to socket\n" \
3929 " -n Print hop addresses numerically rather than symbolically\n" \
3930 " -r Bypass the normal routing tables and send directly to a host\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003931 " -v Verbose\n" \
3932 " -m max_ttl Max time-to-live (max number of hops)\n" \
3933 " -p port# Base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003934 " (default is 33434)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003935 " -q nqueries Number of probes per 'ttl' (default 3)\n" \
3936 " -s src_addr IP address to use as the source address\n" \
3937 " -t tos Type-of-service in probe packets (default 0)\n" \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003938 " -w wait Time in seconds to wait for a response\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003939 " (default 3 sec)\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003940 " -g Loose source route gateway (8 max)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003941
Eric Andersen7e9276b2001-02-22 01:15:47 +00003942#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003943 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003944#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003945 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003946#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003947 "$ true\n" \
3948 "$ echo $?\n" \
3949 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003950
Eric Andersen7e9276b2001-02-22 01:15:47 +00003951#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003952 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003953#define tty_full_usage \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003954 "Print file name of standard input's terminal" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003955 USE_INCLUDE_SUSv2( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003956 "\n\nOptions:\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003957 " -s Print nothing, only return exit status")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003958#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003959 "$ tty\n" \
3960 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003961
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003962#define ttysize_trivial_usage \
3963 "[w] [h]"
3964#define ttysize_full_usage \
3965 "Print dimension(s) of standard input's terminal, on error return 80x25"
3966
Mike Frysinger174808c2005-06-11 01:14:09 +00003967#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003968 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3969 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3970 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3971 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3972 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3973 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003974#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003975 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00003976
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003977#define udhcpc_trivial_usage \
Denis Vlasenkoc82b5102007-07-01 17:05:57 +00003978 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00003979 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003980#define udhcpc_full_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00003981 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003982 " -V,--vendorclass=CLASSID Vendor class identifier" \
3983 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003984 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003985 "\n -c,--clientid=CLIENTID Client identifier" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003986 "\n -C,--clientid-none Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003987 "\n -p,--pidfile=file Create pidfile" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003988 "\n -r,--request=IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003989 "\n -s,--script=file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003990 "\n -t,--retries=N Send up to N request packets" \
3991 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003992 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003993 "\n -f,--foreground Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003994 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003995 "\n -S,--syslog Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003996 "\n -n,--now Exit with failure if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003997 "\n -q,--quit Quit after obtaining lease" \
3998 "\n -R,--release Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00003999 "\n -O,--request-option=OPT Request DHCP option OPT from server" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004000 USE_FEATURE_UDHCP_PORT( \
4001 "\n -P,--client-port N Use port N instead of default 68" \
4002 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004003 USE_FEATURE_UDHCPC_ARPING( \
4004 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004005 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004006 ) \
4007 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004008 " -V CLASSID Vendor class identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004009 "\n -i INTERFACE Interface to use (default: eth0)" \
4010 "\n -H,-h HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004011 "\n -c CLIENTID Client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004012 "\n -C Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004013 "\n -p file Create pidfile" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004014 "\n -r IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004015 "\n -s file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004016 "\n -t N Send up to N request packets" \
4017 "\n -T N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004018 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004019 "\n -f Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004020 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004021 "\n -S Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004022 "\n -n Exit with failure if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004023 "\n -q Quit after obtaining lease" \
4024 "\n -R Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00004025 "\n -O OPT Request DHCP option OPT from server" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004026 USE_FEATURE_UDHCP_PORT( \
4027 "\n -P N Use port N instead of default 68" \
4028 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004029 USE_FEATURE_UDHCPC_ARPING( \
4030 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00004031 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00004032 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00004033
Russ Dill61fb4892002-10-14 21:41:28 +00004034#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004035 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00004036
4037#define udhcpd_full_usage \
Denis Vlasenko9f7b92a2007-08-15 20:03:36 +00004038 "DHCP server" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004039 "\n -f Run in foreground" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004040 "\n -S Log to syslog too" \
4041 USE_FEATURE_UDHCP_PORT( \
4042 "\n -P N Use port N instead of default 67" \
4043 )
Russ Dill61fb4892002-10-14 21:41:28 +00004044
Eric Andersen7e9276b2001-02-22 01:15:47 +00004045#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004046 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004047#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004048 "Unmount file systems" \
4049 "\n\nOptions:\n" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004050 USE_FEATURE_UMOUNT_ALL( \
4051 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab")) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004052 USE_FEATURE_MTAB_SUPPORT( \
4053 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004054 "\n -r Try to remount devices as read-only if mount is busy" \
4055 "\n -l Lazy umount (detach filesystem)" \
4056 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004057 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkob2e578a2008-02-14 12:00:21 +00004058 "\n -d Free loop device if it has been used")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004059#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004060 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004061
4062#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004063 "[-amnrspv]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004064#define uname_full_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004065 "Print system information." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004066 "\n\nOptions:\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004067 " -a Print all\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004068 " -m The machine (hardware) type\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004069 " -n Hostname\n" \
4070 " -r OS release\n" \
4071 " -s OS name (default)\n" \
4072 " -p Processor type\n" \
4073 " -v OS version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004074#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004075 "$ uname -a\n" \
4076 "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 +00004077
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004078#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004079 "[-c] [-f] [name...]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004080#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004081 "Uncompress .Z file[s]" \
4082 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004083 " -c Extract to stdout\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004084 " -f Overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00004085
Denis Vlasenko3952f202007-08-13 14:10:24 +00004086#define unexpand_trivial_usage \
4087 "[-f][-a][-t NUM] [FILE|-]"
4088#define unexpand_full_usage \
4089 "Convert spaces to tabs, writing to standard output." \
4090 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004091 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
4092 "\n -a,--all Convert all blanks" \
4093 "\n -f,--first-only Convert only leading blanks" \
4094 "\n -t,--tabs=N Tabstops every N chars" \
4095 ) \
4096 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
4097 "\n -a Convert all blanks" \
4098 "\n -f Convert only leading blanks" \
4099 "\n -t N Tabstops every N chars" \
4100 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004101
Eric Andersen7e9276b2001-02-22 01:15:47 +00004102#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004103 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004104#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004105 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004106 "(or standard input), writing to OUTPUT (or standard output)" \
4107 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004108 " -c Prefix lines by the number of occurrences\n" \
4109 " -d Only print duplicate lines\n" \
4110 " -u Only print unique lines\n" \
4111 " -f N Skip the first N fields\n" \
4112 " -s N Skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004113#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004114 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4115 "a\n" \
4116 "b\n" \
4117 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004118
4119#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004120 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004121#define unix2dos_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004122 "Convert FILE from unix format to dos format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004123 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004124 "When no file is given, use stdin/stdout." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004125 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004126 " -u Output will be in UNIX format\n" \
4127 " -d Output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004128
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004129#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004130 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004131#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004132 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004133 "\n\nOptions:\n" \
Paul Fox9382b382007-09-07 20:28:25 +00004134 " -l List archive contents (with -q for short form)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004135 " -n Never overwrite existing files (default)\n" \
4136 " -o Overwrite files without prompting\n" \
4137 " -p Send output to stdout\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004138 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004139 " -x Exclude these files\n" \
4140 " -d Extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004141
Eric Andersen7e9276b2001-02-22 01:15:47 +00004142#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004143 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004144#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004145 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004146#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004147 "$ uptime\n" \
4148 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004149
4150#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004151 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004152#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004153 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004154#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004155 "$ usleep 1000000\n" \
4156 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004157
4158#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004159 "[-o outfile] [infile]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004160#define uudecode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004161 "Uudecode a file\n" \
4162 "NB: finds outfile name in uuencoded source unless -o is given"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004163#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004164 "$ uudecode -o busybox busybox.uu\n" \
4165 "$ ls -l busybox\n" \
4166 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004167
4168#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004169 "[-m] [infile] stored_filename"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004170#define uuencode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004171 "Uuencode a file to stdout" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004172 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004173 " -m Use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004174#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004175 "$ uuencode busybox busybox\n" \
4176 "begin 755 busybox\n" \
4177 "<encoded file snipped>\n" \
4178 "$ uudecode busybox busybox > busybox.uu\n" \
4179 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004180
Eric Andersen853c4942003-01-23 05:59:32 +00004181#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004182 "COMMAND [OPTIONS]..."
Eric Andersen853c4942003-01-23 05:59:32 +00004183#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004184 "Create and remove virtual ethernet devices" \
4185 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004186 " add [interface-name] [vlan_id]\n" \
4187 " rem [vlan-name]\n" \
4188 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
4189 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4190 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4191 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00004192
Eric Andersen3f980402001-04-04 17:31:15 +00004193#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004194 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00004195#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004196 "Edit FILE" \
4197 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004198 " -R Read-only - do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00004199
Eric Andersen27f64e12002-06-23 04:24:25 +00004200#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004201 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00004202#define vlock_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004203 "Lock a virtual terminal. A password is required to unlock." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004204 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004205 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00004206
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004207#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004208 "[-n seconds] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004209#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004210 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004211 "\n\nOptions:\n" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004212 " -n Loop period in seconds (default 2)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004213 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004214#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004215 "$ watch date\n" \
4216 "Mon Dec 17 10:31:40 GMT 2000\n" \
4217 "Mon Dec 17 10:31:42 GMT 2000\n" \
4218 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004219
Eric Andersen7e9276b2001-02-22 01:15:47 +00004220#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004221 "[-t N[ms]] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004222#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004223 "Periodically write to watchdog device DEV" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004224 "\n\nOptions:" \
4225 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004226 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004227 "\n" \
4228 "\nUse -t 500ms to specify period in milliseconds"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004229
4230#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004231 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004232#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004233 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004234 "more than one FILE is specified. With no FILE, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004235 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004236 " -c Print the byte counts\n" \
4237 " -l Print the newline counts\n" \
4238 " -L Print the length of the longest line\n" \
4239 " -w Print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004240#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004241 "$ wc /etc/passwd\n" \
4242 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004243
4244#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004245 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004246 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004247 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4248 " [-U|--user-agent agent] url" \
4249 ) \
4250 SKIP_GETOPT_LONG( \
4251 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4252 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00004253#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004254 "Retrieve files via HTTP or FTP" \
4255 "\n\nOptions:\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004256 " -s Spider mode - only check file existence\n" \
4257 " -c Continue retrieval of aborted transfer\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004258 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004259 " -P Set directory prefix to DIR\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004260 " -O Save to filename ('-' for stdout)\n" \
4261 " -U Adjust 'User-Agent' field\n" \
4262 " -Y Use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004263
4264#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004265 "[COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004266#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004267 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004268#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004269 "$ which login\n" \
4270 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004271
Eric Andersen00a6a752002-04-26 23:53:10 +00004272#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004273 "[-a]"
Eric Andersen00a6a752002-04-26 23:53:10 +00004274#define who_full_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004275 "Show who is logged on" \
4276 "\n\nOptions:\n" \
4277 " -a show all"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004278
4279#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004280 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004281#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004282 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004283
4284#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004285 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004286#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004287 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004288 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004289 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
4290 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004291 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004292 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4293 " -x Exit if the size is exceeded\n") \
4294 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
4295 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004296 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004297#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004298 "$ ls | xargs gzip\n" \
4299 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004300
4301#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004302 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004303#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004304 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004305
Eric Andersen7e9276b2001-02-22 01:15:47 +00004306#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004307 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004308#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004309 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004310
Rob Landleyad8071f2005-04-30 03:49:37 +00004311#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004312 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00004313#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004314 "Manage a ZeroConf IPv4 link-local address" \
4315 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004316 " -f Run in foreground\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004317 " -q Quit after address (no daemon)\n" \
4318 " -r 169.254.x.x Request this address first\n" \
4319 " -v Verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00004320
Eric Andersen178de172004-04-06 16:36:20 +00004321#endif /* __BB_USAGE_H__ */