blob: 59e57f3a064564088d6997908ed18ab4b4721c55 [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"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000207#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000208 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000209#define chattr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000210 "Change file attributes on an ext2 fs\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000211 "Modifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000212 " - Remove attributes\n" \
213 " + Add attributes\n" \
214 " = Set attributes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000215 "Attributes:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000216 " A Don't track atime\n" \
217 " a Append mode only\n" \
218 " c Enable compress\n" \
219 " D Write dir contents synchronously\n" \
220 " d Do not backup with dump\n" \
221 " i Cannot be modified (immutable)\n" \
222 " j Write all data to journal first\n" \
223 " s Zero disk storage when deleted\n" \
224 " S Write file contents synchronously\n" \
225 " t Disable tail-merging of partial blocks with other files\n" \
226 " u Allow file to be undeleted\n" \
Denis Vlasenko5dd7ef02006-12-26 03:36:28 +0000227 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000228 " -R Recursively list subdirectories\n" \
229 " -v Set the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000230
Denis Vlasenko49622d72007-03-10 16:58:49 +0000231#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000232 "[OPTIONS] CONTEXT FILE..." \
233 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
234 USE_FEATURE_CHCON_LONG_OPTIONS( \
235 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
236 )
Denis Vlasenko49622d72007-03-10 16:58:49 +0000237#define chcon_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000238 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000239 USE_FEATURE_CHCON_LONG_OPTIONS( \
240 "\n -v,--verbose Verbose" \
241 "\n -c,--changes Report changes made" \
242 "\n -h,--no-dereference Affect symlinks instead of their targets" \
243 "\n -f,--silent,--quiet Suppress most error messages" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000244 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000245 "\n -u,--user=USER Set user USER in the target security context" \
246 "\n -r,--role=ROLE Set role ROLE in the target security context" \
247 "\n -t,--type=TYPE Set type TYPE in the target security context" \
248 "\n -l,--range=RANGE Set range RANGE in the target security context" \
249 "\n -R,--recursive Recurse subdirectories" \
250 ) \
251 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
252 "\n -v Verbose" \
253 "\n -c Report changes made" \
254 "\n -h Affect symlinks instead of their targets" \
255 "\n -f Suppress most error messages" \
256 "\n -u USER Set user USER in the target security context" \
257 "\n -r ROLE Set role ROLE in the target security context" \
258 "\n -t TYPE Set type TYPE in the target security context" \
259 "\n -l RNG Set range RNE in the target security context" \
260 "\n -R Recurse subdirectories" \
261 )
262
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000263
Eric Andersen7e9276b2001-02-22 01:15:47 +0000264#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000265 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000266#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000267 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000268 "symbols +-= and one or more of the letters rwxst" \
269 "\n\nOptions:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000270 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000271 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000272 "\n -c List changed files" \
273 "\n -v List all files" \
274 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000275 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000276#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000277 "$ ls -l /tmp/foo\n" \
278 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
279 "$ chmod u+x /tmp/foo\n" \
280 "$ ls -l /tmp/foo\n" \
281 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
282 "$ chmod 444 /tmp/foo\n" \
283 "$ ls -l /tmp/foo\n" \
284 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000285
Denis Vlasenko081ef792007-03-17 16:38:21 +0000286#define chgrp_trivial_usage \
287 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
288#define chgrp_full_usage \
289 "Change the group membership of each FILE to GROUP" \
290 "\n\nOptions:" \
291 "\n -R Recurse directories" \
292 "\n -h Affect symlinks instead of symlink targets" \
293 "\n -L Traverse all symlinks to directories" \
294 "\n -H Traverse symlinks on command line only" \
295 "\n -P Do not traverse symlinks (default)" \
296 USE_DESKTOP( \
297 "\n -c List changed files" \
298 "\n -v Verbose" \
299 "\n -f Hide errors" \
300 )
301#define chgrp_example_usage \
302 "$ ls -l /tmp/foo\n" \
303 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
304 "$ chgrp root /tmp/foo\n" \
305 "$ ls -l /tmp/foo\n" \
306 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
307
Eric Andersen7e9276b2001-02-22 01:15:47 +0000308#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000309 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000310#define chown_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000311 "Change the owner and/or group of each FILE to OWNER and/or GROUP" \
312 "\n\nOptions:" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000313 "\n -R Recurse directories" \
314 "\n -h Affect symlinks instead of symlink targets" \
315 "\n -L Traverse all symlinks to directories" \
316 "\n -H Traverse symlinks on command line only" \
317 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000318 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000319 "\n -c List changed files" \
320 "\n -v List all files" \
321 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000322 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000323#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000324 "$ ls -l /tmp/foo\n" \
325 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
326 "$ chown root /tmp/foo\n" \
327 "$ ls -l /tmp/foo\n" \
328 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
329 "$ chown root.root /tmp/foo\n" \
330 "ls -l /tmp/foo\n" \
331 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000332
Denis Vlasenkofe544582006-10-03 15:57:40 +0000333#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000334 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
335 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
336 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000337#define chpst_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000338 "Change the process state and run specified program" \
339 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000340 " -u user[:grp] Set uid and gid\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +0000341 " -U user[:grp] Set environment variables UID and GID\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000342 " -e dir Set environment variables as specified by files\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000343 " in the directory: file=1st_line_of_file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000344 " -/ dir Chroot to dir\n" \
345 " -n inc Add inc to nice value\n" \
346 " -m bytes Limit data segment, stack segment, locked physical pages,\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000347 " and total of all segment per process to bytes bytes each\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000348 " -d bytes Limit data segment\n" \
349 " -o n Limit the number of open file descriptors per process to n\n" \
350 " -p n Limit number of processes per uid to n\n" \
351 " -f bytes Limit output file size to bytes bytes\n" \
352 " -c bytes Limit core file size to bytes bytes\n" \
353 " -v Verbose\n" \
354 " -P Run prog in a new process group\n" \
355 " -0 Close standard input\n" \
356 " -1 Close standard output\n" \
357 " -2 Close standard error"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000358#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000359 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000360#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000361 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
362 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000363#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000364 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000365#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000366 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000367#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000368 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000369#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000370 "Set various environment variables as specified by files\n" \
371 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000372#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000373 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
374 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
375 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000376#define softlimit_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000377 "Set soft resource limits, then run prog" \
378 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000379 " -m n Same as -d n -s n -l n -a n\n" \
380 " -d n Limit the data segment per process to n bytes\n" \
381 " -s n Limit the stack segment per process to n bytes\n" \
382 " -l n Limit the locked physical pages per process to n bytes\n" \
383 " -a n Limit the total of all segments per process to n bytes\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000384 " -o n Limit the number of open file descriptors per process to n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000385 " -p n Limit the number of processes per uid to n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000386 "Options controlling file sizes:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000387 " -f n Limit output file sizes to n bytes\n" \
388 " -c n Limit core file sizes to n bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000389 "Efficiency opts:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000390 " -r n Limit the resident set size to n bytes. This limit is not\n" \
391 " enforced unless physical memory is full\n" \
392 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
393 " except that the process receives a SIGXCPU signal after n seconds\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000394 "\n" \
395 "Some options may have no effect on some operating systems\n" \
396 "n may be =, indicating that soft limit should be set equal to hard limit"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000397
Eric Andersen7e9276b2001-02-22 01:15:47 +0000398#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000399 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000400#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000401 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000402#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000403 "$ ls -l /bin/ls\n" \
404 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
405 "# mount /dev/hdc1 /mnt -t minix\n" \
406 "# chroot /mnt\n" \
407 "# ls -l /bin/ls\n" \
408 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000409
Eric Andersen7e9276b2001-02-22 01:15:47 +0000410#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000411 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000412#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000413 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000414
Rob Landley856489b2006-04-18 20:57:28 +0000415#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000416 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000417#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000418 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000419
Eric Andersen7e9276b2001-02-22 01:15:47 +0000420#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000421 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000422#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000423 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000424
Eric Andersen7e9276b2001-02-22 01:15:47 +0000425#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000426 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000427#define cmp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000428 "Compares FILE1 vs stdin if FILE2 is not specified" \
429 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000430 " -l Write the byte numbers (decimal) and values (octal)\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000431 " for all differing bytes\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000432 " -s Quiet"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000433
Rob Landley2acfd7b2005-05-11 23:12:49 +0000434#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000435 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000436#define comm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000437 "Compare FILE1 to FILE2, or to stdin if - is specified" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000438 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000439 " -1 Suppress lines unique to FILE1\n" \
440 " -2 Suppress lines unique to FILE2\n" \
441 " -3 Suppress lines common to both files"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000442
Paul Fox79c142d2005-08-01 16:04:40 +0000443#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000444 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000445#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000446 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000447
Rob Landley69674942006-09-11 00:34:01 +0000448#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000449 "[FILE]...\n" \
450 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000451#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000452 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000453
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000454#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000455 "[OPTION]... [prio] [pid | command [arg]...]"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000456#define chrt_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000457 "manipulate real-time attributes of a process" \
458 "\n\nOptions:\n" \
459 " -p operate on pid\n" \
460 " -r set scheduling policy to SCHED_RR\n" \
461 " -f set scheduling policy to SCHED_FIFO\n" \
462 " -o set scheduling policy to SCHED_OTHER\n" \
463 " -m show min and max priorities"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000464
465#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000466 "$ chrt -r 4 sleep 900; x=$!\n" \
467 "$ chrt -f -p 3 $x\n" \
468 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000469
Eric Andersen7e9276b2001-02-22 01:15:47 +0000470#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000471 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000472#define cp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000473 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000474 "\n\nOptions:" \
475 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000476 USE_SELINUX( \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000477 "\n -c Preserves security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000478 ) \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000479 "\n -d,-P Preserve links" \
480 "\n -H,-L Dereference all symlinks (default)" \
481 "\n -p Preserve file attributes if possible" \
482 "\n -f Force overwrite" \
483 "\n -i Prompt before overwrite" \
484 "\n -R,-r Recurse directories" \
485 "\n -l,-s Create (sym)links"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000486
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000487#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000488 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000489#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000490 "Extract or list files from a cpio archive\n" \
491 "Main operation mode:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000492 " d Make leading directories\n" \
493 " i Extract\n" \
494 " m Preserve mtime\n" \
495 " t List\n" \
496 " v Verbose\n" \
497 " u Unconditional overwrite\n" \
498 " F Input from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000499
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000500#define crond_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +0000501 "-d[#] -c crondir -f -b"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000502#define crond_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000503 " -d [#] -l [#] -S -L logfile -f -b -c dir\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000504 " -d num Debug level\n" \
505 " -l num Log level (8 - default)\n" \
Denis Vlasenko88ce2742007-10-09 18:08:04 +0000506 " -S Log to syslog (default)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000507 " -L file Log to file\n" \
508 " -f Run in foreground\n" \
509 " -b Run in background (default)\n" \
510 " -c dir Working dir"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000511
512#define crontab_trivial_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000513 "[-c DIR] [-u USER] [-ler]|[FILE]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000514#define crontab_full_usage \
Denis Vlasenko069e3472008-02-16 13:17:13 +0000515 " -c Crontab directory" \
516 "\n -u User" \
517 "\n -l List crontab" \
518 "\n -e Edit crontab" \
519 "\n -r Delete crontab" \
520 "\n FILE Replace crontab by FILE ('-': stdin)" \
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000521
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000522#define cryptpw_trivial_usage \
523 "[-a des|md5] [string]"
524#define cryptpw_full_usage \
525 "Outputs crypted string.\n" \
526 "If string isn't supplied on cmdline, reads it from stdin.\n" \
527 "\nOptions:" \
528 "\n -a Algorithm to use (default: md5)"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000529
Eric Andersen7e9276b2001-02-22 01:15:47 +0000530#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000531 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000532#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000533 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000534 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000535 " -b LIST Output only bytes from LIST\n" \
536 " -c LIST Output only characters from LIST\n" \
537 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
538 " -s Output only the lines containing delimiter\n" \
539 " -f N Print only these fields\n" \
540 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000541#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000542 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
543 "Hello\n" \
544 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
545 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000546
Eric Andersen7e9276b2001-02-22 01:15:47 +0000547#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000548 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000549#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000550 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000551 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000552 " -R Outputs RFC-822 compliant date string\n" \
553 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000554 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000555 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
556 " TIMESPEC='date' (or missing) for date only,\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000557 " 'hours', 'minutes', or 'seconds' for date and\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000558 " time to the indicated precision\n" \
559 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000560 ) \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000561 " -s STRING Sets time described by STRING\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000562 " -r FILE Displays the last modification time of FILE\n" \
563 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000564#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000565 "$ date\n" \
566 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000567
Eric Andersen7e9276b2001-02-22 01:15:47 +0000568#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000569 "expression..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000570#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000571 "This is a Tiny RPN calculator that understands the\n" \
572 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
573 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000574 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
575 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000576 "p - Prints the value on the top of the stack, without altering the stack\n" \
577 "f - Prints the entire contents of the stack without altering anything\n" \
578 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
579 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000580#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000581 "$ dc 2 2 + p\n" \
582 "4\n" \
583 "$ dc 8 8 \\* 2 2 + / p\n" \
584 "16\n" \
585 "$ dc 0 1 and p\n" \
586 "0\n" \
587 "$ dc 0 1 or p\n" \
588 "1\n" \
589 "$ echo 72 9 div 8 mul p | dc\n" \
590 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000591
Eric Andersen7e9276b2001-02-22 01:15:47 +0000592#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000593 "[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 +0000594 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000595#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000596 "Copy a file with converting and formatting" \
597 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000598 " if=FILE Read from FILE instead of stdin\n" \
599 " of=FILE Write to FILE instead of stdout\n" \
600 " bs=N Read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000601 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000602 " ibs=N Read N bytes at a time\n") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000603 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000604 " obs=N Write N bytes at a time\n") \
605 " count=N Copy only N input blocks\n" \
606 " skip=N Skip N input blocks\n" \
607 " seek=N Skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000608 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000609 " conv=notrunc Don't truncate output file\n" \
610 " conv=noerror Continue after read errors\n" \
611 " conv=sync Pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000612 "\n" \
613 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
614 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000615#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000616 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
617 "4+0 records in\n" \
618 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000619
Eric Andersen7e9276b2001-02-22 01:15:47 +0000620#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000621 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000622#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000623 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000624
Eric Andersenf349e972001-08-21 16:18:59 +0000625#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000626 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000627#define delgroup_full_usage \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000628 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000629 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000630
631#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000632 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000633#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000634 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000635
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000636#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000637 "mntpnt [-v]" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000638 USE_DEVFSD_FG_NP("[-fg][-np]")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000639#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000640 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000641 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000642 "\n mntpnt The mount point where devfs is mounted" \
643 "\n -v Print the protocol version numbers for devfsd" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000644 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000645 USE_DEVFSD_FG_NP( \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000646 "\n -fg Run in foreground" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000647 "\n -np Exit after parsing the configuration file" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000648 "\n and processing synthetic REGISTER events," \
649 "\n do not poll for events")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000650
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000651/* -k is accepted but ignored for !HUMAN_READABLE,
652 * but we won't mention this (unimportant) */
653#if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
654#define DF_HAS_OPTIONS(x) x
655#else
656#define DF_HAS_OPTIONS(x)
657#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000658#define df_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000659 DF_HAS_OPTIONS("[-") \
660 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
661 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000662#define df_full_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000663 "Print filesystem usage statistics" \
664 DF_HAS_OPTIONS("\n\nOptions:") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000665 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko08294db2007-08-13 12:27:49 +0000666 "\n -h Human readable (e.g. 1K 243M 2G)" \
667 "\n -m 1024*1024 blocks" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000668 "\n -k 1024 blocks" \
669 ) \
670 USE_FEATURE_DF_INODE( \
671 "\n -i Inodes" \
672 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000673#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000674 "$ df\n" \
675 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
676 "/dev/sda3 8690864 8553540 137324 98% /\n" \
677 "/dev/sda1 64216 36364 27852 57% /boot\n" \
678 "$ df /dev/sda3\n" \
679 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
680 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000681
Denis Vlasenko736230e2006-11-20 19:40:36 +0000682#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000683 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000684#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000685 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000686
687#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000688 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000689#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000690 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000691
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000692#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000693 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000694#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000695 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000696 "This diff implementation only supports unified diffs." \
697 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000698 " -a Treat all files as text\n" \
699 " -b Ignore changes in the amount of whitespace\n" \
700 " -d Try hard to find a smaller set of changes\n" \
701 " -i Ignore case differences\n" \
702 " -L Use LABEL instead of the filename in the unified header\n" \
703 " -N Treat absent files as empty\n" \
704 " -q Output only whether files differ\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +0000705 " -r Recursively compare subdirectories\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000706 " -S Start with FILE when comparing directories\n" \
707 " -T Make tabs line up by prefixing a tab when necessary\n" \
708 " -s Report when two files are the same\n" \
709 " -t Expand tabs to spaces in output\n" \
710 " -U Output LINES lines of context\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000711 " -w Ignore all whitespace"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000712
Eric Andersen7e9276b2001-02-22 01:15:47 +0000713#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000714 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000715#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000716 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000717#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000718 "$ dirname /tmp/foo\n" \
719 "/tmp\n" \
720 "$ dirname /tmp/foo/\n" \
721 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000722
Eric Andersen7e9276b2001-02-22 01:15:47 +0000723#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000724 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000725#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000726 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000727 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000728 " -c Clear ring buffer after printing\n" \
729 " -n LEVEL Set console logging level\n" \
730 " -s SIZE Buffer size"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000731
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000732#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000733 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000734#define dnsd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000735 "Small and static DNS server daemon" \
736 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000737 " -c Config filename\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000738 " -t TTL in seconds\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000739 " -p Listening port\n" \
Denis Vlasenkod3bac032007-03-24 12:13:04 +0000740 " -i Listening ip (default all)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000741 " -d Daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000742
Eric Andersen7e9276b2001-02-22 01:15:47 +0000743#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000744 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000745#define dos2unix_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000746 "Convert FILE from dos format to unix format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000747 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000748 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000749 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000750 " -u Output will be in UNIX format\n" \
751 " -d Output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000752
Eric Andersen7e9276b2001-02-22 01:15:47 +0000753#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000754 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000755#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000756 "Install, remove and manage Debian packages" \
757 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000758 " -i Install the package\n" \
759 " -l List of installed packages\n" \
760 " -C Configure an unpackaged package\n" \
761 " -F depends Ignore dependency problems\n" \
762 " -P Purge all files of a package\n" \
763 " -r Remove all but the configuration files for a package\n" \
764 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000765
Eric Andersen7e9276b2001-02-22 01:15:47 +0000766#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000767 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000768#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000769 "Perform actions on Debian packages (.debs)" \
770 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000771 " -c List contents of filesystem tree\n" \
772 " -e Extract control files to [argument] directory\n" \
773 " -f Display control field name starting with [argument]\n" \
774 " -x Extract packages filesystem tree to directory\n" \
775 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000776#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000777 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000778
Eric Andersen7e9276b2001-02-22 01:15:47 +0000779#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000780 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000781#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000782 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000783 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000784 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
785 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000786 " bytes." \
787 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000788 " -a Show sizes of files in addition to directories\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000789 " -H Follow symlinks that are FILE command line args\n" \
790 " -L Follow all symlinks encountered\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000791 " -d N Limit output to directories (and files with -a) of depth < N\n" \
792 " -c Output a grand total\n" \
793 " -l Count sizes many times if hard linked\n" \
794 " -s Display only a total for each argument\n" \
795 " -x Skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000796 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000797 " -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
798 " -m Print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000799 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000800 " -k Print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000801 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000802#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000803 "$ du\n" \
804 "16 ./CVS\n" \
805 "12 ./kernel-patches/CVS\n" \
806 "80 ./kernel-patches\n" \
807 "12 ./tests/CVS\n" \
808 "36 ./tests\n" \
809 "12 ./scripts/CVS\n" \
810 "16 ./scripts\n" \
811 "12 ./docs/CVS\n" \
812 "104 ./docs\n" \
813 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000814
Eric Andersen7e9276b2001-02-22 01:15:47 +0000815#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000816 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000817#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000818 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000819#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000820 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000821
Russ Dill61fb4892002-10-14 21:41:28 +0000822#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000823 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000824#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000825 "Display DHCP leases granted by udhcpd" \
826 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000827 USE_GETOPT_LONG( \
828 " -f,--file=FILE Leases file to load\n" \
829 " -r,--remaining Interpret lease times as time remaining\n" \
830 " -a,--absolute Interpret lease times as expire time" \
831 ) \
832 SKIP_GETOPT_LONG( \
833 " -f FILE Leases file to load\n" \
834 " -r Interpret lease times as time remaining\n" \
835 " -a Interpret lease times as expire time" \
836 )
Russ Dill61fb4892002-10-14 21:41:28 +0000837
Mike Frysinger51a43b42005-09-24 07:11:16 +0000838#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000839 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
840 "[-I inode_buffer_blocks] [-P process_inode_size] " \
841 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
842 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000843#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000844 "Check ext2/ext3 file system" \
845 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000846 " -p Automatic repair (no questions)\n" \
847 " -n Make no changes to the filesystem\n" \
848 " -y Assume 'yes' to all questions\n" \
849 " -c Check for bad blocks and add them to the badblock list\n" \
850 " -f Force checking even if filesystem is marked clean\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000851 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000852 " -b superblock Use alternative superblock\n" \
853 " -B blocksize Force blocksize when looking for superblock\n" \
854 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000855 " -l file Add to badblocks list\n" \
856 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000857
Eric Andersen7e9276b2001-02-22 01:15:47 +0000858#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000859 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000860#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000861 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000862 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000863 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000864 " -n Suppress trailing newline\n" \
865 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
866 " -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000867 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000868#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000869 "$ echo \"Erik is cool\"\n" \
870 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000871 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000872 "Erik\n" \
873 "is\n" \
874 "cool\n" \
875 "$ echo \"Erik\\nis\\ncool\"\n" \
876 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000877
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000878#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000879 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000880#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000881 "Eject specified DEVICE (or default /dev/cdrom)" \
882 "\n\nOptions:\n" \
Bernhard Reutner-Fischerafdad652008-02-08 15:04:00 +0000883 USE_FEATURE_EJECT_SCSI( \
884 " -s scsi device\n" \
885 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000886 " -t Close tray\n" \
887 " -T Open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000888
Rob Landley3b890392006-05-04 20:56:43 +0000889#define ed_trivial_usage ""
890#define ed_full_usage ""
891
Eric Andersen84e229c2001-03-29 22:48:33 +0000892#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000893 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000894#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000895 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000896 "up the specified environment" \
897 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000898 " -, -i Start with an empty environment\n" \
899 " -u Remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000900
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000901#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000902 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000903#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000904 "Send a magic packet to wake up sleeping machines.\n" \
905 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000906 "a hostname with a known 'ethers' entry." \
907 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000908 " -b Send wake-up packet to the broadcast address\n" \
909 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000910 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000911
Denis Vlasenko3952f202007-08-13 14:10:24 +0000912#define expand_trivial_usage \
913 "[-i] [-t NUM] [FILE|-]"
914#define expand_full_usage \
915 "Convert tabs to spaces, writing to standard output." \
916 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000917 USE_FEATURE_EXPAND_LONG_OPTIONS( \
918 "\n -i,--initial Do not convert tabs after non blanks" \
919 "\n -t,--tabs=N Tabstops every N chars" \
920 ) \
921 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
922 "\n -i Do not convert tabs after non blanks" \
923 "\n -t Tabstops every N chars" \
924 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000925
Eric Andersen7e9276b2001-02-22 01:15:47 +0000926#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000927 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000928#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000929 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000930 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000931 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
932 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
933 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
934 " ARG1 <= ARG2\n" \
935 " ARG1 = ARG2\n" \
936 " ARG1 != ARG2\n" \
937 " ARG1 >= ARG2\n" \
938 " ARG1 > ARG2\n" \
939 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
940 " ARG1 - ARG2\n" \
941 " ARG1 * ARG2\n" \
942 " ARG1 / ARG2\n" \
943 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000944 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
945 " match STRING REGEXP Same as STRING : REGEXP\n" \
946 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
947 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
948 " length STRING Length of STRING\n" \
949 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000950 " it is a keyword like 'match' or an\n" \
951 " operator like '/'\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000952 " (EXPRESSION) Value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000953 "Beware that many operators need to be escaped or quoted for shells.\n" \
954 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000955 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000956 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
957 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000958
Mike Frysingerfa69f112005-04-17 07:24:19 +0000959#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000960 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000961#define fakeidentd_full_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000962 "Provide fake ident (auth) service" \
963 "\n\nOptions:" \
964 "\n -f Run in foreground" \
965 "\n -i Inetd mode" \
966 "\n -w Inetd 'wait' mode" \
967 "\n -b ADDR Bind to specified address" \
968 "\n STRING Ident answer string (default is 'nobody')"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000969
Eric Andersen7e9276b2001-02-22 01:15:47 +0000970#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000971 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000972#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000973 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000974#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000975 "$ false\n" \
976 "$ echo $?\n" \
977 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000978
979#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000980 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000981#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000982 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000983#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000984 "$ fbset\n" \
985 "mode \"1024x768-76\"\n" \
986 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
987 " geometry 1024 768 1024 768 16\n" \
988 " timings 12714 128 32 16 4 128 4\n" \
989 " accel false\n" \
990 " rgba 5/11,6/5,5/0,0/0\n" \
991 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000992
Eric Andersen7e9276b2001-02-22 01:15:47 +0000993#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000994 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000995#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000996 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000997
Eric Andersen01c3d402003-07-05 07:51:31 +0000998#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000999 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +00001000#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001001 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001002 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001003 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +00001004
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001005#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001006 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001007#define fdisk_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001008 "Change partition table" \
1009 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001010 " -l List partition table(s)\n" \
1011 " -u Give Start and End in sector (instead of cylinder) units\n" \
1012 " -s PARTITION Give partition size(s) in blocks\n" \
1013 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
1014 " -C CYLINDERS Set the number of cylinders\n" \
1015 " -H HEADS Set the number of heads\n" \
1016 " -S SECTORS Set the number of sectors\n" \
1017 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001018
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00001019#define fetchmail_trivial_usage \
1020 "[-C dir] [-w timeout] [-U user] -P password [-X] [-t] [-z] server[:port]"
1021#define fetchmail_full_usage \
1022 "Fetch content of remote mailbox to local Maildir." \
1023 "\n\nOptions:\n" \
1024 " -C dir Set Maildir location\n" \
1025 " -w timeout Set timeout on network operations\n" \
1026 " -U username Authenticate with specified username\n" \
1027 " -P password Authenticate with specified password\n" \
1028 " -X Use openssl connection helper for secured servers\n" \
1029 " -t Get only headers\n" \
1030 " -z Delete messages on server"
1031
Eric Andersen7e9276b2001-02-22 01:15:47 +00001032#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001033 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001034#define find_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001035 "Search for files in a directory hierarchy. The default PATH is\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001036 "the current directory, default EXPRESSION is '-print'\n" \
1037 "\nEXPRESSION may consist of:" \
1038 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001039 USE_FEATURE_FIND_XDEV( \
1040 "\n -xdev Don't descend directories on other filesystems") \
1041 USE_FEATURE_FIND_MAXDEPTH( \
1042 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1043 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001044 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001045 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001046 USE_FEATURE_FIND_PATH( \
1047 "\n -path PATTERN Path matches PATTERN") \
1048 USE_FEATURE_FIND_REGEX( \
1049 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001050 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001051 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001052 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001053 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001054 "\n or exactly (NNN)") \
1055 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001056 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001057 "\n or exactly (N) days") \
1058 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001059 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001060 "\n or exactly (N) minutes") \
1061 USE_FEATURE_FIND_NEWER( \
1062 "\n -newer FILE Modified time is more recent than FILE's") \
1063 USE_FEATURE_FIND_INUM( \
1064 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001065 USE_FEATURE_FIND_USER( \
1066 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1067 USE_FEATURE_FIND_GROUP( \
1068 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1069 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001070 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001071 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001072 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1073 "\n +/-N: file size is bigger/smaller than N") \
1074 "\n -print Print (default and assumed)" \
1075 USE_FEATURE_FIND_PRINT0( \
1076 "\n -print0 Delimit output with null characters rather than" \
1077 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001078 USE_FEATURE_FIND_CONTEXT ( \
1079 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001080 USE_FEATURE_FIND_EXEC( \
1081 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1082 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001083 USE_FEATURE_FIND_PRUNE( \
1084 "\n -prune Stop traversing current subtree") \
1085 USE_FEATURE_FIND_DELETE( \
1086 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001087 USE_FEATURE_FIND_PAREN( \
1088 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001089
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001090#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001091 "$ find / -name passwd\n" \
1092 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001093
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001094#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001095 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001096#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001097 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001098 "standard output" \
1099 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001100 " -b Count bytes rather than columns\n" \
1101 " -s Break at spaces\n" \
1102 " -w Use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001103
Eric Andersen7e9276b2001-02-22 01:15:47 +00001104#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001105 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001106#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001107 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001108#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001109 "$ free\n" \
1110 " total used free shared buffers\n" \
1111 " Mem: 257628 248724 8904 59644 93124\n" \
1112 " Swap: 128516 8404 120112\n" \
1113 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001114
Eric Andersen7e9276b2001-02-22 01:15:47 +00001115#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001116 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001117#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001118 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001119#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001120 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001121
Mike Frysinger51a43b42005-09-24 07:11:16 +00001122#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001123 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001124#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001125 "Check and repair filesystems" \
1126 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001127 " -A Walk /etc/fstab and check all filesystems\n" \
1128 " -N Don't execute, just show what would be done\n" \
1129 " -P When using -A, check filesystems in parallel\n" \
1130 " -R When using -A, skip the root filesystem\n" \
1131 " -T Don't show title on startup\n" \
Denis Vlasenko0de93752006-12-26 02:51:29 +00001132 " -V Verbose\n" \
1133 " -C n Write status information to specified filedescriptor\n" \
1134 " -t type List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001135
Eric Andersen7e9276b2001-02-22 01:15:47 +00001136#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001137 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001138#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001139 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001140 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001141 " -l List all filenames\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001142 " -r Perform interactive repairs\n" \
1143 " -a Perform automatic repairs\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001144 " -v Verbose\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001145 " -s Output super-block information\n" \
1146 " -m Activate MINIX-like \"mode not cleared\" warnings\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001147 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001148
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001149#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001150 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001151#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001152 "Retrieve a remote file via FTP" \
1153 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001154 USE_GETOPT_LONG( \
1155 " -c,--continue Continue previous transfer\n" \
1156 " -v,--verbose Verbose\n" \
1157 " -u,--username Username\n" \
1158 " -p,--password Password\n" \
1159 " -P,--port Port number" \
1160 ) \
1161 SKIP_GETOPT_LONG( \
1162 " -c Continue previous transfer\n" \
1163 " -v Verbose\n" \
1164 " -u Username\n" \
1165 " -p Password\n" \
1166 " -P Port number" \
1167 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001168
1169#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001170 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001171#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001172 "Store a local file on a remote machine via FTP" \
1173 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001174 USE_GETOPT_LONG( \
1175 " -v,--verbose Verbose\n" \
1176 " -u,--username Username\n" \
1177 " -p,--password Password\n" \
1178 " -P,--port Port number" \
1179 ) \
1180 SKIP_GETOPT_LONG( \
1181 " -v Verbose\n" \
1182 " -u Username\n" \
1183 " -p Password\n" \
1184 " -P Port number" \
1185 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001186
Rob Landleyaa872762005-10-28 13:05:12 +00001187#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001188 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +00001189#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001190 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001191 " -m Show all processes on the same mounted fs\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001192 " -k Kill all processes that match\n" \
1193 " -s Don't print or kill anything\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001194 " -4 When using port/proto only search IPv4 space\n" \
1195 " -6 When using port/proto only search IPv6 space\n" \
1196 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001197
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001198#define getenforce_trivial_usage
1199#define getenforce_full_usage
1200
Eric Andersen7e9276b2001-02-22 01:15:47 +00001201#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001202 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001203#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001204 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001205 USE_GETOPT_LONG( \
1206 " -a,--alternative Allow long options starting with single -\n" \
1207 " -l,--longoptions=longopts Long options to be recognized\n" \
1208 " -n,--name=progname The name under which errors are reported\n" \
1209 " -o,--options=optstring Short options to be recognized\n" \
1210 " -q,--quiet Disable error reporting by getopt(3)\n" \
1211 " -Q,--quiet-output No normal output\n" \
1212 " -s,--shell=shell Set shell quoting conventions\n" \
1213 " -T,--test Test for getopt(1) version\n" \
1214 " -u,--unquoted Don't quote the output" \
1215 ) \
1216 SKIP_GETOPT_LONG( \
1217 " -a Allow long options starting with single -\n" \
1218 " -l longopts Long options to be recognized\n" \
1219 " -n progname The name under which errors are reported\n" \
1220 " -o optstring Short options to be recognized\n" \
1221 " -q Disable error reporting by getopt(3)\n" \
1222 " -Q No normal output\n" \
1223 " -s shell Set shell quoting conventions\n" \
1224 " -T Test for getopt(1) version\n" \
1225 " -u Don't quote the output" \
1226 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001227#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001228 "$ cat getopt.test\n" \
1229 "#!/bin/sh\n" \
1230 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1231 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001232 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001233 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001234 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001235 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001236 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1237 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001238 " -c|--c-long)\n" \
1239 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001240 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1241 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1242 " esac;;\n" \
1243 " --) shift; break;;\n" \
1244 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001245 " esac\n" \
1246 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001247
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001248#define getsebool_trivial_usage \
1249 "-a or getsebool boolean..."
1250#define getsebool_full_usage \
1251 " -a Show all SELinux booleans"
1252
Eric Andersenf349e972001-08-21 16:18:59 +00001253#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001254 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001255#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001256 "Open a tty, prompt for a login name, then invoke /bin/login" \
1257 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001258 " -h Enable hardware (RTS/CTS) flow control\n" \
1259 " -i Do not display /etc/issue before running login\n" \
1260 " -L Local line, so do not do carrier detect\n" \
1261 " -m Get baud rate from modem's CONNECT status message\n" \
1262 " -w Wait for a CR or LF before sending /etc/issue\n" \
1263 " -n Do not prompt the user for a login name\n" \
1264 " -f issue_file Display issue_file instead of /etc/issue\n" \
1265 " -l login_app Invoke login_app instead of /bin/login\n" \
1266 " -t timeout Terminate after timeout if no username is read\n" \
1267 " -I initstring Sets the init string to send before anything else\n" \
1268 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001269
Eric Andersen7e9276b2001-02-22 01:15:47 +00001270#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001271 "[-HhrilLnqvso" \
1272 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001273 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001274 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1275 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001276 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001277#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001278 "Search for PATTERN in each FILE or standard input" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001279 "\n\nOptions:" \
1280 "\n -H Prefix output lines with filename where match was found" \
1281 "\n -h Suppress the prefixing filename on output" \
1282 "\n -r Recurse subdirectories" \
1283 "\n -i Ignore case distinctions" \
1284 "\n -l List names of files that match" \
1285 "\n -L List names of files that do not match" \
1286 "\n -n Print line number with output lines" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001287 "\n -q Quiet. Returns 0 if PATTERN was found, 1 otherwise" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001288 "\n -v Select non-matching lines" \
1289 "\n -s Suppress file open/read error messages" \
1290 "\n -c Only print count of matching lines" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001291 "\n -o Show only the part of a line that matches PATTERN" \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001292 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001293 USE_DESKTOP( \
1294 "\n -w Match whole words only") \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001295 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001296 USE_FEATURE_GREP_EGREP_ALIAS( \
1297 "\n -E PATTERN is an extended regular expression") \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001298 "\n -e PTRN Pattern to match" \
1299 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001300 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001301 "\n -A Print NUM lines of trailing context" \
1302 "\n -B Print NUM lines of leading context" \
1303 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001304
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001305#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001306 "$ grep root /etc/passwd\n" \
1307 "root:x:0:0:root:/root:/bin/bash\n" \
1308 "$ grep ^[rR]oo. /etc/passwd\n" \
1309 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001310
Eric Andersen7e9276b2001-02-22 01:15:47 +00001311#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001312 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001313#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001314 "Uncompress FILE (or standard input if FILE is '-')" \
1315 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001316 " -c Write output to standard output\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001317 " -f Force\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001318 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001319#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001320 "$ ls -la /tmp/BusyBox*\n" \
1321 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1322 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1323 "$ ls -la /tmp/BusyBox*\n" \
1324 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001325
1326#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001327 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001328#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001329 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001330 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001331 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001332 " -c Write output to standard output instead of FILE.gz\n" \
1333 " -d Decompress\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001334 " -f Force"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001335#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001336 "$ ls -la /tmp/busybox*\n" \
1337 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1338 "$ gzip /tmp/busybox.tar\n" \
1339 "$ ls -la /tmp/busybox*\n" \
1340 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001341
1342#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001343 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001344#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001345 "Halt the system" \
Denis Vlasenko1d290d12008-01-24 02:27:30 +00001346 "\n\nOptions:" \
1347 "\n -d Delay interval for halting" \
1348 "\n -n No call to sync()" \
1349 "\n -f Force halt (don't go through init)" \
1350 USE_FEATURE_WTMP( \
1351 "\n -w Only write a wtmp record" \
1352 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001353
Eric Andersen3443bd72003-07-22 07:30:36 +00001354#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001355 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001356#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001357 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001358 "If no device name is specified try to read from stdin.\n\n") \
1359 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001360 " -a Get/set fs readahead\n" \
1361 " -A Set drive read-lookahead flag (0/1)\n" \
1362 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1363 " -B Set Advanced Power Management setting (1-255)\n" \
1364 " -c Get/set IDE 32-bit IO setting\n" \
1365 " -C Check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001366 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001367 " -d Get/set using_dma flag\n") \
1368 " -D Enable/disable drive defect-mgmt\n" \
1369 " -f Flush buffer cache for device on exit\n" \
1370 " -g Display drive geometry\n" \
1371 " -h Display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001372 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001373 " -i Display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001374 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001375 " -I Detailed/current information directly from drive\n") \
1376 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1377 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1378 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1379 " -m Get/set multiple sector count\n" \
1380 " -n Get/set ignore-write-errors flag (0/1)\n" \
1381 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1382 " -P Set drive prefetch count\n" \
1383 " -q Change next setting quietly\n" \
1384 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1385 " -r Get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001386 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001387 " -R Register an IDE interface (DANGEROUS)\n") \
1388 " -S Set standby (spindown) timeout\n" \
1389 " -t Perform device read timings\n" \
1390 " -T Perform cache read timings\n" \
1391 " -u Get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001392 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001393 " -U Un-register an IDE interface (DANGEROUS)\n") \
1394 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1395 " -V Display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001396 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001397 " -w Perform device reset (DANGEROUS)\n") \
1398 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001399 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001400 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1401 " -X Set IDE xfer mode (DANGEROUS)\n" \
1402 " -y Put IDE drive in standby mode\n" \
1403 " -Y Put IDE drive to sleep\n" \
1404 " -Z Disable Seagate auto-powersaving mode\n" \
1405 " -z Re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001406
Eric Andersen7e9276b2001-02-22 01:15:47 +00001407#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001408 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001409#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001410 "Print first 10 lines of each FILE to standard output.\n" \
1411 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001412 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001413 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001414 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001415 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001416 "\n -c NUM Output the first NUM bytes" \
1417 "\n -q Never output headers giving file names" \
1418 "\n -v Always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001419#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001420 "$ head -n 2 /etc/passwd\n" \
1421 "root:x:0:0:root:/root:/bin/bash\n" \
1422 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423
Glenn L McGrath60281112001-11-02 11:39:46 +00001424#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001425 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Glenn L McGrath60281112001-11-02 11:39:46 +00001426#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001427 "Display file(s) or standard input in a user specified format" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001428 "\n\nOptions:" \
1429 "\n -b One-byte octal display" \
1430 "\n -c One-byte character display" \
1431 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1432 "\n -d Two-byte decimal display" \
1433 "\n -e FORMAT STRING" \
1434 "\n -f FORMAT FILE" \
1435 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1436 "\n -o Two-byte octal display" \
1437 "\n -s OFFSET Skip OFFSET bytes" \
1438 "\n -v Display all input data" \
1439 "\n -x Two-byte hexadecimal display" \
1440 USE_FEATURE_HEXDUMP_REVERSE( \
1441 "\n -R Reverse of 'hexdump -Cv'") \
1442
1443#define hd_trivial_usage \
1444 "FILE..."
1445#define hd_full_usage \
1446 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001447
Eric Andersen7e9276b2001-02-22 01:15:47 +00001448#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001449 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001450#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001451 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001452
1453#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001454 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001455#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001456 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001457 "(or FILE with the -F parameter), the host name will be set." \
1458 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001459 " -s Short\n" \
1460 " -i Addresses for the hostname\n" \
1461 " -d DNS domain name\n" \
1462 " -f Fully qualified domain name\n" \
1463 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001464#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001465 "$ hostname\n" \
1466 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001467
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001468#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001469 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001470 " [-p [ip:]port]" \
1471 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001472 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001473 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001474 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001475 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001476 " [-d/-e string]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001477#define httpd_full_usage \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001478 "Listen for incoming HTTP requests" \
1479 "\n\nOptions:" \
1480 "\n -c FILE Configuration file (default httpd.conf)" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001481 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001482 "\n -i Inetd mode" \
1483 "\n -f Do not daemonize" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001484 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001485 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001486 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001487 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001488 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001489 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001490 "\n -m PASS Crypt PASS with md5 algorithm") \
1491 "\n -h HOME Home directory (default .)" \
1492 "\n -e STRING HTML encode STRING" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001493 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001494
Robert Griebl1cd04452002-07-21 16:50:49 +00001495#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001496 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001497 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1498 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001499 " [-f FILE]" \
1500 ) \
1501 SKIP_GETOPT_LONG( \
1502 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1503 )
Robert Griebl1cd04452002-07-21 16:50:49 +00001504#define hwclock_full_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001505 "Query and set a hardware clock (RTC)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001506 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001507 " -r Read hardware clock and print result\n" \
1508 " -s Set the system time from the hardware clock\n" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001509 " -w Set the hardware clock to the system time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001510 " -u The hardware clock is kept in coordinated universal time\n" \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001511 " -l The hardware clock is kept in local time\n" \
1512 " -f FILE Use the specified clock (e.g. /dev/rtc2)"
Robert Griebl1cd04452002-07-21 16:50:49 +00001513
Eric Andersen7e9276b2001-02-22 01:15:47 +00001514#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001515 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001516#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001517 "Print information for USERNAME or the current user" \
1518 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001519 USE_SELINUX( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001520 " -Z Prints only the security context\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001521 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001522 " -g Prints only the group ID\n" \
1523 " -u Prints only the user ID\n" \
1524 " -n Print a name instead of a number\n" \
1525 " -r Prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001526#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001527 "$ id\n" \
1528 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001529
Eric Andersen7e9276b2001-02-22 01:15:47 +00001530#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001531 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001532#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001533 "Configure a network interface" \
1534 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001535 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001536 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001537 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001538 " [del ADDRESS[/PREFIXLEN]]\n") \
1539 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1540 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001541 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001542 " [outfill NN] [keepalive NN]\n") \
1543 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001544 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001545 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001546 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001547 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001548 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001549
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001550#define ifup_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001551 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001552#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001553 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001554 " -a De/configure all interfaces automatically\n" \
1555 " -i FILE Use FILE for interface definitions\n" \
1556 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001557 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001558 " -v Print out what would happen before doing it\n" \
1559 " -m Don't run any mappings\n" \
1560 " -f Force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001561
1562#define ifdown_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001563 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001564#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001565 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001566 " -a De/configure all interfaces automatically\n" \
1567 " -i FILE Use FILE for interface definitions\n" \
1568 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001569 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001570 " -v Print out what would happen before doing it\n" \
1571 " -m Don't run any mappings\n" \
1572 " -f Force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001573
Glenn L McGrath06e95652003-02-09 06:51:14 +00001574#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001575 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001576#define inetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001577 "Listen for network connections and launch programs" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001578 "\n\nOptions:\n" \
Denis Vlasenko886bb0d2007-01-09 23:48:46 +00001579 " -f Run in foreground\n" \
1580 " -q N Set the size of the socket listen queue to N\n" \
1581 " (default: 128)"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001582
Eric Andersen7e9276b2001-02-22 01:15:47 +00001583#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001584 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001585#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001586 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001587#define init_notes_usage \
1588"This version of init is designed to be run only by the kernel.\n" \
1589"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001590"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001591"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001592"runlevels, use sysvinit.\n" \
1593"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001594"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001595"it has the following default behavior:\n" \
1596"\n" \
1597" ::sysinit:/etc/init.d/rcS\n" \
1598" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001599" ::ctrlaltdel:/sbin/reboot\n" \
1600" ::shutdown:/sbin/swapoff -a\n" \
1601" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001602" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001603"\n" \
1604"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1605"\n" \
1606" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001607" tty3::askfirst:/bin/sh\n" \
1608" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001609"\n" \
1610"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1611"\n" \
1612" <id>:<runlevels>:<action>:<process>\n" \
1613"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001614" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001615"\n" \
1616" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1617" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001618" the specified process to run on. The contents of this field are\n" \
1619" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1620" be unique, although if it isn't you may have strange results. If this\n" \
1621" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001622" note that if BusyBox detects that a serial console is in use, then only\n" \
1623" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001624" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001625" stinkin' utmp.\n" \
1626"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001627" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001628"\n" \
1629" The runlevels field is completely ignored.\n" \
1630"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001631" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001632"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001633" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001634" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001635"\n" \
1636" The available actions can be classified into two groups: actions\n" \
1637" that are run only once, and actions that are re-run when the specified\n" \
1638" process exits.\n" \
1639"\n" \
1640" Run only-once actions:\n" \
1641"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001642" 'sysinit' is the first item run on boot. init waits until all\n" \
1643" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001644" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001645" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001646" the specified task completes. 'once' actions are asynchronous,\n" \
1647" therefore, init does not wait for them to complete. 'restart' is\n" \
1648" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001649" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001650" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001651" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001652" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001653" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001654" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001655" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001656" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001657"\n" \
1658" Run repeatedly actions:\n" \
1659"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001660" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001661" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001662" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1663" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001664" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001665" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001666" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001667" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001668"\n" \
1669" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001670" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001671" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001672"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001673" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001674"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001675" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001676"\n" \
1677"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001678"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001679" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001680" #\n" \
1681" ::sysinit:/etc/init.d/rcS\n" \
1682" \n" \
1683" # /bin/sh invocations on selected ttys\n" \
1684" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001685" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001686" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001687" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001688" tty2::askfirst:-/bin/sh\n" \
1689" tty3::askfirst:-/bin/sh\n" \
1690" tty4::askfirst:-/bin/sh\n" \
1691" \n" \
1692" # /sbin/getty invocations for selected ttys\n" \
1693" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001694" tty4::respawn:/sbin/getty 38400 tty4\n" \
1695" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001696" \n" \
1697" \n" \
1698" # Example of how to put a getty on a serial line (for a terminal)\n" \
1699" #\n" \
1700" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1701" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1702" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001703" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001704" #::respawn:/sbin/getty 57600 ttyS2\n" \
1705" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001706" # Stuff to do when restarting the init process\n" \
1707" ::restart:/sbin/init\n" \
1708" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001709" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001710" ::ctrlaltdel:/sbin/reboot\n" \
1711" ::shutdown:/bin/umount -a -r\n" \
1712" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001713
1714#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001715 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001716#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001717 "Load the specified kernel modules into the kernel" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001718 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001719 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001720 " -f Force module to load into the wrong kernel version\n" \
1721 " -k Make module autoclean-able\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001722 " -v Verbose\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001723 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001724 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001725 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001726 " -m Output load map to stdout\n" \
1727 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001728 " -o NAME Set internal module name to NAME\n" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001729 " -x Do not export externs" \
1730 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001731
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001732#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001733 "[-cgmops] [sources] dest|directory"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001734#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001735 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001736 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001737 " -c Copy the file, default\n" \
1738 " -d Create directories\n" \
1739 " -g Set group ownership\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001740 " -m Set permissions\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001741 " -o Set ownership\n" \
1742 " -p Preserve date\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001743 " -s Strip symbol tables" \
1744 USE_SELINUX( \
1745 "\n -Z Set security context of copy" \
1746 )
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001747/* would need to make the " | " optional depending on more than one selected */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001748#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001749 "[OPTIONS] {" \
1750 USE_FEATURE_IP_ADDRESS("address | ") \
1751 USE_FEATURE_IP_ROUTE("route | ") \
1752 USE_FEATURE_IP_LINK("link | ") \
1753 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1754 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001755 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001756#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001757 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001758 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001759 USE_FEATURE_IP_ADDRESS("address | ") \
1760 USE_FEATURE_IP_ROUTE("route | ") \
1761 USE_FEATURE_IP_LINK("link | ") \
1762 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1763 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001764 "}\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001765 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001766
1767#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001768 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001769 " [dev STRING] [to PREFIX] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001770#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001771 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001772 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1773 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001774 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001775 " [broadcast ADDR] [anycast ADDR]\n" \
1776 " [label STRING] [scope SCOPE-ID]\n" \
1777 " SCOPE-ID := [host | link | global | NUMBER]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001778
Eric Andersende4f07e2003-12-11 01:18:07 +00001779#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001780 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001781#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001782 "Calculate IP network settings from a IP address" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001783 "\n\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001784 USE_FEATURE_IPCALC_LONG_OPTIONS( \
1785 "\n -b,--broadcast Display calculated broadcast address" \
1786 "\n -n,--network Display calculated network address" \
1787 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001788 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko03630782007-10-18 11:11:12 +00001789 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1790 "\n -h,--hostname Display first resolved host name" \
1791 "\n -s,--silent Don't ever display error messages" \
1792 ) \
1793 ) \
1794 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
1795 "\n -b Display calculated broadcast address" \
1796 "\n -n Display calculated network address" \
1797 "\n -m Display default netmask for IP" \
1798 USE_FEATURE_IPCALC_FANCY( \
1799 "\n -p Display the prefix for IP/NETMASK" \
1800 "\n -h Display first resolved host name" \
1801 "\n -s Don't ever display error messages" \
1802 ) \
1803 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001804
Rob Landley6eb1e412005-06-20 04:30:36 +00001805#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001806 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001807#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001808 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1809 "segment by a shmkey value. The lower-case options mqs are used\n" \
1810 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001811 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001812 " -[mM] Remove the memory segment after the last detach\n" \
1813 " -[qQ] Remove the message queue\n" \
1814 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001815
1816#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001817 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001818#define ipcs_full_usage \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001819 " -i Show a specific resource\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001820 "Resource specification:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001821 " -m Shared memory segments\n" \
1822 " -q Message queues\n" \
1823 " -s Semaphore arrays\n" \
1824 " -a All (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001825 "Output format:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001826 " -t Time\n" \
1827 " -c Creator\n" \
1828 " -p Pid\n" \
1829 " -l Limits\n" \
1830 " -u Summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001831
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001832#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001833 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001834#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001835 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001836 " dynamic { on | off } |\n" \
1837 " mtu MTU }\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001838 "iplink show [DEVICE]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001839
1840#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001841 "{ list | flush | { add | del | change | append |\n" \
1842 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001843#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001844 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001845 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1846 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001847 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001848 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
1849 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001850
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001851#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001852 "{[list | add | del] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001853#define iprule_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001854 "iprule [list | add | del] SELECTOR ACTION\n" \
1855 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1856 " [dev STRING] [pref NUMBER]\n" \
1857 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1858 " [prohibit | reject | unreachable]\n" \
1859 " [realms [SRCREALM/]DSTREALM]\n" \
1860 " TABLE_ID := [local | main | default | NUMBER]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001861
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001862#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001863 "{ add | change | del | show } [NAME]\n" \
1864 " [mode { ipip | gre | sit }]\n" \
1865 " [remote ADDR] [local ADDR] [ttl TTL]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001866#define iptunnel_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001867 "iptunnel { add | change | del | show } [NAME]\n" \
1868 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1869 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
1870 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001871
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001872#define kbd_mode_trivial_usage \
1873 "[-a|k|s|u]"
1874#define kbd_mode_full_usage \
1875 "Report or set the keyboard mode" \
1876 "\n\nOptions set mode:\n" \
1877 " -a Default (ASCII)\n" \
1878 " -k Medium-raw (keyboard)\n" \
1879 " -s Raw (scancode)\n" \
1880 " -u Unicode (utf-8)"
1881
Eric Andersen7e9276b2001-02-22 01:15:47 +00001882#define kill_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001883 "[-l] [-signal] process-id [process-id...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001884#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001885 "Send a signal (default is TERM) to the specified process(es)" \
1886 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001887 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001888#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001889 "$ ps | grep apache\n" \
1890 "252 root root S [apache]\n" \
1891 "263 www-data www-data S [apache]\n" \
1892 "264 www-data www-data S [apache]\n" \
1893 "265 www-data www-data S [apache]\n" \
1894 "266 www-data www-data S [apache]\n" \
1895 "267 www-data www-data S [apache]\n" \
1896 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001897
1898#define killall_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001899 "[-l] [-q] [-signal] process-name [process-name...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001900#define killall_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\n" \
1904 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001905#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001906 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001907
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001908#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001909 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001910#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001911 "Send a signal (default is TERM) to all processes outside current session" \
1912 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001913 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001914
Mark Whitley6317c4b2001-03-12 22:51:50 +00001915#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001916 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001917#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001918 "Kernel logger" \
1919 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001920 " -c n Sets the default log level of console messages to n\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001921 " -n Run in foreground"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001922
Eric Andersen7e9276b2001-02-22 01:15:47 +00001923#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001924 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001925#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001926 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001927#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001928 "$ length Hello\n" \
1929 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001930
Rob Landley9200e792005-09-15 19:26:59 +00001931#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001932 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001933#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001934 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001935 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001936 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001937 " -E Quit once the end of a file is reached\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001938 " -M,-m Display a status line containing the current line numbers\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001939 " and the percentage through the file\n" \
1940 " -N Prefix line numbers to each line\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001941 " -~ Suppress ~s displayed when input past the end of the file is\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001942 " reached"
Rob Landley9200e792005-09-15 19:26:59 +00001943
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001944#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001945 "personality program [args...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001946#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001947 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001948 " linux32 Set 32bit uname emulation\n" \
1949 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001950
Eric Andersen7e9276b2001-02-22 01:15:47 +00001951#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001952 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001953#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001954 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1955 "You may use '--' to indicate that all following arguments are non-options." \
1956 "\n\nOptions:\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00001957 " -s Make symlinks instead of hardlinks\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001958 " -f Remove existing destination files\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001959 " -n Don't dereference symlinks - treat like normal file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001960 " -b Make a backup of the target (if exists) before link operation\n" \
1961 " -S suf Use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001962#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001963 "$ ln -s BusyBox /tmp/ls\n" \
1964 "$ ls -l /tmp/ls\n" \
1965 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001966
Denis Vlasenkob042bd92007-09-26 18:01:32 +00001967#define load_policy_trivial_usage
1968
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00001969#define load_policy_full_usage
1970
Eric Andersen7e9276b2001-02-22 01:15:47 +00001971#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001972 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001973#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001974 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001975#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001976 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001977
1978#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001979 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001980#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001981 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001982#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001983 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001984
1985#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001986 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001987#define logger_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001988 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001989 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001990 " -s Log to stderr as well as the system log\n" \
1991 " -t TAG Log using the specified tag (defaults to user name)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001992 " -p PRIO Enter the message with the specified priority.\n" \
1993 " This may be numerical or a 'facility.level' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001994#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001995 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001996
Robert Griebl1fca5582002-06-04 20:45:46 +00001997#define login_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001998 "[OPTION]... [username] [ENV=VAR...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00001999#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002000 "Begin a new session on the system" \
2001 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002002 " -f Do not authenticate (user already authenticated)\n" \
2003 " -h Name of the remote host for this login\n" \
2004 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00002005
Eric Andersen7e9276b2001-02-22 01:15:47 +00002006#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002007 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002008#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002009 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002010#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002011 "$ logname\n" \
2012 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002013
Mark Whitley6317c4b2001-03-12 22:51:50 +00002014#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002015 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00002016#define logread_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002017 "Show the messages from syslogd (using circular buffer)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002018 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002019 " -f Output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00002020
Matt Kraai83788da2002-03-20 17:38:37 +00002021#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002022 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2023 " losetup -d LOOPDEV - disassociate\n" \
2024 " losetup [-f] - show"
Matt Kraai83788da2002-03-20 17:38:37 +00002025#define losetup_full_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002026 "Options:\n" \
2027 " -o OFS Start OFS bytes into FILE\n" \
2028 " -f Show first free loop device"
Rob Landley1d589b22005-11-29 23:47:10 +00002029#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002030 "No arguments will display all current associations.\n" \
2031 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002032 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002033 "and filename of the file the loop device is currently bound to.\n\n" \
2034 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002035 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2036 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002037
Eric Andersen7e9276b2001-02-22 01:15:47 +00002038#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002039 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002040 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002041 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2042 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2043 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2044 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2045 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2046 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002047#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002048 "List directory contents" \
2049 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002050 "\n -1 List files in a single column" \
2051 "\n -A Do not list implied . and .." \
2052 "\n -a Do not hide entries starting with ." \
2053 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002054 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002055 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002056 USE_FEATURE_LS_COLOR( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002057 "\n --color[={always,never,auto}] Control coloring") \
2058 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002059 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002060 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002061 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002062 "\n -F Append indicator (one of */=@|) to entries") \
2063 "\n -i List the i-node for each file" \
2064 "\n -l Use a long listing format" \
2065 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002066 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002067 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002068 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002069 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002070 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002071 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002072 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002073 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002074 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002075 "\n -S Sort the listing by file size") \
2076 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002077 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002078 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002079 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002080 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002081 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002082 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002083 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002084 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002085 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002086 "\n -w NUM Assume the terminal is NUM columns wide") \
2087 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002088 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002089 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002090 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002091 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002092 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002093 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002094 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002095 "\n -K Print security context in long format") \
2096 USE_SELINUX( \
2097 "\n -Z Print security context and permission")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002098
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002099#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002100 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002101#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002102 "List file attributes on an ext2 fs" \
2103 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002104 " -R Recursively list subdirectories\n" \
2105 " -a Do not hide entries starting with .\n" \
2106 " -d List directory entries instead of contents\n" \
2107 " -l Print long flag names\n" \
2108 " -v List the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002109
Eric Andersen7e9276b2001-02-22 01:15:47 +00002110#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002111 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002112#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002113 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002114
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002115#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002116#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002117 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002118#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002119 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002120 "TYPEs include:\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002121 " b: Make a block (buffered) device\n" \
2122 " c or u: Make a character (un-buffered) device\n" \
2123 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
2124 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002125 "FIRST specifies the number appended to NAME to create the first device.\n" \
2126 "LAST specifies the number of the last item that should be created\n" \
2127 "If 's' is the last argument, the base device is created as well.\n\n" \
2128 "For example:\n" \
2129 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2130 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002131#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002132 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2133 "[creates ttyS2-ttyS63]\n" \
2134 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2135 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002136#endif
2137
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002138#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002139#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002140 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00002141#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002142 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002143 "Device table entries take the form of:\n" \
2144 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002145 "Where name is the file name, type can be one of:\n" \
2146 " f A regular file\n" \
2147 " d Directory\n" \
2148 " c Character special device file\n" \
2149 " b Block special device file\n" \
2150 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002151 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002152 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2153 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002154#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002155 "For example:\n" \
2156 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2157 "/dev d 755 0 0 - - - - -\n" \
2158 "/dev/console c 666 0 0 5 1 - - -\n" \
2159 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2160 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2161 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2162 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2163 "Will Produce:\n" \
2164 "/dev\n" \
2165 "/dev/console\n" \
2166 "/dev/null\n" \
2167 "/dev/zero\n" \
2168 "/dev/hda\n" \
2169 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002170#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002171
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002172#define matchpathcon_trivial_usage \
2173 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2174#define matchpathcon_full_usage \
2175 " -n Do not display path" \
2176 "\n -N Do not use translations" \
2177 "\n -f Use alternate file_context file" \
2178 "\n -p Use prefix to speed translations" \
2179 "\n -V Verify file context on disk matches defaults"
2180
Eric Andersen7e9276b2001-02-22 01:15:47 +00002181#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002182 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002183 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002184#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002185 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2186 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002187 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002188 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002189 " -c Check MD5 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002190 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002191 " -s Don't output anything, status code shows success\n" \
2192 " -w Warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002193#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002194 "$ md5sum < busybox\n" \
2195 "6fd11e98b98a58f64ff3398d7b324003\n" \
2196 "$ md5sum busybox\n" \
2197 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2198 "$ md5sum -c -\n" \
2199 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2200 "busybox: OK\n" \
2201 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002202
Rob Landley70f7ef72005-12-13 08:21:33 +00002203#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002204 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002205#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002206 " -s Scan /sys and populate /dev during system boot\n\n" \
2207 "Called with no options (via hotplug) it uses environment variables\n" \
2208 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00002209#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002210 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002211 "The mdev config file contains lines that look like:\n" \
2212 " hd[a-z][0-9]* 0:3 660\n\n" \
2213 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002214 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002215 "Optionally, that can be followed (on the same line) by a special character\n" \
2216 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002217 "device(s). The environment variable $MDEV indicates the active device node\n" \
2218 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002219 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2220 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002221 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002222 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002223 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002224 "Config file parsing stops on the first matching line. If no config\n" \
2225 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002226 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002227 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002228
Glenn L McGrath061c9002002-09-16 04:21:46 +00002229#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002230 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002231#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002232 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002233 " y Allow write access to your terminal\n" \
2234 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002235
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002236#define microcom_trivial_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002237 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002238#define microcom_full_usage \
Denis Vlasenkod56e3cc2008-02-09 11:37:21 +00002239 "Copy bytes for stdin to TTY and from TTY to stdout" \
2240 "\n\nOptions:" \
Mike Frysinger1e47c422008-02-15 01:34:14 +00002241 "\n -d Wait up to DELAY ms for TTY output before sending every" \
2242 "\n next byte to it" \
2243 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
2244 "\n -s Set serial line to SPEED" \
2245 "\n -X Disable special meaning of NUL and Ctrl-X from stdin"
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002246
Eric Andersen7e9276b2001-02-22 01:15:47 +00002247#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002248 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002249#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002250 "Create the DIRECTORY(ies) if they do not already exist" \
2251 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002252 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002253 " -p No error if existing, make parent directories as needed" \
2254 USE_SELINUX( \
2255 "\n -Z Set security context" \
2256 )
2257
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002258#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002259 "$ mkdir /tmp/foo\n" \
2260 "$ mkdir /tmp/foo\n" \
2261 "/tmp/foo: File exists\n" \
2262 "$ mkdir /tmp/foo/bar/baz\n" \
2263 "/tmp/foo/bar/baz: No such file or directory\n" \
2264 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002265
Mike Frysinger6447ac02005-06-11 05:29:40 +00002266#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002267 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2268 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2269 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2270 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2271 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2272 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002273#define mke2fs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002274 " -b size Block size in bytes\n" \
2275 " -c Check for bad blocks before creating\n" \
2276 " -E opts Set extended options\n" \
2277 " -f size Fragment size in bytes\n" \
2278 " -F Force (ignore sanity checks)\n" \
2279 " -g num Number of blocks in a block group\n" \
2280 " -i ratio The bytes/inode ratio\n" \
2281 " -j Create a journal (ext3)\n" \
2282 " -J opts Set journal options (size/device)\n" \
2283 " -l file Read bad blocks list from file\n" \
2284 " -L lbl Set the volume label\n" \
2285 " -m percent Percent of fs blocks to reserve for admin\n" \
2286 " -M dir Set last mounted directory\n" \
2287 " -n Do not actually create anything\n" \
2288 " -N num Number of inodes to create\n" \
2289 " -o os Set the 'creator os' field\n" \
2290 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002291 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002292 " -r rev Set filesystem revision\n" \
2293 " -S Write superblock and group descriptors only\n" \
2294 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002295 " -v Verbose"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002296
Eric Andersen7e9276b2001-02-22 01:15:47 +00002297#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002298 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002299#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002300 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002301 "\n\nOptions:\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002302 " -m Create the pipe using the specified mode (default a=rw)" \
2303 USE_SELINUX( \
2304 "\n -Z Set security context" \
2305 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002306
Eric Andersen7e9276b2001-02-22 01:15:47 +00002307#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002308 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002309#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002310 "Make a MINIX filesystem" \
2311 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002312 " -c Check device for bad blocks\n" \
2313 " -n [14|30] Maximum length of filenames\n" \
2314 " -i INODES Number of inodes for the filesystem\n" \
2315 " -l FILENAME Read bad blocks list from FILENAME\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002316 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002317
Eric Andersen7e9276b2001-02-22 01:15:47 +00002318#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002319 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002320#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002321 "Create a special file (block, character, or pipe)" \
2322 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002323 " -m Create the special file using the specified mode (default a=rw)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002324 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002325 " b: Make a block (buffered) device\n" \
2326 " c or u: Make a character (un-buffered) device\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002327 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes" \
2328 USE_SELINUX( \
2329 "\n -Z Set security context" \
2330 )
2331
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002332#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002333 "$ mknod /dev/fd0 b 2 0\n" \
2334 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002335
Eric Andersen7e9276b2001-02-22 01:15:47 +00002336#define mkswap_trivial_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002337 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002338#define mkswap_full_usage \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00002339 "Prepare block device to be used as swap partition"
2340#if 0
2341 "[-c] [-v0|-v1] DEVICE [BLOCKS]"
2342 "\n\nOptions:"
2343 "\n -c Check for readability"
2344 "\n -v0 Make swap version 0 (max 128M)"
2345 "\n -v1 Make swap version 1 (default for kernels > 2.1.117)"
2346 "\n BLOCKS Number of blocks to use (default is entire partition)"
2347#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002348
Eric Andersen7e9276b2001-02-22 01:15:47 +00002349#define mktemp_trivial_usage \
Denis Vlasenko761e1d12008-02-09 06:29:32 +00002350 "[-dt] [-p DIR] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002351#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002352 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002353 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2354 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002355 " -d Make a directory instead of a file\n" \
Denis Vlasenko65581f32008-02-09 06:26:53 +00002356 /* " -q Fail silently if an error occurs\n" - we ignore it */ \
2357 " -t Generate a path rooted in temporary directory\n" \
2358 " -p DIR Use DIR as a temporary directory (implies -t)\n" \
2359 "\n" \
2360 "For -t or -p, directory is chosen as follows:\n" \
2361 "$TMPDIR if set, else -p DIR, else /tmp"
2362
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002363#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002364 "$ mktemp /tmp/temp.XXXXXX\n" \
2365 "/tmp/temp.mWiLjM\n" \
2366 "$ ls -la /tmp/temp.mWiLjM\n" \
2367 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002368
Eric Andersen8d79ce82001-07-22 23:00:15 +00002369#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002370 "[-knqrsv] MODULE [symbol=value...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002371#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002372 "Options:\n" \
2373 " -k Make module autoclean-able\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002374 " -n Dry run\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002375 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002376 " -r Remove module (stacks) or do autoclean\n" \
2377 " -s Report via syslog instead of stderr\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002378 " -v Verbose"
Rob Landley9c32a152005-12-11 20:12:24 +00002379#define modprobe_notes_usage \
2380"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2381"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2382"pass each module it loads.\n" \
2383"\n" \
2384"The configuration file is searched (in order) amongst:\n" \
2385"\n" \
2386" /etc/modprobe.conf (2.6 only)\n" \
2387" /etc/modules.conf\n" \
2388" /etc/conf.modules (deprecated)\n" \
2389"\n" \
2390"They all have the same syntax (see below). If none is present, it is\n" \
2391"_not_ an error; each loaded module is then expected to load without\n" \
2392"options. Once a file is found, the others are tested for.\n" \
2393"\n" \
2394"/etc/modules.conf entry format:\n" \
2395"\n" \
2396" alias <alias_name> <mod_name>\n" \
2397" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002398" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002399" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2400" This makes it also possible to use a different set of options (below) for\n" \
2401" the module and the alias.\n" \
2402" A module can be aliased more than once.\n" \
2403"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002404" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002405" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2406" the \"symbol=value\" pairs as option to that module.\n" \
2407"\n" \
2408"Sample /etc/modules.conf file:\n" \
2409"\n" \
2410" options tulip irq=3\n" \
2411" alias tulip tulip2\n" \
2412" options tulip2 irq=4 io=0x308\n" \
2413"\n" \
2414"Other functionality offered by 'classic' modprobe is not available in\n" \
2415"this implementation.\n" \
2416"\n" \
2417"If module options are present both in the config file, and on the command line,\n" \
2418"then the options from the command line will be passed to the module _after_\n" \
2419"the options from the config file. That way, you can have defaults in the config\n" \
2420"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002421#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002422 "(with the above /etc/modules.conf):\n\n" \
2423 "$ modprobe tulip\n" \
2424 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2425 "$ modprobe tulip irq=5\n" \
2426 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2427 "$ modprobe tulip2\n" \
2428 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2429 " which are the default for alias 'tulip2'\n\n" \
2430 "$ modprobe tulip2 irq=8\n" \
2431 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2432 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2433 " from the command line\n\n" \
2434 "$ modprobe tulip2 irq=2 io=0x210\n" \
2435 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2436 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2437 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002438
Eric Andersen7e9276b2001-02-22 01:15:47 +00002439#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002440 "[FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002441#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002442 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002443#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002444 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002445
Eric Andersen7e9276b2001-02-22 01:15:47 +00002446#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002447 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002448#define mount_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002449 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2450 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002451 " -a Mount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002452 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002453 " -f Update /etc/mtab, but don't mount\n" \
2454 " -n Don't update /etc/mtab\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002455 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002456 " -r Read-only mount\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002457 " -t fs-type Filesystem type\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002458 " -w Read-write mount (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002459 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002460 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002461 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002462 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002463 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002464 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002465 " [a]sync Writes are asynchronous / synchronous\n" \
2466 " [no]atime Disable / enable updates to inode access times\n" \
2467 " [no]diratime Disable / enable atime updates to directories\n" \
2468 " [no]dev Allow use of special device files / disallow them\n" \
2469 " [no]exec Allow use of executable files / disallow them\n" \
2470 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2471 " [r]shared Convert [recursively] to a shared subtree\n" \
2472 " [r]slave Convert [recursively] to a slave subtree\n" \
2473 " [r]private Convert [recursively] to a private subtree\n" \
2474 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2475 " bind Bind a directory to an additional location\n" \
2476 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002477 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002478 " remount Remount a mounted filesystem, changing its flags\n" \
2479 " ro/rw Mount for read-only / read-write\n" \
2480 "\n" \
2481 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002482 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002483#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002484 "$ mount\n" \
2485 "/dev/hda3 on / type minix (rw)\n" \
2486 "proc on /proc type proc (rw)\n" \
2487 "devpts on /dev/pts type devpts (rw)\n" \
2488 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2489 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2490 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002491#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002492 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002493
Rob Landleyd00b3a52005-08-20 05:07:08 +00002494#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002495 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002496#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002497 "mountpoint checks if the directory is a mountpoint" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002498 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002499 " -q Quiet\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002500 " -d Print major/minor device number of the filesystem\n" \
2501 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002502#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002503 "$ mountpoint /proc\n" \
2504 "/proc is not a mountpoint\n" \
2505 "$ mountpoint /sys\n" \
2506 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002507
Eric Andersen7e9276b2001-02-22 01:15:47 +00002508#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002509 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002510#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002511 "Control magnetic tape drive operation\n" \
2512 "\nAvailable Opcodes:\n\n" \
2513 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2514 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2515 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2516 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002517
Eric Andersen7e9276b2001-02-22 01:15:47 +00002518#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002519 "[OPTION]... SOURCE DEST\n" \
2520 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002521#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002522 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2523 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002524 " -f Don't prompt before overwriting\n" \
2525 " -i Interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002526#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002527 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002528
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002529#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002530 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002531#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002532 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002533 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002534 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2535 " -s Use syslog (LOCAL0 facility)\n" \
2536 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002537#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002538 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2539 " or\n" \
2540 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002541
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002542#if !ENABLE_DESKTOP
2543
Rob Landley1cca9482006-07-10 19:45:20 +00002544#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002545#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002546#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002547#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002548#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002549
Eric Andersen7e9276b2001-02-22 01:15:47 +00002550#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002551 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002552 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002553#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002554 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002555 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002556 USE_NC_EXTRA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002557 "\n -e Exec rest of command line after connect" \
2558 "\n -i SECS Delay interval for lines sent" \
2559 "\n -w SECS Timeout for connect" \
Denis Vlasenko5d687242007-01-12 20:59:31 +00002560 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002561 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002562 USE_NC_SERVER( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002563 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002564 USE_NC_EXTRA( \
2565 "\n (use -l twice with -e for persistent server)") \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002566 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002567 )
2568
Rob Landley1cca9482006-07-10 19:45:20 +00002569#define nc_notes_usage "" \
2570 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002571 "To use netcat as a terminal emulator on a serial port:\n\n" \
2572 "$ stty 115200 -F /dev/ttyS0\n" \
2573 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2574 )
Rob Landley1cca9482006-07-10 19:45:20 +00002575
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002576#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002577 "$ nc foobar.somedomain.com 25\n" \
2578 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2579 "help\n" \
2580 "214-Commands supported:\n" \
2581 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2582 "214 NOOP QUIT RSET HELP\n" \
2583 "quit\n" \
2584 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002585
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002586#else /* DESKTOP nc - much more compatible with nc 1.10 */
2587
2588#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002589 "[-options] hostname port - connect" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002590 USE_NC_SERVER("\nnc [-options] -l -p port [hostname] [port] - listen")
2591#define nc_full_usage \
2592 USE_NC_SERVER( \
2593 "-l Listen mode, for inbound connects\n" \
2594 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002595 "-n Don't do DNS resolution" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002596 "\n-s addr Local address" \
2597 "\n-p port Local port" \
2598 "\n-u UDP mode" \
2599 "\n-v Verbose (cumulative: -vv)" \
2600 "\n-w secs Timeout for connects and final net reads" \
2601 USE_NC_EXTRA( \
2602 "\n-i sec Delay interval for lines sent" /* ", ports scanned" */ \
2603 "\n-o file Hex dump of traffic" \
2604 "\n-z Zero-I/O mode (scanning)" \
2605 ) \
2606 "\n-e prog [args] Program to exec after connect (must be last)" \
2607/* "\n-r Randomize local and remote ports" */
2608/* "\n-g gateway Source-routing hop point[s], up to 8" */
2609/* "\n-G num Source-routing pointer: 4, 8, 12, ..." */
2610/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2611
2612#endif
2613
Eric Andersen1552ff72001-10-31 11:07:12 +00002614#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002615 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002616#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002617 "Display networking information" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002618 "\n\nOptions:" \
2619 "\n -l Display listening server sockets" \
2620 "\n -a Display all sockets (default: connected)" \
2621 "\n -e Display other/more information" \
2622 "\n -n Don't resolve names" \
2623 "\n -t Tcp sockets" \
2624 "\n -u Udp sockets" \
2625 "\n -w Raw sockets" \
2626 "\n -x Unix sockets" \
2627 "\n -r Display routing table" \
2628 USE_FEATURE_NETSTAT_WIDE( \
2629 "\n -W Display with no column truncation" \
2630 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002631
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002632#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002633 "[-n ADJUST] [COMMAND [ARG]...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002634#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002635 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002636 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002637 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002638
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002639#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002640 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002641#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002642 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002643 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002644 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002645 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002646 "%[niface] Monitor network interface 'iface'\n" \
2647 "%m Monitor allocated memory\n" \
2648 "%[mf] Monitor free memory\n" \
2649 "%[mt] Monitor total memory\n" \
2650 "%s Monitor allocated swap\n" \
2651 "%f Monitor number of used file descriptors\n" \
2652 "%Ni Monitor total/specific IRQ rate\n" \
2653 "%x Monitor context switch rate\n" \
2654 "%p Monitor forks\n" \
2655 "%[pn] Monitor # of processes\n" \
2656 "%b Monitor block io\n" \
2657 "%Nt Show time (with N decimal points)\n" \
2658 "%Nd Milliseconds between updates (default=1000)\n" \
2659 "%r Print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002660#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002661 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002662
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002663#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002664 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002665#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002666 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002667#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002668 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002669
Eric Andersen7e9276b2001-02-22 01:15:47 +00002670#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002671 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002672#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002673 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002674 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002675#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002676 "$ nslookup localhost\n" \
2677 "Server: default\n" \
2678 "Address: default\n" \
2679 "\n" \
2680 "Name: debian\n" \
2681 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002682
Glenn L McGrath60281112001-11-02 11:39:46 +00002683#define od_trivial_usage \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002684 "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002685#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002686 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenko97bd0e02008-02-08 15:41:01 +00002687 "to standard output. With no FILE or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002688
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002689#define openvt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002690 "VTNUM COMMAND [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002691#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002692 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002693#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002694 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002695
Eric Andersen27f64e12002-06-23 04:24:25 +00002696#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002697 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002698#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002699 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002700 "changes the password for the current user." \
2701 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002702 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002703 " (choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002704 " -d Delete the password for the specified user account\n" \
2705 " -l Locks (disables) the specified user account\n" \
2706 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002707
Denis Vlasenko21d10142007-07-20 21:28:41 +00002708#define chpasswd_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002709 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko21d10142007-07-20 21:28:41 +00002710#define chpasswd_full_usage \
2711 "Read user:password information from stdin\n" \
2712 "and update /etc/passwd accordingly." \
2713 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002714 USE_GETOPT_LONG( \
2715 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2716 "\n -m,--md5 Use MD5 encryption instead of DES" \
2717 ) \
2718 SKIP_GETOPT_LONG( \
2719 "\n -e Supplied passwords are in encrypted form" \
2720 "\n -m Use MD5 encryption instead of DES" \
2721 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002722
Glenn L McGrath655d8142003-06-22 15:32:41 +00002723#define patch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002724 "[-p num] [-i diff]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002725#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002726 " -p NUM Strip NUM leading components from file names\n" \
2727 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002728#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002729 "$ patch -p1 < example.diff\n" \
2730 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002731
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002732#define pgrep_trivial_usage \
2733 "[-flnovx] pattern"
2734#define pgrep_full_usage \
2735 "Display process(es) selected by regex pattern" \
2736 "\n\nOptions:\n" \
2737 " -l Show command name too\n" \
2738 " -f Match against entire command line\n" \
2739 " -n Signal the newest process only\n" \
2740 " -o Signal the oldest process only\n" \
2741 " -v Negate the matching\n" \
2742 " -x Match whole name (not substring)"
2743
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002744#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2745#define USAGE_PIDOF "Options:"
2746#else
Denis Vlasenko765996a2006-12-24 16:59:27 +00002747#define USAGE_PIDOF "\nThis version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002748#endif
2749
Eric Andersen221b2ea2001-07-31 19:06:07 +00002750#define pidof_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002751 "process-name [OPTION] [process-name...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002752
Eric Andersen221b2ea2001-07-31 19:06:07 +00002753#define pidof_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002754 "List the PIDs of all processes with names that match the\n" \
2755 "names on the command line\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002756 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002757 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002758 "\n -s Display only a single PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002759 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenko198bada2007-06-23 14:56:43 +00002760 "\n -o PID Omit given pid") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002761 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002762 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002763#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002764 "$ pidof init\n" \
2765 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002766 USE_FEATURE_PIDOF_OMIT( \
2767 "$ pidof /bin/sh\n20351 5973 5950\n") \
2768 USE_FEATURE_PIDOF_OMIT( \
2769 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002770
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002771#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002772#define ping_trivial_usage \
2773 "host"
2774#define ping_full_usage \
2775 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002776#define ping6_trivial_usage \
2777 "host"
2778#define ping6_full_usage \
2779 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002780#else
2781#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002782 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002783#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002784 "Send ICMP ECHO_REQUEST packets to network hosts" \
2785 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002786 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2787 " -c CNT Send only CNT pings\n" \
2788 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2789 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002790 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002791 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002792#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002793 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002794#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002795 "Send ICMP ECHO_REQUEST packets to network hosts" \
2796 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002797 " -c CNT Send only CNT pings\n" \
2798 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2799 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002800 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002801 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002802#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002803#define ping_example_usage \
2804 "$ ping localhost\n" \
2805 "PING slag (127.0.0.1): 56 data bytes\n" \
2806 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2807 "\n" \
2808 "--- debian ping statistics ---\n" \
2809 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2810 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002811#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002812 "$ ping6 ip6-localhost\n" \
2813 "PING ip6-localhost (::1): 56 data bytes\n" \
2814 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2815 "\n" \
2816 "--- ip6-localhost ping statistics ---\n" \
2817 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2818 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002819
Eric Andersen7e9276b2001-02-22 01:15:47 +00002820#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002821 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002822#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002823 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002824 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002825
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002826#define pkill_trivial_usage \
2827 "[-l] | [-fnovx] [-signal] pattern"
2828#define pkill_full_usage \
2829 "Send a signal to process(es) selected by regex pattern" \
2830 "\n\nOptions:\n" \
2831 " -l List all signals\n" \
2832 " -f Match against entire command line\n" \
2833 " -n Signal the newest process only\n" \
2834 " -o Signal the oldest process only\n" \
2835 " -v Negate the matching\n" \
2836 " -x Match whole name (not substring)"
2837
Eric Andersen7e9276b2001-02-22 01:15:47 +00002838#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002839 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002840#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002841 "Halt and shut off power" \
2842 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002843 " -d Delay interval for halting\n" \
2844 " -n No call to sync()\n" \
2845 " -f Force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002846
Mike Frysinger95d3c452005-04-21 23:29:24 +00002847#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002848 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002849#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002850 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002851 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002852
Eric Andersen7e9276b2001-02-22 01:15:47 +00002853#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002854 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002855#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002856 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002857 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002858#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002859 "$ printf \"Val=%d\\n\" 5\n" \
2860 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002861
Denis Vlasenko94949192006-11-05 00:45:47 +00002862
2863#if ENABLE_DESKTOP
2864
2865#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002866 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002867#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002868 "Report process status" \
2869 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002870 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002871
2872#else /* !ENABLE_DESKTOP */
2873
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002874#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002875#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002876#else
2877#define USAGE_PS "\nOptions:"
2878#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002879
Eric Andersen7e9276b2001-02-22 01:15:47 +00002880#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002881 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002882#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002883 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002884 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002885 USE_SELINUX( \
Bernhard Reutner-Fischer26a80162007-03-14 08:52:28 +00002886 "\n -Z Show SE Linux context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002887 USE_FEATURE_PS_WIDE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002888 "\n w Wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002889
Denis Vlasenko94949192006-11-05 00:45:47 +00002890#endif /* ENABLE_DESKTOP */
2891
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002892#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002893 "$ ps\n" \
2894 " PID Uid Gid State Command\n" \
2895 " 1 root root S init\n" \
2896 " 2 root root S [kflushd]\n" \
2897 " 3 root root S [kupdate]\n" \
2898 " 4 root root S [kpiod]\n" \
2899 " 5 root root S [kswapd]\n" \
2900 " 742 andersen andersen S [bash]\n" \
2901 " 743 andersen andersen S -bash\n" \
2902 " 745 root root S [getty]\n" \
2903 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002904
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00002905#define pscan_trivial_usage \
2906 "[-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
2907#define pscan_full_usage \
2908 "Scan a host, print all open ports" \
2909 "\n\nOptions:" \
2910 "\n -p Scan from this port (default 1)" \
2911 "\n -P Scan up to this port (default 1024)" \
2912 "\n -t Timeout (default 5000 ms)" \
2913 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
2914
Eric Andersen7e9276b2001-02-22 01:15:47 +00002915#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002916 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002917#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002918 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002919#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002920 "$ pwd\n" \
2921 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002922
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002923#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002924 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002925#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002926 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002927#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002928 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002929
Eric Andersen7e9276b2001-02-22 01:15:47 +00002930#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002931 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002932#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002933 "Get and possibly set the system date and time from a remote HOST" \
2934 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002935 " -s Set the system date and time (default)\n" \
2936 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002937
Rob Landley0e4690d2006-08-20 22:12:18 +00002938#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002939 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002940#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002941 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2942 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00002943
Eric Andersen7e9276b2001-02-22 01:15:47 +00002944#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002945 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002946#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002947 "Display the value of a symlink" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002948 USE_FEATURE_READLINK_FOLLOW( \
2949 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002950 " -f Canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002951
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002952#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002953 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002954#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002955 "Options:\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002956 " -m mapfile (Default: /boot/System.map)\n" \
2957 " -p profile (Default: /proc/profile)\n" \
2958 " -M mult Set the profiling multiplier to mult\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002959 " -i Print only info about the sampling step\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002960 " -v Verbose\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002961 " -a Print all symbols, even if count is 0\n" \
2962 " -b Print individual histogram-bin counts\n" \
2963 " -s Print individual counters within functions\n" \
2964 " -r Reset all the counters (root only)\n" \
2965 " -n Disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002966
Glenn L McGrath62fae302002-12-10 00:14:33 +00002967#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002968 "pathname..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00002969#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002970 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00002971
Eric Andersen7e9276b2001-02-22 01:15:47 +00002972#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002973 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002974#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002975 "Reboot the system" \
2976 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002977 " -d Delay interval for rebooting\n" \
2978 " -n No call to sync()\n" \
2979 " -f Force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002980
2981#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002982 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002983#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002984 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002985 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002986 " -n Adjust current nice value (smaller is faster)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002987 " -p Process id(s) (default)\n" \
2988 " -g Process group id(s)\n" \
2989 " -u Process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002990
Eric Andersen7e9276b2001-02-22 01:15:47 +00002991#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002992 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002993#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002994 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002995
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002996#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002997 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002998#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002999 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00003000
Denis Vlasenko397137b2007-07-23 14:03:30 +00003001#define restorecon_trivial_usage \
3002 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
3003#define restorecon_full_usage \
3004 "Reset security contexts of files in pathname\n" \
3005 "\n -i Ignore files that do not exist" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003006 "\n -f file File with list of files to process. Use - for stdin" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003007 "\n -e directory Directory to exclude" \
3008 "\n -R,-r Recurse directories" \
3009 "\n -n Don't change any file labels" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003010 "\n -o file Save list of files with incorrect context" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003011 "\n -v Verbose" \
3012 "\n -vv Show changed labels" \
3013 "\n -F Force reset of context to match file_context" \
3014 "\n for customizable files, or the user section," \
3015 "\n if it has changed"
3016
Eric Andersen7e9276b2001-02-22 01:15:47 +00003017#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003018 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003019#define rm_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003020 "Remove (unlink) the FILE(s). You may use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003021 "indicate that all following arguments are non-options." \
3022 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003023 " -i Always prompt before removing each destination\n" \
3024 " -f Remove existing destinations, never prompt\n" \
3025 " -r,-R Remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003026#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003027 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003028
Eric Andersen7e9276b2001-02-22 01:15:47 +00003029#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003030 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003031#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003032 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003033#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003034 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003035
Eric Andersen7e9276b2001-02-22 01:15:47 +00003036#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003037 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003038#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003039 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003040 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003041 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003042#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003043 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003044
Eric Andersen7e9276b2001-02-22 01:15:47 +00003045#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003046 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003047#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003048 "Edit the kernel's routing tables" \
3049 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003050 " -n Dont resolve names\n" \
3051 " -e Display other/more information\n" \
3052 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003053
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003054#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003055 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003056#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003057 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003058 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003059 "\n -i Install package" \
3060 "\n -q Query package" \
3061 "\n -p Query uninstalled package" \
3062 "\n -i Show information" \
3063 "\n -l List contents" \
3064 "\n -d List documents" \
3065 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003066
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003067#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003068 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003069#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003070 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003071
Mike Frysinger6b160e42008-02-15 02:27:19 +00003072#define rtcwake_trivial_usage \
3073 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SECS | -t TIME]"
3074#define rtcwake_full_usage \
3075 "enter a system sleep state until specified wakeup time\n\n" \
3076 USE_GETOPT_LONG( \
3077 " -a,--auto Read clock mode from adjtime\n" \
3078 " -l,--local Clock is set to local time\n" \
3079 " -u,--utc Clock is set to UTC time\n" \
3080 " -d,--device=DEV Specify the RTC device\n" \
3081 " -m,--mode=MODE Set the sleep state (default: standby)\n" \
3082 " -s,--seconds=SEC Set the timeout in SEC seconds from now\n" \
3083 " -t,--time=TIME Set the timeout to TIME seconds from epoch" \
3084 ) \
3085 SKIP_GETOPT_LONG( \
3086 " -a Read clock mode from adjtime\n" \
3087 " -l Clock is set to local time\n" \
3088 " -u Clock is set to UTC time\n" \
3089 " -d DEV Specify the RTC device\n" \
3090 " -m MODE Set the sleep state (default: standby)\n" \
3091 " -s SEC Set the timeout in SEC seconds from now\n" \
3092 " -t TIME Set the timeout to TIME seconds from epoch" \
3093 )
3094
Denis Vlasenko49622d72007-03-10 16:58:49 +00003095#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003096 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3097 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko49622d72007-03-10 16:58:49 +00003098#define runcon_full_usage \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003099 "Run a program in a different security context\n\n" \
3100 " CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003101 USE_GETOPT_LONG( \
3102 " -c,--compute Compute process transition context before modifying\n" \
3103 " -t,--type=TYPE Type (for same role as parent)\n" \
3104 " -u,--user=USER User identity\n" \
3105 " -r,--role=ROLE Role\n" \
3106 " -l,--range=RNG Levelrange" \
3107 ) \
3108 SKIP_GETOPT_LONG( \
3109 " -c Compute process transition context before modifying\n" \
3110 " -t TYPE Type (for same role as parent)\n" \
3111 " -u USER User identity\n" \
3112 " -r ROLE Role\n" \
3113 " -l RNG Levelrange" \
3114 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003115
Eric Andersen6cf47a72001-10-31 10:24:36 +00003116#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003117 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003118#define run_parts_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003119 "Run a bunch of scripts in a directory" \
3120 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003121 " -t Prints what would be run, but does not actually run anything\n" \
3122 " -a ARG Pass ARG as an argument for every program invoked\n" \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003123 " -u MASK Set the umask to MASK before executing every program" \
3124USE_FEATURE_RUN_PARTS_FANCY("\n -l Prints names of all matching files even when they are not executable")
3125
3126#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003127 "$ run-parts -a start /etc/init.d\n" \
3128 "$ run-parts -a stop=now /etc/init.d\n\n" \
3129 "Let's assume you have a script foo/dosomething:\n" \
3130 "#!/bin/sh\n" \
3131 "for i in $*; do eval $i; done; unset i\n" \
3132 "case \"$1\" in\n" \
3133 "start*) echo starting something;;\n" \
3134 "stop*) set -x; shutdown -h $stop;;\n" \
3135 "esac\n\n" \
3136 "Running this yields:\n" \
3137 "$run-parts -a stop=+4m foo/\n" \
3138 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003139
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003140#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003141 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003142#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003143 "Find the current and previous system runlevel.\n\n" \
3144 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003145 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003146#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003147 "$ runlevel /var/run/utmp\n" \
3148 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003149
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003150#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003151 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003152#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003153 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003154
3155#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003156 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003157#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003158 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003159
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003160#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003161 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003162#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003163 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003164#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003165 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003166
Eric Andersen7e9276b2001-02-22 01:15:47 +00003167#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003168 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003169#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003170 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003171 " -e script Add the script to the commands to be executed\n" \
3172 " -f scriptfile Add script-file contents to the\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003173 " commands to be executed\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003174 " -i Edit files in-place\n" \
3175 " -n Suppress automatic printing of pattern space\n" \
3176 " -r Use extended regular expression syntax\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003177 "\n" \
3178 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
3179 "script to interpret. All remaining arguments are names of input files; if no\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003180 "input files are specified, then the standard input is read. Source files\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003181 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00003182
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003183#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003184 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3185 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003186
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003187#define selinuxenabled_trivial_usage
3188#define selinuxenabled_full_usage
3189
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003190#define sendmail_trivial_usage \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003191 "[-C dir] [-w timeout] [-U user] [-P password] [-X]\n" \
3192 "-t to [-t to] -f from [-n] [-s subject] [-c charset] server[:port] [body] [attachment ...]"
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003193#define sendmail_full_usage \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003194 "Send an email with optional attachments." \
3195 "\n\nOptions:\n" \
3196 " -C dir Change current directory to dir\n" \
3197 " -w timeout Set timeout on network operations\n" \
3198 " -U username Authenticate with specified username\n" \
3199 " -P password Authenticate with specified password\n" \
3200 " -X Use openssl connection helper for secured servers\n" \
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003201 " -t to Recipient email. May be multiple\n" \
Denis Vlasenkoa2980c62008-02-02 17:54:35 +00003202 " -f from Sender address\n" \
Denis Vlasenko6d52c1e2008-02-08 18:24:54 +00003203 " -n Request delivery notification to sender\n" \
3204 " -s subject Subject\n" \
3205 " -c charset Assumed charset for body and subject [utf-8]"
Denis Vlasenko73032ca2008-01-28 22:47:03 +00003206
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003207#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003208 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003209#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003210 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003211 "FIRST, INCREMENT default to 1" \
3212 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003213 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003214 " FIRST LAST\n" \
3215 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003216
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003217#define sestatus_trivial_usage \
3218 "[-vb]"
3219#define sestatus_full_usage \
3220 "-v Verbose\n" \
3221 "-b Display current state of booleans"
3222
Paul Foxfc2256a2005-08-01 18:12:30 +00003223#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003224 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00003225#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003226 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003227 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003228 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00003229
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003230#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003231 "[Enforcing | Permissive | 1 | 0]"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003232#define setenforce_full_usage
3233
Denis Vlasenko397137b2007-07-23 14:03:30 +00003234#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003235 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003236 USE_FEATURE_SETFILES_CHECK_OPTION( \
3237 " [-c policyfile] spec_file" \
3238 ) \
3239 " pathname"
3240
3241#define setfiles_full_usage \
3242 "Reset file contexts under pathname according to spec_file" \
3243 USE_FEATURE_SETFILES_CHECK_OPTION( \
3244 "\n -c file Check the validity of the contexts against the specified binary policy" \
3245 ) \
3246 "\n -d Show which specification matched each file" \
3247 "\n -l Log changes in file labels to syslog" \
3248 "\n -n Don't change any file labels" \
Denis Vlasenko1da77722007-07-24 06:17:43 +00003249 "\n -q Suppress warnings" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003250 "\n -r dir Use an altenate root path" \
3251 "\n -e dir Exclude directory" \
3252 "\n -F Force reset of context to match file_context for customizable files" \
3253 "\n -o file Save list of files with incorrect context" \
3254 "\n -s Take a list of files from standard input (instead of command line)" \
3255 "\n -v Show changes in file labels, if type or role are changing" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003256 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3257 "\n -W Display warnings about entries that had no matching files"
Denis Vlasenko397137b2007-07-23 14:03:30 +00003258
Eric Andersen7e9276b2001-02-22 01:15:47 +00003259#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003260 "SCANCODE KEYCODE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003261#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003262 "Set entries into the kernel's scancode-to-keycode map,\n" \
3263 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3264 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
3265 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003266#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003267 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003268
Rob Landley87848d92006-03-27 23:23:43 +00003269#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003270 "N"
Rob Landley87848d92006-03-27 23:23:43 +00003271#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003272 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003273
Denis Vlasenkobe039372007-10-14 04:48:44 +00003274#define setsebool_trivial_usage \
3275 "boolean value"
3276
3277#define setsebool_full_usage \
3278 "Change boolean setting"
3279
Paul Fox42403642005-08-01 22:52:09 +00003280#define setsid_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003281 "program [arg...]"
Paul Fox42403642005-08-01 22:52:09 +00003282#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003283 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003284 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00003285
Matt Kraai2d91deb2001-08-01 17:21:35 +00003286#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003287 "[FILE]...\n" \
3288 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00003289#define lash_full_usage \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003290 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003291
Eric Andersen2e9c2572003-08-08 22:26:06 +00003292#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003293 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00003294#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003295 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00003296
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003297#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003298 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003299 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003300#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003301 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003302 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003303 "\n\nOptions:\n" \
3304 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003305 " -c Check SHA1 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003306 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003307 " -s Don't output anything, status code shows success\n" \
3308 " -w Warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003309
Denis Vlasenko14923db2007-06-20 15:23:03 +00003310#define slattach_trivial_usage \
3311 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3312#define slattach_full_usage \
3313 "Attach network interface(s) to serial line(s)\n" \
3314 "\nOptions:" \
3315 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3316 "\n -s Set line speed" \
3317 "\n -e Exit after initializing device" \
3318 "\n -h Exit when the carrier is lost" \
3319 "\n -c Execute a command when the line is hung up" \
3320 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3321 "\n -L Enable 3-wire operation" \
3322 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003323
Eric Andersen7e9276b2001-02-22 01:15:47 +00003324#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003325 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003326#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003327 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003328 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003329 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003330 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003331#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003332 "$ sleep 2\n" \
3333 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003334 USE_FEATURE_FANCY_SLEEP( \
3335 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003336 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003337
Eric Andersen7e9276b2001-02-22 01:15:47 +00003338#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003339 "[-nru" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003340 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o FILE] [-k start[.offset][opts][,end[.offset][opts]] [-t CHAR") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003341 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003342#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003343 "Sort lines of text in the specified files" \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003344 "\n\nOptions:" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003345 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003346 "\n -b Ignore leading blanks" \
3347 "\n -c Check whether input is sorted" \
3348 "\n -d Dictionary order (blank or alphanumeric only)" \
3349 "\n -f Ignore case" \
3350 "\n -g General numerical sort" \
3351 "\n -i Ignore unprintable characters" \
3352 "\n -k Sort key" \
3353 "\n -M Sort month" \
3354 ) \
3355 "\n -n Sort numbers" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003356 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003357 "\n -o Output to file" \
3358 "\n -k Sort by key" \
3359 "\n -t CHAR Key separator" \
3360 ) \
3361 "\n -r Reverse sort order" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003362 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003363 "\n -s Stable (don't sort ties alphabetically)" \
3364 ) \
3365 "\n -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003366 USE_FEATURE_SORT_BIG( \
Denis Vlasenko9d96af22008-02-13 15:35:52 +00003367 "\n -z Lines are terminated by NUL, not newline" \
3368 "\n -mST Ignored for GNU compatibility") \
3369
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003370#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003371 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3372 "a\n" \
3373 "b\n" \
3374 "c\n" \
3375 "d\n" \
3376 "e\n" \
3377 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003378 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003379 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3380 "d 2\n" \
3381 "b 2\n" \
3382 "c 3\n" \
3383 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003384 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003385
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003386#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003387 "[OPTION] [INPUT [PREFIX]]"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003388#define split_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003389 "Options:" \
3390 "\n -b n[k|m] Split by bytes" \
3391 "\n -l n Split by lines" \
3392 "\n -a n Use n letters as suffix"
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003393#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003394 "$ split TODO foo\n" \
3395 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003396
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003397#define start_stop_daemon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003398 "[OPTIONS] [" \
3399 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3400 "] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003401#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003402 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003403 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003404 USE_GETOPT_LONG( \
3405 "\n -S,--start Start" \
3406 "\n -K,--stop Stop" \
3407 "\n -a,--startas pathname Starts process specified by pathname" \
3408 "\n -b,--background Put process into background" \
3409 "\n -u,--user username|uid Stop this user's processes" \
3410 "\n -x,--exec executable Program to either start or check" \
3411 "\n -n,--name process-name Stop processes with this name" \
3412 "\n -p,--pidfile pid-file Save or load pid using a pid-file" \
3413 "\n -m,--make-pidfile Create the -p file and enter pid in it" \
3414 "\n -q,--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003415 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003416 "\n -o,--oknodo Exit status 0 if nothing done" \
3417 "\n -v,--verbose Verbose" \
3418 "\n -N,--nicelevel N Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003419 ) \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003420 "\n -s,--signal signal Signal to send (default TERM)" \
3421 "\n -c,--chuid user[:[grp]] Change to specified user/group" \
3422 ) \
3423 SKIP_GETOPT_LONG( \
3424 "\n -S Start" \
3425 "\n -K Stop" \
3426 "\n -a pathname Starts process specified by pathname" \
3427 "\n -b Put process into background" \
3428 "\n -u username|uid Stop this user's processes" \
3429 "\n -x executable Program to either start or check" \
3430 "\n -n process-name Stop processes with this name" \
3431 "\n -p pid-file Save or load pid using a pid-file" \
3432 "\n -m Create the -p file and enter pid in it" \
3433 "\n -q Quiet" \
3434 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3435 "\n -o Exit status 0 if nothing done" \
3436 "\n -v Verbose" \
3437 "\n -N N Add N to process's nice level" \
3438 ) \
3439 "\n -s signal Signal to send (default TERM)" \
3440 "\n -c user[:[grp]] Change to specified user/group" \
3441 )
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003442
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003443#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003444 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003445#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003446 "Display file (default) or filesystem status" \
3447 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003448 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003449 " -c fmt Use the specified format\n") \
3450 " -f Display filesystem status\n" \
Bernhard Reutner-Fischer52432f22008-01-17 11:05:09 +00003451 " -L Dereference links\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003452 " -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003453 USE_SELINUX( \
3454 "\n -Z Print security context" \
3455 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003456 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003457 "\n\nValid format sequences for files:\n" \
3458 " %a Access rights in octal\n" \
3459 " %A Access rights in human readable form\n" \
3460 " %b Number of blocks allocated (see %B)\n" \
3461 " %B The size in bytes of each block reported by %b\n" \
3462 " %d Device number in decimal\n" \
3463 " %D Device number in hex\n" \
3464 " %f Raw mode in hex\n" \
3465 " %F File type\n" \
3466 " %g Group ID of owner\n" \
3467 " %G Group name of owner\n" \
3468 " %h Number of hard links\n" \
3469 " %i Inode number\n" \
3470 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003471 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003472 " %o I/O block size\n" \
3473 " %s Total size, in bytes\n" \
3474 " %t Major device type in hex\n" \
3475 " %T Minor device type in hex\n" \
3476 " %u User ID of owner\n" \
3477 " %U User name of owner\n" \
3478 " %x Time of last access\n" \
3479 " %X Time of last access as seconds since Epoch\n" \
3480 " %y Time of last modification\n" \
3481 " %Y Time of last modification as seconds since Epoch\n" \
3482 " %z Time of last change\n" \
3483 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003484 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003485 " %a Free blocks available to non-superuser\n" \
3486 " %b Total data blocks in file system\n" \
3487 " %c Total file nodes in file system\n" \
3488 " %d Free file nodes in file system\n" \
3489 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003490 USE_SELINUX( \
3491 " %C Security context in SELinux\n" \
3492 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003493 " %i File System ID in hex\n" \
3494 " %l Maximum length of filenames\n" \
3495 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003496 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003497 " %S Fundamental block size (for block counts)\n" \
3498 " %t Type in hex\n" \
3499 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003500 )
3501
Eric Andersenef5e8f82002-11-07 02:09:37 +00003502#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003503 "[-afo] [-n length] [file...]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003504#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003505 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003506 "\n\nOptions:" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003507 "\n -a Scan whole file (default)" \
3508 "\n -f Precede strings with filenames" \
3509 "\n -n N At least N characters form a string (default 4)" \
3510 "\n -o Precede strings with decimal offsets"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003511
Eric Andersen7e9276b2001-02-22 01:15:47 +00003512#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003513 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003514#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003515 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003516 "and deviations from stty sane" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003517 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003518 "\n -F DEVICE Open device instead of stdin" \
3519 "\n -a Print all current settings in human-readable form" \
3520 "\n -g Print in stty-readable form" \
3521 "\n [SETTING] See manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003522
Robert Griebl1fca5582002-06-04 20:45:46 +00003523#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003524 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003525#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003526 "Change user id or become root" \
3527 "\n\nOptions:" \
3528 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003529 "\n -c Command to pass to 'sh -c'" \
3530 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00003531
Eric Andersen27f64e12002-06-23 04:24:25 +00003532#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003533 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003534#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003535 "Single user login" \
3536 "\n\nOptions:" \
3537 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00003538
Mike Frysinger95d3c452005-04-21 23:29:24 +00003539#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003540 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003541#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003542 "Checksum and count the blocks in a file" \
3543 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003544 " -r Use BSD sum algorithm (1K blocks)\n" \
3545 " -s Use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003546
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003547#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003548 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003549#define sv_full_usage \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003550 "Control services monitored by runsv supervisor.\n" \
3551 "Commands (only first character is enough):\n" \
3552 "\n" \
3553 "status: query service status\n" \
3554 "up: if service isn't running, start it. If service stops, restart it\n" \
3555 "once: like 'up', but if service stops, don't restart it\n" \
3556 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3557 " if it exists. After it stops, do not restart service\n" \
3558 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3559 " runsv exits too\n" \
3560 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
3561 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003562
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003563#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003564 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003565#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003566 "Continuously read log data from standard input, optionally " \
3567 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003568 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003569
Eric Andersen7e9276b2001-02-22 01:15:47 +00003570#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003571 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003572#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003573 "Stop swapping virtual memory pages on DEVICE" \
3574 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003575 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003576
Eric Andersen7e9276b2001-02-22 01:15:47 +00003577#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003578 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003579#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003580 "Start swapping virtual memory pages on DEVICE" \
3581 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003582 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003583
Rob Landley0f34a822005-10-27 22:55:50 +00003584#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003585 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003586#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003587 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003588 "and exec NEW_INIT" \
3589 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003590 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00003591
Eric Andersen7e9276b2001-02-22 01:15:47 +00003592#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003593 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003594#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003595 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003596
Eric Andersenb9050282003-12-24 06:02:11 +00003597#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003598 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003599#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003600 "Configure kernel parameters at runtime" \
3601 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003602 " -n Disable printing of key names\n" \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003603 " -e Don't warn about unknown keys\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003604 " -w Change sysctl setting\n" \
3605 " -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)\n" \
3606 " -a Display all values\n" \
3607 " -A Display all values in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003608#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003609 "sysctl [-n] [-e] variable...\n" \
3610 "sysctl [-n] [-e] -w variable=value...\n" \
3611 "sysctl [-n] [-e] -a\n" \
3612 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3613 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003614
Eric Andersen7e9276b2001-02-22 01:15:47 +00003615#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003616 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003617#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003618 "System logging utility.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003619 "Note that this version of syslogd ignores /etc/syslog.conf." \
3620 "\n\nOptions:" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003621 "\n -n Run in foreground" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003622 "\n -O FILE Log to given file (default=/var/log/messages)" \
3623 "\n -l n Set local log level" \
3624 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003625 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003626 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3627 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003628 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003629 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003630 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003631 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003632 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)")
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003633 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003634/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003635#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003636 "$ syslogd -R masterlog:514\n" \
3637 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003638
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003639#define tac_trivial_usage \
3640 "[FILE]..."
3641#define tac_full_usage \
3642 "Concatenates FILE(s) and prints them to stdout in reverse"
3643
Eric Andersen7e9276b2001-02-22 01:15:47 +00003644#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003645 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003646#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003647 "Print last 10 lines of each FILE to standard output.\n" \
3648 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003649 "file name. With no FILE, or when FILE is -, read standard input." \
3650 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003651 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003652 "\n -c N[kbm] Output the last N bytes") \
3653 "\n -n N[kbm] Print last N lines instead of last 10" \
3654 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003655 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003656 "\n -q Never output headers giving file names" \
3657 "\n -s SEC Wait SEC seconds between reads with -f" \
3658 "\n -v Always output headers giving file names" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003659 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003660 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3661 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3662 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003663#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003664 "$ tail -n 1 /etc/resolv.conf\n" \
3665 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003666
Eric Andersen7e9276b2001-02-22 01:15:47 +00003667#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003668 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003669 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3670 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003671 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003672 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003673#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003674 "Create, extract, or list files from a tar file" \
3675 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003676 USE_FEATURE_TAR_CREATE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003677 " c Create\n") \
3678 " x Extract\n" \
3679 " t List\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003680 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003681 USE_FEATURE_TAR_GZIP( \
3682 " z Filter the archive through gzip\n") \
3683 USE_FEATURE_TAR_BZIP2( \
3684 " j Filter the archive through bzip2\n") \
3685 USE_FEATURE_TAR_LZMA( \
3686 " a Filter the archive through lzma\n") \
3687 USE_FEATURE_TAR_COMPRESS( \
3688 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003689 "\nFile selection:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003690 " f Name of TARFILE or \"-\" for stdin\n" \
3691 " O Extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003692 USE_FEATURE_TAR_FROM( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003693 " exclude File to exclude\n" \
3694 " X File with names to exclude\n") \
3695 " C Change to directory DIR before operation\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003696 " v Verbose"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003697#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003698 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3699 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003700
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003701#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003702 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003703#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003704 "Set or get CPU affinity" \
3705 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003706 " -p Operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003707#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003708 "$ taskset 0x7 ./dgemm_test&\n" \
3709 "$ taskset -p 0x1 $!\n" \
3710 "pid 4790's current affinity mask: 7\n" \
3711 "pid 4790's new affinity mask: 1\n" \
3712 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3713 "pid 6671's current affinity mask: 1\n" \
3714 "pid 6671's new affinity mask: 1\n" \
3715 "$ taskset -p 1\n" \
3716 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003717
Eric Andersen7e9276b2001-02-22 01:15:47 +00003718#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003719 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003720#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003721 "Copy standard input to each FILE, and also to standard output" \
3722 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003723 " -a Append to the given FILEs, do not overwrite\n" \
3724 " -i Ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003725#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003726 "$ echo \"Hello\" | tee /tmp/foo\n" \
3727 "$ cat /tmp/foo\n" \
3728 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003729
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003730#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003731#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003732 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003733#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003734 "Connect to remote telnet server" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003735 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003736 " -a Attempt an automatic login with the USER variable\n" \
3737 " -l USER Attempt an automatic login with the USER argument\n" \
3738 " HOST The official name, alias or the IP address of the\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00003739 " remote host\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003740 " PORT The remote port number to connect to. If it is not\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003741 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003742#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003743#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003744 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003745#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003746 "Connect to remote telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003747#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003748
Eric Andersen08a72202002-09-30 20:52:10 +00003749#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003750 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003751#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003752 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003753 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3754 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003755 "\n -l LOGIN Exec LOGIN on connect" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003756 "\n -f issue_file Display issue_file instead of /etc/issue" \
Denis Vlasenko2450c452007-10-15 22:09:15 +00003757 "\n -K Close connection as soon as login exits" \
3758 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003759 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003760 "\n -p PORT Port to listen to" \
3761 "\n -b ADDR Address to bind to" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003762 "\n -F Run in foreground" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003763 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003764 )
Eric Andersen08a72202002-09-30 20:52:10 +00003765
Eric Andersen7e9276b2001-02-22 01:15:47 +00003766#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003767 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003768#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003769 "Check file types and compares values returning an exit code\n" \
3770 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003771#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003772 "$ test 1 -eq 2\n" \
3773 "$ echo $?\n" \
3774 "1\n" \
3775 "$ test 1 -eq 1\n" \
3776 "$ echo $?\n" \
3777 "0\n" \
3778 "$ [ -d /etc ]\n" \
3779 "$ echo $?\n" \
3780 "0\n" \
3781 "$ [ -d /junk ]\n" \
3782 "$ echo $?\n" \
3783 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003784
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003785#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003786 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003787/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003788/* "[-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 +00003789#define tcpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003790 "Creates TCP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003791 "for incoming connections. For each connection it runs prog." \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003792 "\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003793 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003794 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003795 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003796 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3797 "\n-u user[:group] Change to user/group after bind" \
3798 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003799 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003800 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3801 "\n New connections from this IP address are closed" \
3802 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003803 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003804 "\n-E Do not set up environment variables" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003805 "\n-v Verbose"
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003806
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003807#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003808 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003809#define udpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003810 "Creates UDP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003811 "for incoming packets. For each packet it runs prog\n" \
3812 "(redirecting all further packets with same peer ip:port to it)." \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003813 "\n" \
3814 "\nip IP to listen on. '0' = all" \
3815 "\nport Port to listen on" \
3816 "\nprog [arg] Program to run" \
3817 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3818 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003819 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003820 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003821 "\n-E Do not set up environment variables" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003822 "\n-v Verbose"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003823
Mark Whitley450736c2001-03-02 19:08:50 +00003824#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003825 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003826#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003827 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003828 "\n\nOptions:" \
3829 "\n -l FILE Local FILE" \
3830 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003831 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003832 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003833 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003834 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003835 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003836 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003837 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003838 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003839 )
Eric Andersenc3657422001-11-30 07:54:32 +00003840#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003841 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003842#define time_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003843 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003844 "COMMAND's resource usage information is displayed." \
3845 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003846 " -v Verbose"
Mark Whitley450736c2001-03-02 19:08:50 +00003847
Eric Andersen420b2082002-09-17 22:14:58 +00003848#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003849 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003850#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003851 "Provide a view of process activity in real time.\n" \
3852 "Read the status of all processes from /proc each <seconds>\n" \
3853 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003854
Eric Andersen7e9276b2001-02-22 01:15:47 +00003855#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003856 "[-c] FILE [FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003857#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003858 "Update the last-modified date on the given FILE[s]" \
3859 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003860 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003861#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003862 "$ ls -l /tmp/foo\n" \
3863 "/bin/ls: /tmp/foo: No such file or directory\n" \
3864 "$ touch /tmp/foo\n" \
3865 "$ ls -l /tmp/foo\n" \
3866 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003867
3868#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003869 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003870#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003871 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003872 "standard input, writing to standard output" \
3873 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003874 " -c Take complement of STRING1\n" \
3875 " -d Delete input characters coded STRING1\n" \
3876 " -s Squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003877#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003878 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3879 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003880
Eric Andersen5c58d282001-07-10 16:29:00 +00003881#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003882 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3883 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3884 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003885#define traceroute_full_usage \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003886 "Trace the route to \"host\"" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003887 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003888 " -F Set the don't fragment bit\n" \
3889 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3890 " -l Display the ttl value of the returned packet\n" \
3891 " -d Set SO_DEBUG options to socket\n" \
3892 " -n Print hop addresses numerically rather than symbolically\n" \
3893 " -r Bypass the normal routing tables and send directly to a host\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003894 " -v Verbose\n" \
3895 " -m max_ttl Max time-to-live (max number of hops)\n" \
3896 " -p port# Base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003897 " (default is 33434)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003898 " -q nqueries Number of probes per 'ttl' (default 3)\n" \
3899 " -s src_addr IP address to use as the source address\n" \
3900 " -t tos Type-of-service in probe packets (default 0)\n" \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003901 " -w wait Time in seconds to wait for a response\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003902 " (default 3 sec)\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003903 " -g Loose source route gateway (8 max)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003904
Eric Andersen7e9276b2001-02-22 01:15:47 +00003905#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003906 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003907#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003908 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003909#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003910 "$ true\n" \
3911 "$ echo $?\n" \
3912 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003913
Eric Andersen7e9276b2001-02-22 01:15:47 +00003914#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003915 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003916#define tty_full_usage \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003917 "Print file name of standard input's terminal" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003918 USE_INCLUDE_SUSv2( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003919 "\n\nOptions:\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003920 " -s Print nothing, only return exit status")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003921#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003922 "$ tty\n" \
3923 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003924
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003925#define ttysize_trivial_usage \
3926 "[w] [h]"
3927#define ttysize_full_usage \
3928 "Print dimension(s) of standard input's terminal, on error return 80x25"
3929
Mike Frysinger174808c2005-06-11 01:14:09 +00003930#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003931 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3932 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3933 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3934 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3935 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3936 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003937#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003938 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00003939
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003940#define udhcpc_trivial_usage \
Denis Vlasenkoc82b5102007-07-01 17:05:57 +00003941 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00003942 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003943#define udhcpc_full_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00003944 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003945 " -V,--vendorclass=CLASSID Vendor class identifier" \
3946 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003947 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003948 "\n -c,--clientid=CLIENTID Client identifier" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003949 "\n -C,--clientid-none Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003950 "\n -p,--pidfile=file Create pidfile" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003951 "\n -r,--request=IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003952 "\n -s,--script=file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003953 "\n -t,--retries=N Send up to N request packets" \
3954 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003955 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003956 "\n -f,--foreground Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003957 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003958 "\n -S,--syslog Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003959 "\n -n,--now Exit with failure if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003960 "\n -q,--quit Quit after obtaining lease" \
3961 "\n -R,--release Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00003962 "\n -O,--request-option=OPT Request DHCP option OPT from server" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00003963 USE_FEATURE_UDHCP_PORT( \
3964 "\n -P,--client-port N Use port N instead of default 68" \
3965 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003966 USE_FEATURE_UDHCPC_ARPING( \
3967 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003968 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00003969 ) \
3970 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003971 " -V CLASSID Vendor class identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003972 "\n -i INTERFACE Interface to use (default: eth0)" \
3973 "\n -H,-h HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003974 "\n -c CLIENTID Client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003975 "\n -C Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003976 "\n -p file Create pidfile" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003977 "\n -r IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003978 "\n -s file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003979 "\n -t N Send up to N request packets" \
3980 "\n -T N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003981 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003982 "\n -f Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003983 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003984 "\n -S Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003985 "\n -n Exit with failure if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003986 "\n -q Quit after obtaining lease" \
3987 "\n -R Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00003988 "\n -O OPT Request DHCP option OPT from server" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00003989 USE_FEATURE_UDHCP_PORT( \
3990 "\n -P N Use port N instead of default 68" \
3991 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003992 USE_FEATURE_UDHCPC_ARPING( \
3993 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003994 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00003995 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003996
Russ Dill61fb4892002-10-14 21:41:28 +00003997#define udhcpd_trivial_usage \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00003998 "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00003999
4000#define udhcpd_full_usage \
Denis Vlasenko9f7b92a2007-08-15 20:03:36 +00004001 "DHCP server" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004002 "\n -f Run in foreground" \
Denis Vlasenkod55fe3e2008-02-04 13:12:16 +00004003 "\n -S Log to syslog too" \
4004 USE_FEATURE_UDHCP_PORT( \
4005 "\n -P N Use port N instead of default 67" \
4006 )
Russ Dill61fb4892002-10-14 21:41:28 +00004007
Eric Andersen7e9276b2001-02-22 01:15:47 +00004008#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004009 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004010#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004011 "Unmount file systems" \
4012 "\n\nOptions:\n" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00004013 USE_FEATURE_UMOUNT_ALL( \
4014 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab")) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004015 USE_FEATURE_MTAB_SUPPORT( \
4016 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004017 "\n -r Try to remount devices as read-only if mount is busy" \
4018 "\n -l Lazy umount (detach filesystem)" \
4019 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004020 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkob2e578a2008-02-14 12:00:21 +00004021 "\n -d Free loop device if it has been used")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004022#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004023 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004024
4025#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004026 "[-amnrspv]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004027#define uname_full_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004028 "Print system information." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004029 "\n\nOptions:\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004030 " -a Print all\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004031 " -m The machine (hardware) type\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004032 " -n Hostname\n" \
4033 " -r OS release\n" \
4034 " -s OS name (default)\n" \
4035 " -p Processor type\n" \
4036 " -v OS version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004037#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004038 "$ uname -a\n" \
4039 "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 +00004040
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004041#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004042 "[-c] [-f] [name...]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00004043#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004044 "Uncompress .Z file[s]" \
4045 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004046 " -c Extract to stdout\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00004047 " -f Overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00004048
Denis Vlasenko3952f202007-08-13 14:10:24 +00004049#define unexpand_trivial_usage \
4050 "[-f][-a][-t NUM] [FILE|-]"
4051#define unexpand_full_usage \
4052 "Convert spaces to tabs, writing to standard output." \
4053 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00004054 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
4055 "\n -a,--all Convert all blanks" \
4056 "\n -f,--first-only Convert only leading blanks" \
4057 "\n -t,--tabs=N Tabstops every N chars" \
4058 ) \
4059 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
4060 "\n -a Convert all blanks" \
4061 "\n -f Convert only leading blanks" \
4062 "\n -t N Tabstops every N chars" \
4063 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00004064
Eric Andersen7e9276b2001-02-22 01:15:47 +00004065#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004066 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004067#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004068 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004069 "(or standard input), writing to OUTPUT (or standard output)" \
4070 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004071 " -c Prefix lines by the number of occurrences\n" \
4072 " -d Only print duplicate lines\n" \
4073 " -u Only print unique lines\n" \
4074 " -f N Skip the first N fields\n" \
4075 " -s N Skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004076#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004077 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
4078 "a\n" \
4079 "b\n" \
4080 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004081
4082#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004083 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004084#define unix2dos_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004085 "Convert FILE from unix format to dos format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004086 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004087 "When no file is given, use stdin/stdout." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004088 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004089 " -u Output will be in UNIX format\n" \
4090 " -d Output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004091
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004092#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004093 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004094#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004095 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004096 "\n\nOptions:\n" \
Paul Fox9382b382007-09-07 20:28:25 +00004097 " -l List archive contents (with -q for short form)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004098 " -n Never overwrite existing files (default)\n" \
4099 " -o Overwrite files without prompting\n" \
4100 " -p Send output to stdout\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004101 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004102 " -x Exclude these files\n" \
4103 " -d Extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004104
Eric Andersen7e9276b2001-02-22 01:15:47 +00004105#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004106 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004107#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004108 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004109#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004110 "$ uptime\n" \
4111 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004112
4113#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004114 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004115#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004116 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004117#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004118 "$ usleep 1000000\n" \
4119 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004120
4121#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004122 "[-o outfile] [infile]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004123#define uudecode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004124 "Uudecode a file\n" \
4125 "NB: finds outfile name in uuencoded source unless -o is given"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004126#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004127 "$ uudecode -o busybox busybox.uu\n" \
4128 "$ ls -l busybox\n" \
4129 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004130
4131#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004132 "[-m] [infile] stored_filename"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004133#define uuencode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004134 "Uuencode a file to stdout" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004135 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004136 " -m Use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004137#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004138 "$ uuencode busybox busybox\n" \
4139 "begin 755 busybox\n" \
4140 "<encoded file snipped>\n" \
4141 "$ uudecode busybox busybox > busybox.uu\n" \
4142 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004143
Eric Andersen853c4942003-01-23 05:59:32 +00004144#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004145 "COMMAND [OPTIONS]..."
Eric Andersen853c4942003-01-23 05:59:32 +00004146#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004147 "Create and remove virtual ethernet devices" \
4148 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004149 " add [interface-name] [vlan_id]\n" \
4150 " rem [vlan-name]\n" \
4151 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
4152 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4153 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4154 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00004155
Eric Andersen3f980402001-04-04 17:31:15 +00004156#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004157 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00004158#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004159 "Edit FILE" \
4160 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004161 " -R Read-only - do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00004162
Eric Andersen27f64e12002-06-23 04:24:25 +00004163#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004164 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00004165#define vlock_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004166 "Lock a virtual terminal. A password is required to unlock." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004167 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004168 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00004169
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004170#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004171 "[-n seconds] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004172#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004173 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004174 "\n\nOptions:\n" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004175 " -n Loop period in seconds (default 2)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004176 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004177#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004178 "$ watch date\n" \
4179 "Mon Dec 17 10:31:40 GMT 2000\n" \
4180 "Mon Dec 17 10:31:42 GMT 2000\n" \
4181 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004182
Eric Andersen7e9276b2001-02-22 01:15:47 +00004183#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004184 "[-t N[ms]] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004185#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004186 "Periodically write to watchdog device DEV" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004187 "\n\nOptions:" \
4188 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004189 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004190 "\n" \
4191 "\nUse -t 500ms to specify period in milliseconds"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004192
4193#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004194 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004195#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004196 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004197 "more than one FILE is specified. With no FILE, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004198 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004199 " -c Print the byte counts\n" \
4200 " -l Print the newline counts\n" \
4201 " -L Print the length of the longest line\n" \
4202 " -w Print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004203#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004204 "$ wc /etc/passwd\n" \
4205 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004206
4207#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004208 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004209 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004210 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4211 " [-U|--user-agent agent] url" \
4212 ) \
4213 SKIP_GETOPT_LONG( \
4214 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4215 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00004216#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004217 "Retrieve files via HTTP or FTP" \
4218 "\n\nOptions:\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004219 " -s Spider mode - only check file existence\n" \
4220 " -c Continue retrieval of aborted transfer\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004221 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004222 " -P Set directory prefix to DIR\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004223 " -O Save to filename ('-' for stdout)\n" \
4224 " -U Adjust 'User-Agent' field\n" \
4225 " -Y Use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004226
4227#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004228 "[COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004229#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004230 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004231#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004232 "$ which login\n" \
4233 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004234
Eric Andersen00a6a752002-04-26 23:53:10 +00004235#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004236 "[-a]"
Eric Andersen00a6a752002-04-26 23:53:10 +00004237#define who_full_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004238 "Show who is logged on" \
4239 "\n\nOptions:\n" \
4240 " -a show all"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004241
4242#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004243 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004244#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004245 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004246
4247#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004248 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004249#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004250 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004251 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004252 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
4253 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004254 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004255 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4256 " -x Exit if the size is exceeded\n") \
4257 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
4258 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004259 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004260#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004261 "$ ls | xargs gzip\n" \
4262 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004263
4264#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004265 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004266#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004267 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004268
Eric Andersen7e9276b2001-02-22 01:15:47 +00004269#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004270 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004271#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004272 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004273
Rob Landleyad8071f2005-04-30 03:49:37 +00004274#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004275 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00004276#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004277 "Manage a ZeroConf IPv4 link-local address" \
4278 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004279 " -f Run in foreground\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004280 " -q Quit after address (no daemon)\n" \
4281 " -r 169.254.x.x Request this address first\n" \
4282 " -v Verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00004283
Eric Andersen178de172004-04-06 16:36:20 +00004284#endif /* __BB_USAGE_H__ */