blob: 0b5c66cc995cb0b66f5df68cc7d668cf04856a73 [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 Vlasenko1fffe382006-11-28 00:06:39 +0000513 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000514#define crontab_full_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +0000515 " file [opts] Replace crontab from file\n" \
516 " - [opts] Replace crontab from stdin\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000517 " -u user User\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000518 " -l [user] List crontab for user\n" \
519 " -e [user] Edit crontab for user\n" \
520 " -d [user] Delete crontab for user\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000521 " -c dir Crontab directory"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000522
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000523#define cryptpw_trivial_usage \
524 "[-a des|md5] [string]"
525#define cryptpw_full_usage \
526 "Outputs crypted string.\n" \
527 "If string isn't supplied on cmdline, reads it from stdin.\n" \
528 "\nOptions:" \
529 "\n -a Algorithm to use (default: md5)"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000530
Eric Andersen7e9276b2001-02-22 01:15:47 +0000531#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000532 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000533#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000534 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000535 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000536 " -b LIST Output only bytes from LIST\n" \
537 " -c LIST Output only characters from LIST\n" \
538 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
539 " -s Output only the lines containing delimiter\n" \
540 " -f N Print only these fields\n" \
541 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000542#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000543 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
544 "Hello\n" \
545 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
546 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000547
Eric Andersen7e9276b2001-02-22 01:15:47 +0000548#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000549 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000550#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000551 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000552 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000553 " -R Outputs RFC-822 compliant date string\n" \
554 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000555 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000556 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
557 " TIMESPEC='date' (or missing) for date only,\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000558 " 'hours', 'minutes', or 'seconds' for date and\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000559 " time to the indicated precision\n" \
560 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000561 ) \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000562 " -s STRING Sets time described by STRING\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000563 " -r FILE Displays the last modification time of FILE\n" \
564 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000565#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000566 "$ date\n" \
567 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000568
Eric Andersen7e9276b2001-02-22 01:15:47 +0000569#define dc_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000570 "expression..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000571#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000572 "This is a Tiny RPN calculator that understands the\n" \
573 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
574 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000575 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
576 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000577 "p - Prints the value on the top of the stack, without altering the stack\n" \
578 "f - Prints the entire contents of the stack without altering anything\n" \
579 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
580 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000581#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000582 "$ dc 2 2 + p\n" \
583 "4\n" \
584 "$ dc 8 8 \\* 2 2 + / p\n" \
585 "16\n" \
586 "$ dc 0 1 and p\n" \
587 "0\n" \
588 "$ dc 0 1 or p\n" \
589 "1\n" \
590 "$ echo 72 9 div 8 mul p | dc\n" \
591 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000592
Eric Andersen7e9276b2001-02-22 01:15:47 +0000593#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000594 "[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 +0000595 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000596#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000597 "Copy a file with converting and formatting" \
598 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000599 " if=FILE Read from FILE instead of stdin\n" \
600 " of=FILE Write to FILE instead of stdout\n" \
601 " bs=N Read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000602 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000603 " ibs=N Read N bytes at a time\n") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000604 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000605 " obs=N Write N bytes at a time\n") \
606 " count=N Copy only N input blocks\n" \
607 " skip=N Skip N input blocks\n" \
608 " seek=N Skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000609 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000610 " conv=notrunc Don't truncate output file\n" \
611 " conv=noerror Continue after read errors\n" \
612 " conv=sync Pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000613 "\n" \
614 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
615 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000616#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000617 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
618 "4+0 records in\n" \
619 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000620
Eric Andersen7e9276b2001-02-22 01:15:47 +0000621#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000622 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000623#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000624 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000625
Eric Andersenf349e972001-08-21 16:18:59 +0000626#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000627 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000628#define delgroup_full_usage \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000629 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000630 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000631
632#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000633 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000634#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000635 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000636
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000637#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000638 "mntpnt [-v]" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000639 USE_DEVFSD_FG_NP("[-fg][-np]")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000640#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000641 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000642 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000643 "\n mntpnt The mount point where devfs is mounted" \
644 "\n -v Print the protocol version numbers for devfsd" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000645 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000646 USE_DEVFSD_FG_NP( \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000647 "\n -fg Run in foreground" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000648 "\n -np Exit after parsing the configuration file" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000649 "\n and processing synthetic REGISTER events," \
650 "\n do not poll for events")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000651
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000652/* -k is accepted but ignored for !HUMAN_READABLE,
653 * but we won't mention this (unimportant) */
654#if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
655#define DF_HAS_OPTIONS(x) x
656#else
657#define DF_HAS_OPTIONS(x)
658#endif
Eric Andersen7e9276b2001-02-22 01:15:47 +0000659#define df_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000660 DF_HAS_OPTIONS("[-") \
661 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
662 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000663#define df_full_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000664 "Print filesystem usage statistics" \
665 DF_HAS_OPTIONS("\n\nOptions:") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000666 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko08294db2007-08-13 12:27:49 +0000667 "\n -h Human readable (e.g. 1K 243M 2G)" \
668 "\n -m 1024*1024 blocks" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000669 "\n -k 1024 blocks" \
670 ) \
671 USE_FEATURE_DF_INODE( \
672 "\n -i Inodes" \
673 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000674#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000675 "$ df\n" \
676 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
677 "/dev/sda3 8690864 8553540 137324 98% /\n" \
678 "/dev/sda1 64216 36364 27852 57% /boot\n" \
679 "$ df /dev/sda3\n" \
680 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
681 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000682
Denis Vlasenko736230e2006-11-20 19:40:36 +0000683#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000684 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000685#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000686 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000687
688#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000689 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000690#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000691 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000692
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000693#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000694 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000695#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000696 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000697 "This diff implementation only supports unified diffs." \
698 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000699 " -a Treat all files as text\n" \
700 " -b Ignore changes in the amount of whitespace\n" \
701 " -d Try hard to find a smaller set of changes\n" \
702 " -i Ignore case differences\n" \
703 " -L Use LABEL instead of the filename in the unified header\n" \
704 " -N Treat absent files as empty\n" \
705 " -q Output only whether files differ\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +0000706 " -r Recursively compare subdirectories\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000707 " -S Start with FILE when comparing directories\n" \
708 " -T Make tabs line up by prefixing a tab when necessary\n" \
709 " -s Report when two files are the same\n" \
710 " -t Expand tabs to spaces in output\n" \
711 " -U Output LINES lines of context\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000712 " -w Ignore all whitespace"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000713
Eric Andersen7e9276b2001-02-22 01:15:47 +0000714#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000715 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000716#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000717 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000718#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000719 "$ dirname /tmp/foo\n" \
720 "/tmp\n" \
721 "$ dirname /tmp/foo/\n" \
722 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000723
Eric Andersen7e9276b2001-02-22 01:15:47 +0000724#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000725 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000726#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000727 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000728 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000729 " -c Clear ring buffer after printing\n" \
730 " -n LEVEL Set console logging level\n" \
731 " -s SIZE Buffer size"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000732
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000733#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000734 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000735#define dnsd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000736 "Small and static DNS server daemon" \
737 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000738 " -c Config filename\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000739 " -t TTL in seconds\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000740 " -p Listening port\n" \
Denis Vlasenkod3bac032007-03-24 12:13:04 +0000741 " -i Listening ip (default all)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000742 " -d Daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000743
Eric Andersen7e9276b2001-02-22 01:15:47 +0000744#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000745 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000746#define dos2unix_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000747 "Convert FILE from dos format to unix format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000748 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000749 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000750 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000751 " -u Output will be in UNIX format\n" \
752 " -d Output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000753
Eric Andersen7e9276b2001-02-22 01:15:47 +0000754#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000755 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000756#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000757 "Install, remove and manage Debian packages" \
758 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000759 " -i Install the package\n" \
760 " -l List of installed packages\n" \
761 " -C Configure an unpackaged package\n" \
762 " -F depends Ignore dependency problems\n" \
763 " -P Purge all files of a package\n" \
764 " -r Remove all but the configuration files for a package\n" \
765 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000766
Eric Andersen7e9276b2001-02-22 01:15:47 +0000767#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000768 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000769#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000770 "Perform actions on Debian packages (.debs)" \
771 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000772 " -c List contents of filesystem tree\n" \
773 " -e Extract control files to [argument] directory\n" \
774 " -f Display control field name starting with [argument]\n" \
775 " -x Extract packages filesystem tree to directory\n" \
776 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000777#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000778 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000779
Eric Andersen7e9276b2001-02-22 01:15:47 +0000780#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000781 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000782#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000783 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000784 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000785 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
786 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000787 " bytes." \
788 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000789 " -a Show sizes of files in addition to directories\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000790 " -H Follow symlinks that are FILE command line args\n" \
791 " -L Follow all symlinks encountered\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000792 " -d N Limit output to directories (and files with -a) of depth < N\n" \
793 " -c Output a grand total\n" \
794 " -l Count sizes many times if hard linked\n" \
795 " -s Display only a total for each argument\n" \
796 " -x Skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000797 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000798 " -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
799 " -m Print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000800 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000801 " -k Print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000802 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000803#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000804 "$ du\n" \
805 "16 ./CVS\n" \
806 "12 ./kernel-patches/CVS\n" \
807 "80 ./kernel-patches\n" \
808 "12 ./tests/CVS\n" \
809 "36 ./tests\n" \
810 "12 ./scripts/CVS\n" \
811 "16 ./scripts\n" \
812 "12 ./docs/CVS\n" \
813 "104 ./docs\n" \
814 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000815
Eric Andersen7e9276b2001-02-22 01:15:47 +0000816#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000817 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000818#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000819 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000820#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000821 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000822
Russ Dill61fb4892002-10-14 21:41:28 +0000823#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000824 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000825#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000826 "Display DHCP leases granted by udhcpd" \
827 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000828 USE_GETOPT_LONG( \
829 " -f,--file=FILE Leases file to load\n" \
830 " -r,--remaining Interpret lease times as time remaining\n" \
831 " -a,--absolute Interpret lease times as expire time" \
832 ) \
833 SKIP_GETOPT_LONG( \
834 " -f FILE Leases file to load\n" \
835 " -r Interpret lease times as time remaining\n" \
836 " -a Interpret lease times as expire time" \
837 )
Russ Dill61fb4892002-10-14 21:41:28 +0000838
Mike Frysinger51a43b42005-09-24 07:11:16 +0000839#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000840 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
841 "[-I inode_buffer_blocks] [-P process_inode_size] " \
842 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
843 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000844#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000845 "Check ext2/ext3 file system" \
846 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000847 " -p Automatic repair (no questions)\n" \
848 " -n Make no changes to the filesystem\n" \
849 " -y Assume 'yes' to all questions\n" \
850 " -c Check for bad blocks and add them to the badblock list\n" \
851 " -f Force checking even if filesystem is marked clean\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000852 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000853 " -b superblock Use alternative superblock\n" \
854 " -B blocksize Force blocksize when looking for superblock\n" \
855 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000856 " -l file Add to badblocks list\n" \
857 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000858
Eric Andersen7e9276b2001-02-22 01:15:47 +0000859#define echo_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +0000860 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000861#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000862 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000863 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000864 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000865 " -n Suppress trailing newline\n" \
866 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
867 " -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000868 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000869#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000870 "$ echo \"Erik is cool\"\n" \
871 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000872 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000873 "Erik\n" \
874 "is\n" \
875 "cool\n" \
876 "$ echo \"Erik\\nis\\ncool\"\n" \
877 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000878
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000879#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000880 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000881#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000882 "Eject specified DEVICE (or default /dev/cdrom)" \
883 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000884 " -t Close tray\n" \
885 " -T Open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000886
Rob Landley3b890392006-05-04 20:56:43 +0000887#define ed_trivial_usage ""
888#define ed_full_usage ""
889
Eric Andersen84e229c2001-03-29 22:48:33 +0000890#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000891 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000892#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000893 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000894 "up the specified environment" \
895 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000896 " -, -i Start with an empty environment\n" \
897 " -u Remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000898
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000899#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000900 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000901#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000902 "Send a magic packet to wake up sleeping machines.\n" \
903 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000904 "a hostname with a known 'ethers' entry." \
905 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000906 " -b Send wake-up packet to the broadcast address\n" \
907 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000908 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000909
Denis Vlasenko3952f202007-08-13 14:10:24 +0000910#define expand_trivial_usage \
911 "[-i] [-t NUM] [FILE|-]"
912#define expand_full_usage \
913 "Convert tabs to spaces, writing to standard output." \
914 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000915 USE_FEATURE_EXPAND_LONG_OPTIONS( \
916 "\n -i,--initial Do not convert tabs after non blanks" \
917 "\n -t,--tabs=N Tabstops every N chars" \
918 ) \
919 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
920 "\n -i Do not convert tabs after non blanks" \
921 "\n -t Tabstops every N chars" \
922 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000923
Eric Andersen7e9276b2001-02-22 01:15:47 +0000924#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000925 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000926#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000927 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000928 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000929 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
930 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
931 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
932 " ARG1 <= ARG2\n" \
933 " ARG1 = ARG2\n" \
934 " ARG1 != ARG2\n" \
935 " ARG1 >= ARG2\n" \
936 " ARG1 > ARG2\n" \
937 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
938 " ARG1 - ARG2\n" \
939 " ARG1 * ARG2\n" \
940 " ARG1 / ARG2\n" \
941 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000942 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
943 " match STRING REGEXP Same as STRING : REGEXP\n" \
944 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
945 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
946 " length STRING Length of STRING\n" \
947 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000948 " it is a keyword like 'match' or an\n" \
949 " operator like '/'\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000950 " (EXPRESSION) Value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000951 "Beware that many operators need to be escaped or quoted for shells.\n" \
952 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000953 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000954 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
955 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000956
Mike Frysingerfa69f112005-04-17 07:24:19 +0000957#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000958 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000959#define fakeidentd_full_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000960 "Provide fake ident (auth) service" \
961 "\n\nOptions:" \
962 "\n -f Run in foreground" \
963 "\n -i Inetd mode" \
964 "\n -w Inetd 'wait' mode" \
965 "\n -b ADDR Bind to specified address" \
966 "\n STRING Ident answer string (default is 'nobody')"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000967
Eric Andersen7e9276b2001-02-22 01:15:47 +0000968#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000969 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000970#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000971 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000972#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000973 "$ false\n" \
974 "$ echo $?\n" \
975 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000976
977#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000978 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000979#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000980 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000981#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000982 "$ fbset\n" \
983 "mode \"1024x768-76\"\n" \
984 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
985 " geometry 1024 768 1024 768 16\n" \
986 " timings 12714 128 32 16 4 128 4\n" \
987 " accel false\n" \
988 " rgba 5/11,6/5,5/0,0/0\n" \
989 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000990
Eric Andersen7e9276b2001-02-22 01:15:47 +0000991#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000992 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000993#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000994 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000995
Eric Andersen01c3d402003-07-05 07:51:31 +0000996#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000997 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +0000998#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000999 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001000 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001001 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +00001002
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001003#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001004 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001005#define fdisk_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001006 "Change partition table" \
1007 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001008 " -l List partition table(s)\n" \
1009 " -u Give Start and End in sector (instead of cylinder) units\n" \
1010 " -s PARTITION Give partition size(s) in blocks\n" \
1011 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
1012 " -C CYLINDERS Set the number of cylinders\n" \
1013 " -H HEADS Set the number of heads\n" \
1014 " -S SECTORS Set the number of sectors\n" \
1015 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +00001016
Eric Andersen7e9276b2001-02-22 01:15:47 +00001017#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001018 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001019#define find_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001020 "Search for files in a directory hierarchy. The default PATH is\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001021 "the current directory, default EXPRESSION is '-print'\n" \
1022 "\nEXPRESSION may consist of:" \
1023 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001024 USE_FEATURE_FIND_XDEV( \
1025 "\n -xdev Don't descend directories on other filesystems") \
1026 USE_FEATURE_FIND_MAXDEPTH( \
1027 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1028 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001029 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
Denis Vlasenko75aa6152007-12-09 10:07:39 +00001030 "\n -iname PATTERN Case insensitive -name" \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001031 USE_FEATURE_FIND_PATH( \
1032 "\n -path PATTERN Path matches PATTERN") \
1033 USE_FEATURE_FIND_REGEX( \
1034 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001035 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001036 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001037 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001038 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001039 "\n or exactly (NNN)") \
1040 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001041 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001042 "\n or exactly (N) days") \
1043 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001044 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001045 "\n or exactly (N) minutes") \
1046 USE_FEATURE_FIND_NEWER( \
1047 "\n -newer FILE Modified time is more recent than FILE's") \
1048 USE_FEATURE_FIND_INUM( \
1049 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001050 USE_FEATURE_FIND_USER( \
1051 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1052 USE_FEATURE_FIND_GROUP( \
1053 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1054 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001055 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001056 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001057 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1058 "\n +/-N: file size is bigger/smaller than N") \
1059 "\n -print Print (default and assumed)" \
1060 USE_FEATURE_FIND_PRINT0( \
1061 "\n -print0 Delimit output with null characters rather than" \
1062 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001063 USE_FEATURE_FIND_CONTEXT ( \
1064 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001065 USE_FEATURE_FIND_EXEC( \
1066 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1067 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001068 USE_FEATURE_FIND_PRUNE( \
1069 "\n -prune Stop traversing current subtree") \
1070 USE_FEATURE_FIND_DELETE( \
1071 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001072 USE_FEATURE_FIND_PAREN( \
1073 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001074
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001075#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001076 "$ find / -name passwd\n" \
1077 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001078
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001079#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001080 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001081#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001082 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001083 "standard output" \
1084 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001085 " -b Count bytes rather than columns\n" \
1086 " -s Break at spaces\n" \
1087 " -w Use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001088
Eric Andersen7e9276b2001-02-22 01:15:47 +00001089#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001090 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001091#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001092 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001093#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001094 "$ free\n" \
1095 " total used free shared buffers\n" \
1096 " Mem: 257628 248724 8904 59644 93124\n" \
1097 " Swap: 128516 8404 120112\n" \
1098 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001099
Eric Andersen7e9276b2001-02-22 01:15:47 +00001100#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001101 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001102#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001103 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001104#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001105 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001106
Mike Frysinger51a43b42005-09-24 07:11:16 +00001107#define fsck_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001108 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001109#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001110 "Check and repair filesystems" \
1111 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001112 " -A Walk /etc/fstab and check all filesystems\n" \
1113 " -N Don't execute, just show what would be done\n" \
1114 " -P When using -A, check filesystems in parallel\n" \
1115 " -R When using -A, skip the root filesystem\n" \
1116 " -T Don't show title on startup\n" \
Denis Vlasenko0de93752006-12-26 02:51:29 +00001117 " -V Verbose\n" \
1118 " -C n Write status information to specified filedescriptor\n" \
1119 " -t type List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001120
Eric Andersen7e9276b2001-02-22 01:15:47 +00001121#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001122 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001123#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001124 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001125 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001126 " -l List all filenames\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001127 " -r Perform interactive repairs\n" \
1128 " -a Perform automatic repairs\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001129 " -v Verbose\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001130 " -s Output super-block information\n" \
1131 " -m Activate MINIX-like \"mode not cleared\" warnings\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001132 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001133
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001134#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001135 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001136#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001137 "Retrieve a remote file via FTP" \
1138 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001139 USE_GETOPT_LONG( \
1140 " -c,--continue Continue previous transfer\n" \
1141 " -v,--verbose Verbose\n" \
1142 " -u,--username Username\n" \
1143 " -p,--password Password\n" \
1144 " -P,--port Port number" \
1145 ) \
1146 SKIP_GETOPT_LONG( \
1147 " -c Continue previous transfer\n" \
1148 " -v Verbose\n" \
1149 " -u Username\n" \
1150 " -p Password\n" \
1151 " -P Port number" \
1152 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001153
1154#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001155 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001156#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001157 "Store a local file on a remote machine via FTP" \
1158 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001159 USE_GETOPT_LONG( \
1160 " -v,--verbose Verbose\n" \
1161 " -u,--username Username\n" \
1162 " -p,--password Password\n" \
1163 " -P,--port Port number" \
1164 ) \
1165 SKIP_GETOPT_LONG( \
1166 " -v Verbose\n" \
1167 " -u Username\n" \
1168 " -p Password\n" \
1169 " -P Port number" \
1170 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001171
Rob Landleyaa872762005-10-28 13:05:12 +00001172#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001173 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +00001174#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001175 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001176 " -m Show all processes on the same mounted fs\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001177 " -k Kill all processes that match\n" \
1178 " -s Don't print or kill anything\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001179 " -4 When using port/proto only search IPv4 space\n" \
1180 " -6 When using port/proto only search IPv6 space\n" \
1181 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001182
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001183#define getenforce_trivial_usage
1184#define getenforce_full_usage
1185
Eric Andersen7e9276b2001-02-22 01:15:47 +00001186#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001187 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001188#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001189 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001190 USE_GETOPT_LONG( \
1191 " -a,--alternative Allow long options starting with single -\n" \
1192 " -l,--longoptions=longopts Long options to be recognized\n" \
1193 " -n,--name=progname The name under which errors are reported\n" \
1194 " -o,--options=optstring Short options to be recognized\n" \
1195 " -q,--quiet Disable error reporting by getopt(3)\n" \
1196 " -Q,--quiet-output No normal output\n" \
1197 " -s,--shell=shell Set shell quoting conventions\n" \
1198 " -T,--test Test for getopt(1) version\n" \
1199 " -u,--unquoted Don't quote the output" \
1200 ) \
1201 SKIP_GETOPT_LONG( \
1202 " -a Allow long options starting with single -\n" \
1203 " -l longopts Long options to be recognized\n" \
1204 " -n progname The name under which errors are reported\n" \
1205 " -o optstring Short options to be recognized\n" \
1206 " -q Disable error reporting by getopt(3)\n" \
1207 " -Q No normal output\n" \
1208 " -s shell Set shell quoting conventions\n" \
1209 " -T Test for getopt(1) version\n" \
1210 " -u Don't quote the output" \
1211 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001212#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001213 "$ cat getopt.test\n" \
1214 "#!/bin/sh\n" \
1215 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1216 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001217 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001218 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001219 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001220 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001221 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1222 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001223 " -c|--c-long)\n" \
1224 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001225 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1226 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1227 " esac;;\n" \
1228 " --) shift; break;;\n" \
1229 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001230 " esac\n" \
1231 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001232
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001233#define getsebool_trivial_usage \
1234 "-a or getsebool boolean..."
1235#define getsebool_full_usage \
1236 " -a Show all SELinux booleans"
1237
Eric Andersenf349e972001-08-21 16:18:59 +00001238#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001239 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001240#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001241 "Open a tty, prompt for a login name, then invoke /bin/login" \
1242 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001243 " -h Enable hardware (RTS/CTS) flow control\n" \
1244 " -i Do not display /etc/issue before running login\n" \
1245 " -L Local line, so do not do carrier detect\n" \
1246 " -m Get baud rate from modem's CONNECT status message\n" \
1247 " -w Wait for a CR or LF before sending /etc/issue\n" \
1248 " -n Do not prompt the user for a login name\n" \
1249 " -f issue_file Display issue_file instead of /etc/issue\n" \
1250 " -l login_app Invoke login_app instead of /bin/login\n" \
1251 " -t timeout Terminate after timeout if no username is read\n" \
1252 " -I initstring Sets the init string to send before anything else\n" \
1253 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001254
Eric Andersen7e9276b2001-02-22 01:15:47 +00001255#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001256 "[-HhrilLnqvso" \
1257 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001258 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001259 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1260 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001261 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001262#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001263 "Search for PATTERN in each FILE or standard input" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001264 "\n\nOptions:" \
1265 "\n -H Prefix output lines with filename where match was found" \
1266 "\n -h Suppress the prefixing filename on output" \
1267 "\n -r Recurse subdirectories" \
1268 "\n -i Ignore case distinctions" \
1269 "\n -l List names of files that match" \
1270 "\n -L List names of files that do not match" \
1271 "\n -n Print line number with output lines" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001272 "\n -q Quiet. Returns 0 if PATTERN was found, 1 otherwise" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001273 "\n -v Select non-matching lines" \
1274 "\n -s Suppress file open/read error messages" \
1275 "\n -c Only print count of matching lines" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001276 "\n -o Show only the part of a line that matches PATTERN" \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001277 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001278 USE_DESKTOP( \
1279 "\n -w Match whole words only") \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001280 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001281 USE_FEATURE_GREP_EGREP_ALIAS( \
1282 "\n -E PATTERN is an extended regular expression") \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001283 "\n -e PTRN Pattern to match" \
1284 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001285 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001286 "\n -A Print NUM lines of trailing context" \
1287 "\n -B Print NUM lines of leading context" \
1288 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001289
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001290#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001291 "$ grep root /etc/passwd\n" \
1292 "root:x:0:0:root:/root:/bin/bash\n" \
1293 "$ grep ^[rR]oo. /etc/passwd\n" \
1294 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001295
Eric Andersen7e9276b2001-02-22 01:15:47 +00001296#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001297 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001298#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001299 "Uncompress FILE (or standard input if FILE is '-')" \
1300 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001301 " -c Write output to standard output\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001302 " -f Force\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001303 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001304#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001305 "$ ls -la /tmp/BusyBox*\n" \
1306 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1307 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1308 "$ ls -la /tmp/BusyBox*\n" \
1309 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001310
1311#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001312 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001313#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001314 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001315 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001316 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001317 " -c Write output to standard output instead of FILE.gz\n" \
1318 " -d Decompress\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001319 " -f Force"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001320#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001321 "$ ls -la /tmp/busybox*\n" \
1322 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1323 "$ gzip /tmp/busybox.tar\n" \
1324 "$ ls -la /tmp/busybox*\n" \
1325 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001326
1327#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001328 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001329#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001330 "Halt the system" \
1331 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001332 " -d Delay interval for halting\n" \
1333 " -n No call to sync()\n" \
1334 " -f Force halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001335
Eric Andersen3443bd72003-07-22 07:30:36 +00001336#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001337 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001338#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001339 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001340 "If no device name is specified try to read from stdin.\n\n") \
1341 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001342 " -a Get/set fs readahead\n" \
1343 " -A Set drive read-lookahead flag (0/1)\n" \
1344 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1345 " -B Set Advanced Power Management setting (1-255)\n" \
1346 " -c Get/set IDE 32-bit IO setting\n" \
1347 " -C Check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001348 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001349 " -d Get/set using_dma flag\n") \
1350 " -D Enable/disable drive defect-mgmt\n" \
1351 " -f Flush buffer cache for device on exit\n" \
1352 " -g Display drive geometry\n" \
1353 " -h Display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001354 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001355 " -i Display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001356 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001357 " -I Detailed/current information directly from drive\n") \
1358 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1359 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1360 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1361 " -m Get/set multiple sector count\n" \
1362 " -n Get/set ignore-write-errors flag (0/1)\n" \
1363 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1364 " -P Set drive prefetch count\n" \
1365 " -q Change next setting quietly\n" \
1366 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1367 " -r Get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001368 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001369 " -R Register an IDE interface (DANGEROUS)\n") \
1370 " -S Set standby (spindown) timeout\n" \
1371 " -t Perform device read timings\n" \
1372 " -T Perform cache read timings\n" \
1373 " -u Get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001374 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001375 " -U Un-register an IDE interface (DANGEROUS)\n") \
1376 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1377 " -V Display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001378 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001379 " -w Perform device reset (DANGEROUS)\n") \
1380 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001381 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001382 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1383 " -X Set IDE xfer mode (DANGEROUS)\n" \
1384 " -y Put IDE drive in standby mode\n" \
1385 " -Y Put IDE drive to sleep\n" \
1386 " -Z Disable Seagate auto-powersaving mode\n" \
1387 " -z Re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001388
Eric Andersen7e9276b2001-02-22 01:15:47 +00001389#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001390 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001391#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001392 "Print first 10 lines of each FILE to standard output.\n" \
1393 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001394 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001395 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001396 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001397 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001398 "\n -c NUM Output the first NUM bytes" \
1399 "\n -q Never output headers giving file names" \
1400 "\n -v Always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001401#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001402 "$ head -n 2 /etc/passwd\n" \
1403 "root:x:0:0:root:/root:/bin/bash\n" \
1404 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001405
Glenn L McGrath60281112001-11-02 11:39:46 +00001406#define hexdump_trivial_usage \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001407 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
Glenn L McGrath60281112001-11-02 11:39:46 +00001408#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001409 "Display file(s) or standard input in a user specified format" \
Denis Vlasenkofbe5f392007-11-18 05:36:50 +00001410 "\n\nOptions:" \
1411 "\n -b One-byte octal display" \
1412 "\n -c One-byte character display" \
1413 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1414 "\n -d Two-byte decimal display" \
1415 "\n -e FORMAT STRING" \
1416 "\n -f FORMAT FILE" \
1417 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1418 "\n -o Two-byte octal display" \
1419 "\n -s OFFSET Skip OFFSET bytes" \
1420 "\n -v Display all input data" \
1421 "\n -x Two-byte hexadecimal display" \
1422 USE_FEATURE_HEXDUMP_REVERSE( \
1423 "\n -R Reverse of 'hexdump -Cv'") \
1424
1425#define hd_trivial_usage \
1426 "FILE..."
1427#define hd_full_usage \
1428 "hd is an alias for hexdump -C"
Glenn L McGrath60281112001-11-02 11:39:46 +00001429
Eric Andersen7e9276b2001-02-22 01:15:47 +00001430#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001431 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001432#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001433 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001434
1435#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001436 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001437#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001438 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001439 "(or FILE with the -F parameter), the host name will be set." \
1440 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001441 " -s Short\n" \
1442 " -i Addresses for the hostname\n" \
1443 " -d DNS domain name\n" \
1444 " -f Fully qualified domain name\n" \
1445 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001446#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001447 "$ hostname\n" \
1448 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001449
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001450#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001451 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001452 " [-p [ip:]port]" \
1453 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001454 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001455 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001456 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001457 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001458 " [-d/-e string]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001459#define httpd_full_usage \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001460 "Listen for incoming HTTP requests" \
1461 "\n\nOptions:" \
1462 "\n -c FILE Configuration file (default httpd.conf)" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001463 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001464 "\n -i Inetd mode" \
1465 "\n -f Do not daemonize" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001466 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001467 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001468 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001469 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001470 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001471 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001472 "\n -m PASS Crypt PASS with md5 algorithm") \
1473 "\n -h HOME Home directory (default .)" \
1474 "\n -e STRING HTML encode STRING" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001475 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001476
Robert Griebl1cd04452002-07-21 16:50:49 +00001477#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001478 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001479 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1480 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001481 " [-f FILE]" \
1482 ) \
1483 SKIP_GETOPT_LONG( \
1484 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1485 )
Robert Griebl1cd04452002-07-21 16:50:49 +00001486#define hwclock_full_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001487 "Query and set a hardware clock (RTC)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001488 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001489 " -r Read hardware clock and print result\n" \
1490 " -s Set the system time from the hardware clock\n" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001491 " -w Set the hardware clock to the system time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001492 " -u The hardware clock is kept in coordinated universal time\n" \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001493 " -l The hardware clock is kept in local time\n" \
1494 " -f FILE Use the specified clock (e.g. /dev/rtc2)"
Robert Griebl1cd04452002-07-21 16:50:49 +00001495
Eric Andersen7e9276b2001-02-22 01:15:47 +00001496#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001497 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001498#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001499 "Print information for USERNAME or the current user" \
1500 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001501 USE_SELINUX( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001502 " -Z Prints only the security context\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001503 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001504 " -g Prints only the group ID\n" \
1505 " -u Prints only the user ID\n" \
1506 " -n Print a name instead of a number\n" \
1507 " -r Prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001508#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001509 "$ id\n" \
1510 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001511
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001513 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001514#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001515 "Configure a network interface" \
1516 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001517 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001518 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001519 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001520 " [del ADDRESS[/PREFIXLEN]]\n") \
1521 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1522 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001523 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001524 " [outfill NN] [keepalive NN]\n") \
1525 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001526 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001527 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001528 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001529 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001530 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001531
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001532#define ifup_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001533 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001534#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001535 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001536 " -a De/configure all interfaces automatically\n" \
1537 " -i FILE Use FILE for interface definitions\n" \
1538 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001539 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001540 " -v Print out what would happen before doing it\n" \
1541 " -m Don't run any mappings\n" \
1542 " -f Force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001543
1544#define ifdown_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001545 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001546#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001547 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001548 " -a De/configure all interfaces automatically\n" \
1549 " -i FILE Use FILE for interface definitions\n" \
1550 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001551 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001552 " -v Print out what would happen before doing it\n" \
1553 " -m Don't run any mappings\n" \
1554 " -f Force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001555
Glenn L McGrath06e95652003-02-09 06:51:14 +00001556#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001557 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001558#define inetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001559 "Listen for network connections and launch programs" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001560 "\n\nOptions:\n" \
Denis Vlasenko886bb0d2007-01-09 23:48:46 +00001561 " -f Run in foreground\n" \
1562 " -q N Set the size of the socket listen queue to N\n" \
1563 " (default: 128)"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001564
Eric Andersen7e9276b2001-02-22 01:15:47 +00001565#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001566 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001567#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001568 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001569#define init_notes_usage \
1570"This version of init is designed to be run only by the kernel.\n" \
1571"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001572"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001573"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001574"runlevels, use sysvinit.\n" \
1575"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001576"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001577"it has the following default behavior:\n" \
1578"\n" \
1579" ::sysinit:/etc/init.d/rcS\n" \
1580" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001581" ::ctrlaltdel:/sbin/reboot\n" \
1582" ::shutdown:/sbin/swapoff -a\n" \
1583" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001584" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001585"\n" \
1586"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1587"\n" \
1588" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001589" tty3::askfirst:/bin/sh\n" \
1590" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001591"\n" \
1592"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1593"\n" \
1594" <id>:<runlevels>:<action>:<process>\n" \
1595"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001596" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001597"\n" \
1598" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1599" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001600" the specified process to run on. The contents of this field are\n" \
1601" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1602" be unique, although if it isn't you may have strange results. If this\n" \
1603" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001604" note that if BusyBox detects that a serial console is in use, then only\n" \
1605" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001606" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001607" stinkin' utmp.\n" \
1608"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001609" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001610"\n" \
1611" The runlevels field is completely ignored.\n" \
1612"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001613" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001614"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001615" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001616" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001617"\n" \
1618" The available actions can be classified into two groups: actions\n" \
1619" that are run only once, and actions that are re-run when the specified\n" \
1620" process exits.\n" \
1621"\n" \
1622" Run only-once actions:\n" \
1623"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001624" 'sysinit' is the first item run on boot. init waits until all\n" \
1625" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001626" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001627" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001628" the specified task completes. 'once' actions are asynchronous,\n" \
1629" therefore, init does not wait for them to complete. 'restart' is\n" \
1630" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001631" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001632" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001633" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001634" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001635" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001636" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001637" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001638" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001639"\n" \
1640" Run repeatedly actions:\n" \
1641"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001642" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001643" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001644" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1645" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001646" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001647" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001648" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001649" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001650"\n" \
1651" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001652" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001653" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001654"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001655" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001656"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001657" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001658"\n" \
1659"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001660"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001661" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001662" #\n" \
1663" ::sysinit:/etc/init.d/rcS\n" \
1664" \n" \
1665" # /bin/sh invocations on selected ttys\n" \
1666" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001667" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001668" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001669" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001670" tty2::askfirst:-/bin/sh\n" \
1671" tty3::askfirst:-/bin/sh\n" \
1672" tty4::askfirst:-/bin/sh\n" \
1673" \n" \
1674" # /sbin/getty invocations for selected ttys\n" \
1675" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001676" tty4::respawn:/sbin/getty 38400 tty4\n" \
1677" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001678" \n" \
1679" \n" \
1680" # Example of how to put a getty on a serial line (for a terminal)\n" \
1681" #\n" \
1682" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1683" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1684" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001685" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001686" #::respawn:/sbin/getty 57600 ttyS2\n" \
1687" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001688" # Stuff to do when restarting the init process\n" \
1689" ::restart:/sbin/init\n" \
1690" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001691" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001692" ::ctrlaltdel:/sbin/reboot\n" \
1693" ::shutdown:/bin/umount -a -r\n" \
1694" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001695
1696#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001697 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001699 "Load the specified kernel modules into the kernel" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001700 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001701 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001702 " -f Force module to load into the wrong kernel version\n" \
1703 " -k Make module autoclean-able\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001704 " -v Verbose\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001705 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001706 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001707 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001708 " -m Output load map to stdout\n" \
1709 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001710 " -o NAME Set internal module name to NAME\n" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001711 " -x Do not export externs" \
1712 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001713
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001714#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001715 "[-cgmops] [sources] dest|directory"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001716#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001717 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001718 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001719 " -c Copy the file, default\n" \
1720 " -d Create directories\n" \
1721 " -g Set group ownership\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001722 " -m Set permissions\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001723 " -o Set ownership\n" \
1724 " -p Preserve date\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001725 " -s Strip symbol tables" \
1726 USE_SELINUX( \
1727 "\n -Z Set security context of copy" \
1728 )
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001729/* would need to make the " | " optional depending on more than one selected */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001730#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001731 "[OPTIONS] {" \
1732 USE_FEATURE_IP_ADDRESS("address | ") \
1733 USE_FEATURE_IP_ROUTE("route | ") \
1734 USE_FEATURE_IP_LINK("link | ") \
1735 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1736 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001737 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001738#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001739 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001740 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001741 USE_FEATURE_IP_ADDRESS("address | ") \
1742 USE_FEATURE_IP_ROUTE("route | ") \
1743 USE_FEATURE_IP_LINK("link | ") \
1744 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1745 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001746 "}\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001747 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001748
1749#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001750 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001751 " [dev STRING] [to PREFIX] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001752#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001753 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001754 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1755 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001756 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001757 " [broadcast ADDR] [anycast ADDR]\n" \
1758 " [label STRING] [scope SCOPE-ID]\n" \
1759 " SCOPE-ID := [host | link | global | NUMBER]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001760
Eric Andersende4f07e2003-12-11 01:18:07 +00001761#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001762 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001763#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001764 "Calculate IP network settings from a IP address" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001765 "\n\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001766 USE_FEATURE_IPCALC_LONG_OPTIONS( \
1767 "\n -b,--broadcast Display calculated broadcast address" \
1768 "\n -n,--network Display calculated network address" \
1769 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001770 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko03630782007-10-18 11:11:12 +00001771 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1772 "\n -h,--hostname Display first resolved host name" \
1773 "\n -s,--silent Don't ever display error messages" \
1774 ) \
1775 ) \
1776 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
1777 "\n -b Display calculated broadcast address" \
1778 "\n -n Display calculated network address" \
1779 "\n -m Display default netmask for IP" \
1780 USE_FEATURE_IPCALC_FANCY( \
1781 "\n -p Display the prefix for IP/NETMASK" \
1782 "\n -h Display first resolved host name" \
1783 "\n -s Don't ever display error messages" \
1784 ) \
1785 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001786
Rob Landley6eb1e412005-06-20 04:30:36 +00001787#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001788 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001789#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001790 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1791 "segment by a shmkey value. The lower-case options mqs are used\n" \
1792 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001793 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001794 " -[mM] Remove the memory segment after the last detach\n" \
1795 " -[qQ] Remove the message queue\n" \
1796 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001797
1798#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001799 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001800#define ipcs_full_usage \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001801 " -i Show a specific resource\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001802 "Resource specification:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001803 " -m Shared memory segments\n" \
1804 " -q Message queues\n" \
1805 " -s Semaphore arrays\n" \
1806 " -a All (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001807 "Output format:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001808 " -t Time\n" \
1809 " -c Creator\n" \
1810 " -p Pid\n" \
1811 " -l Limits\n" \
1812 " -u Summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001813
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001814#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001815 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001816#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001817 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001818 " dynamic { on | off } |\n" \
1819 " mtu MTU }\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001820 "iplink show [DEVICE]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001821
1822#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001823 "{ list | flush | { add | del | change | append |\n" \
1824 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001825#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001826 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001827 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1828 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001829 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001830 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
1831 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001832
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001833#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001834 "{[list | add | del] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001835#define iprule_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001836 "iprule [list | add | del] SELECTOR ACTION\n" \
1837 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1838 " [dev STRING] [pref NUMBER]\n" \
1839 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1840 " [prohibit | reject | unreachable]\n" \
1841 " [realms [SRCREALM/]DSTREALM]\n" \
1842 " TABLE_ID := [local | main | default | NUMBER]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001843
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001844#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001845 "{ add | change | del | show } [NAME]\n" \
1846 " [mode { ipip | gre | sit }]\n" \
1847 " [remote ADDR] [local ADDR] [ttl TTL]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001848#define iptunnel_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001849 "iptunnel { add | change | del | show } [NAME]\n" \
1850 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1851 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
1852 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001853
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001854#define kbd_mode_trivial_usage \
1855 "[-a|k|s|u]"
1856#define kbd_mode_full_usage \
1857 "Report or set the keyboard mode" \
1858 "\n\nOptions set mode:\n" \
1859 " -a Default (ASCII)\n" \
1860 " -k Medium-raw (keyboard)\n" \
1861 " -s Raw (scancode)\n" \
1862 " -u Unicode (utf-8)"
1863
Eric Andersen7e9276b2001-02-22 01:15:47 +00001864#define kill_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001865 "[-l] [-signal] process-id [process-id...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001866#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001867 "Send a signal (default is TERM) to the specified process(es)" \
1868 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001869 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001870#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001871 "$ ps | grep apache\n" \
1872 "252 root root S [apache]\n" \
1873 "263 www-data www-data S [apache]\n" \
1874 "264 www-data www-data S [apache]\n" \
1875 "265 www-data www-data S [apache]\n" \
1876 "266 www-data www-data S [apache]\n" \
1877 "267 www-data www-data S [apache]\n" \
1878 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001879
1880#define killall_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001881 "[-l] [-q] [-signal] process-name [process-name...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001882#define killall_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001883 "Send a signal (default is TERM) to the specified process(es)" \
1884 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001885 " -l List all signal names and numbers\n" \
1886 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001887#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001888 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001889
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001890#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001891 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001892#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001893 "Send a signal (default is TERM) to all processes outside current session" \
1894 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001895 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001896
Mark Whitley6317c4b2001-03-12 22:51:50 +00001897#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001898 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001899#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001900 "Kernel logger" \
1901 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001902 " -c n Sets the default log level of console messages to n\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001903 " -n Run in foreground"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001904
Eric Andersen7e9276b2001-02-22 01:15:47 +00001905#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001906 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001907#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001908 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001909#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001910 "$ length Hello\n" \
1911 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001912
Rob Landley9200e792005-09-15 19:26:59 +00001913#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001914 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001915#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001916 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001917 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001918 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001919 " -E Quit once the end of a file is reached\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001920 " -M,-m Display a status line containing the current line numbers\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001921 " and the percentage through the file\n" \
1922 " -N Prefix line numbers to each line\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001923 " -~ Suppress ~s displayed when input past the end of the file is\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001924 " reached"
Rob Landley9200e792005-09-15 19:26:59 +00001925
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001926#define setarch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001927 "personality program [args...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001928#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001929 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001930 " linux32 Set 32bit uname emulation\n" \
1931 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001932
Eric Andersen7e9276b2001-02-22 01:15:47 +00001933#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001934 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001935#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001936 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1937 "You may use '--' to indicate that all following arguments are non-options." \
1938 "\n\nOptions:\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00001939 " -s Make symlinks instead of hardlinks\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001940 " -f Remove existing destination files\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001941 " -n Don't dereference symlinks - treat like normal file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001942 " -b Make a backup of the target (if exists) before link operation\n" \
1943 " -S suf Use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001944#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001945 "$ ln -s BusyBox /tmp/ls\n" \
1946 "$ ls -l /tmp/ls\n" \
1947 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001948
Denis Vlasenkob042bd92007-09-26 18:01:32 +00001949#define load_policy_trivial_usage
1950
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00001951#define load_policy_full_usage
1952
Eric Andersen7e9276b2001-02-22 01:15:47 +00001953#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001954 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001955#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001956 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001957#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001958 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001959
1960#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001961 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001962#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001963 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001964#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001965 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001966
1967#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001968 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001969#define logger_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001970 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001971 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001972 " -s Log to stderr as well as the system log\n" \
1973 " -t TAG Log using the specified tag (defaults to user name)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001974 " -p PRIO Enter the message with the specified priority.\n" \
1975 " This may be numerical or a 'facility.level' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001976#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001977 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001978
Robert Griebl1fca5582002-06-04 20:45:46 +00001979#define login_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00001980 "[OPTION]... [username] [ENV=VAR...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00001981#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001982 "Begin a new session on the system" \
1983 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001984 " -f Do not authenticate (user already authenticated)\n" \
1985 " -h Name of the remote host for this login\n" \
1986 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001987
Eric Andersen7e9276b2001-02-22 01:15:47 +00001988#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001989 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001990#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001991 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001992#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001993 "$ logname\n" \
1994 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001995
Mark Whitley6317c4b2001-03-12 22:51:50 +00001996#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001997 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001998#define logread_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001999 "Show the messages from syslogd (using circular buffer)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002000 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002001 " -f Output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00002002
Matt Kraai83788da2002-03-20 17:38:37 +00002003#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002004 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
2005 " losetup -d LOOPDEV - disassociate\n" \
2006 " losetup [-f] - show"
Matt Kraai83788da2002-03-20 17:38:37 +00002007#define losetup_full_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002008 "Options:\n" \
2009 " -o OFS Start OFS bytes into FILE\n" \
2010 " -f Show first free loop device"
Rob Landley1d589b22005-11-29 23:47:10 +00002011#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002012 "No arguments will display all current associations.\n" \
2013 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002014 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002015 "and filename of the file the loop device is currently bound to.\n\n" \
2016 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00002017 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
2018 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00002019
Eric Andersen7e9276b2001-02-22 01:15:47 +00002020#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002021 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00002022 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002023 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2024 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2025 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2026 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2027 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2028 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002029#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002030 "List directory contents" \
2031 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002032 "\n -1 List files in a single column" \
2033 "\n -A Do not list implied . and .." \
2034 "\n -a Do not hide entries starting with ." \
2035 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002036 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002037 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002038 USE_FEATURE_LS_COLOR( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002039 "\n --color[={always,never,auto}] Control coloring") \
2040 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002041 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002042 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002043 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002044 "\n -F Append indicator (one of */=@|) to entries") \
2045 "\n -i List the i-node for each file" \
2046 "\n -l Use a long listing format" \
2047 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002048 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002049 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002050 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002051 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002052 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002053 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002054 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002055 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002056 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002057 "\n -S Sort the listing by file size") \
2058 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002059 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002060 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002061 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002062 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002063 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002064 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002065 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002066 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002067 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002068 "\n -w NUM Assume the terminal is NUM columns wide") \
2069 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002070 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002071 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002072 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002073 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002074 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002075 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002076 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002077 "\n -K Print security context in long format") \
2078 USE_SELINUX( \
2079 "\n -Z Print security context and permission")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002080
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002081#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002082 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002083#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002084 "List file attributes on an ext2 fs" \
2085 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002086 " -R Recursively list subdirectories\n" \
2087 " -a Do not hide entries starting with .\n" \
2088 " -d List directory entries instead of contents\n" \
2089 " -l Print long flag names\n" \
2090 " -v List the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002091
Eric Andersen7e9276b2001-02-22 01:15:47 +00002092#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002093 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002094#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002095 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002096
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002097#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002098#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002099 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002100#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002101 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002102 "TYPEs include:\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002103 " b: Make a block (buffered) device\n" \
2104 " c or u: Make a character (un-buffered) device\n" \
2105 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
2106 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002107 "FIRST specifies the number appended to NAME to create the first device.\n" \
2108 "LAST specifies the number of the last item that should be created\n" \
2109 "If 's' is the last argument, the base device is created as well.\n\n" \
2110 "For example:\n" \
2111 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2112 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002113#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002114 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2115 "[creates ttyS2-ttyS63]\n" \
2116 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2117 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002118#endif
2119
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002120#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002121#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002122 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00002123#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002124 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002125 "Device table entries take the form of:\n" \
2126 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002127 "Where name is the file name, type can be one of:\n" \
2128 " f A regular file\n" \
2129 " d Directory\n" \
2130 " c Character special device file\n" \
2131 " b Block special device file\n" \
2132 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002133 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002134 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2135 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002136#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002137 "For example:\n" \
2138 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2139 "/dev d 755 0 0 - - - - -\n" \
2140 "/dev/console c 666 0 0 5 1 - - -\n" \
2141 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2142 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2143 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2144 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2145 "Will Produce:\n" \
2146 "/dev\n" \
2147 "/dev/console\n" \
2148 "/dev/null\n" \
2149 "/dev/zero\n" \
2150 "/dev/hda\n" \
2151 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002152#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002153
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002154#define matchpathcon_trivial_usage \
2155 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2156#define matchpathcon_full_usage \
2157 " -n Do not display path" \
2158 "\n -N Do not use translations" \
2159 "\n -f Use alternate file_context file" \
2160 "\n -p Use prefix to speed translations" \
2161 "\n -V Verify file context on disk matches defaults"
2162
Eric Andersen7e9276b2001-02-22 01:15:47 +00002163#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002164 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002165 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002166#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002167 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2168 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002169 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002170 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002171 " -c Check MD5 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002172 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002173 " -s Don't output anything, status code shows success\n" \
2174 " -w Warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002175#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002176 "$ md5sum < busybox\n" \
2177 "6fd11e98b98a58f64ff3398d7b324003\n" \
2178 "$ md5sum busybox\n" \
2179 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2180 "$ md5sum -c -\n" \
2181 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2182 "busybox: OK\n" \
2183 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002184
Rob Landley70f7ef72005-12-13 08:21:33 +00002185#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002186 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002187#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002188 " -s Scan /sys and populate /dev during system boot\n\n" \
2189 "Called with no options (via hotplug) it uses environment variables\n" \
2190 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00002191#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002192 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002193 "The mdev config file contains lines that look like:\n" \
2194 " hd[a-z][0-9]* 0:3 660\n\n" \
2195 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002196 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002197 "Optionally, that can be followed (on the same line) by a special character\n" \
2198 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002199 "device(s). The environment variable $MDEV indicates the active device node\n" \
2200 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002201 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2202 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002203 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002204 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002205 ) \
Denis Vlasenko223bc972007-11-22 00:58:49 +00002206 "Config file parsing stops on the first matching line. If no config\n" \
2207 "entry is matched, devices are created with default 0:0 660. (Make\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002208 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002209 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002210
Glenn L McGrath061c9002002-09-16 04:21:46 +00002211#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002212 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002213#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002214 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002215 " y Allow write access to your terminal\n" \
2216 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002217
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002218#define microcom_trivial_usage \
2219 "[-s speed] tty-name"
2220#define microcom_full_usage \
2221 ""
2222
Eric Andersen7e9276b2001-02-22 01:15:47 +00002223#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002224 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002225#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002226 "Create the DIRECTORY(ies) if they do not already exist" \
2227 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002228 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002229 " -p No error if existing, make parent directories as needed" \
2230 USE_SELINUX( \
2231 "\n -Z Set security context" \
2232 )
2233
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002234#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002235 "$ mkdir /tmp/foo\n" \
2236 "$ mkdir /tmp/foo\n" \
2237 "/tmp/foo: File exists\n" \
2238 "$ mkdir /tmp/foo/bar/baz\n" \
2239 "/tmp/foo/bar/baz: No such file or directory\n" \
2240 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002241
Mike Frysinger6447ac02005-06-11 05:29:40 +00002242#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002243 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2244 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2245 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2246 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2247 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2248 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002249#define mke2fs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002250 " -b size Block size in bytes\n" \
2251 " -c Check for bad blocks before creating\n" \
2252 " -E opts Set extended options\n" \
2253 " -f size Fragment size in bytes\n" \
2254 " -F Force (ignore sanity checks)\n" \
2255 " -g num Number of blocks in a block group\n" \
2256 " -i ratio The bytes/inode ratio\n" \
2257 " -j Create a journal (ext3)\n" \
2258 " -J opts Set journal options (size/device)\n" \
2259 " -l file Read bad blocks list from file\n" \
2260 " -L lbl Set the volume label\n" \
2261 " -m percent Percent of fs blocks to reserve for admin\n" \
2262 " -M dir Set last mounted directory\n" \
2263 " -n Do not actually create anything\n" \
2264 " -N num Number of inodes to create\n" \
2265 " -o os Set the 'creator os' field\n" \
2266 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002267 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002268 " -r rev Set filesystem revision\n" \
2269 " -S Write superblock and group descriptors only\n" \
2270 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002271 " -v Verbose"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002272
Eric Andersen7e9276b2001-02-22 01:15:47 +00002273#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002274 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002275#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002276 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002277 "\n\nOptions:\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002278 " -m Create the pipe using the specified mode (default a=rw)" \
2279 USE_SELINUX( \
2280 "\n -Z Set security context" \
2281 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002282
Eric Andersen7e9276b2001-02-22 01:15:47 +00002283#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002284 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002285#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002286 "Make a MINIX filesystem" \
2287 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002288 " -c Check device for bad blocks\n" \
2289 " -n [14|30] Maximum length of filenames\n" \
2290 " -i INODES Number of inodes for the filesystem\n" \
2291 " -l FILENAME Read bad blocks list from FILENAME\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002292 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002293
Eric Andersen7e9276b2001-02-22 01:15:47 +00002294#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002295 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002296#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002297 "Create a special file (block, character, or pipe)" \
2298 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002299 " -m Create the special file using the specified mode (default a=rw)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002300 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002301 " b: Make a block (buffered) device\n" \
2302 " c or u: Make a character (un-buffered) device\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002303 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes" \
2304 USE_SELINUX( \
2305 "\n -Z Set security context" \
2306 )
2307
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002308#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002309 "$ mknod /dev/fd0 b 2 0\n" \
2310 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002311
Eric Andersen7e9276b2001-02-22 01:15:47 +00002312#define mkswap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002313 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002314#define mkswap_full_usage \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00002315 "Prepare a disk partition to be used as swap partition" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002316 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002317 " -c Check for read-ability\n" \
2318 " -v0 Make version 0 swap [max 128 Megs]\n" \
2319 " -v1 Make version 1 swap [big!] (default for kernels > 2.1.117)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002320 " block-count Number of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002321
Eric Andersen7e9276b2001-02-22 01:15:47 +00002322#define mktemp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002323 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002324#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002325 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002326 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2327 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002328 " -d Make a directory instead of a file\n" \
2329 " -q Fail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002330#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002331 "$ mktemp /tmp/temp.XXXXXX\n" \
2332 "/tmp/temp.mWiLjM\n" \
2333 "$ ls -la /tmp/temp.mWiLjM\n" \
2334 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002335
Eric Andersen8d79ce82001-07-22 23:00:15 +00002336#define modprobe_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002337 "[-knqrsv] MODULE [symbol=value...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002338#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002339 "Options:\n" \
2340 " -k Make module autoclean-able\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002341 " -n Dry run\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002342 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002343 " -r Remove module (stacks) or do autoclean\n" \
2344 " -s Report via syslog instead of stderr\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002345 " -v Verbose"
Rob Landley9c32a152005-12-11 20:12:24 +00002346#define modprobe_notes_usage \
2347"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2348"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2349"pass each module it loads.\n" \
2350"\n" \
2351"The configuration file is searched (in order) amongst:\n" \
2352"\n" \
2353" /etc/modprobe.conf (2.6 only)\n" \
2354" /etc/modules.conf\n" \
2355" /etc/conf.modules (deprecated)\n" \
2356"\n" \
2357"They all have the same syntax (see below). If none is present, it is\n" \
2358"_not_ an error; each loaded module is then expected to load without\n" \
2359"options. Once a file is found, the others are tested for.\n" \
2360"\n" \
2361"/etc/modules.conf entry format:\n" \
2362"\n" \
2363" alias <alias_name> <mod_name>\n" \
2364" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002365" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002366" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2367" This makes it also possible to use a different set of options (below) for\n" \
2368" the module and the alias.\n" \
2369" A module can be aliased more than once.\n" \
2370"\n" \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002371" options <mod_name|alias_name> <symbol=value...>\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002372" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2373" the \"symbol=value\" pairs as option to that module.\n" \
2374"\n" \
2375"Sample /etc/modules.conf file:\n" \
2376"\n" \
2377" options tulip irq=3\n" \
2378" alias tulip tulip2\n" \
2379" options tulip2 irq=4 io=0x308\n" \
2380"\n" \
2381"Other functionality offered by 'classic' modprobe is not available in\n" \
2382"this implementation.\n" \
2383"\n" \
2384"If module options are present both in the config file, and on the command line,\n" \
2385"then the options from the command line will be passed to the module _after_\n" \
2386"the options from the config file. That way, you can have defaults in the config\n" \
2387"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002388#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002389 "(with the above /etc/modules.conf):\n\n" \
2390 "$ modprobe tulip\n" \
2391 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2392 "$ modprobe tulip irq=5\n" \
2393 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2394 "$ modprobe tulip2\n" \
2395 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2396 " which are the default for alias 'tulip2'\n\n" \
2397 "$ modprobe tulip2 irq=8\n" \
2398 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2399 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2400 " from the command line\n\n" \
2401 "$ modprobe tulip2 irq=2 io=0x210\n" \
2402 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2403 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2404 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002405
Eric Andersen7e9276b2001-02-22 01:15:47 +00002406#define more_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002407 "[FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002408#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002409 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002410#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002411 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002412
Eric Andersen7e9276b2001-02-22 01:15:47 +00002413#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002414 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002415#define mount_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002416 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2417 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002418 " -a Mount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002419 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002420 " -f Update /etc/mtab, but don't mount\n" \
2421 " -n Don't update /etc/mtab\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002422 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002423 " -r Read-only mount\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002424 " -t fs-type Filesystem type\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002425 " -w Read-write mount (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002426 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002427 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002428 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002429 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002430 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002431 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002432 " [a]sync Writes are asynchronous / synchronous\n" \
2433 " [no]atime Disable / enable updates to inode access times\n" \
2434 " [no]diratime Disable / enable atime updates to directories\n" \
2435 " [no]dev Allow use of special device files / disallow them\n" \
2436 " [no]exec Allow use of executable files / disallow them\n" \
2437 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2438 " [r]shared Convert [recursively] to a shared subtree\n" \
2439 " [r]slave Convert [recursively] to a slave subtree\n" \
2440 " [r]private Convert [recursively] to a private subtree\n" \
2441 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2442 " bind Bind a directory to an additional location\n" \
2443 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002444 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002445 " remount Remount a mounted filesystem, changing its flags\n" \
2446 " ro/rw Mount for read-only / read-write\n" \
2447 "\n" \
2448 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002449 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002450#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002451 "$ mount\n" \
2452 "/dev/hda3 on / type minix (rw)\n" \
2453 "proc on /proc type proc (rw)\n" \
2454 "devpts on /dev/pts type devpts (rw)\n" \
2455 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2456 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2457 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002458#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002459 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002460
Rob Landleyd00b3a52005-08-20 05:07:08 +00002461#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002462 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002463#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002464 "mountpoint checks if the directory is a mountpoint" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002465 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002466 " -q Quiet\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002467 " -d Print major/minor device number of the filesystem\n" \
2468 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002469#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002470 "$ mountpoint /proc\n" \
2471 "/proc is not a mountpoint\n" \
2472 "$ mountpoint /sys\n" \
2473 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002474
Eric Andersen7e9276b2001-02-22 01:15:47 +00002475#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002476 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002477#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002478 "Control magnetic tape drive operation\n" \
2479 "\nAvailable Opcodes:\n\n" \
2480 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2481 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2482 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2483 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002484
Eric Andersen7e9276b2001-02-22 01:15:47 +00002485#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002486 "[OPTION]... SOURCE DEST\n" \
2487 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002488#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002489 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2490 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002491 " -f Don't prompt before overwriting\n" \
2492 " -i Interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002493#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002494 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002495
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002496#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002497 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002498#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002499 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002500 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002501 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2502 " -s Use syslog (LOCAL0 facility)\n" \
2503 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002504#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002505 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2506 " or\n" \
2507 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002508
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002509#if !ENABLE_DESKTOP
2510
Rob Landley1cca9482006-07-10 19:45:20 +00002511#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002512#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002513#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002514#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002515#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002516
Eric Andersen7e9276b2001-02-22 01:15:47 +00002517#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002518 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002519 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002520#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002521 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002522 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002523 USE_NC_EXTRA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002524 "\n -e Exec rest of command line after connect" \
2525 "\n -i SECS Delay interval for lines sent" \
2526 "\n -w SECS Timeout for connect" \
Denis Vlasenko5d687242007-01-12 20:59:31 +00002527 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002528 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002529 USE_NC_SERVER( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002530 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002531 USE_NC_EXTRA( \
2532 "\n (use -l twice with -e for persistent server)") \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002533 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002534 )
2535
Rob Landley1cca9482006-07-10 19:45:20 +00002536#define nc_notes_usage "" \
2537 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002538 "To use netcat as a terminal emulator on a serial port:\n\n" \
2539 "$ stty 115200 -F /dev/ttyS0\n" \
2540 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2541 )
Rob Landley1cca9482006-07-10 19:45:20 +00002542
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002543#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002544 "$ nc foobar.somedomain.com 25\n" \
2545 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2546 "help\n" \
2547 "214-Commands supported:\n" \
2548 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2549 "214 NOOP QUIT RSET HELP\n" \
2550 "quit\n" \
2551 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002552
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002553#else /* DESKTOP nc - much more compatible with nc 1.10 */
2554
2555#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002556 "[-options] hostname port - connect" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002557 USE_NC_SERVER("\nnc [-options] -l -p port [hostname] [port] - listen")
2558#define nc_full_usage \
2559 USE_NC_SERVER( \
2560 "-l Listen mode, for inbound connects\n" \
2561 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002562 "-n Don't do DNS resolution" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002563 "\n-s addr Local address" \
2564 "\n-p port Local port" \
2565 "\n-u UDP mode" \
2566 "\n-v Verbose (cumulative: -vv)" \
2567 "\n-w secs Timeout for connects and final net reads" \
2568 USE_NC_EXTRA( \
2569 "\n-i sec Delay interval for lines sent" /* ", ports scanned" */ \
2570 "\n-o file Hex dump of traffic" \
2571 "\n-z Zero-I/O mode (scanning)" \
2572 ) \
2573 "\n-e prog [args] Program to exec after connect (must be last)" \
2574/* "\n-r Randomize local and remote ports" */
2575/* "\n-g gateway Source-routing hop point[s], up to 8" */
2576/* "\n-G num Source-routing pointer: 4, 8, 12, ..." */
2577/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2578
2579#endif
2580
Eric Andersen1552ff72001-10-31 11:07:12 +00002581#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002582 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002583#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002584 "Display networking information" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002585 "\n\nOptions:" \
2586 "\n -l Display listening server sockets" \
2587 "\n -a Display all sockets (default: connected)" \
2588 "\n -e Display other/more information" \
2589 "\n -n Don't resolve names" \
2590 "\n -t Tcp sockets" \
2591 "\n -u Udp sockets" \
2592 "\n -w Raw sockets" \
2593 "\n -x Unix sockets" \
2594 "\n -r Display routing table" \
2595 USE_FEATURE_NETSTAT_WIDE( \
2596 "\n -W Display with no column truncation" \
2597 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002598
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002599#define nice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002600 "[-n ADJUST] [COMMAND [ARG]...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002601#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002602 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002603 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002604 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002605
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002606#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002607 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002608#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002609 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002610 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002611 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002612 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002613 "%[niface] Monitor network interface 'iface'\n" \
2614 "%m Monitor allocated memory\n" \
2615 "%[mf] Monitor free memory\n" \
2616 "%[mt] Monitor total memory\n" \
2617 "%s Monitor allocated swap\n" \
2618 "%f Monitor number of used file descriptors\n" \
2619 "%Ni Monitor total/specific IRQ rate\n" \
2620 "%x Monitor context switch rate\n" \
2621 "%p Monitor forks\n" \
2622 "%[pn] Monitor # of processes\n" \
2623 "%b Monitor block io\n" \
2624 "%Nt Show time (with N decimal points)\n" \
2625 "%Nd Milliseconds between updates (default=1000)\n" \
2626 "%r Print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002627#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002628 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002629
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002630#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002631 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002632#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002633 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002634#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002635 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002636
Eric Andersen7e9276b2001-02-22 01:15:47 +00002637#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002638 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002639#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002640 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002641 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002642#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002643 "$ nslookup localhost\n" \
2644 "Server: default\n" \
2645 "Address: default\n" \
2646 "\n" \
2647 "Name: debian\n" \
2648 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002649
Glenn L McGrath60281112001-11-02 11:39:46 +00002650#define od_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002651 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002652#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002653 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002654 "to standard output. With no FILE, or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002655
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002656#define openvt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002657 "VTNUM COMMAND [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002658#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002659 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002660#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002661 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002662
Eric Andersen27f64e12002-06-23 04:24:25 +00002663#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002664 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002665#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002666 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002667 "changes the password for the current user." \
2668 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002669 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002670 " (choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002671 " -d Delete the password for the specified user account\n" \
2672 " -l Locks (disables) the specified user account\n" \
2673 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002674
Denis Vlasenko21d10142007-07-20 21:28:41 +00002675#define chpasswd_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002676 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko21d10142007-07-20 21:28:41 +00002677#define chpasswd_full_usage \
2678 "Read user:password information from stdin\n" \
2679 "and update /etc/passwd accordingly." \
2680 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002681 USE_GETOPT_LONG( \
2682 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2683 "\n -m,--md5 Use MD5 encryption instead of DES" \
2684 ) \
2685 SKIP_GETOPT_LONG( \
2686 "\n -e Supplied passwords are in encrypted form" \
2687 "\n -m Use MD5 encryption instead of DES" \
2688 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002689
Glenn L McGrath655d8142003-06-22 15:32:41 +00002690#define patch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002691 "[-p num] [-i diff]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002692#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002693 " -p NUM Strip NUM leading components from file names\n" \
2694 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002695#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002696 "$ patch -p1 < example.diff\n" \
2697 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002698
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002699#define pgrep_trivial_usage \
2700 "[-flnovx] pattern"
2701#define pgrep_full_usage \
2702 "Display process(es) selected by regex pattern" \
2703 "\n\nOptions:\n" \
2704 " -l Show command name too\n" \
2705 " -f Match against entire command line\n" \
2706 " -n Signal the newest process only\n" \
2707 " -o Signal the oldest process only\n" \
2708 " -v Negate the matching\n" \
2709 " -x Match whole name (not substring)"
2710
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002711#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2712#define USAGE_PIDOF "Options:"
2713#else
Denis Vlasenko765996a2006-12-24 16:59:27 +00002714#define USAGE_PIDOF "\nThis version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002715#endif
2716
Eric Andersen221b2ea2001-07-31 19:06:07 +00002717#define pidof_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002718 "process-name [OPTION] [process-name...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002719
Eric Andersen221b2ea2001-07-31 19:06:07 +00002720#define pidof_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002721 "List the PIDs of all processes with names that match the\n" \
2722 "names on the command line\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002723 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002724 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002725 "\n -s Display only a single PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002726 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenko198bada2007-06-23 14:56:43 +00002727 "\n -o PID Omit given pid") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002728 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002729 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002730#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002731 "$ pidof init\n" \
2732 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002733 USE_FEATURE_PIDOF_OMIT( \
2734 "$ pidof /bin/sh\n20351 5973 5950\n") \
2735 USE_FEATURE_PIDOF_OMIT( \
2736 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002737
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002738#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002739#define ping_trivial_usage \
2740 "host"
2741#define ping_full_usage \
2742 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002743#define ping6_trivial_usage \
2744 "host"
2745#define ping6_full_usage \
2746 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002747#else
2748#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002749 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002750#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002751 "Send ICMP ECHO_REQUEST packets to network hosts" \
2752 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002753 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2754 " -c CNT Send only CNT pings\n" \
2755 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2756 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002757 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002758 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002759#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002760 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002761#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002762 "Send ICMP ECHO_REQUEST packets to network hosts" \
2763 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002764 " -c CNT Send only CNT pings\n" \
2765 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2766 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002767 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002768 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002769#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002770#define ping_example_usage \
2771 "$ ping localhost\n" \
2772 "PING slag (127.0.0.1): 56 data bytes\n" \
2773 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2774 "\n" \
2775 "--- debian ping statistics ---\n" \
2776 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2777 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002778#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002779 "$ ping6 ip6-localhost\n" \
2780 "PING ip6-localhost (::1): 56 data bytes\n" \
2781 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2782 "\n" \
2783 "--- ip6-localhost ping statistics ---\n" \
2784 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2785 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002786
Eric Andersen7e9276b2001-02-22 01:15:47 +00002787#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002788 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002789#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002790 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002791 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002792
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002793#define pkill_trivial_usage \
2794 "[-l] | [-fnovx] [-signal] pattern"
2795#define pkill_full_usage \
2796 "Send a signal to process(es) selected by regex pattern" \
2797 "\n\nOptions:\n" \
2798 " -l List all signals\n" \
2799 " -f Match against entire command line\n" \
2800 " -n Signal the newest process only\n" \
2801 " -o Signal the oldest process only\n" \
2802 " -v Negate the matching\n" \
2803 " -x Match whole name (not substring)"
2804
Eric Andersen7e9276b2001-02-22 01:15:47 +00002805#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002806 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002807#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002808 "Halt and shut off power" \
2809 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002810 " -d Delay interval for halting\n" \
2811 " -n No call to sync()\n" \
2812 " -f Force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002813
Mike Frysinger95d3c452005-04-21 23:29:24 +00002814#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002815 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002816#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002817 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002818 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002819
Eric Andersen7e9276b2001-02-22 01:15:47 +00002820#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002821 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002822#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002823 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002824 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002825#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002826 "$ printf \"Val=%d\\n\" 5\n" \
2827 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002828
Denis Vlasenko94949192006-11-05 00:45:47 +00002829
2830#if ENABLE_DESKTOP
2831
2832#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002833 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002834#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002835 "Report process status" \
2836 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002837 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002838
2839#else /* !ENABLE_DESKTOP */
2840
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002841#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002842#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002843#else
2844#define USAGE_PS "\nOptions:"
2845#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002846
Eric Andersen7e9276b2001-02-22 01:15:47 +00002847#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002848 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002849#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002850 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002851 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002852 USE_SELINUX( \
Bernhard Reutner-Fischer26a80162007-03-14 08:52:28 +00002853 "\n -Z Show SE Linux context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002854 USE_FEATURE_PS_WIDE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002855 "\n w Wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002856
Denis Vlasenko94949192006-11-05 00:45:47 +00002857#endif /* ENABLE_DESKTOP */
2858
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002859#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002860 "$ ps\n" \
2861 " PID Uid Gid State Command\n" \
2862 " 1 root root S init\n" \
2863 " 2 root root S [kflushd]\n" \
2864 " 3 root root S [kupdate]\n" \
2865 " 4 root root S [kpiod]\n" \
2866 " 5 root root S [kswapd]\n" \
2867 " 742 andersen andersen S [bash]\n" \
2868 " 743 andersen andersen S -bash\n" \
2869 " 745 root root S [getty]\n" \
2870 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002871
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00002872#define pscan_trivial_usage \
2873 "[-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
2874#define pscan_full_usage \
2875 "Scan a host, print all open ports" \
2876 "\n\nOptions:" \
2877 "\n -p Scan from this port (default 1)" \
2878 "\n -P Scan up to this port (default 1024)" \
2879 "\n -t Timeout (default 5000 ms)" \
2880 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
2881
Eric Andersen7e9276b2001-02-22 01:15:47 +00002882#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002883 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002884#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002885 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002886#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002887 "$ pwd\n" \
2888 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002889
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002890#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002891 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002892#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002893 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002894#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002895 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002896
Eric Andersen7e9276b2001-02-22 01:15:47 +00002897#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002898 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002899#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002900 "Get and possibly set the system date and time from a remote HOST" \
2901 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002902 " -s Set the system date and time (default)\n" \
2903 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002904
Rob Landley0e4690d2006-08-20 22:12:18 +00002905#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002906 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002907#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002908 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2909 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00002910
Eric Andersen7e9276b2001-02-22 01:15:47 +00002911#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002912 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002913#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002914 "Display the value of a symlink" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002915 USE_FEATURE_READLINK_FOLLOW( \
2916 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002917 " -f Canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002918
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002919#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002920 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002921#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002922 "Options:\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002923 " -m mapfile (Default: /boot/System.map)\n" \
2924 " -p profile (Default: /proc/profile)\n" \
2925 " -M mult Set the profiling multiplier to mult\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002926 " -i Print only info about the sampling step\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002927 " -v Verbose\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002928 " -a Print all symbols, even if count is 0\n" \
2929 " -b Print individual histogram-bin counts\n" \
2930 " -s Print individual counters within functions\n" \
2931 " -r Reset all the counters (root only)\n" \
2932 " -n Disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002933
Glenn L McGrath62fae302002-12-10 00:14:33 +00002934#define realpath_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002935 "pathname..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00002936#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002937 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00002938
Eric Andersen7e9276b2001-02-22 01:15:47 +00002939#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002940 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002941#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002942 "Reboot the system" \
2943 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002944 " -d Delay interval for rebooting\n" \
2945 " -n No call to sync()\n" \
2946 " -f Force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002947
2948#define renice_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00002949 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002950#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002951 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002952 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002953 " -n Adjust current nice value (smaller is faster)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002954 " -p Process id(s) (default)\n" \
2955 " -g Process group id(s)\n" \
2956 " -u Process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002957
Eric Andersen7e9276b2001-02-22 01:15:47 +00002958#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002959 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002960#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002961 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002962
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002963#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002964 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002965#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002966 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002967
Denis Vlasenko397137b2007-07-23 14:03:30 +00002968#define restorecon_trivial_usage \
2969 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
2970#define restorecon_full_usage \
2971 "Reset security contexts of files in pathname\n" \
2972 "\n -i Ignore files that do not exist" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00002973 "\n -f file File with list of files to process. Use - for stdin" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00002974 "\n -e directory Directory to exclude" \
2975 "\n -R,-r Recurse directories" \
2976 "\n -n Don't change any file labels" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00002977 "\n -o file Save list of files with incorrect context" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00002978 "\n -v Verbose" \
2979 "\n -vv Show changed labels" \
2980 "\n -F Force reset of context to match file_context" \
2981 "\n for customizable files, or the user section," \
2982 "\n if it has changed"
2983
Eric Andersen7e9276b2001-02-22 01:15:47 +00002984#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002985 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002986#define rm_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002987 "Remove (unlink) the FILE(s). You may use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002988 "indicate that all following arguments are non-options." \
2989 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002990 " -i Always prompt before removing each destination\n" \
2991 " -f Remove existing destinations, never prompt\n" \
2992 " -r,-R Remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002993#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002994 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002995
Eric Andersen7e9276b2001-02-22 01:15:47 +00002996#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002997 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002998#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002999 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003000#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003001 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003002
Eric Andersen7e9276b2001-02-22 01:15:47 +00003003#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003004 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003005#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003006 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003007 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003008 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003009#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003010 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003011
Eric Andersen7e9276b2001-02-22 01:15:47 +00003012#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003013 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003014#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003015 "Edit the kernel's routing tables" \
3016 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003017 " -n Dont resolve names\n" \
3018 " -e Display other/more information\n" \
3019 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003020
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003021#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003022 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003023#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003024 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003025 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003026 "\n -i Install package" \
3027 "\n -q Query package" \
3028 "\n -p Query uninstalled package" \
3029 "\n -i Show information" \
3030 "\n -l List contents" \
3031 "\n -d List documents" \
3032 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00003033
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003034#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003035 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003036#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003037 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003038
Denis Vlasenko49622d72007-03-10 16:58:49 +00003039#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003040 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3041 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko49622d72007-03-10 16:58:49 +00003042#define runcon_full_usage \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003043 "Run a program in a different security context\n\n" \
3044 " CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003045 USE_GETOPT_LONG( \
3046 " -c,--compute Compute process transition context before modifying\n" \
3047 " -t,--type=TYPE Type (for same role as parent)\n" \
3048 " -u,--user=USER User identity\n" \
3049 " -r,--role=ROLE Role\n" \
3050 " -l,--range=RNG Levelrange" \
3051 ) \
3052 SKIP_GETOPT_LONG( \
3053 " -c Compute process transition context before modifying\n" \
3054 " -t TYPE Type (for same role as parent)\n" \
3055 " -u USER User identity\n" \
3056 " -r ROLE Role\n" \
3057 " -l RNG Levelrange" \
3058 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003059
Eric Andersen6cf47a72001-10-31 10:24:36 +00003060#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003061 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003062#define run_parts_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003063 "Run a bunch of scripts in a directory" \
3064 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003065 " -t Prints what would be run, but does not actually run anything\n" \
3066 " -a ARG Pass ARG as an argument for every program invoked\n" \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003067 " -u MASK Set the umask to MASK before executing every program" \
3068USE_FEATURE_RUN_PARTS_FANCY("\n -l Prints names of all matching files even when they are not executable")
3069
3070#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003071 "$ run-parts -a start /etc/init.d\n" \
3072 "$ run-parts -a stop=now /etc/init.d\n\n" \
3073 "Let's assume you have a script foo/dosomething:\n" \
3074 "#!/bin/sh\n" \
3075 "for i in $*; do eval $i; done; unset i\n" \
3076 "case \"$1\" in\n" \
3077 "start*) echo starting something;;\n" \
3078 "stop*) set -x; shutdown -h $stop;;\n" \
3079 "esac\n\n" \
3080 "Running this yields:\n" \
3081 "$run-parts -a stop=+4m foo/\n" \
3082 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003083
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003084#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003085 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003086#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003087 "Find the current and previous system runlevel.\n\n" \
3088 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003089 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003090#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003091 "$ runlevel /var/run/utmp\n" \
3092 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003093
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003094#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003095 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003096#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003097 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003098
3099#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003100 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003101#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003102 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003103
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003104#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003105 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003106#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003107 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003108#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003109 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003110
Eric Andersen7e9276b2001-02-22 01:15:47 +00003111#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003112 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003113#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003114 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003115 " -e script Add the script to the commands to be executed\n" \
3116 " -f scriptfile Add script-file contents to the\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003117 " commands to be executed\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003118 " -i Edit files in-place\n" \
3119 " -n Suppress automatic printing of pattern space\n" \
3120 " -r Use extended regular expression syntax\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003121 "\n" \
3122 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
3123 "script to interpret. All remaining arguments are names of input files; if no\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003124 "input files are specified, then the standard input is read. Source files\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003125 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00003126
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003127#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003128 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3129 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003130
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003131#define selinuxenabled_trivial_usage
3132#define selinuxenabled_full_usage
3133
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003134#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003135 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003136#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003137 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003138 "FIRST, INCREMENT default to 1" \
3139 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003140 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003141 " FIRST LAST\n" \
3142 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003143
Denis Vlasenko705eaf82007-11-22 01:10:41 +00003144#define sestatus_trivial_usage \
3145 "[-vb]"
3146#define sestatus_full_usage \
3147 "-v Verbose\n" \
3148 "-b Display current state of booleans"
3149
Paul Foxfc2256a2005-08-01 18:12:30 +00003150#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003151 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00003152#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003153 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003154 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003155 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00003156
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003157#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003158 "[Enforcing | Permissive | 1 | 0]"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003159#define setenforce_full_usage
3160
Denis Vlasenko397137b2007-07-23 14:03:30 +00003161#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003162 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003163 USE_FEATURE_SETFILES_CHECK_OPTION( \
3164 " [-c policyfile] spec_file" \
3165 ) \
3166 " pathname"
3167
3168#define setfiles_full_usage \
3169 "Reset file contexts under pathname according to spec_file" \
3170 USE_FEATURE_SETFILES_CHECK_OPTION( \
3171 "\n -c file Check the validity of the contexts against the specified binary policy" \
3172 ) \
3173 "\n -d Show which specification matched each file" \
3174 "\n -l Log changes in file labels to syslog" \
3175 "\n -n Don't change any file labels" \
Denis Vlasenko1da77722007-07-24 06:17:43 +00003176 "\n -q Suppress warnings" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003177 "\n -r dir Use an altenate root path" \
3178 "\n -e dir Exclude directory" \
3179 "\n -F Force reset of context to match file_context for customizable files" \
3180 "\n -o file Save list of files with incorrect context" \
3181 "\n -s Take a list of files from standard input (instead of command line)" \
3182 "\n -v Show changes in file labels, if type or role are changing" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003183 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3184 "\n -W Display warnings about entries that had no matching files"
Denis Vlasenko397137b2007-07-23 14:03:30 +00003185
Eric Andersen7e9276b2001-02-22 01:15:47 +00003186#define setkeycodes_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003187 "SCANCODE KEYCODE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003188#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003189 "Set entries into the kernel's scancode-to-keycode map,\n" \
3190 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3191 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
3192 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003193#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003194 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003195
Rob Landley87848d92006-03-27 23:23:43 +00003196#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003197 "N"
Rob Landley87848d92006-03-27 23:23:43 +00003198#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003199 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003200
Denis Vlasenkobe039372007-10-14 04:48:44 +00003201#define setsebool_trivial_usage \
3202 "boolean value"
3203
3204#define setsebool_full_usage \
3205 "Change boolean setting"
3206
Paul Fox42403642005-08-01 22:52:09 +00003207#define setsid_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003208 "program [arg...]"
Paul Fox42403642005-08-01 22:52:09 +00003209#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003210 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003211 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00003212
Matt Kraai2d91deb2001-08-01 17:21:35 +00003213#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003214 "[FILE]...\n" \
3215 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00003216#define lash_full_usage \
Denis Vlasenko96702ca2007-11-23 23:28:55 +00003217 "lash is deprecated, please use hush"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003218
Eric Andersen2e9c2572003-08-08 22:26:06 +00003219#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003220 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00003221#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003222 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00003223
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003224#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003225 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003226 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003227#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003228 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003229 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003230 "\n\nOptions:\n" \
3231 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003232 " -c Check SHA1 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003233 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003234 " -s Don't output anything, status code shows success\n" \
3235 " -w Warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003236
Denis Vlasenko14923db2007-06-20 15:23:03 +00003237#define slattach_trivial_usage \
3238 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3239#define slattach_full_usage \
3240 "Attach network interface(s) to serial line(s)\n" \
3241 "\nOptions:" \
3242 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3243 "\n -s Set line speed" \
3244 "\n -e Exit after initializing device" \
3245 "\n -h Exit when the carrier is lost" \
3246 "\n -c Execute a command when the line is hung up" \
3247 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3248 "\n -L Enable 3-wire operation" \
3249 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003250
Eric Andersen7e9276b2001-02-22 01:15:47 +00003251#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003252 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003253#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003254 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003255 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003256 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003257 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003258#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003259 "$ sleep 2\n" \
3260 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003261 USE_FEATURE_FANCY_SLEEP( \
3262 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003263 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003264
Eric Andersen7e9276b2001-02-22 01:15:47 +00003265#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003266 "[-nru" \
3267 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") \
3268 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003269#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003270 "Sort lines of text in the specified files" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003271 "\n\nOptions:\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003272 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003273 " -b Ignore leading blanks\n" \
3274 " -c Check whether input is sorted\n" \
3275 " -d Dictionary order (blank or alphanumeric only)\n" \
3276 " -f Ignore case\n" \
3277 " -g General numerical sort\n" \
3278 " -i Ignore unprintable characters\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003279 " -k Sort key\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003280 " -M Sort month\n") \
3281 " -n Sort numbers\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003282 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003283 " -o Output to file\n" \
3284 " -k Sort by key\n" \
3285 " -t Use key separator other than whitespace\n") \
3286 " -r Reverse sort order\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003287 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003288 " -s Stable (don't sort ties alphabetically)\n") \
3289 " -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003290 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003291 "\n -z Input terminated by nulls, not newlines\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003292 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003293 " -mST Ignored for GNU compatibility") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003294 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003295#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003296 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3297 "a\n" \
3298 "b\n" \
3299 "c\n" \
3300 "d\n" \
3301 "e\n" \
3302 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003303 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003304 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3305 "d 2\n" \
3306 "b 2\n" \
3307 "c 3\n" \
3308 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003309 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003310
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003311#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003312 "[OPTION] [INPUT [PREFIX]]"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003313#define split_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003314 "Options:" \
3315 "\n -b n[k|m] Split by bytes" \
3316 "\n -l n Split by lines" \
3317 "\n -a n Use n letters as suffix"
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003318#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003319 "$ split TODO foo\n" \
3320 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003321
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003322#define start_stop_daemon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003323 "[OPTIONS] [" \
3324 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3325 "] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003326#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003327 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003328 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003329 USE_GETOPT_LONG( \
3330 "\n -S,--start Start" \
3331 "\n -K,--stop Stop" \
3332 "\n -a,--startas pathname Starts process specified by pathname" \
3333 "\n -b,--background Put process into background" \
3334 "\n -u,--user username|uid Stop this user's processes" \
3335 "\n -x,--exec executable Program to either start or check" \
3336 "\n -n,--name process-name Stop processes with this name" \
3337 "\n -p,--pidfile pid-file Save or load pid using a pid-file" \
3338 "\n -m,--make-pidfile Create the -p file and enter pid in it" \
3339 "\n -q,--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003340 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003341 "\n -o,--oknodo Exit status 0 if nothing done" \
3342 "\n -v,--verbose Verbose" \
3343 "\n -N,--nicelevel N Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003344 ) \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003345 "\n -s,--signal signal Signal to send (default TERM)" \
3346 "\n -c,--chuid user[:[grp]] Change to specified user/group" \
3347 ) \
3348 SKIP_GETOPT_LONG( \
3349 "\n -S Start" \
3350 "\n -K Stop" \
3351 "\n -a pathname Starts process specified by pathname" \
3352 "\n -b Put process into background" \
3353 "\n -u username|uid Stop this user's processes" \
3354 "\n -x executable Program to either start or check" \
3355 "\n -n process-name Stop processes with this name" \
3356 "\n -p pid-file Save or load pid using a pid-file" \
3357 "\n -m Create the -p file and enter pid in it" \
3358 "\n -q Quiet" \
3359 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3360 "\n -o Exit status 0 if nothing done" \
3361 "\n -v Verbose" \
3362 "\n -N N Add N to process's nice level" \
3363 ) \
3364 "\n -s signal Signal to send (default TERM)" \
3365 "\n -c user[:[grp]] Change to specified user/group" \
3366 )
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003367
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003368#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003369 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003370#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003371 "Display file (default) or filesystem status" \
3372 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003373 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003374 " -c fmt Use the specified format\n") \
3375 " -f Display filesystem status\n" \
Bernhard Reutner-Fischer52432f22008-01-17 11:05:09 +00003376 " -L Dereference links\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003377 " -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003378 USE_SELINUX( \
3379 "\n -Z Print security context" \
3380 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003381 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003382 "\n\nValid format sequences for files:\n" \
3383 " %a Access rights in octal\n" \
3384 " %A Access rights in human readable form\n" \
3385 " %b Number of blocks allocated (see %B)\n" \
3386 " %B The size in bytes of each block reported by %b\n" \
3387 " %d Device number in decimal\n" \
3388 " %D Device number in hex\n" \
3389 " %f Raw mode in hex\n" \
3390 " %F File type\n" \
3391 " %g Group ID of owner\n" \
3392 " %G Group name of owner\n" \
3393 " %h Number of hard links\n" \
3394 " %i Inode number\n" \
3395 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003396 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003397 " %o I/O block size\n" \
3398 " %s Total size, in bytes\n" \
3399 " %t Major device type in hex\n" \
3400 " %T Minor device type in hex\n" \
3401 " %u User ID of owner\n" \
3402 " %U User name of owner\n" \
3403 " %x Time of last access\n" \
3404 " %X Time of last access as seconds since Epoch\n" \
3405 " %y Time of last modification\n" \
3406 " %Y Time of last modification as seconds since Epoch\n" \
3407 " %z Time of last change\n" \
3408 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003409 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003410 " %a Free blocks available to non-superuser\n" \
3411 " %b Total data blocks in file system\n" \
3412 " %c Total file nodes in file system\n" \
3413 " %d Free file nodes in file system\n" \
3414 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003415 USE_SELINUX( \
3416 " %C Security context in SELinux\n" \
3417 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003418 " %i File System ID in hex\n" \
3419 " %l Maximum length of filenames\n" \
3420 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003421 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003422 " %S Fundamental block size (for block counts)\n" \
3423 " %t Type in hex\n" \
3424 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003425 )
3426
Eric Andersenef5e8f82002-11-07 02:09:37 +00003427#define strings_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003428 "[-afo] [-n length] [file...]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003429#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003430 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003431 "\n\nOptions:" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003432 "\n -a Scan whole file (default)" \
3433 "\n -f Precede strings with filenames" \
3434 "\n -n N At least N characters form a string (default 4)" \
3435 "\n -o Precede strings with decimal offsets"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003436
Eric Andersen7e9276b2001-02-22 01:15:47 +00003437#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003438 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003439#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003440 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003441 "and deviations from stty sane" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003442 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003443 "\n -F DEVICE Open device instead of stdin" \
3444 "\n -a Print all current settings in human-readable form" \
3445 "\n -g Print in stty-readable form" \
3446 "\n [SETTING] See manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003447
Robert Griebl1fca5582002-06-04 20:45:46 +00003448#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003449 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003450#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003451 "Change user id or become root" \
3452 "\n\nOptions:" \
3453 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003454 "\n -c Command to pass to 'sh -c'" \
3455 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00003456
Eric Andersen27f64e12002-06-23 04:24:25 +00003457#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003458 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003459#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003460 "Single user login" \
3461 "\n\nOptions:" \
3462 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00003463
Mike Frysinger95d3c452005-04-21 23:29:24 +00003464#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003465 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003466#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003467 "Checksum and count the blocks in a file" \
3468 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003469 " -r Use BSD sum algorithm (1K blocks)\n" \
3470 " -s Use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003471
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003472#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003473 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003474#define sv_full_usage \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003475 "Control services monitored by runsv supervisor.\n" \
3476 "Commands (only first character is enough):\n" \
3477 "\n" \
3478 "status: query service status\n" \
3479 "up: if service isn't running, start it. If service stops, restart it\n" \
3480 "once: like 'up', but if service stops, don't restart it\n" \
3481 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3482 " if it exists. After it stops, do not restart service\n" \
3483 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3484 " runsv exits too\n" \
3485 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
3486 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003487
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003488#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003489 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003490#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003491 "Continuously read log data from standard input, optionally " \
3492 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003493 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003494
Eric Andersen7e9276b2001-02-22 01:15:47 +00003495#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003496 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003497#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003498 "Stop swapping virtual memory pages on DEVICE" \
3499 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003500 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003501
Eric Andersen7e9276b2001-02-22 01:15:47 +00003502#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003503 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003504#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003505 "Start swapping virtual memory pages on DEVICE" \
3506 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003507 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003508
Rob Landley0f34a822005-10-27 22:55:50 +00003509#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003510 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003511#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003512 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003513 "and exec NEW_INIT" \
3514 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003515 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00003516
Eric Andersen7e9276b2001-02-22 01:15:47 +00003517#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003518 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003519#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003520 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003521
Eric Andersenb9050282003-12-24 06:02:11 +00003522#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003523 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003524#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003525 "Configure kernel parameters at runtime" \
3526 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003527 " -n Disable printing of key names\n" \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003528 " -e Don't warn about unknown keys\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003529 " -w Change sysctl setting\n" \
3530 " -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)\n" \
3531 " -a Display all values\n" \
3532 " -A Display all values in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003533#define sysctl_example_usage \
Denis Vlasenko64309f82007-11-29 06:40:28 +00003534 "sysctl [-n] [-e] variable...\n" \
3535 "sysctl [-n] [-e] -w variable=value...\n" \
3536 "sysctl [-n] [-e] -a\n" \
3537 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
3538 "sysctl [-n] [-e] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003539
Eric Andersen7e9276b2001-02-22 01:15:47 +00003540#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003541 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003542#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003543 "System logging utility.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003544 "Note that this version of syslogd ignores /etc/syslog.conf." \
3545 "\n\nOptions:" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003546 "\n -n Run in foreground" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003547 "\n -O FILE Log to given file (default=/var/log/messages)" \
3548 "\n -l n Set local log level" \
3549 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003550 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003551 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3552 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003553 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003554 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003555 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003556 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003557 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)")
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003558 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003559/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003560#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003561 "$ syslogd -R masterlog:514\n" \
3562 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003563
Denis Vlasenkobcd5fc12008-01-06 06:27:17 +00003564#define tac_trivial_usage \
3565 "[FILE]..."
3566#define tac_full_usage \
3567 "Concatenates FILE(s) and prints them to stdout in reverse"
3568
Eric Andersen7e9276b2001-02-22 01:15:47 +00003569#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003570 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003571#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003572 "Print last 10 lines of each FILE to standard output.\n" \
3573 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003574 "file name. With no FILE, or when FILE is -, read standard input." \
3575 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003576 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003577 "\n -c N[kbm] Output the last N bytes") \
3578 "\n -n N[kbm] Print last N lines instead of last 10" \
3579 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003580 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003581 "\n -q Never output headers giving file names" \
3582 "\n -s SEC Wait SEC seconds between reads with -f" \
3583 "\n -v Always output headers giving file names" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003584 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003585 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3586 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3587 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003588#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003589 "$ tail -n 1 /etc/resolv.conf\n" \
3590 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003591
Eric Andersen7e9276b2001-02-22 01:15:47 +00003592#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003593 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003594 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3595 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003596 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003597 "[-f TARFILE] [-C DIR] [FILE(s)]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003598#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003599 "Create, extract, or list files from a tar file" \
3600 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003601 USE_FEATURE_TAR_CREATE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003602 " c Create\n") \
3603 " x Extract\n" \
3604 " t List\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003605 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003606 USE_FEATURE_TAR_GZIP( \
3607 " z Filter the archive through gzip\n") \
3608 USE_FEATURE_TAR_BZIP2( \
3609 " j Filter the archive through bzip2\n") \
3610 USE_FEATURE_TAR_LZMA( \
3611 " a Filter the archive through lzma\n") \
3612 USE_FEATURE_TAR_COMPRESS( \
3613 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003614 "\nFile selection:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003615 " f Name of TARFILE or \"-\" for stdin\n" \
3616 " O Extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003617 USE_FEATURE_TAR_FROM( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003618 " exclude File to exclude\n" \
3619 " X File with names to exclude\n") \
3620 " C Change to directory DIR before operation\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003621 " v Verbose"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003622#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003623 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3624 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003625
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003626#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003627 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003628#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003629 "Set or get CPU affinity" \
3630 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003631 " -p Operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003632#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003633 "$ taskset 0x7 ./dgemm_test&\n" \
3634 "$ taskset -p 0x1 $!\n" \
3635 "pid 4790's current affinity mask: 7\n" \
3636 "pid 4790's new affinity mask: 1\n" \
3637 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3638 "pid 6671's current affinity mask: 1\n" \
3639 "pid 6671's new affinity mask: 1\n" \
3640 "$ taskset -p 1\n" \
3641 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003642
Eric Andersen7e9276b2001-02-22 01:15:47 +00003643#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003644 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003645#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003646 "Copy standard input to each FILE, and also to standard output" \
3647 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003648 " -a Append to the given FILEs, do not overwrite\n" \
3649 " -i Ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003650#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003651 "$ echo \"Hello\" | tee /tmp/foo\n" \
3652 "$ cat /tmp/foo\n" \
3653 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003654
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003655#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003656#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003657 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003658#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003659 "Connect to remote telnet server" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003660 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003661 " -a Attempt an automatic login with the USER variable\n" \
3662 " -l USER Attempt an automatic login with the USER argument\n" \
3663 " HOST The official name, alias or the IP address of the\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00003664 " remote host\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003665 " PORT The remote port number to connect to. If it is not\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003666 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003667#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003668#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003669 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003670#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003671 "Connect to remote telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003672#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003673
Eric Andersen08a72202002-09-30 20:52:10 +00003674#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003675 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003676#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003677 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003678 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3679 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003680 "\n -l LOGIN Exec LOGIN on connect" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003681 "\n -f issue_file Display issue_file instead of /etc/issue" \
Denis Vlasenko2450c452007-10-15 22:09:15 +00003682 "\n -K Close connection as soon as login exits" \
3683 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003684 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003685 "\n -p PORT Port to listen to" \
3686 "\n -b ADDR Address to bind to" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003687 "\n -F Run in foreground" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003688 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003689 )
Eric Andersen08a72202002-09-30 20:52:10 +00003690
Eric Andersen7e9276b2001-02-22 01:15:47 +00003691#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003692 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003693#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003694 "Check file types and compares values returning an exit code\n" \
3695 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003696#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003697 "$ test 1 -eq 2\n" \
3698 "$ echo $?\n" \
3699 "1\n" \
3700 "$ test 1 -eq 1\n" \
3701 "$ echo $?\n" \
3702 "0\n" \
3703 "$ [ -d /etc ]\n" \
3704 "$ echo $?\n" \
3705 "0\n" \
3706 "$ [ -d /junk ]\n" \
3707 "$ echo $?\n" \
3708 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003709
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003710#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003711 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003712/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003713/* "[-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 +00003714#define tcpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003715 "Creates TCP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003716 "for incoming connections. For each connection it runs prog." \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003717 "\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003718 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003719 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003720 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003721 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3722 "\n-u user[:group] Change to user/group after bind" \
3723 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003724 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003725 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3726 "\n New connections from this IP address are closed" \
3727 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003728 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003729 "\n-E Do not set up environment variables" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003730 "\n-v Verbose"
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003731
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003732#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003733 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003734#define udpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003735 "Creates UDP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003736 "for incoming packets. For each packet it runs prog\n" \
3737 "(redirecting all further packets with same peer ip:port to it)." \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003738 "\n" \
3739 "\nip IP to listen on. '0' = all" \
3740 "\nport Port to listen on" \
3741 "\nprog [arg] Program to run" \
3742 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3743 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003744 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003745 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003746 "\n-E Do not set up environment variables" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003747 "\n-v Verbose"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003748
Mark Whitley450736c2001-03-02 19:08:50 +00003749#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003750 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003751#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003752 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003753 "\n\nOptions:" \
3754 "\n -l FILE Local FILE" \
3755 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003756 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003757 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003758 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003759 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003760 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003761 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003762 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003763 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003764 )
Eric Andersenc3657422001-11-30 07:54:32 +00003765#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003766 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003767#define time_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003768 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003769 "COMMAND's resource usage information is displayed." \
3770 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003771 " -v Verbose"
Mark Whitley450736c2001-03-02 19:08:50 +00003772
Eric Andersen420b2082002-09-17 22:14:58 +00003773#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003774 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003775#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003776 "Provide a view of process activity in real time.\n" \
3777 "Read the status of all processes from /proc each <seconds>\n" \
3778 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003779
Eric Andersen7e9276b2001-02-22 01:15:47 +00003780#define touch_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00003781 "[-c] FILE [FILE...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003782#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003783 "Update the last-modified date on the given FILE[s]" \
3784 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003785 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003786#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003787 "$ ls -l /tmp/foo\n" \
3788 "/bin/ls: /tmp/foo: No such file or directory\n" \
3789 "$ touch /tmp/foo\n" \
3790 "$ ls -l /tmp/foo\n" \
3791 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003792
3793#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003794 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003795#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003796 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003797 "standard input, writing to standard output" \
3798 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003799 " -c Take complement of STRING1\n" \
3800 " -d Delete input characters coded STRING1\n" \
3801 " -s Squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003802#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003803 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3804 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003805
Eric Andersen5c58d282001-07-10 16:29:00 +00003806#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003807 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3808 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3809 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003810#define traceroute_full_usage \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003811 "Trace the route to \"host\"" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003812 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003813 " -F Set the don't fragment bit\n" \
3814 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3815 " -l Display the ttl value of the returned packet\n" \
3816 " -d Set SO_DEBUG options to socket\n" \
3817 " -n Print hop addresses numerically rather than symbolically\n" \
3818 " -r Bypass the normal routing tables and send directly to a host\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003819 " -v Verbose\n" \
3820 " -m max_ttl Max time-to-live (max number of hops)\n" \
3821 " -p port# Base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003822 " (default is 33434)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003823 " -q nqueries Number of probes per 'ttl' (default 3)\n" \
3824 " -s src_addr IP address to use as the source address\n" \
3825 " -t tos Type-of-service in probe packets (default 0)\n" \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003826 " -w wait Time in seconds to wait for a response\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003827 " (default 3 sec)\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003828 " -g Loose source route gateway (8 max)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003829
Eric Andersen7e9276b2001-02-22 01:15:47 +00003830#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003831 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003832#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003833 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003834#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003835 "$ true\n" \
3836 "$ echo $?\n" \
3837 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003838
Eric Andersen7e9276b2001-02-22 01:15:47 +00003839#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003840 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003841#define tty_full_usage \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003842 "Print file name of standard input's terminal" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003843 USE_INCLUDE_SUSv2( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003844 "\n\nOptions:\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003845 " -s Print nothing, only return exit status")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003846#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003847 "$ tty\n" \
3848 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003849
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003850#define ttysize_trivial_usage \
3851 "[w] [h]"
3852#define ttysize_full_usage \
3853 "Print dimension(s) of standard input's terminal, on error return 80x25"
3854
Mike Frysinger174808c2005-06-11 01:14:09 +00003855#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003856 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3857 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3858 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3859 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3860 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3861 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003862#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003863 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00003864
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003865#define udhcpc_trivial_usage \
Denis Vlasenkoc82b5102007-07-01 17:05:57 +00003866 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
Denis Vlasenko19183682007-12-10 07:03:38 +00003867 " [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..."
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003868#define udhcpc_full_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00003869 USE_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003870 " -V,--vendorclass=CLASSID Vendor class identifier" \
3871 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003872 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003873 "\n -c,--clientid=CLIENTID Client identifier" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003874 "\n -C,--clientid-none Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003875 "\n -p,--pidfile=file Create pidfile" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003876 "\n -r,--request=IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003877 "\n -s,--script=file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003878 "\n -t,--retries=N Send up to N request packets" \
3879 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003880 "\n -A,--tryagain=N Wait N seconds (default 20) after failure" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003881 "\n -f,--foreground Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003882 "\n -b,--background Background if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003883 "\n -S,--syslog Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003884 "\n -n,--now Exit with failure if lease is not immediately obtained" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003885 "\n -q,--quit Quit after obtaining lease" \
3886 "\n -R,--release Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00003887 "\n -O,--request-option=OPT Request DHCP option OPT from server" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003888 USE_FEATURE_UDHCPC_ARPING( \
3889 "\n -a,--arping Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003890 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00003891 ) \
3892 SKIP_GETOPT_LONG( \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003893 " -V CLASSID Vendor class identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003894 "\n -i INTERFACE Interface to use (default: eth0)" \
3895 "\n -H,-h HOSTNAME Client hostname" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003896 "\n -c CLIENTID Client identifier" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003897 "\n -C Suppress default client identifier" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003898 "\n -p file Create pidfile" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003899 "\n -r IP IP address to request" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003900 "\n -s file Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003901 "\n -t N Send up to N request packets" \
3902 "\n -T N Try to get a lease for N seconds (default 3)" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003903 "\n -A N Wait N seconds (default 20) after failure" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003904 "\n -f Run in foreground" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003905 "\n -b Background if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003906 "\n -S Log to syslog too" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003907 "\n -n Exit with failure if lease is not immediately obtained" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003908 "\n -q Quit after obtaining lease" \
3909 "\n -R Release IP on quit" \
Denis Vlasenko19183682007-12-10 07:03:38 +00003910 "\n -O OPT Request DHCP option OPT from server" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003911 USE_FEATURE_UDHCPC_ARPING( \
3912 "\n -a Use arping to validate offered address" \
Denis Vlasenko223bc972007-11-22 00:58:49 +00003913 ) \
Denis Vlasenko03630782007-10-18 11:11:12 +00003914 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003915
Russ Dill61fb4892002-10-14 21:41:28 +00003916#define udhcpd_trivial_usage \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003917 "[-fS] [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00003918
3919#define udhcpd_full_usage \
Denis Vlasenko9f7b92a2007-08-15 20:03:36 +00003920 "DHCP server" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003921 "\n -f Run in foreground" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003922 "\n -S Log to syslog too"
Russ Dill61fb4892002-10-14 21:41:28 +00003923
Eric Andersen7e9276b2001-02-22 01:15:47 +00003924#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003925 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003926#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003927 "Unmount file systems" \
3928 "\n\nOptions:\n" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00003929 USE_FEATURE_UMOUNT_ALL( \
3930 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab")) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003931 USE_FEATURE_MTAB_SUPPORT( \
3932 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003933 "\n -r Try to remount devices as read-only if mount is busy" \
3934 "\n -l Lazy umount (detach filesystem)" \
3935 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003936 USE_FEATURE_MOUNT_LOOP( \
3937 "\n -D Do not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003938#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003939 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003940
3941#define uname_trivial_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003942 "[-amnrspv]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003943#define uname_full_usage \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003944 "Print system information." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003945 "\n\nOptions:\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003946 " -a Print all\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003947 " -m The machine (hardware) type\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003948 " -n Hostname\n" \
3949 " -r OS release\n" \
3950 " -s OS name (default)\n" \
3951 " -p Processor type\n" \
3952 " -v OS version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003953#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003954 "$ uname -a\n" \
3955 "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 +00003956
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003957#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003958 "[-c] [-f] [name...]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003959#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003960 "Uncompress .Z file[s]" \
3961 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003962 " -c Extract to stdout\n" \
Denis Vlasenko68af8e72007-11-22 21:41:14 +00003963 " -f Overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003964
Denis Vlasenko3952f202007-08-13 14:10:24 +00003965#define unexpand_trivial_usage \
3966 "[-f][-a][-t NUM] [FILE|-]"
3967#define unexpand_full_usage \
3968 "Convert spaces to tabs, writing to standard output." \
3969 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003970 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
3971 "\n -a,--all Convert all blanks" \
3972 "\n -f,--first-only Convert only leading blanks" \
3973 "\n -t,--tabs=N Tabstops every N chars" \
3974 ) \
3975 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
3976 "\n -a Convert all blanks" \
3977 "\n -f Convert only leading blanks" \
3978 "\n -t N Tabstops every N chars" \
3979 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00003980
Eric Andersen7e9276b2001-02-22 01:15:47 +00003981#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003982 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003983#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003984 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003985 "(or standard input), writing to OUTPUT (or standard output)" \
3986 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003987 " -c Prefix lines by the number of occurrences\n" \
3988 " -d Only print duplicate lines\n" \
3989 " -u Only print unique lines\n" \
3990 " -f N Skip the first N fields\n" \
3991 " -s N Skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003992#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003993 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3994 "a\n" \
3995 "b\n" \
3996 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003997
3998#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003999 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004000#define unix2dos_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004001 "Convert FILE from unix format to dos format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004002 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004003 "When no file is given, use stdin/stdout." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004004 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004005 " -u Output will be in UNIX format\n" \
4006 " -d Output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004007
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004008#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004009 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004010#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004011 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004012 "\n\nOptions:\n" \
Paul Fox9382b382007-09-07 20:28:25 +00004013 " -l List archive contents (with -q for short form)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004014 " -n Never overwrite existing files (default)\n" \
4015 " -o Overwrite files without prompting\n" \
4016 " -p Send output to stdout\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004017 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004018 " -x Exclude these files\n" \
4019 " -d Extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00004020
Eric Andersen7e9276b2001-02-22 01:15:47 +00004021#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004022 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004023#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004024 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004025#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004026 "$ uptime\n" \
4027 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004028
4029#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004030 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004031#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004032 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004033#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004034 "$ usleep 1000000\n" \
4035 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004036
4037#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004038 "[-o outfile] [infile]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004039#define uudecode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004040 "Uudecode a file\n" \
4041 "NB: finds outfile name in uuencoded source unless -o is given"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004042#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004043 "$ uudecode -o busybox busybox.uu\n" \
4044 "$ ls -l busybox\n" \
4045 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004046
4047#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004048 "[-m] [infile] stored_filename"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004049#define uuencode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00004050 "Uuencode a file to stdout" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004051 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004052 " -m Use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004053#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004054 "$ uuencode busybox busybox\n" \
4055 "begin 755 busybox\n" \
4056 "<encoded file snipped>\n" \
4057 "$ uudecode busybox busybox > busybox.uu\n" \
4058 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004059
Eric Andersen853c4942003-01-23 05:59:32 +00004060#define vconfig_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004061 "COMMAND [OPTIONS]..."
Eric Andersen853c4942003-01-23 05:59:32 +00004062#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004063 "Create and remove virtual ethernet devices" \
4064 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004065 " add [interface-name] [vlan_id]\n" \
4066 " rem [vlan-name]\n" \
4067 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
4068 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4069 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4070 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00004071
Eric Andersen3f980402001-04-04 17:31:15 +00004072#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004073 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00004074#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004075 "Edit FILE" \
4076 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004077 " -R Read-only - do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00004078
Eric Andersen27f64e12002-06-23 04:24:25 +00004079#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004080 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00004081#define vlock_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004082 "Lock a virtual terminal. A password is required to unlock." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004083 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004084 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00004085
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004086#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004087 "[-n seconds] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004088#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004089 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004090 "\n\nOptions:\n" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004091 " -n Loop period in seconds (default 2)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004092 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004093#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004094 "$ watch date\n" \
4095 "Mon Dec 17 10:31:40 GMT 2000\n" \
4096 "Mon Dec 17 10:31:42 GMT 2000\n" \
4097 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004098
Eric Andersen7e9276b2001-02-22 01:15:47 +00004099#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004100 "[-t N[ms]] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004101#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004102 "Periodically write to watchdog device DEV" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004103 "\n\nOptions:" \
4104 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004105 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004106 "\n" \
4107 "\nUse -t 500ms to specify period in milliseconds"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004108
4109#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004110 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004111#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004112 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004113 "more than one FILE is specified. With no FILE, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004114 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004115 " -c Print the byte counts\n" \
4116 " -l Print the newline counts\n" \
4117 " -L Print the length of the longest line\n" \
4118 " -w Print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004119#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004120 "$ wc /etc/passwd\n" \
4121 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004122
4123#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004124 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004125 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004126 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4127 " [-U|--user-agent agent] url" \
4128 ) \
4129 SKIP_GETOPT_LONG( \
4130 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4131 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00004132#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004133 "Retrieve files via HTTP or FTP" \
4134 "\n\nOptions:\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004135 " -s Spider mode - only check file existence\n" \
4136 " -c Continue retrieval of aborted transfer\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004137 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004138 " -P Set directory prefix to DIR\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004139 " -O Save to filename ('-' for stdout)\n" \
4140 " -U Adjust 'User-Agent' field\n" \
4141 " -Y Use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004142
4143#define which_trivial_usage \
Denis Vlasenkof430cdb2007-11-15 07:02:55 +00004144 "[COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004145#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004146 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004147#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004148 "$ which login\n" \
4149 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004150
Eric Andersen00a6a752002-04-26 23:53:10 +00004151#define who_trivial_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004152 "[-a]"
Eric Andersen00a6a752002-04-26 23:53:10 +00004153#define who_full_usage \
Denis Vlasenko01cd9572007-11-16 05:24:43 +00004154 "Show who is logged on" \
4155 "\n\nOptions:\n" \
4156 " -a show all"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004157
4158#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004159 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004160#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004161 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004162
4163#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004164 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004165#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004166 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004167 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004168 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
4169 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004170 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004171 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4172 " -x Exit if the size is exceeded\n") \
4173 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
4174 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004175 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004176#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004177 "$ ls | xargs gzip\n" \
4178 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004179
4180#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004181 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004182#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004183 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004184
Eric Andersen7e9276b2001-02-22 01:15:47 +00004185#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004186 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004187#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004188 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004189
Rob Landleyad8071f2005-04-30 03:49:37 +00004190#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004191 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00004192#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004193 "Manage a ZeroConf IPv4 link-local address" \
4194 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004195 " -f Run in foreground\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004196 " -q Quit after address (no daemon)\n" \
4197 " -r 169.254.x.x Request this address first\n" \
4198 " -v Verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00004199
Eric Andersen178de172004-04-06 16:36:20 +00004200#endif /* __BB_USAGE_H__ */