blob: 682b4d7607991f7ff22089341207da846098b6a3 [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 Vlasenkod63c3a02006-12-25 15:10:32 +000030 " -S Create a system user (ignored)\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 Vlasenko1fffe382006-11-28 00:06:39 +000079 "[-fqbDUA] [-c count] [-w timeout] [-i device] [-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" \
87 " -U Unsolicited ARP mode, update your neighbours\n" \
88 " -A ARP answer mode, update your neighbours\n" \
89 " -c count Stop after sending count ARP request packets\n" \
90 " -w timeout Time to wait for ARP reply, in seconds\n" \
Denis Vlasenkoea9e7982007-06-17 00:36:57 +000091 " -I device Outgoing interface name, default is eth0\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000092 " -s sender Set specific sender IP address\n" \
93 " target Target IP address of ARP request"
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 Vlasenko1fffe382006-11-28 00:06:39 +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
Glenn L McGrath24e28332001-10-05 03:48:57 +0000122#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000123 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000124#define bunzip2_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000125 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
126 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000127 " -c Write output to standard output\n" \
128 " -f Force"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000129
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000130#define bzip2_trivial_usage \
131 "[OPTION]... [FILE]..."
132#define bzip2_full_usage \
133 "Compress FILE(s) with bzip2 algorithm.\n" \
134 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenkod898b862007-10-14 07:57:26 +0000135 "\n\nOptions:" \
136 "\n -c Write output to standard output instead of FILE.bz2" \
137 "\n -d Decompress" \
138 "\n -f Force" \
139 "\n -1..-9 Compression level"
Denis Vlasenko77f1ec12007-10-13 03:36:03 +0000140
Rob Landley6130b9b2006-01-23 21:10:38 +0000141#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000142 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000143
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000144#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000145 "FILE"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000146#define bzcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000147 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000148
Rob Landleyc1d69902006-01-20 18:28:50 +0000149#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000150 "[OPTION]... [FILE]"
Rob Landleyc1d69902006-01-20 18:28:50 +0000151#define unlzma_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000152 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
153 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000154 " -c Write output to standard output\n" \
155 " -f Force"
Rob Landleyc1d69902006-01-20 18:28:50 +0000156
157#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000158 "FILE"
Rob Landleyc1d69902006-01-20 18:28:50 +0000159#define lzmacat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000160 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000161
Eric Andersenc98c0622001-12-06 15:16:43 +0000162#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000163 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000164#define cal_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000165 "Display a calendar" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000166 "\n\nOptions:" \
167 "\n -j Use julian dates" \
168 "\n -y Display the entire year"
Eric Andersenc98c0622001-12-06 15:16:43 +0000169
Eric Andersen7e9276b2001-02-22 01:15:47 +0000170#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000171 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000172#define cat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000173 "Concatenate FILE(s) and print them to stdout" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000174 "\n\nOptions:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000175 "\n -u Use unbuffered i/o (ignored)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000176#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000177 "$ cat /proc/uptime\n" \
178 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000179
Rob Landley8abbee42006-05-31 19:36:04 +0000180#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000181 "[-etv] [FILE]..."
Rob Landley8abbee42006-05-31 19:36:04 +0000182#define catv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000183 "Display nonprinting characters as ^x or M-x" \
184 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000185 " -e End each line with $\n" \
186 " -t Show tabs as ^I\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000187 " -v Don't use ^x or M-x escapes"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000188#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000189 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000190#define chattr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000191 "Change file attributes on an ext2 fs\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000192 "Modifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000193 " - Remove attributes\n" \
194 " + Add attributes\n" \
195 " = Set attributes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000196 "Attributes:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000197 " A Don't track atime\n" \
198 " a Append mode only\n" \
199 " c Enable compress\n" \
200 " D Write dir contents synchronously\n" \
201 " d Do not backup with dump\n" \
202 " i Cannot be modified (immutable)\n" \
203 " j Write all data to journal first\n" \
204 " s Zero disk storage when deleted\n" \
205 " S Write file contents synchronously\n" \
206 " t Disable tail-merging of partial blocks with other files\n" \
207 " u Allow file to be undeleted\n" \
Denis Vlasenko5dd7ef02006-12-26 03:36:28 +0000208 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000209 " -R Recursively list subdirectories\n" \
210 " -v Set the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000211
Denis Vlasenko49622d72007-03-10 16:58:49 +0000212#define chcon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000213 "[OPTIONS] CONTEXT FILE..." \
214 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
215 USE_FEATURE_CHCON_LONG_OPTIONS( \
216 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
217 )
Denis Vlasenko49622d72007-03-10 16:58:49 +0000218#define chcon_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000219 "Change the security context of each FILE to CONTEXT\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000220 USE_FEATURE_CHCON_LONG_OPTIONS( \
221 "\n -v,--verbose Verbose" \
222 "\n -c,--changes Report changes made" \
223 "\n -h,--no-dereference Affect symlinks instead of their targets" \
224 "\n -f,--silent,--quiet Suppress most error messages" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000225 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000226 "\n -u,--user=USER Set user USER in the target security context" \
227 "\n -r,--role=ROLE Set role ROLE in the target security context" \
228 "\n -t,--type=TYPE Set type TYPE in the target security context" \
229 "\n -l,--range=RANGE Set range RANGE in the target security context" \
230 "\n -R,--recursive Recurse subdirectories" \
231 ) \
232 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
233 "\n -v Verbose" \
234 "\n -c Report changes made" \
235 "\n -h Affect symlinks instead of their targets" \
236 "\n -f Suppress most error messages" \
237 "\n -u USER Set user USER in the target security context" \
238 "\n -r ROLE Set role ROLE in the target security context" \
239 "\n -t TYPE Set type TYPE in the target security context" \
240 "\n -l RNG Set range RNE in the target security context" \
241 "\n -R Recurse subdirectories" \
242 )
243
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000244
Eric Andersen7e9276b2001-02-22 01:15:47 +0000245#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000246 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000247#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000248 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000249 "symbols +-= and one or more of the letters rwxst" \
250 "\n\nOptions:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000251 "\n -R Recurse directories" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000252 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000253 "\n -c List changed files" \
254 "\n -v List all files" \
255 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000256 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000257#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000258 "$ ls -l /tmp/foo\n" \
259 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
260 "$ chmod u+x /tmp/foo\n" \
261 "$ ls -l /tmp/foo\n" \
262 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
263 "$ chmod 444 /tmp/foo\n" \
264 "$ ls -l /tmp/foo\n" \
265 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000266
Denis Vlasenko081ef792007-03-17 16:38:21 +0000267#define chgrp_trivial_usage \
268 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
269#define chgrp_full_usage \
270 "Change the group membership of each FILE to GROUP" \
271 "\n\nOptions:" \
272 "\n -R Recurse directories" \
273 "\n -h Affect symlinks instead of symlink targets" \
274 "\n -L Traverse all symlinks to directories" \
275 "\n -H Traverse symlinks on command line only" \
276 "\n -P Do not traverse symlinks (default)" \
277 USE_DESKTOP( \
278 "\n -c List changed files" \
279 "\n -v Verbose" \
280 "\n -f Hide errors" \
281 )
282#define chgrp_example_usage \
283 "$ ls -l /tmp/foo\n" \
284 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
285 "$ chgrp root /tmp/foo\n" \
286 "$ ls -l /tmp/foo\n" \
287 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
288
Eric Andersen7e9276b2001-02-22 01:15:47 +0000289#define chown_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000290 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000291#define chown_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000292 "Change the owner and/or group of each FILE to OWNER and/or GROUP" \
293 "\n\nOptions:" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000294 "\n -R Recurse directories" \
295 "\n -h Affect symlinks instead of symlink targets" \
296 "\n -L Traverse all symlinks to directories" \
297 "\n -H Traverse symlinks on command line only" \
298 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000299 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000300 "\n -c List changed files" \
301 "\n -v List all files" \
302 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000303 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000304#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000305 "$ ls -l /tmp/foo\n" \
306 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
307 "$ chown root /tmp/foo\n" \
308 "$ ls -l /tmp/foo\n" \
309 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
310 "$ chown root.root /tmp/foo\n" \
311 "ls -l /tmp/foo\n" \
312 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000313
Denis Vlasenkofe544582006-10-03 15:57:40 +0000314#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000315 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
316 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
317 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000318#define chpst_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000319 "Change the process state and run specified program" \
320 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000321 " -u user[:grp] Set uid and gid\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +0000322 " -U user[:grp] Set environment variables UID and GID\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000323 " -e dir Set environment variables as specified by files\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000324 " in the directory: file=1st_line_of_file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000325 " -/ dir Chroot to dir\n" \
326 " -n inc Add inc to nice value\n" \
327 " -m bytes Limit data segment, stack segment, locked physical pages,\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000328 " and total of all segment per process to bytes bytes each\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000329 " -d bytes Limit data segment\n" \
330 " -o n Limit the number of open file descriptors per process to n\n" \
331 " -p n Limit number of processes per uid to n\n" \
332 " -f bytes Limit output file size to bytes bytes\n" \
333 " -c bytes Limit core file size to bytes bytes\n" \
334 " -v Verbose\n" \
335 " -P Run prog in a new process group\n" \
336 " -0 Close standard input\n" \
337 " -1 Close standard output\n" \
338 " -2 Close standard error"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000339#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000340 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000341#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000342 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
343 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000344#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000345 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000346#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000347 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000348#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000349 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000350#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000351 "Set various environment variables as specified by files\n" \
352 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000353#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000354 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
355 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
356 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000357#define softlimit_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000358 "Set soft resource limits, then run prog" \
359 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000360 " -m n Same as -d n -s n -l n -a n\n" \
361 " -d n Limit the data segment per process to n bytes\n" \
362 " -s n Limit the stack segment per process to n bytes\n" \
363 " -l n Limit the locked physical pages per process to n bytes\n" \
364 " -a n Limit the total of all segments per process to n bytes\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000365 " -o n Limit the number of open file descriptors per process to n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000366 " -p n Limit the number of processes per uid to n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000367 "Options controlling file sizes:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000368 " -f n Limit output file sizes to n bytes\n" \
369 " -c n Limit core file sizes to n bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000370 "Efficiency opts:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000371 " -r n Limit the resident set size to n bytes. This limit is not\n" \
372 " enforced unless physical memory is full\n" \
373 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
374 " except that the process receives a SIGXCPU signal after n seconds\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000375 "\n" \
376 "Some options may have no effect on some operating systems\n" \
377 "n may be =, indicating that soft limit should be set equal to hard limit"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000378
Eric Andersen7e9276b2001-02-22 01:15:47 +0000379#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000380 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000381#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000382 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000383#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000384 "$ ls -l /bin/ls\n" \
385 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
386 "# mount /dev/hdc1 /mnt -t minix\n" \
387 "# chroot /mnt\n" \
388 "# ls -l /bin/ls\n" \
389 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000390
Eric Andersen7e9276b2001-02-22 01:15:47 +0000391#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000392 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000393#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000394 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000395
Rob Landley856489b2006-04-18 20:57:28 +0000396#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000397 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000398#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000399 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000400
Eric Andersen7e9276b2001-02-22 01:15:47 +0000401#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000402 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000403#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000404 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000405
Eric Andersen7e9276b2001-02-22 01:15:47 +0000406#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000407 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000408#define cmp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000409 "Compares FILE1 vs stdin if FILE2 is not specified" \
410 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000411 " -l Write the byte numbers (decimal) and values (octal)\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000412 " for all differing bytes\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000413 " -s Quiet"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000414
Rob Landley2acfd7b2005-05-11 23:12:49 +0000415#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000416 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000417#define comm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000418 "Compare FILE1 to FILE2, or to stdin if - is specified" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000419 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000420 " -1 Suppress lines unique to FILE1\n" \
421 " -2 Suppress lines unique to FILE2\n" \
422 " -3 Suppress lines common to both files"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000423
Paul Fox79c142d2005-08-01 16:04:40 +0000424#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000425 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000426#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000427 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000428
Rob Landley69674942006-09-11 00:34:01 +0000429#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000430 "[FILE]...\n" \
431 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000432#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000433 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000434
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000435#define chrt_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000436 "[OPTION]... [prio] [pid | command [arg]...]"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000437#define chrt_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000438 "manipulate real-time attributes of a process" \
439 "\n\nOptions:\n" \
440 " -p operate on pid\n" \
441 " -r set scheduling policy to SCHED_RR\n" \
442 " -f set scheduling policy to SCHED_FIFO\n" \
443 " -o set scheduling policy to SCHED_OTHER\n" \
444 " -m show min and max priorities"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000445
446#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000447 "$ chrt -r 4 sleep 900; x=$!\n" \
448 "$ chrt -f -p 3 $x\n" \
449 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000450
Eric Andersen7e9276b2001-02-22 01:15:47 +0000451#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000452 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000453#define cp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000454 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000455 "\n\nOptions:" \
456 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000457 USE_SELINUX( \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000458 "\n -c Preserves security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000459 ) \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000460 "\n -d,-P Preserve links" \
461 "\n -H,-L Dereference all symlinks (default)" \
462 "\n -p Preserve file attributes if possible" \
463 "\n -f Force overwrite" \
464 "\n -i Prompt before overwrite" \
465 "\n -R,-r Recurse directories" \
466 "\n -l,-s Create (sym)links"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000467
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000468#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000469 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000470#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000471 "Extract or list files from a cpio archive\n" \
472 "Main operation mode:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000473 " d Make leading directories\n" \
474 " i Extract\n" \
475 " m Preserve mtime\n" \
476 " t List\n" \
477 " v Verbose\n" \
478 " u Unconditional overwrite\n" \
479 " F Input from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000480
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000481#define crond_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +0000482 "-d[#] -c crondir -f -b"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000483#define crond_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000484 " -d [#] -l [#] -S -L logfile -f -b -c dir\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000485 " -d num Debug level\n" \
486 " -l num Log level (8 - default)\n" \
Denis Vlasenko88ce2742007-10-09 18:08:04 +0000487 " -S Log to syslog (default)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000488 " -L file Log to file\n" \
489 " -f Run in foreground\n" \
490 " -b Run in background (default)\n" \
491 " -c dir Working dir"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000492
493#define crontab_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000494 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000495#define crontab_full_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +0000496 " file [opts] Replace crontab from file\n" \
497 " - [opts] Replace crontab from stdin\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000498 " -u user User\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000499 " -l [user] List crontab for user\n" \
500 " -e [user] Edit crontab for user\n" \
501 " -d [user] Delete crontab for user\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000502 " -c dir Crontab directory"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000503
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000504#define cryptpw_trivial_usage \
505 "[-a des|md5] [string]"
506#define cryptpw_full_usage \
507 "Outputs crypted string.\n" \
508 "If string isn't supplied on cmdline, reads it from stdin.\n" \
509 "\nOptions:" \
510 "\n -a Algorithm to use (default: md5)"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000511
Eric Andersen7e9276b2001-02-22 01:15:47 +0000512#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000513 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000514#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000515 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000516 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000517 " -b LIST Output only bytes from LIST\n" \
518 " -c LIST Output only characters from LIST\n" \
519 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
520 " -s Output only the lines containing delimiter\n" \
521 " -f N Print only these fields\n" \
522 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000523#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000524 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
525 "Hello\n" \
526 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
527 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000528
Eric Andersen7e9276b2001-02-22 01:15:47 +0000529#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000530 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000531#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000532 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000533 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000534 " -R Outputs RFC-822 compliant date string\n" \
535 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000536 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000537 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
538 " TIMESPEC='date' (or missing) for date only,\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000539 " 'hours', 'minutes', or 'seconds' for date and\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000540 " time to the indicated precision\n" \
541 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000542 ) \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000543 " -s STRING Sets time described by STRING\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000544 " -r FILE Displays the last modification time of FILE\n" \
545 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000546#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000547 "$ date\n" \
548 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000549
Eric Andersen7e9276b2001-02-22 01:15:47 +0000550#define dc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000551 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000552#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000553 "This is a Tiny RPN calculator that understands the\n" \
554 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
555 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000556 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
557 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000558 "p - Prints the value on the top of the stack, without altering the stack\n" \
559 "f - Prints the entire contents of the stack without altering anything\n" \
560 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
561 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000562#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000563 "$ dc 2 2 + p\n" \
564 "4\n" \
565 "$ dc 8 8 \\* 2 2 + / p\n" \
566 "16\n" \
567 "$ dc 0 1 and p\n" \
568 "0\n" \
569 "$ dc 0 1 or p\n" \
570 "1\n" \
571 "$ echo 72 9 div 8 mul p | dc\n" \
572 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000573
Eric Andersen7e9276b2001-02-22 01:15:47 +0000574#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000575 "[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 +0000576 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000578 "Copy a file with converting and formatting" \
579 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000580 " if=FILE Read from FILE instead of stdin\n" \
581 " of=FILE Write to FILE instead of stdout\n" \
582 " bs=N Read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000583 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000584 " ibs=N Read N bytes at a time\n") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000585 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000586 " obs=N Write N bytes at a time\n") \
587 " count=N Copy only N input blocks\n" \
588 " skip=N Skip N input blocks\n" \
589 " seek=N Skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000590 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000591 " conv=notrunc Don't truncate output file\n" \
592 " conv=noerror Continue after read errors\n" \
593 " conv=sync Pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000594 "\n" \
595 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
596 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000597#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000598 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
599 "4+0 records in\n" \
600 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000601
Eric Andersen7e9276b2001-02-22 01:15:47 +0000602#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000603 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000604#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000605 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000606
Eric Andersenf349e972001-08-21 16:18:59 +0000607#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000608 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000609#define delgroup_full_usage \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000610 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000611 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000612
613#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000614 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000615#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000616 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000617
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000618#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000619 "mntpnt [-v]" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000620 USE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000621#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000622 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000623 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000624 "\n mntpnt The mount point where devfs is mounted" \
625 "\n -v Print the protocol version numbers for devfsd" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000626 "\n and the kernel-side protocol version and exit" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000627 USE_DEVFSD_FG_NP( \
Denis Vlasenkocef23e02007-09-05 15:45:51 +0000628 "\n -fg Run in foreground" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000629 "\n -np Exit after parsing the configuration file" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000630 "\n and processing synthetic REGISTER events," \
631 "\n do not poll for events")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000632
Eric Andersen7e9276b2001-02-22 01:15:47 +0000633#define df_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000634 "[-" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000635#define df_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000636 "Print the filesystem space used and space available" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000637 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko08294db2007-08-13 12:27:49 +0000638 "\n\nOptions control size display:" \
639 "\n -h Human readable (e.g. 1K 243M 2G)" \
640 "\n -m 1024*1024 blocks" \
641 "\n -k 1024 blocks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000642 SKIP_FEATURE_HUMAN_READABLE( \
Denis Vlasenko08294db2007-08-13 12:27:49 +0000643 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000644 "\n -k Ignored")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000645#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000646 "$ df\n" \
647 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
648 "/dev/sda3 8690864 8553540 137324 98% /\n" \
649 "/dev/sda1 64216 36364 27852 57% /boot\n" \
650 "$ df /dev/sda3\n" \
651 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
652 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000653
Denis Vlasenko736230e2006-11-20 19:40:36 +0000654#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000655 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000656#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000657 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000658
659#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000660 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000661#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000662 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000663
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000664#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000665 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000666#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000667 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000668 "This diff implementation only supports unified diffs." \
669 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000670 " -a Treat all files as text\n" \
671 " -b Ignore changes in the amount of whitespace\n" \
672 " -d Try hard to find a smaller set of changes\n" \
673 " -i Ignore case differences\n" \
674 " -L Use LABEL instead of the filename in the unified header\n" \
675 " -N Treat absent files as empty\n" \
676 " -q Output only whether files differ\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +0000677 " -r Recursively compare subdirectories\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000678 " -S Start with FILE when comparing directories\n" \
679 " -T Make tabs line up by prefixing a tab when necessary\n" \
680 " -s Report when two files are the same\n" \
681 " -t Expand tabs to spaces in output\n" \
682 " -U Output LINES lines of context\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000683 " -w Ignore all whitespace"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000684
Eric Andersen7e9276b2001-02-22 01:15:47 +0000685#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000686 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000687#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000688 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000689#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000690 "$ dirname /tmp/foo\n" \
691 "/tmp\n" \
692 "$ dirname /tmp/foo/\n" \
693 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000694
Eric Andersen7e9276b2001-02-22 01:15:47 +0000695#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000696 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000697#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000698 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000699 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000700 " -c Clear ring buffer after printing\n" \
701 " -n LEVEL Set console logging level\n" \
702 " -s SIZE Buffer size"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000703
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000704#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000705 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000706#define dnsd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000707 "Small and static DNS server daemon" \
708 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000709 " -c Config filename\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000710 " -t TTL in seconds\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000711 " -p Listening port\n" \
Denis Vlasenkod3bac032007-03-24 12:13:04 +0000712 " -i Listening ip (default all)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000713 " -d Daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000714
Eric Andersen7e9276b2001-02-22 01:15:47 +0000715#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000716 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000717#define dos2unix_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000718 "Convert FILE from dos format to unix format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000719 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000720 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000721 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000722 " -u Output will be in UNIX format\n" \
723 " -d Output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000724
Eric Andersen7e9276b2001-02-22 01:15:47 +0000725#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000726 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000727#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000728 "Install, remove and manage Debian packages" \
729 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000730 " -i Install the package\n" \
731 " -l List of installed packages\n" \
732 " -C Configure an unpackaged package\n" \
733 " -F depends Ignore dependency problems\n" \
734 " -P Purge all files of a package\n" \
735 " -r Remove all but the configuration files for a package\n" \
736 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000737
Eric Andersen7e9276b2001-02-22 01:15:47 +0000738#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000739 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000740#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000741 "Perform actions on Debian packages (.debs)" \
742 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000743 " -c List contents of filesystem tree\n" \
744 " -e Extract control files to [argument] directory\n" \
745 " -f Display control field name starting with [argument]\n" \
746 " -x Extract packages filesystem tree to directory\n" \
747 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000748#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000749 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000750
Eric Andersen7e9276b2001-02-22 01:15:47 +0000751#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000752 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000753#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000754 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000755 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000756 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
757 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000758 " bytes." \
759 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000760 " -a Show sizes of files in addition to directories\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000761 " -H Follow symlinks that are FILE command line args\n" \
762 " -L Follow all symlinks encountered\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000763 " -d N Limit output to directories (and files with -a) of depth < N\n" \
764 " -c Output a grand total\n" \
765 " -l Count sizes many times if hard linked\n" \
766 " -s Display only a total for each argument\n" \
767 " -x Skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000768 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000769 " -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
770 " -m Print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000771 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000772 " -k Print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000773 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000774#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000775 "$ du\n" \
776 "16 ./CVS\n" \
777 "12 ./kernel-patches/CVS\n" \
778 "80 ./kernel-patches\n" \
779 "12 ./tests/CVS\n" \
780 "36 ./tests\n" \
781 "12 ./scripts/CVS\n" \
782 "16 ./scripts\n" \
783 "12 ./docs/CVS\n" \
784 "104 ./docs\n" \
785 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000786
Eric Andersen7e9276b2001-02-22 01:15:47 +0000787#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000788 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000789#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000790 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000791#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000792 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000793
Russ Dill61fb4892002-10-14 21:41:28 +0000794#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000795 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000796#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000797 "Display DHCP leases granted by udhcpd" \
798 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +0000799 USE_GETOPT_LONG( \
800 " -f,--file=FILE Leases file to load\n" \
801 " -r,--remaining Interpret lease times as time remaining\n" \
802 " -a,--absolute Interpret lease times as expire time" \
803 ) \
804 SKIP_GETOPT_LONG( \
805 " -f FILE Leases file to load\n" \
806 " -r Interpret lease times as time remaining\n" \
807 " -a Interpret lease times as expire time" \
808 )
Russ Dill61fb4892002-10-14 21:41:28 +0000809
Mike Frysinger51a43b42005-09-24 07:11:16 +0000810#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000811 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
812 "[-I inode_buffer_blocks] [-P process_inode_size] " \
813 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
814 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000815#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000816 "Check ext2/ext3 file system" \
817 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000818 " -p Automatic repair (no questions)\n" \
819 " -n Make no changes to the filesystem\n" \
820 " -y Assume 'yes' to all questions\n" \
821 " -c Check for bad blocks and add them to the badblock list\n" \
822 " -f Force checking even if filesystem is marked clean\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000823 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000824 " -b superblock Use alternative superblock\n" \
825 " -B blocksize Force blocksize when looking for superblock\n" \
826 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000827 " -l file Add to badblocks list\n" \
828 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000829
Eric Andersen7e9276b2001-02-22 01:15:47 +0000830#define echo_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000831 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000832#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000833 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000834 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000835 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000836 " -n Suppress trailing newline\n" \
837 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
838 " -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000839 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000840#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000841 "$ echo \"Erik is cool\"\n" \
842 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000843 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000844 "Erik\n" \
845 "is\n" \
846 "cool\n" \
847 "$ echo \"Erik\\nis\\ncool\"\n" \
848 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000849
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000850#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000851 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000852#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000853 "Eject specified DEVICE (or default /dev/cdrom)" \
854 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000855 " -t Close tray\n" \
856 " -T Open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000857
Rob Landley3b890392006-05-04 20:56:43 +0000858#define ed_trivial_usage ""
859#define ed_full_usage ""
860
Eric Andersen84e229c2001-03-29 22:48:33 +0000861#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000862 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000863#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000864 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000865 "up the specified environment" \
866 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000867 " -, -i Start with an empty environment\n" \
868 " -u Remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000869
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000870#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000871 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000872#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000873 "Send a magic packet to wake up sleeping machines.\n" \
874 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000875 "a hostname with a known 'ethers' entry." \
876 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000877 " -b Send wake-up packet to the broadcast address\n" \
878 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000879 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000880
Denis Vlasenko3952f202007-08-13 14:10:24 +0000881#define expand_trivial_usage \
882 "[-i] [-t NUM] [FILE|-]"
883#define expand_full_usage \
884 "Convert tabs to spaces, writing to standard output." \
885 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +0000886 USE_FEATURE_EXPAND_LONG_OPTIONS( \
887 "\n -i,--initial Do not convert tabs after non blanks" \
888 "\n -t,--tabs=N Tabstops every N chars" \
889 ) \
890 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
891 "\n -i Do not convert tabs after non blanks" \
892 "\n -t Tabstops every N chars" \
893 )
Denis Vlasenko3952f202007-08-13 14:10:24 +0000894
Eric Andersen7e9276b2001-02-22 01:15:47 +0000895#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000896 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000897#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000898 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000899 "EXPRESSION may be:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +0000900 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
901 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
902 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
903 " ARG1 <= ARG2\n" \
904 " ARG1 = ARG2\n" \
905 " ARG1 != ARG2\n" \
906 " ARG1 >= ARG2\n" \
907 " ARG1 > ARG2\n" \
908 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
909 " ARG1 - ARG2\n" \
910 " ARG1 * ARG2\n" \
911 " ARG1 / ARG2\n" \
912 " ARG1 % ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000913 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
914 " match STRING REGEXP Same as STRING : REGEXP\n" \
915 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
916 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
917 " length STRING Length of STRING\n" \
918 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000919 " it is a keyword like 'match' or an\n" \
920 " operator like '/'\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000921 " (EXPRESSION) Value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000922 "Beware that many operators need to be escaped or quoted for shells.\n" \
923 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000924 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000925 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
926 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000927
Mike Frysingerfa69f112005-04-17 07:24:19 +0000928#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000929 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000930#define fakeidentd_full_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000931 "Provide fake ident (auth) service" \
932 "\n\nOptions:" \
933 "\n -f Run in foreground" \
934 "\n -i Inetd mode" \
935 "\n -w Inetd 'wait' mode" \
936 "\n -b ADDR Bind to specified address" \
937 "\n STRING Ident answer string (default is 'nobody')"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000938
Eric Andersen7e9276b2001-02-22 01:15:47 +0000939#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000940 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000941#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000942 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000943#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000944 "$ false\n" \
945 "$ echo $?\n" \
946 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000947
948#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000949 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000950#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000951 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000952#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000953 "$ fbset\n" \
954 "mode \"1024x768-76\"\n" \
955 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
956 " geometry 1024 768 1024 768 16\n" \
957 " timings 12714 128 32 16 4 128 4\n" \
958 " accel false\n" \
959 " rgba 5/11,6/5,5/0,0/0\n" \
960 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000961
Eric Andersen7e9276b2001-02-22 01:15:47 +0000962#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000963 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000964#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000965 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000966
Eric Andersen01c3d402003-07-05 07:51:31 +0000967#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000968 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +0000969#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000970 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000971 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000972 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +0000973
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000974#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000975 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000976#define fdisk_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000977 "Change partition table" \
978 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000979 " -l List partition table(s)\n" \
980 " -u Give Start and End in sector (instead of cylinder) units\n" \
981 " -s PARTITION Give partition size(s) in blocks\n" \
982 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
983 " -C CYLINDERS Set the number of cylinders\n" \
984 " -H HEADS Set the number of heads\n" \
985 " -S SECTORS Set the number of sectors\n" \
986 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000987
Eric Andersen7e9276b2001-02-22 01:15:47 +0000988#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000989 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000990#define find_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000991 "Search for files in a directory hierarchy. The default PATH is\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +0000992 "the current directory, default EXPRESSION is '-print'\n" \
993 "\nEXPRESSION may consist of:" \
994 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +0000995 USE_FEATURE_FIND_XDEV( \
996 "\n -xdev Don't descend directories on other filesystems") \
997 USE_FEATURE_FIND_MAXDEPTH( \
998 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
999 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001000 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
1001 USE_FEATURE_FIND_PATH( \
1002 "\n -path PATTERN Path matches PATTERN") \
1003 USE_FEATURE_FIND_REGEX( \
1004 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001005 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001006 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001007 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001008 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001009 "\n or exactly (NNN)") \
1010 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001011 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001012 "\n or exactly (N) days") \
1013 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +00001014 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001015 "\n or exactly (N) minutes") \
1016 USE_FEATURE_FIND_NEWER( \
1017 "\n -newer FILE Modified time is more recent than FILE's") \
1018 USE_FEATURE_FIND_INUM( \
1019 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001020 USE_FEATURE_FIND_USER( \
1021 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1022 USE_FEATURE_FIND_GROUP( \
1023 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1024 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001025 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001026 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001027 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1028 "\n +/-N: file size is bigger/smaller than N") \
1029 "\n -print Print (default and assumed)" \
1030 USE_FEATURE_FIND_PRINT0( \
1031 "\n -print0 Delimit output with null characters rather than" \
1032 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +00001033 USE_FEATURE_FIND_CONTEXT ( \
1034 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +00001035 USE_FEATURE_FIND_EXEC( \
1036 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1037 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001038 USE_FEATURE_FIND_PRUNE( \
1039 "\n -prune Stop traversing current subtree") \
1040 USE_FEATURE_FIND_DELETE( \
1041 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001042 USE_FEATURE_FIND_PAREN( \
1043 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001044
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001045#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001046 "$ find / -name passwd\n" \
1047 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001048
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001049#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001050 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001051#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001052 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001053 "standard output" \
1054 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001055 " -b Count bytes rather than columns\n" \
1056 " -s Break at spaces\n" \
1057 " -w Use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001058
Eric Andersen7e9276b2001-02-22 01:15:47 +00001059#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001060 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001061#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001062 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001063#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001064 "$ free\n" \
1065 " total used free shared buffers\n" \
1066 " Mem: 257628 248724 8904 59644 93124\n" \
1067 " Swap: 128516 8404 120112\n" \
1068 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001069
Eric Andersen7e9276b2001-02-22 01:15:47 +00001070#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001071 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001072#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001073 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001074#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001075 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001076
Mike Frysinger51a43b42005-09-24 07:11:16 +00001077#define fsck_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001078 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys ...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001079#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001080 "Check and repair filesystems" \
1081 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001082 " -A Walk /etc/fstab and check all filesystems\n" \
1083 " -N Don't execute, just show what would be done\n" \
1084 " -P When using -A, check filesystems in parallel\n" \
1085 " -R When using -A, skip the root filesystem\n" \
1086 " -T Don't show title on startup\n" \
Denis Vlasenko0de93752006-12-26 02:51:29 +00001087 " -V Verbose\n" \
1088 " -C n Write status information to specified filedescriptor\n" \
1089 " -t type List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001090
Eric Andersen7e9276b2001-02-22 01:15:47 +00001091#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001092 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001093#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001094 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001095 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001096 " -l List all filenames\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001097 " -r Perform interactive repairs\n" \
1098 " -a Perform automatic repairs\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001099 " -v Verbose\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00001100 " -s Output super-block information\n" \
1101 " -m Activate MINIX-like \"mode not cleared\" warnings\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001102 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001103
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001104#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001105 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001106#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001107 "Retrieve a remote file via FTP" \
1108 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001109 USE_GETOPT_LONG( \
1110 " -c,--continue Continue previous transfer\n" \
1111 " -v,--verbose Verbose\n" \
1112 " -u,--username Username\n" \
1113 " -p,--password Password\n" \
1114 " -P,--port Port number" \
1115 ) \
1116 SKIP_GETOPT_LONG( \
1117 " -c Continue previous transfer\n" \
1118 " -v Verbose\n" \
1119 " -u Username\n" \
1120 " -p Password\n" \
1121 " -P Port number" \
1122 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001123
1124#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001125 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001126#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001127 "Store a local file on a remote machine via FTP" \
1128 "\n\nOptions:\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001129 USE_GETOPT_LONG( \
1130 " -v,--verbose Verbose\n" \
1131 " -u,--username Username\n" \
1132 " -p,--password Password\n" \
1133 " -P,--port Port number" \
1134 ) \
1135 SKIP_GETOPT_LONG( \
1136 " -v Verbose\n" \
1137 " -u Username\n" \
1138 " -p Password\n" \
1139 " -P Port number" \
1140 )
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001141
Rob Landleyaa872762005-10-28 13:05:12 +00001142#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001143 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +00001144#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001145 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001146 " -m Show all processes on the same mounted fs\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001147 " -k Kill all processes that match\n" \
1148 " -s Don't print or kill anything\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001149 " -4 When using port/proto only search IPv4 space\n" \
1150 " -6 When using port/proto only search IPv6 space\n" \
1151 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001152
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001153#define getenforce_trivial_usage
1154#define getenforce_full_usage
1155
Eric Andersen7e9276b2001-02-22 01:15:47 +00001156#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001157 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001158#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001159 "Parse command options\n" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00001160 USE_GETOPT_LONG( \
1161 " -a,--alternative Allow long options starting with single -\n" \
1162 " -l,--longoptions=longopts Long options to be recognized\n" \
1163 " -n,--name=progname The name under which errors are reported\n" \
1164 " -o,--options=optstring Short options to be recognized\n" \
1165 " -q,--quiet Disable error reporting by getopt(3)\n" \
1166 " -Q,--quiet-output No normal output\n" \
1167 " -s,--shell=shell Set shell quoting conventions\n" \
1168 " -T,--test Test for getopt(1) version\n" \
1169 " -u,--unquoted Don't quote the output" \
1170 ) \
1171 SKIP_GETOPT_LONG( \
1172 " -a Allow long options starting with single -\n" \
1173 " -l longopts Long options to be recognized\n" \
1174 " -n progname The name under which errors are reported\n" \
1175 " -o optstring Short options to be recognized\n" \
1176 " -q Disable error reporting by getopt(3)\n" \
1177 " -Q No normal output\n" \
1178 " -s shell Set shell quoting conventions\n" \
1179 " -T Test for getopt(1) version\n" \
1180 " -u Don't quote the output" \
1181 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001182#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001183 "$ cat getopt.test\n" \
1184 "#!/bin/sh\n" \
1185 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1186 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001187 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001188 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001189 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001190 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001191 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1192 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001193 " -c|--c-long)\n" \
1194 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001195 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1196 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1197 " esac;;\n" \
1198 " --) shift; break;;\n" \
1199 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001200 " esac\n" \
1201 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001202
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001203#define getsebool_trivial_usage \
1204 "-a or getsebool boolean..."
1205#define getsebool_full_usage \
1206 " -a Show all SELinux booleans"
1207
Eric Andersenf349e972001-08-21 16:18:59 +00001208#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001209 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001210#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001211 "Open a tty, prompt for a login name, then invoke /bin/login" \
1212 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001213 " -h Enable hardware (RTS/CTS) flow control\n" \
1214 " -i Do not display /etc/issue before running login\n" \
1215 " -L Local line, so do not do carrier detect\n" \
1216 " -m Get baud rate from modem's CONNECT status message\n" \
1217 " -w Wait for a CR or LF before sending /etc/issue\n" \
1218 " -n Do not prompt the user for a login name\n" \
1219 " -f issue_file Display issue_file instead of /etc/issue\n" \
1220 " -l login_app Invoke login_app instead of /bin/login\n" \
1221 " -t timeout Terminate after timeout if no username is read\n" \
1222 " -I initstring Sets the init string to send before anything else\n" \
1223 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001224
Eric Andersen7e9276b2001-02-22 01:15:47 +00001225#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001226 "[-HhrilLnqvso" \
1227 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001228 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001229 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1230 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001231 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001232#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001233 "Search for PATTERN in each FILE or standard input" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001234 "\n\nOptions:" \
1235 "\n -H Prefix output lines with filename where match was found" \
1236 "\n -h Suppress the prefixing filename on output" \
1237 "\n -r Recurse subdirectories" \
1238 "\n -i Ignore case distinctions" \
1239 "\n -l List names of files that match" \
1240 "\n -L List names of files that do not match" \
1241 "\n -n Print line number with output lines" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001242 "\n -q Quiet. Returns 0 if PATTERN was found, 1 otherwise" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001243 "\n -v Select non-matching lines" \
1244 "\n -s Suppress file open/read error messages" \
1245 "\n -c Only print count of matching lines" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001246 "\n -o Show only the part of a line that matches PATTERN" \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001247 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001248 USE_DESKTOP( \
1249 "\n -w Match whole words only") \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001250 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001251 USE_FEATURE_GREP_EGREP_ALIAS( \
1252 "\n -E PATTERN is an extended regular expression") \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001253 "\n -e PTRN Pattern to match" \
1254 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001255 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001256 "\n -A Print NUM lines of trailing context" \
1257 "\n -B Print NUM lines of leading context" \
1258 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001259
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001260#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001261 "$ grep root /etc/passwd\n" \
1262 "root:x:0:0:root:/root:/bin/bash\n" \
1263 "$ grep ^[rR]oo. /etc/passwd\n" \
1264 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001265
Eric Andersen7e9276b2001-02-22 01:15:47 +00001266#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001267 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001268#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001269 "Uncompress FILE (or standard input if FILE is '-')" \
1270 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001271 " -c Write output to standard output\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001272 " -f Force\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001273 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001274#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001275 "$ ls -la /tmp/BusyBox*\n" \
1276 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1277 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1278 "$ ls -la /tmp/BusyBox*\n" \
1279 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001280
1281#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001282 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001283#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001284 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001285 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001286 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001287 " -c Write output to standard output instead of FILE.gz\n" \
1288 " -d Decompress\n" \
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001289 " -f Force"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001290#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001291 "$ ls -la /tmp/busybox*\n" \
1292 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1293 "$ gzip /tmp/busybox.tar\n" \
1294 "$ ls -la /tmp/busybox*\n" \
1295 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001296
1297#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001298 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001299#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001300 "Halt the system" \
1301 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001302 " -d Delay interval for halting\n" \
1303 " -n No call to sync()\n" \
1304 " -f Force halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001305
Eric Andersen3443bd72003-07-22 07:30:36 +00001306#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001307 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001308#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001309 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001310 "If no device name is specified try to read from stdin.\n\n") \
1311 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001312 " -a Get/set fs readahead\n" \
1313 " -A Set drive read-lookahead flag (0/1)\n" \
1314 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1315 " -B Set Advanced Power Management setting (1-255)\n" \
1316 " -c Get/set IDE 32-bit IO setting\n" \
1317 " -C Check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001318 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001319 " -d Get/set using_dma flag\n") \
1320 " -D Enable/disable drive defect-mgmt\n" \
1321 " -f Flush buffer cache for device on exit\n" \
1322 " -g Display drive geometry\n" \
1323 " -h Display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001324 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001325 " -i Display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001326 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001327 " -I Detailed/current information directly from drive\n") \
1328 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1329 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1330 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1331 " -m Get/set multiple sector count\n" \
1332 " -n Get/set ignore-write-errors flag (0/1)\n" \
1333 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1334 " -P Set drive prefetch count\n" \
1335 " -q Change next setting quietly\n" \
1336 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1337 " -r Get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001338 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001339 " -R Register an IDE interface (DANGEROUS)\n") \
1340 " -S Set standby (spindown) timeout\n" \
1341 " -t Perform device read timings\n" \
1342 " -T Perform cache read timings\n" \
1343 " -u Get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001344 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001345 " -U Un-register an IDE interface (DANGEROUS)\n") \
1346 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1347 " -V Display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001348 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001349 " -w Perform device reset (DANGEROUS)\n") \
1350 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001351 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001352 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1353 " -X Set IDE xfer mode (DANGEROUS)\n" \
1354 " -y Put IDE drive in standby mode\n" \
1355 " -Y Put IDE drive to sleep\n" \
1356 " -Z Disable Seagate auto-powersaving mode\n" \
1357 " -z Re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001358
Eric Andersen7e9276b2001-02-22 01:15:47 +00001359#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001360 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001361#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001362 "Print first 10 lines of each FILE to standard output.\n" \
1363 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001364 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001365 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001366 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001367 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001368 "\n -c NUM Output the first NUM bytes" \
1369 "\n -q Never output headers giving file names" \
1370 "\n -v Always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001371#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001372 "$ head -n 2 /etc/passwd\n" \
1373 "root:x:0:0:root:/root:/bin/bash\n" \
1374 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001375
Glenn L McGrath60281112001-11-02 11:39:46 +00001376#define hexdump_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001377 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001378#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001379 "Display file(s) or standard input in a user specified format" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001380 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001381 " -b One-byte octal display\n" \
1382 " -c One-byte character display\n" \
1383 " -C Canonical hex+ASCII, 16 bytes per line\n" \
1384 " -d Two-byte decimal display\n" \
1385 " -e FORMAT STRING\n" \
1386 " -f FORMAT FILE\n" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001387 " -n LENGTH Interpret only LENGTH bytes of input\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001388 " -o Two-byte octal display\n" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001389 " -s OFFSET Skip OFFSET bytes\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001390 " -v Display all input data\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001391 " -x Two-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001392
Eric Andersen7e9276b2001-02-22 01:15:47 +00001393#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001394 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001395#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001396 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001397
1398#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001399 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001400#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001401 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001402 "(or FILE with the -F parameter), the host name will be set." \
1403 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001404 " -s Short\n" \
1405 " -i Addresses for the hostname\n" \
1406 " -d DNS domain name\n" \
1407 " -f Fully qualified domain name\n" \
1408 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001409#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001410 "$ hostname\n" \
1411 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001412
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001413#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001414 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001415 " [-p [ip:]port]" \
1416 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001417 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001418 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001419 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001420 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001421 " [-d/-e string]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001422#define httpd_full_usage \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001423 "Listen for incoming HTTP requests" \
1424 "\n\nOptions:" \
1425 "\n -c FILE Configuration file (default httpd.conf)" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001426 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001427 "\n -i Inetd mode" \
1428 "\n -f Do not daemonize" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001429 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001430 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001431 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001432 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001433 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001434 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001435 "\n -m PASS Crypt PASS with md5 algorithm") \
1436 "\n -h HOME Home directory (default .)" \
1437 "\n -e STRING HTML encode STRING" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001438 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001439
Robert Griebl1cd04452002-07-21 16:50:49 +00001440#define hwclock_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001441 USE_GETOPT_LONG( \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001442 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1443 " [-l|--localtime] [-u|--utc]" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001444 " [-f FILE]" \
1445 ) \
1446 SKIP_GETOPT_LONG( \
1447 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1448 )
Robert Griebl1cd04452002-07-21 16:50:49 +00001449#define hwclock_full_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001450 "Query and set a hardware clock (RTC)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001451 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001452 " -r Read hardware clock and print result\n" \
1453 " -s Set the system time from the hardware clock\n" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001454 " -w Set the hardware clock to the system time\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001455 " -u The hardware clock is kept in coordinated universal time\n" \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001456 " -l The hardware clock is kept in local time\n" \
1457 " -f FILE Use the specified clock (e.g. /dev/rtc2)"
Robert Griebl1cd04452002-07-21 16:50:49 +00001458
Eric Andersen7e9276b2001-02-22 01:15:47 +00001459#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001460 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001461#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001462 "Print information for USERNAME or the current user" \
1463 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001464 USE_SELINUX( \
Denis Vlasenko99014e82007-10-20 14:54:58 +00001465 " -Z Prints only the security context\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001466 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001467 " -g Prints only the group ID\n" \
1468 " -u Prints only the user ID\n" \
1469 " -n Print a name instead of a number\n" \
1470 " -r Prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001471#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001472 "$ id\n" \
1473 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001474
Eric Andersen7e9276b2001-02-22 01:15:47 +00001475#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001476 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001477#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001478 "Configure a network interface" \
1479 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001480 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001481 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001482 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001483 " [del ADDRESS[/PREFIXLEN]]\n") \
1484 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1485 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001486 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001487 " [outfill NN] [keepalive NN]\n") \
1488 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001489 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001490 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001491 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001492 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001493 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001494
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001495#define ifup_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001496 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001497#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001498 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001499 " -a De/configure all interfaces automatically\n" \
1500 " -i FILE Use FILE for interface definitions\n" \
1501 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001502 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001503 " -v Print out what would happen before doing it\n" \
1504 " -m Don't run any mappings\n" \
1505 " -f Force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001506
1507#define ifdown_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001508 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001509#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001510 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001511 " -a De/configure all interfaces automatically\n" \
1512 " -i FILE Use FILE for interface definitions\n" \
1513 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001514 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001515 " -v Print out what would happen before doing it\n" \
1516 " -m Don't run any mappings\n" \
1517 " -f Force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001518
Glenn L McGrath06e95652003-02-09 06:51:14 +00001519#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001520 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001521#define inetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001522 "Listen for network connections and launch programs" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001523 "\n\nOptions:\n" \
Denis Vlasenko886bb0d2007-01-09 23:48:46 +00001524 " -f Run in foreground\n" \
1525 " -q N Set the size of the socket listen queue to N\n" \
1526 " (default: 128)"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001527
Eric Andersen7e9276b2001-02-22 01:15:47 +00001528#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001529 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001530#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001531 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001532#define init_notes_usage \
1533"This version of init is designed to be run only by the kernel.\n" \
1534"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001535"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001536"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001537"runlevels, use sysvinit.\n" \
1538"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001539"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001540"it has the following default behavior:\n" \
1541"\n" \
1542" ::sysinit:/etc/init.d/rcS\n" \
1543" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001544" ::ctrlaltdel:/sbin/reboot\n" \
1545" ::shutdown:/sbin/swapoff -a\n" \
1546" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001547" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001548"\n" \
1549"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1550"\n" \
1551" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001552" tty3::askfirst:/bin/sh\n" \
1553" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001554"\n" \
1555"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1556"\n" \
1557" <id>:<runlevels>:<action>:<process>\n" \
1558"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001559" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001560"\n" \
1561" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1562" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001563" the specified process to run on. The contents of this field are\n" \
1564" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1565" be unique, although if it isn't you may have strange results. If this\n" \
1566" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001567" note that if BusyBox detects that a serial console is in use, then only\n" \
1568" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001569" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001570" stinkin' utmp.\n" \
1571"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001572" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001573"\n" \
1574" The runlevels field is completely ignored.\n" \
1575"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001576" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001577"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001578" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001579" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001580"\n" \
1581" The available actions can be classified into two groups: actions\n" \
1582" that are run only once, and actions that are re-run when the specified\n" \
1583" process exits.\n" \
1584"\n" \
1585" Run only-once actions:\n" \
1586"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001587" 'sysinit' is the first item run on boot. init waits until all\n" \
1588" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001589" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001590" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001591" the specified task completes. 'once' actions are asynchronous,\n" \
1592" therefore, init does not wait for them to complete. 'restart' is\n" \
1593" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001594" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001595" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001596" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001597" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001598" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001599" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001600" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001601" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001602"\n" \
1603" Run repeatedly actions:\n" \
1604"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001605" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001606" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001607" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1608" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001609" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001610" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001611" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001612" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001613"\n" \
1614" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001615" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001616" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001617"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001618" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001619"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001620" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001621"\n" \
1622"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001623"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001624" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001625" #\n" \
1626" ::sysinit:/etc/init.d/rcS\n" \
1627" \n" \
1628" # /bin/sh invocations on selected ttys\n" \
1629" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001630" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001631" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001632" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001633" tty2::askfirst:-/bin/sh\n" \
1634" tty3::askfirst:-/bin/sh\n" \
1635" tty4::askfirst:-/bin/sh\n" \
1636" \n" \
1637" # /sbin/getty invocations for selected ttys\n" \
1638" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001639" tty4::respawn:/sbin/getty 38400 tty4\n" \
1640" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001641" \n" \
1642" \n" \
1643" # Example of how to put a getty on a serial line (for a terminal)\n" \
1644" #\n" \
1645" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1646" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1647" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001648" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001649" #::respawn:/sbin/getty 57600 ttyS2\n" \
1650" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001651" # Stuff to do when restarting the init process\n" \
1652" ::restart:/sbin/init\n" \
1653" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001654" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001655" ::ctrlaltdel:/sbin/reboot\n" \
1656" ::shutdown:/bin/umount -a -r\n" \
1657" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001658
1659#define insmod_trivial_usage \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001660 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001661#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001662 "Load the specified kernel modules into the kernel" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001663 USE_FEATURE_2_4_MODULES( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001664 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001665 " -f Force module to load into the wrong kernel version\n" \
1666 " -k Make module autoclean-able\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001667 " -v Verbose\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001668 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001669 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001670 USE_FEATURE_INSMOD_LOAD_MAP( \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001671 " -m Output load map to stdout\n" \
1672 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001673 " -o NAME Set internal module name to NAME\n" \
Denis Vlasenkoa5457262007-09-24 20:14:32 +00001674 " -x Do not export externs" \
1675 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00001676
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001677#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001678 "[-cgmops] [sources] dest|directory"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001679#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001680 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001681 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001682 " -c Copy the file, default\n" \
1683 " -d Create directories\n" \
1684 " -g Set group ownership\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001685 " -m Set permissions\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001686 " -o Set ownership\n" \
1687 " -p Preserve date\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001688 " -s Strip symbol tables" \
1689 USE_SELINUX( \
1690 "\n -Z Set security context of copy" \
1691 )
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001692/* would need to make the " | " optional depending on more than one selected */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001693#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001694 "[OPTIONS] {" \
1695 USE_FEATURE_IP_ADDRESS("address | ") \
1696 USE_FEATURE_IP_ROUTE("route | ") \
1697 USE_FEATURE_IP_LINK("link | ") \
1698 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1699 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001700 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001701#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001702 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001703 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001704 USE_FEATURE_IP_ADDRESS("address | ") \
1705 USE_FEATURE_IP_ROUTE("route | ") \
1706 USE_FEATURE_IP_LINK("link | ") \
1707 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1708 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001709 "}\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001710 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001711
1712#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001713 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001714 " [dev STRING] [to PREFIX] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001715#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001716 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001717 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1718 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001719 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001720 " [broadcast ADDR] [anycast ADDR]\n" \
1721 " [label STRING] [scope SCOPE-ID]\n" \
1722 " SCOPE-ID := [host | link | global | NUMBER]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001723
Eric Andersende4f07e2003-12-11 01:18:07 +00001724#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001725 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001726#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001727 "Calculate IP network settings from a IP address" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001728 "\n\nOptions:" \
Denis Vlasenko03630782007-10-18 11:11:12 +00001729 USE_FEATURE_IPCALC_LONG_OPTIONS( \
1730 "\n -b,--broadcast Display calculated broadcast address" \
1731 "\n -n,--network Display calculated network address" \
1732 "\n -m,--netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001733 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko03630782007-10-18 11:11:12 +00001734 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1735 "\n -h,--hostname Display first resolved host name" \
1736 "\n -s,--silent Don't ever display error messages" \
1737 ) \
1738 ) \
1739 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
1740 "\n -b Display calculated broadcast address" \
1741 "\n -n Display calculated network address" \
1742 "\n -m Display default netmask for IP" \
1743 USE_FEATURE_IPCALC_FANCY( \
1744 "\n -p Display the prefix for IP/NETMASK" \
1745 "\n -h Display first resolved host name" \
1746 "\n -s Don't ever display error messages" \
1747 ) \
1748 )
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001749
Rob Landley6eb1e412005-06-20 04:30:36 +00001750#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001751 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001752#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001753 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1754 "segment by a shmkey value. The lower-case options mqs are used\n" \
1755 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001756 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001757 " -[mM] Remove the memory segment after the last detach\n" \
1758 " -[qQ] Remove the message queue\n" \
1759 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001760
1761#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001762 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001763#define ipcs_full_usage \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001764 " -i Show a specific resource\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001765 "Resource specification:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001766 " -m Shared memory segments\n" \
1767 " -q Message queues\n" \
1768 " -s Semaphore arrays\n" \
1769 " -a All (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001770 "Output format:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001771 " -t Time\n" \
1772 " -c Creator\n" \
1773 " -p Pid\n" \
1774 " -l Limits\n" \
1775 " -u Summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001776
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001777#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001778 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001779#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001780 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001781 " dynamic { on | off } |\n" \
1782 " mtu MTU }\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001783 "iplink show [DEVICE]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001784
1785#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001786 "{ list | flush | { add | del | change | append |\n" \
1787 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001788#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001789 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001790 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1791 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001792 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001793 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
1794 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001795
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001796#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001797 "{[list | add | del] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001798#define iprule_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001799 "iprule [list | add | del] SELECTOR ACTION\n" \
1800 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1801 " [dev STRING] [pref NUMBER]\n" \
1802 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1803 " [prohibit | reject | unreachable]\n" \
1804 " [realms [SRCREALM/]DSTREALM]\n" \
1805 " TABLE_ID := [local | main | default | NUMBER]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001806
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001807#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001808 "{ add | change | del | show } [NAME]\n" \
1809 " [mode { ipip | gre | sit }]\n" \
1810 " [remote ADDR] [local ADDR] [ttl TTL]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001811#define iptunnel_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001812 "iptunnel { add | change | del | show } [NAME]\n" \
1813 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1814 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
1815 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001816
Denis Vlasenkoaa7a8882007-10-20 00:17:34 +00001817#define kbd_mode_trivial_usage \
1818 "[-a|k|s|u]"
1819#define kbd_mode_full_usage \
1820 "Report or set the keyboard mode" \
1821 "\n\nOptions set mode:\n" \
1822 " -a Default (ASCII)\n" \
1823 " -k Medium-raw (keyboard)\n" \
1824 " -s Raw (scancode)\n" \
1825 " -u Unicode (utf-8)"
1826
Eric Andersen7e9276b2001-02-22 01:15:47 +00001827#define kill_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001828 "[-l] [-signal] process-id [process-id ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001829#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001830 "Send a signal (default is TERM) to the specified process(es)" \
1831 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001832 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001833#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001834 "$ ps | grep apache\n" \
1835 "252 root root S [apache]\n" \
1836 "263 www-data www-data S [apache]\n" \
1837 "264 www-data www-data S [apache]\n" \
1838 "265 www-data www-data S [apache]\n" \
1839 "266 www-data www-data S [apache]\n" \
1840 "267 www-data www-data S [apache]\n" \
1841 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001842
1843#define killall_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001844 "[-l] [-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001845#define killall_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001846 "Send a signal (default is TERM) to the specified process(es)" \
1847 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001848 " -l List all signal names and numbers\n" \
1849 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001850#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001851 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001852
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001853#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001854 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001855#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001856 "Send a signal (default is TERM) to all processes outside current session" \
1857 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001858 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001859
Mark Whitley6317c4b2001-03-12 22:51:50 +00001860#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001861 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001862#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001863 "Kernel logger" \
1864 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001865 " -c n Sets the default log level of console messages to n\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001866 " -n Run in foreground"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001867
Eric Andersen7e9276b2001-02-22 01:15:47 +00001868#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001869 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001870#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001871 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001872#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001873 "$ length Hello\n" \
1874 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001875
Rob Landley9200e792005-09-15 19:26:59 +00001876#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001877 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001878#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001879 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001880 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001881 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001882 " -E Quit once the end of a file is reached\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001883 " -M,-m Display a status line containing the current line numbers\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001884 " and the percentage through the file\n" \
1885 " -N Prefix line numbers to each line\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001886 " -~ Suppress ~s displayed when input past the end of the file is\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001887 " reached"
Rob Landley9200e792005-09-15 19:26:59 +00001888
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001889#define setarch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001890 "personality program [args ...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001891#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001892 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001893 " linux32 Set 32bit uname emulation\n" \
1894 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001895
Eric Andersen7e9276b2001-02-22 01:15:47 +00001896#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001897 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001898#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001899 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1900 "You may use '--' to indicate that all following arguments are non-options." \
1901 "\n\nOptions:\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00001902 " -s Make symlinks instead of hardlinks\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001903 " -f Remove existing destination files\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00001904 " -n Don't dereference symlinks - treat like normal file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001905 " -b Make a backup of the target (if exists) before link operation\n" \
1906 " -S suf Use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001907#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001908 "$ ln -s BusyBox /tmp/ls\n" \
1909 "$ ls -l /tmp/ls\n" \
1910 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001911
Denis Vlasenkob042bd92007-09-26 18:01:32 +00001912#define load_policy_trivial_usage
1913
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00001914#define load_policy_full_usage
1915
Eric Andersen7e9276b2001-02-22 01:15:47 +00001916#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001917 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001918#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001919 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001920#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001921 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001922
1923#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001924 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001925#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001926 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001927#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001928 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001929
1930#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001931 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001932#define logger_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001933 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001934 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001935 " -s Log to stderr as well as the system log\n" \
1936 " -t TAG Log using the specified tag (defaults to user name)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001937 " -p PRIO Enter the message with the specified priority.\n" \
1938 " This may be numerical or a 'facility.level' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001939#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001940 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001941
Robert Griebl1fca5582002-06-04 20:45:46 +00001942#define login_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001943 "[OPTION]... [username] [ENV=VAR ...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00001944#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001945 "Begin a new session on the system" \
1946 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001947 " -f Do not authenticate (user already authenticated)\n" \
1948 " -h Name of the remote host for this login\n" \
1949 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001950
Eric Andersen7e9276b2001-02-22 01:15:47 +00001951#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001952 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001953#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001954 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001955#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001956 "$ logname\n" \
1957 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001958
Mark Whitley6317c4b2001-03-12 22:51:50 +00001959#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001960 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001961#define logread_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001962 "Show the messages from syslogd (using circular buffer)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001963 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001964 " -f Output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001965
Matt Kraai83788da2002-03-20 17:38:37 +00001966#define losetup_trivial_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00001967 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
1968 " losetup -d LOOPDEV - disassociate\n" \
1969 " losetup [-f] - show"
Matt Kraai83788da2002-03-20 17:38:37 +00001970#define losetup_full_usage \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00001971 "Options:\n" \
1972 " -o OFS Start OFS bytes into FILE\n" \
1973 " -f Show first free loop device"
Rob Landley1d589b22005-11-29 23:47:10 +00001974#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001975 "No arguments will display all current associations.\n" \
1976 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001977 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001978 "and filename of the file the loop device is currently bound to.\n\n" \
1979 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenko7ae209c2007-09-26 17:54:18 +00001980 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
1981 "losetup -f will show the first loop free loop device\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001982
Eric Andersen7e9276b2001-02-22 01:15:47 +00001983#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001984 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00001985 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001986 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
1987 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
1988 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
1989 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
1990 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
1991 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001992#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001993 "List directory contents" \
1994 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001995 "\n -1 List files in a single column" \
1996 "\n -A Do not list implied . and .." \
1997 "\n -a Do not hide entries starting with ." \
1998 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001999 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002000 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002001 USE_FEATURE_LS_COLOR( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002002 "\n --color[={always,never,auto}] Control coloring") \
2003 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002004 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002005 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002006 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002007 "\n -F Append indicator (one of */=@|) to entries") \
2008 "\n -i List the i-node for each file" \
2009 "\n -l Use a long listing format" \
2010 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002011 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002012 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002013 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002014 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002015 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002016 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002017 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002018 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002019 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002020 "\n -S Sort the listing by file size") \
2021 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002022 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002023 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002024 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002025 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002026 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002027 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002028 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002029 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002030 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002031 "\n -w NUM Assume the terminal is NUM columns wide") \
2032 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002033 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002034 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00002035 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002036 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002037 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002038 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002039 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002040 "\n -K Print security context in long format") \
2041 USE_SELINUX( \
2042 "\n -Z Print security context and permission")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002043
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002044#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002045 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002046#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002047 "List file attributes on an ext2 fs" \
2048 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002049 " -R Recursively list subdirectories\n" \
2050 " -a Do not hide entries starting with .\n" \
2051 " -d List directory entries instead of contents\n" \
2052 " -l Print long flag names\n" \
2053 " -v List the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00002054
Eric Andersen7e9276b2001-02-22 01:15:47 +00002055#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002056 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002057#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002058 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002059
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002060#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00002061#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002062 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002063#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002064 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002065 "TYPEs include:\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00002066 " b: Make a block (buffered) device\n" \
2067 " c or u: Make a character (un-buffered) device\n" \
2068 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
2069 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002070 "FIRST specifies the number appended to NAME to create the first device.\n" \
2071 "LAST specifies the number of the last item that should be created\n" \
2072 "If 's' is the last argument, the base device is created as well.\n\n" \
2073 "For example:\n" \
2074 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2075 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002076#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002077 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2078 "[creates ttyS2-ttyS63]\n" \
2079 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2080 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002081#endif
2082
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002083#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00002084#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002085 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00002086#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002087 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002088 "Device table entries take the form of:\n" \
2089 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002090 "Where name is the file name, type can be one of:\n" \
2091 " f A regular file\n" \
2092 " d Directory\n" \
2093 " c Character special device file\n" \
2094 " b Block special device file\n" \
2095 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002096 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002097 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2098 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002099#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002100 "For example:\n" \
2101 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2102 "/dev d 755 0 0 - - - - -\n" \
2103 "/dev/console c 666 0 0 5 1 - - -\n" \
2104 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2105 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2106 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2107 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2108 "Will Produce:\n" \
2109 "/dev\n" \
2110 "/dev/console\n" \
2111 "/dev/null\n" \
2112 "/dev/zero\n" \
2113 "/dev/hda\n" \
2114 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002115#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002116
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002117#define matchpathcon_trivial_usage \
2118 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2119#define matchpathcon_full_usage \
2120 " -n Do not display path" \
2121 "\n -N Do not use translations" \
2122 "\n -f Use alternate file_context file" \
2123 "\n -p Use prefix to speed translations" \
2124 "\n -V Verify file context on disk matches defaults"
2125
Eric Andersen7e9276b2001-02-22 01:15:47 +00002126#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002127 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002128 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002129#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002130 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2131 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002132 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002133 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002134 " -c Check MD5 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002135 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002136 " -s Don't output anything, status code shows success\n" \
2137 " -w Warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002138#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002139 "$ md5sum < busybox\n" \
2140 "6fd11e98b98a58f64ff3398d7b324003\n" \
2141 "$ md5sum busybox\n" \
2142 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2143 "$ md5sum -c -\n" \
2144 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2145 "busybox: OK\n" \
2146 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002147
Rob Landley70f7ef72005-12-13 08:21:33 +00002148#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002149 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002150#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002151 " -s Scan /sys and populate /dev during system boot\n\n" \
2152 "Called with no options (via hotplug) it uses environment variables\n" \
2153 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00002154#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002155 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002156 "The mdev config file contains lines that look like:\n" \
2157 " hd[a-z][0-9]* 0:3 660\n\n" \
2158 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002159 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002160 "Optionally, that can be followed (on the same line) by a special character\n" \
2161 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002162 "device(s). The environment variable $MDEV indicates the active device node\n" \
2163 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002164 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2165 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002166 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002167 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002168 ) \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002169 "Config file parsing stops on the first matching line. If no config\n"\
2170 "entry is matched, devices are created with default 0:0 660. (Make\n"\
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002171 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002172 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002173
Glenn L McGrath061c9002002-09-16 04:21:46 +00002174#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002175 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002176#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002177 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002178 " y Allow write access to your terminal\n" \
2179 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002180
Denis Vlasenkoefd3f382007-09-21 13:43:28 +00002181#define microcom_trivial_usage \
2182 "[-s speed] tty-name"
2183#define microcom_full_usage \
2184 ""
2185
Eric Andersen7e9276b2001-02-22 01:15:47 +00002186#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002187 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002188#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002189 "Create the DIRECTORY(ies) if they do not already exist" \
2190 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002191 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002192 " -p No error if existing, make parent directories as needed" \
2193 USE_SELINUX( \
2194 "\n -Z Set security context" \
2195 )
2196
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002197#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002198 "$ mkdir /tmp/foo\n" \
2199 "$ mkdir /tmp/foo\n" \
2200 "/tmp/foo: File exists\n" \
2201 "$ mkdir /tmp/foo/bar/baz\n" \
2202 "/tmp/foo/bar/baz: No such file or directory\n" \
2203 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002204
Mike Frysinger6447ac02005-06-11 05:29:40 +00002205#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002206 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2207 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2208 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2209 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2210 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2211 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002212#define mke2fs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002213 " -b size Block size in bytes\n" \
2214 " -c Check for bad blocks before creating\n" \
2215 " -E opts Set extended options\n" \
2216 " -f size Fragment size in bytes\n" \
2217 " -F Force (ignore sanity checks)\n" \
2218 " -g num Number of blocks in a block group\n" \
2219 " -i ratio The bytes/inode ratio\n" \
2220 " -j Create a journal (ext3)\n" \
2221 " -J opts Set journal options (size/device)\n" \
2222 " -l file Read bad blocks list from file\n" \
2223 " -L lbl Set the volume label\n" \
2224 " -m percent Percent of fs blocks to reserve for admin\n" \
2225 " -M dir Set last mounted directory\n" \
2226 " -n Do not actually create anything\n" \
2227 " -N num Number of inodes to create\n" \
2228 " -o os Set the 'creator os' field\n" \
2229 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002230 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002231 " -r rev Set filesystem revision\n" \
2232 " -S Write superblock and group descriptors only\n" \
2233 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002234 " -v Verbose"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002235
Eric Andersen7e9276b2001-02-22 01:15:47 +00002236#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002237 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002238#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002239 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002240 "\n\nOptions:\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002241 " -m Create the pipe using the specified mode (default a=rw)" \
2242 USE_SELINUX( \
2243 "\n -Z Set security context" \
2244 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002245
Eric Andersen7e9276b2001-02-22 01:15:47 +00002246#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002247 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002248#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002249 "Make a MINIX filesystem" \
2250 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002251 " -c Check device for bad blocks\n" \
2252 " -n [14|30] Maximum length of filenames\n" \
2253 " -i INODES Number of inodes for the filesystem\n" \
2254 " -l FILENAME Read bad blocks list from FILENAME\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002255 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002256
Eric Andersen7e9276b2001-02-22 01:15:47 +00002257#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002258 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002259#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002260 "Create a special file (block, character, or pipe)" \
2261 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002262 " -m Create the special file using the specified mode (default a=rw)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002263 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002264 " b: Make a block (buffered) device\n" \
2265 " c or u: Make a character (un-buffered) device\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002266 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes" \
2267 USE_SELINUX( \
2268 "\n -Z Set security context" \
2269 )
2270
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002271#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002272 "$ mknod /dev/fd0 b 2 0\n" \
2273 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002274
Eric Andersen7e9276b2001-02-22 01:15:47 +00002275#define mkswap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002276 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002277#define mkswap_full_usage \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00002278 "Prepare a disk partition to be used as swap partition" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002279 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002280 " -c Check for read-ability\n" \
2281 " -v0 Make version 0 swap [max 128 Megs]\n" \
2282 " -v1 Make version 1 swap [big!] (default for kernels > 2.1.117)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002283 " block-count Number of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002284
Eric Andersen7e9276b2001-02-22 01:15:47 +00002285#define mktemp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002286 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002287#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002288 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002289 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2290 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002291 " -d Make a directory instead of a file\n" \
2292 " -q Fail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002293#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002294 "$ mktemp /tmp/temp.XXXXXX\n" \
2295 "/tmp/temp.mWiLjM\n" \
2296 "$ ls -la /tmp/temp.mWiLjM\n" \
2297 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002298
Eric Andersen8d79ce82001-07-22 23:00:15 +00002299#define modprobe_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002300 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002301#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002302 "Options:\n" \
2303 " -k Make module autoclean-able\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002304 " -n Dry run\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002305 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002306 " -r Remove module (stacks) or do autoclean\n" \
2307 " -s Report via syslog instead of stderr\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002308 " -v Verbose"
Rob Landley9c32a152005-12-11 20:12:24 +00002309#define modprobe_notes_usage \
2310"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2311"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2312"pass each module it loads.\n" \
2313"\n" \
2314"The configuration file is searched (in order) amongst:\n" \
2315"\n" \
2316" /etc/modprobe.conf (2.6 only)\n" \
2317" /etc/modules.conf\n" \
2318" /etc/conf.modules (deprecated)\n" \
2319"\n" \
2320"They all have the same syntax (see below). If none is present, it is\n" \
2321"_not_ an error; each loaded module is then expected to load without\n" \
2322"options. Once a file is found, the others are tested for.\n" \
2323"\n" \
2324"/etc/modules.conf entry format:\n" \
2325"\n" \
2326" alias <alias_name> <mod_name>\n" \
2327" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002328" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002329" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2330" This makes it also possible to use a different set of options (below) for\n" \
2331" the module and the alias.\n" \
2332" A module can be aliased more than once.\n" \
2333"\n" \
2334" options <mod_name|alias_name> <symbol=value ...>\n" \
2335" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2336" the \"symbol=value\" pairs as option to that module.\n" \
2337"\n" \
2338"Sample /etc/modules.conf file:\n" \
2339"\n" \
2340" options tulip irq=3\n" \
2341" alias tulip tulip2\n" \
2342" options tulip2 irq=4 io=0x308\n" \
2343"\n" \
2344"Other functionality offered by 'classic' modprobe is not available in\n" \
2345"this implementation.\n" \
2346"\n" \
2347"If module options are present both in the config file, and on the command line,\n" \
2348"then the options from the command line will be passed to the module _after_\n" \
2349"the options from the config file. That way, you can have defaults in the config\n" \
2350"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002351#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002352 "(with the above /etc/modules.conf):\n\n" \
2353 "$ modprobe tulip\n" \
2354 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2355 "$ modprobe tulip irq=5\n" \
2356 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2357 "$ modprobe tulip2\n" \
2358 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2359 " which are the default for alias 'tulip2'\n\n" \
2360 "$ modprobe tulip2 irq=8\n" \
2361 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2362 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2363 " from the command line\n\n" \
2364 "$ modprobe tulip2 irq=2 io=0x210\n" \
2365 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2366 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2367 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002368
Eric Andersen7e9276b2001-02-22 01:15:47 +00002369#define more_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002370 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002371#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002372 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002373#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002374 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002375
Eric Andersen7e9276b2001-02-22 01:15:47 +00002376#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002377 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002378#define mount_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002379 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2380 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002381 " -a Mount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002382 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002383 " -f Update /etc/mtab, but don't mount\n" \
2384 " -n Don't update /etc/mtab\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002385 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002386 " -r Read-only mount\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00002387 " -t fs-type Filesystem type\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002388 " -w Read-write mount (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002389 "\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002390 "-o option:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002391 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002392 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002393 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002394 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002395 " [a]sync Writes are asynchronous / synchronous\n" \
2396 " [no]atime Disable / enable updates to inode access times\n" \
2397 " [no]diratime Disable / enable atime updates to directories\n" \
2398 " [no]dev Allow use of special device files / disallow them\n" \
2399 " [no]exec Allow use of executable files / disallow them\n" \
2400 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2401 " [r]shared Convert [recursively] to a shared subtree\n" \
2402 " [r]slave Convert [recursively] to a slave subtree\n" \
2403 " [r]private Convert [recursively] to a private subtree\n" \
2404 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2405 " bind Bind a directory to an additional location\n" \
2406 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002407 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002408 " remount Remount a mounted filesystem, changing its flags\n" \
2409 " ro/rw Mount for read-only / read-write\n" \
2410 "\n" \
2411 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002412 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002413#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002414 "$ mount\n" \
2415 "/dev/hda3 on / type minix (rw)\n" \
2416 "proc on /proc type proc (rw)\n" \
2417 "devpts on /dev/pts type devpts (rw)\n" \
2418 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2419 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2420 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002421#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002422 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002423
Rob Landleyd00b3a52005-08-20 05:07:08 +00002424#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002425 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002426#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002427 "mountpoint checks if the directory is a mountpoint" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002428 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002429 " -q Quiet\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002430 " -d Print major/minor device number of the filesystem\n" \
2431 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002432#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002433 "$ mountpoint /proc\n" \
2434 "/proc is not a mountpoint\n" \
2435 "$ mountpoint /sys\n" \
2436 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002437
Eric Andersen7e9276b2001-02-22 01:15:47 +00002438#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002439 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002440#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002441 "Control magnetic tape drive operation\n" \
2442 "\nAvailable Opcodes:\n\n" \
2443 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2444 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2445 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2446 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002447
Eric Andersen7e9276b2001-02-22 01:15:47 +00002448#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002449 "[OPTION]... SOURCE DEST\n" \
2450 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002451#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002452 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2453 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002454 " -f Don't prompt before overwriting\n" \
2455 " -i Interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002456#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002457 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002458
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002459#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002460 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002461#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002462 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002463 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002464 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2465 " -s Use syslog (LOCAL0 facility)\n" \
2466 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002467#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002468 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2469 " or\n" \
2470 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002471
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002472#if !ENABLE_DESKTOP
2473
Rob Landley1cca9482006-07-10 19:45:20 +00002474#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002475#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002476#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002477#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002478#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002479
Eric Andersen7e9276b2001-02-22 01:15:47 +00002480#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002481 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002482 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002483#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002484 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002485 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002486 USE_NC_EXTRA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002487 "\n -e Exec rest of command line after connect" \
2488 "\n -i SECS Delay interval for lines sent" \
2489 "\n -w SECS Timeout for connect" \
Denis Vlasenko5d687242007-01-12 20:59:31 +00002490 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002491 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002492 USE_NC_SERVER( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002493 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002494 USE_NC_EXTRA( \
2495 "\n (use -l twice with -e for persistent server)") \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002496 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002497 )
2498
Rob Landley1cca9482006-07-10 19:45:20 +00002499#define nc_notes_usage "" \
2500 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002501 "To use netcat as a terminal emulator on a serial port:\n\n" \
2502 "$ stty 115200 -F /dev/ttyS0\n" \
2503 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2504 )
Rob Landley1cca9482006-07-10 19:45:20 +00002505
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002506#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002507 "$ nc foobar.somedomain.com 25\n" \
2508 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2509 "help\n" \
2510 "214-Commands supported:\n" \
2511 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2512 "214 NOOP QUIT RSET HELP\n" \
2513 "quit\n" \
2514 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002515
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002516#else /* DESKTOP nc - much more compatible with nc 1.10 */
2517
2518#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002519 "[-options] hostname port - connect" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002520 USE_NC_SERVER("\nnc [-options] -l -p port [hostname] [port] - listen")
2521#define nc_full_usage \
2522 USE_NC_SERVER( \
2523 "-l Listen mode, for inbound connects\n" \
2524 ) \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002525 "-n Don't do DNS resolution" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002526 "\n-s addr Local address" \
2527 "\n-p port Local port" \
2528 "\n-u UDP mode" \
2529 "\n-v Verbose (cumulative: -vv)" \
2530 "\n-w secs Timeout for connects and final net reads" \
2531 USE_NC_EXTRA( \
2532 "\n-i sec Delay interval for lines sent" /* ", ports scanned" */ \
2533 "\n-o file Hex dump of traffic" \
2534 "\n-z Zero-I/O mode (scanning)" \
2535 ) \
2536 "\n-e prog [args] Program to exec after connect (must be last)" \
2537/* "\n-r Randomize local and remote ports" */
2538/* "\n-g gateway Source-routing hop point[s], up to 8" */
2539/* "\n-G num Source-routing pointer: 4, 8, 12, ..." */
2540/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2541
2542#endif
2543
Eric Andersen1552ff72001-10-31 11:07:12 +00002544#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002545 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002546#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002547 "Display networking information" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002548 "\n\nOptions:" \
2549 "\n -l Display listening server sockets" \
2550 "\n -a Display all sockets (default: connected)" \
2551 "\n -e Display other/more information" \
2552 "\n -n Don't resolve names" \
2553 "\n -t Tcp sockets" \
2554 "\n -u Udp sockets" \
2555 "\n -w Raw sockets" \
2556 "\n -x Unix sockets" \
2557 "\n -r Display routing table" \
2558 USE_FEATURE_NETSTAT_WIDE( \
2559 "\n -W Display with no column truncation" \
2560 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002561
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002562#define nice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002563 "[-n ADJUST] [COMMAND [ARG] ...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002564#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002565 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002566 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002567 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002568
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002569#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002570 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002571#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002572 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002573 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002574 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002575 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002576 "%[niface] Monitor network interface 'iface'\n" \
2577 "%m Monitor allocated memory\n" \
2578 "%[mf] Monitor free memory\n" \
2579 "%[mt] Monitor total memory\n" \
2580 "%s Monitor allocated swap\n" \
2581 "%f Monitor number of used file descriptors\n" \
2582 "%Ni Monitor total/specific IRQ rate\n" \
2583 "%x Monitor context switch rate\n" \
2584 "%p Monitor forks\n" \
2585 "%[pn] Monitor # of processes\n" \
2586 "%b Monitor block io\n" \
2587 "%Nt Show time (with N decimal points)\n" \
2588 "%Nd Milliseconds between updates (default=1000)\n" \
2589 "%r Print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002590#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002591 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002592
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002593#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002594 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002595#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002596 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002597#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002598 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002599
Eric Andersen7e9276b2001-02-22 01:15:47 +00002600#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002601 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002602#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002603 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002604 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002605#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002606 "$ nslookup localhost\n" \
2607 "Server: default\n" \
2608 "Address: default\n" \
2609 "\n" \
2610 "Name: debian\n" \
2611 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002612
Glenn L McGrath60281112001-11-02 11:39:46 +00002613#define od_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002614 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002615#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002616 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002617 "to standard output. With no FILE, or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002618
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002619#define openvt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002620 "VTNUM COMMAND [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002621#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002622 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002623#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002624 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002625
Eric Andersen27f64e12002-06-23 04:24:25 +00002626#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002627 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002628#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002629 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002630 "changes the password for the current user." \
2631 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002632 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002633 " (choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002634 " -d Delete the password for the specified user account\n" \
2635 " -l Locks (disables) the specified user account\n" \
2636 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002637
Denis Vlasenko21d10142007-07-20 21:28:41 +00002638#define chpasswd_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002639 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
Denis Vlasenko21d10142007-07-20 21:28:41 +00002640#define chpasswd_full_usage \
2641 "Read user:password information from stdin\n" \
2642 "and update /etc/passwd accordingly." \
2643 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00002644 USE_GETOPT_LONG( \
2645 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2646 "\n -m,--md5 Use MD5 encryption instead of DES" \
2647 ) \
2648 SKIP_GETOPT_LONG( \
2649 "\n -e Supplied passwords are in encrypted form" \
2650 "\n -m Use MD5 encryption instead of DES" \
2651 )
Denis Vlasenko21d10142007-07-20 21:28:41 +00002652
Glenn L McGrath655d8142003-06-22 15:32:41 +00002653#define patch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002654 "[-p num] [-i diff]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002655#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002656 " -p NUM Strip NUM leading components from file names\n" \
2657 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002658#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002659 "$ patch -p1 < example.diff\n" \
2660 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002661
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002662#define pgrep_trivial_usage \
2663 "[-flnovx] pattern"
2664#define pgrep_full_usage \
2665 "Display process(es) selected by regex pattern" \
2666 "\n\nOptions:\n" \
2667 " -l Show command name too\n" \
2668 " -f Match against entire command line\n" \
2669 " -n Signal the newest process only\n" \
2670 " -o Signal the oldest process only\n" \
2671 " -v Negate the matching\n" \
2672 " -x Match whole name (not substring)"
2673
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002674#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2675#define USAGE_PIDOF "Options:"
2676#else
Denis Vlasenko765996a2006-12-24 16:59:27 +00002677#define USAGE_PIDOF "\nThis version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002678#endif
2679
Eric Andersen221b2ea2001-07-31 19:06:07 +00002680#define pidof_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002681 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002682
Eric Andersen221b2ea2001-07-31 19:06:07 +00002683#define pidof_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002684 "List the PIDs of all processes with names that match the\n" \
2685 "names on the command line\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002686 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002687 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002688 "\n -s Display only a single PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002689 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenko198bada2007-06-23 14:56:43 +00002690 "\n -o PID Omit given pid") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002691 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002692 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002693#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002694 "$ pidof init\n" \
2695 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002696 USE_FEATURE_PIDOF_OMIT( \
2697 "$ pidof /bin/sh\n20351 5973 5950\n") \
2698 USE_FEATURE_PIDOF_OMIT( \
2699 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002700
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002701#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002702#define ping_trivial_usage \
2703 "host"
2704#define ping_full_usage \
2705 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002706#define ping6_trivial_usage \
2707 "host"
2708#define ping6_full_usage \
2709 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002710#else
2711#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002712 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002713#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002714 "Send ICMP ECHO_REQUEST packets to network hosts" \
2715 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002716 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2717 " -c CNT Send only CNT pings\n" \
2718 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2719 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002720 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002721 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002722#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002723 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002724#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002725 "Send ICMP ECHO_REQUEST packets to network hosts" \
2726 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002727 " -c CNT Send only CNT pings\n" \
2728 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2729 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002730 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002731 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002732#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002733#define ping_example_usage \
2734 "$ ping localhost\n" \
2735 "PING slag (127.0.0.1): 56 data bytes\n" \
2736 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2737 "\n" \
2738 "--- debian ping statistics ---\n" \
2739 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2740 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002741#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002742 "$ ping6 ip6-localhost\n" \
2743 "PING ip6-localhost (::1): 56 data bytes\n" \
2744 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2745 "\n" \
2746 "--- ip6-localhost ping statistics ---\n" \
2747 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2748 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002749
Eric Andersen7e9276b2001-02-22 01:15:47 +00002750#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002751 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002752#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002753 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002754 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002755
Denis Vlasenko72e1c892007-09-29 22:26:01 +00002756#define pkill_trivial_usage \
2757 "[-l] | [-fnovx] [-signal] pattern"
2758#define pkill_full_usage \
2759 "Send a signal to process(es) selected by regex pattern" \
2760 "\n\nOptions:\n" \
2761 " -l List all signals\n" \
2762 " -f Match against entire command line\n" \
2763 " -n Signal the newest process only\n" \
2764 " -o Signal the oldest process only\n" \
2765 " -v Negate the matching\n" \
2766 " -x Match whole name (not substring)"
2767
Eric Andersen7e9276b2001-02-22 01:15:47 +00002768#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002769 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002770#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002771 "Halt and shut off power" \
2772 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002773 " -d Delay interval for halting\n" \
2774 " -n No call to sync()\n" \
2775 " -f Force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002776
Mike Frysinger95d3c452005-04-21 23:29:24 +00002777#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002778 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002779#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002780 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002781 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002782
Eric Andersen7e9276b2001-02-22 01:15:47 +00002783#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002784 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002785#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002786 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002787 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002788#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002789 "$ printf \"Val=%d\\n\" 5\n" \
2790 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002791
Denis Vlasenko94949192006-11-05 00:45:47 +00002792
2793#if ENABLE_DESKTOP
2794
2795#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002796 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002797#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002798 "Report process status" \
2799 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002800 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002801
2802#else /* !ENABLE_DESKTOP */
2803
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002804#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002805#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002806#else
2807#define USAGE_PS "\nOptions:"
2808#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002809
Eric Andersen7e9276b2001-02-22 01:15:47 +00002810#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002811 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002812#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002813 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002814 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002815 USE_SELINUX( \
Bernhard Reutner-Fischer26a80162007-03-14 08:52:28 +00002816 "\n -Z Show SE Linux context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002817 USE_FEATURE_PS_WIDE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002818 "\n w Wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002819
Denis Vlasenko94949192006-11-05 00:45:47 +00002820#endif /* ENABLE_DESKTOP */
2821
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002822#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002823 "$ ps\n" \
2824 " PID Uid Gid State Command\n" \
2825 " 1 root root S init\n" \
2826 " 2 root root S [kflushd]\n" \
2827 " 3 root root S [kupdate]\n" \
2828 " 4 root root S [kpiod]\n" \
2829 " 5 root root S [kswapd]\n" \
2830 " 742 andersen andersen S [bash]\n" \
2831 " 743 andersen andersen S -bash\n" \
2832 " 745 root root S [getty]\n" \
2833 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002834
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00002835#define pscan_trivial_usage \
2836 "[-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
2837#define pscan_full_usage \
2838 "Scan a host, print all open ports" \
2839 "\n\nOptions:" \
2840 "\n -p Scan from this port (default 1)" \
2841 "\n -P Scan up to this port (default 1024)" \
2842 "\n -t Timeout (default 5000 ms)" \
2843 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
2844
Eric Andersen7e9276b2001-02-22 01:15:47 +00002845#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002846 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002847#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002848 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002849#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002850 "$ pwd\n" \
2851 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002852
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002853#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002854 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002855#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002856 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002857#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002858 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002859
Eric Andersen7e9276b2001-02-22 01:15:47 +00002860#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002861 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002862#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002863 "Get and possibly set the system date and time from a remote HOST" \
2864 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002865 " -s Set the system date and time (default)\n" \
2866 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002867
Rob Landley0e4690d2006-08-20 22:12:18 +00002868#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002869 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002870#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002871 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2872 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00002873
Eric Andersen7e9276b2001-02-22 01:15:47 +00002874#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002875 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002876#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002877 "Display the value of a symlink" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002878 USE_FEATURE_READLINK_FOLLOW( \
2879 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002880 " -f Canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002881
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002882#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002883 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002884#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002885 "Options:\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002886 " -m mapfile (Default: /boot/System.map)\n" \
2887 " -p profile (Default: /proc/profile)\n" \
2888 " -M mult Set the profiling multiplier to mult\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002889 " -i Print only info about the sampling step\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002890 " -v Verbose\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002891 " -a Print all symbols, even if count is 0\n" \
2892 " -b Print individual histogram-bin counts\n" \
2893 " -s Print individual counters within functions\n" \
2894 " -r Reset all the counters (root only)\n" \
2895 " -n Disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002896
Glenn L McGrath62fae302002-12-10 00:14:33 +00002897#define realpath_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002898 "pathname ..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00002899#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002900 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00002901
Eric Andersen7e9276b2001-02-22 01:15:47 +00002902#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002903 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002904#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002905 "Reboot the system" \
2906 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002907 " -d Delay interval for rebooting\n" \
2908 " -n No call to sync()\n" \
2909 " -f Force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002910
2911#define renice_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002912 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002913#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002914 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002915 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00002916 " -n Adjust current nice value (smaller is faster)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002917 " -p Process id(s) (default)\n" \
2918 " -g Process group id(s)\n" \
2919 " -u Process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002920
Eric Andersen7e9276b2001-02-22 01:15:47 +00002921#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002922 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002923#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002924 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002925
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002926#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002927 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002928#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002929 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002930
Denis Vlasenko397137b2007-07-23 14:03:30 +00002931#define restorecon_trivial_usage \
2932 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
2933#define restorecon_full_usage \
2934 "Reset security contexts of files in pathname\n" \
2935 "\n -i Ignore files that do not exist" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00002936 "\n -f file File with list of files to process. Use - for stdin" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00002937 "\n -e directory Directory to exclude" \
2938 "\n -R,-r Recurse directories" \
2939 "\n -n Don't change any file labels" \
Denis Vlasenkod898b862007-10-14 07:57:26 +00002940 "\n -o file Save list of files with incorrect context" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00002941 "\n -v Verbose" \
2942 "\n -vv Show changed labels" \
2943 "\n -F Force reset of context to match file_context" \
2944 "\n for customizable files, or the user section," \
2945 "\n if it has changed"
2946
Eric Andersen7e9276b2001-02-22 01:15:47 +00002947#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002948 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002949#define rm_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002950 "Remove (unlink) the FILE(s). You may use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002951 "indicate that all following arguments are non-options." \
2952 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002953 " -i Always prompt before removing each destination\n" \
2954 " -f Remove existing destinations, never prompt\n" \
2955 " -r,-R Remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002956#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002957 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002958
Eric Andersen7e9276b2001-02-22 01:15:47 +00002959#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002960 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002961#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002962 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002963#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002964 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002965
Eric Andersen7e9276b2001-02-22 01:15:47 +00002966#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002967 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002968#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002969 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002970 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002971 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002972#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002973 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002974
Eric Andersen7e9276b2001-02-22 01:15:47 +00002975#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002976 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002977#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002978 "Edit the kernel's routing tables" \
2979 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002980 " -n Dont resolve names\n" \
2981 " -e Display other/more information\n" \
2982 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002983
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002984#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002985 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002986#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002987 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002988 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002989 "\n -i Install package" \
2990 "\n -q Query package" \
2991 "\n -p Query uninstalled package" \
2992 "\n -i Show information" \
2993 "\n -l List contents" \
2994 "\n -d List documents" \
2995 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002996
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002997#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002998 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002999#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003000 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00003001
Denis Vlasenko49622d72007-03-10 16:58:49 +00003002#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003003 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3004 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko49622d72007-03-10 16:58:49 +00003005#define runcon_full_usage \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003006 "Run a program in a different security context\n\n" \
3007 " CONTEXT Complete security context\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003008 USE_GETOPT_LONG( \
3009 " -c,--compute Compute process transition context before modifying\n" \
3010 " -t,--type=TYPE Type (for same role as parent)\n" \
3011 " -u,--user=USER User identity\n" \
3012 " -r,--role=ROLE Role\n" \
3013 " -l,--range=RNG Levelrange" \
3014 ) \
3015 SKIP_GETOPT_LONG( \
3016 " -c Compute process transition context before modifying\n" \
3017 " -t TYPE Type (for same role as parent)\n" \
3018 " -u USER User identity\n" \
3019 " -r ROLE Role\n" \
3020 " -l RNG Levelrange" \
3021 )
Denis Vlasenko49622d72007-03-10 16:58:49 +00003022
Eric Andersen6cf47a72001-10-31 10:24:36 +00003023#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003024 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003025#define run_parts_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003026 "Run a bunch of scripts in a directory" \
3027 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003028 " -t Prints what would be run, but does not actually run anything\n" \
3029 " -a ARG Pass ARG as an argument for every program invoked\n" \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00003030 " -u MASK Set the umask to MASK before executing every program" \
3031USE_FEATURE_RUN_PARTS_FANCY("\n -l Prints names of all matching files even when they are not executable")
3032
3033#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003034 "$ run-parts -a start /etc/init.d\n" \
3035 "$ run-parts -a stop=now /etc/init.d\n\n" \
3036 "Let's assume you have a script foo/dosomething:\n" \
3037 "#!/bin/sh\n" \
3038 "for i in $*; do eval $i; done; unset i\n" \
3039 "case \"$1\" in\n" \
3040 "start*) echo starting something;;\n" \
3041 "stop*) set -x; shutdown -h $stop;;\n" \
3042 "esac\n\n" \
3043 "Running this yields:\n" \
3044 "$run-parts -a stop=+4m foo/\n" \
3045 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00003046
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003047#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003048 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003049#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003050 "Find the current and previous system runlevel.\n\n" \
3051 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003052 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003053#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003054 "$ runlevel /var/run/utmp\n" \
3055 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00003056
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003057#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003058 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003059#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003060 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003061
3062#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003063 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003064#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003065 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003066
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003067#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003068 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003069#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003070 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003071#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003072 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00003073
Eric Andersen7e9276b2001-02-22 01:15:47 +00003074#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003075 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003076#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003077 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003078 " -e script Add the script to the commands to be executed\n" \
3079 " -f scriptfile Add script-file contents to the\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003080 " commands to be executed\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003081 " -i Edit files in-place\n" \
3082 " -n Suppress automatic printing of pattern space\n" \
3083 " -r Use extended regular expression syntax\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003084 "\n" \
3085 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
3086 "script to interpret. All remaining arguments are names of input files; if no\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003087 "input files are specified, then the standard input is read. Source files\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003088 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00003089
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003090#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003091 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3092 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003093
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003094#define selinuxenabled_trivial_usage
3095#define selinuxenabled_full_usage
3096
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003097#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003098 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003099#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003100 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003101 "FIRST, INCREMENT default to 1" \
3102 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003103 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003104 " FIRST LAST\n" \
3105 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00003106
Paul Foxfc2256a2005-08-01 18:12:30 +00003107#define setconsole_trivial_usage \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003108 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00003109#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003110 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003111 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003112 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00003113
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003114#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003115 "[Enforcing | Permissive | 1 | 0]"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003116#define setenforce_full_usage
3117
Denis Vlasenko397137b2007-07-23 14:03:30 +00003118#define setfiles_trivial_usage \
Denis Vlasenkod898b862007-10-14 07:57:26 +00003119 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003120 USE_FEATURE_SETFILES_CHECK_OPTION( \
3121 " [-c policyfile] spec_file" \
3122 ) \
3123 " pathname"
3124
3125#define setfiles_full_usage \
3126 "Reset file contexts under pathname according to spec_file" \
3127 USE_FEATURE_SETFILES_CHECK_OPTION( \
3128 "\n -c file Check the validity of the contexts against the specified binary policy" \
3129 ) \
3130 "\n -d Show which specification matched each file" \
3131 "\n -l Log changes in file labels to syslog" \
3132 "\n -n Don't change any file labels" \
Denis Vlasenko1da77722007-07-24 06:17:43 +00003133 "\n -q Suppress warnings" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00003134 "\n -r dir Use an altenate root path" \
3135 "\n -e dir Exclude directory" \
3136 "\n -F Force reset of context to match file_context for customizable files" \
3137 "\n -o file Save list of files with incorrect context" \
3138 "\n -s Take a list of files from standard input (instead of command line)" \
3139 "\n -v Show changes in file labels, if type or role are changing" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003140 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3141 "\n -W Display warnings about entries that had no matching files"
Denis Vlasenko397137b2007-07-23 14:03:30 +00003142
Eric Andersen7e9276b2001-02-22 01:15:47 +00003143#define setkeycodes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003144 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003145#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003146 "Set entries into the kernel's scancode-to-keycode map,\n" \
3147 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3148 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
3149 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003150#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003151 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003152
Rob Landley87848d92006-03-27 23:23:43 +00003153#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003154 "N"
Rob Landley87848d92006-03-27 23:23:43 +00003155#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003156 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003157
Denis Vlasenkobe039372007-10-14 04:48:44 +00003158#define setsebool_trivial_usage \
3159 "boolean value"
3160
3161#define setsebool_full_usage \
3162 "Change boolean setting"
3163
Paul Fox42403642005-08-01 22:52:09 +00003164#define setsid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003165 "program [arg ...]"
Paul Fox42403642005-08-01 22:52:09 +00003166#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003167 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003168 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00003169
Matt Kraai2d91deb2001-08-01 17:21:35 +00003170#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003171 "[FILE]...\n" \
3172 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00003173#define lash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003174 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00003175#define lash_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003176 "This command does not yet have proper documentation.\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003177 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003178 "redirects, job control, can be used as the shell for scripts, and has a\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003179 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
3180 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
3181 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003182 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003183
Eric Andersen2e9c2572003-08-08 22:26:06 +00003184#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003185 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00003186#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003187 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00003188
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003189#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003190 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003191 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003192#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003193 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003194 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003195 "\n\nOptions:\n" \
3196 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003197 " -c Check SHA1 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003198 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003199 " -s Don't output anything, status code shows success\n" \
3200 " -w Warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003201
Denis Vlasenko14923db2007-06-20 15:23:03 +00003202#define slattach_trivial_usage \
3203 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3204#define slattach_full_usage \
3205 "Attach network interface(s) to serial line(s)\n" \
3206 "\nOptions:" \
3207 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3208 "\n -s Set line speed" \
3209 "\n -e Exit after initializing device" \
3210 "\n -h Exit when the carrier is lost" \
3211 "\n -c Execute a command when the line is hung up" \
3212 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3213 "\n -L Enable 3-wire operation" \
3214 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003215
Eric Andersen7e9276b2001-02-22 01:15:47 +00003216#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003217 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003218#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003219 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003220 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003221 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003222 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003223#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003224 "$ sleep 2\n" \
3225 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003226 USE_FEATURE_FANCY_SLEEP( \
3227 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003228 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003229
Eric Andersen7e9276b2001-02-22 01:15:47 +00003230#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003231 "[-nru" \
3232 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") \
3233 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003234#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003235 "Sort lines of text in the specified files" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003236 "\n\nOptions:\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003237 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003238 " -b Ignore leading blanks\n" \
3239 " -c Check whether input is sorted\n" \
3240 " -d Dictionary order (blank or alphanumeric only)\n" \
3241 " -f Ignore case\n" \
3242 " -g General numerical sort\n" \
3243 " -i Ignore unprintable characters\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003244 " -k Sort key\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003245 " -M Sort month\n") \
3246 " -n Sort numbers\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003247 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003248 " -o Output to file\n" \
3249 " -k Sort by key\n" \
3250 " -t Use key separator other than whitespace\n") \
3251 " -r Reverse sort order\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003252 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003253 " -s Stable (don't sort ties alphabetically)\n") \
3254 " -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003255 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003256 "\n -z Input terminated by nulls, not newlines\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003257 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003258 " -mST Ignored for GNU compatibility") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003259 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003260#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003261 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3262 "a\n" \
3263 "b\n" \
3264 "c\n" \
3265 "d\n" \
3266 "e\n" \
3267 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003268 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003269 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3270 "d 2\n" \
3271 "b 2\n" \
3272 "c 3\n" \
3273 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003274 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003275
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003276#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003277 "[OPTION] [INPUT [PREFIX]]"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003278#define split_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003279 "Options:" \
3280 "\n -b n[k|m] Split by bytes" \
3281 "\n -l n Split by lines" \
3282 "\n -a n Use n letters as suffix"
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003283#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003284 "$ split TODO foo\n" \
3285 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003286
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003287#define start_stop_daemon_trivial_usage \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003288 "[OPTIONS] [" \
3289 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3290 "] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003291#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003292 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003293 "\n\nOptions:" \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003294 USE_GETOPT_LONG( \
3295 "\n -S,--start Start" \
3296 "\n -K,--stop Stop" \
3297 "\n -a,--startas pathname Starts process specified by pathname" \
3298 "\n -b,--background Put process into background" \
3299 "\n -u,--user username|uid Stop this user's processes" \
3300 "\n -x,--exec executable Program to either start or check" \
3301 "\n -n,--name process-name Stop processes with this name" \
3302 "\n -p,--pidfile pid-file Save or load pid using a pid-file" \
3303 "\n -m,--make-pidfile Create the -p file and enter pid in it" \
3304 "\n -q,--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003305 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003306 "\n -o,--oknodo Exit status 0 if nothing done" \
3307 "\n -v,--verbose Verbose" \
3308 "\n -N,--nicelevel N Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003309 ) \
Denis Vlasenko73e5ed22007-10-18 10:52:36 +00003310 "\n -s,--signal signal Signal to send (default TERM)" \
3311 "\n -c,--chuid user[:[grp]] Change to specified user/group" \
3312 ) \
3313 SKIP_GETOPT_LONG( \
3314 "\n -S Start" \
3315 "\n -K Stop" \
3316 "\n -a pathname Starts process specified by pathname" \
3317 "\n -b Put process into background" \
3318 "\n -u username|uid Stop this user's processes" \
3319 "\n -x executable Program to either start or check" \
3320 "\n -n process-name Stop processes with this name" \
3321 "\n -p pid-file Save or load pid using a pid-file" \
3322 "\n -m Create the -p file and enter pid in it" \
3323 "\n -q Quiet" \
3324 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3325 "\n -o Exit status 0 if nothing done" \
3326 "\n -v Verbose" \
3327 "\n -N N Add N to process's nice level" \
3328 ) \
3329 "\n -s signal Signal to send (default TERM)" \
3330 "\n -c user[:[grp]] Change to specified user/group" \
3331 )
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003332
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003333#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003334 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003335#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003336 "Display file (default) or filesystem status" \
3337 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003338 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003339 " -c fmt Use the specified format\n") \
3340 " -f Display filesystem status\n" \
3341 " -L,-l Dereference links\n" \
3342 " -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003343 USE_SELINUX( \
3344 "\n -Z Print security context" \
3345 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003346 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003347 "\n\nValid format sequences for files:\n" \
3348 " %a Access rights in octal\n" \
3349 " %A Access rights in human readable form\n" \
3350 " %b Number of blocks allocated (see %B)\n" \
3351 " %B The size in bytes of each block reported by %b\n" \
3352 " %d Device number in decimal\n" \
3353 " %D Device number in hex\n" \
3354 " %f Raw mode in hex\n" \
3355 " %F File type\n" \
3356 " %g Group ID of owner\n" \
3357 " %G Group name of owner\n" \
3358 " %h Number of hard links\n" \
3359 " %i Inode number\n" \
3360 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003361 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003362 " %o I/O block size\n" \
3363 " %s Total size, in bytes\n" \
3364 " %t Major device type in hex\n" \
3365 " %T Minor device type in hex\n" \
3366 " %u User ID of owner\n" \
3367 " %U User name of owner\n" \
3368 " %x Time of last access\n" \
3369 " %X Time of last access as seconds since Epoch\n" \
3370 " %y Time of last modification\n" \
3371 " %Y Time of last modification as seconds since Epoch\n" \
3372 " %z Time of last change\n" \
3373 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003374 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003375 " %a Free blocks available to non-superuser\n" \
3376 " %b Total data blocks in file system\n" \
3377 " %c Total file nodes in file system\n" \
3378 " %d Free file nodes in file system\n" \
3379 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003380 USE_SELINUX( \
3381 " %C Security context in SELinux\n" \
3382 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003383 " %i File System ID in hex\n" \
3384 " %l Maximum length of filenames\n" \
3385 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003386 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003387 " %S Fundamental block size (for block counts)\n" \
3388 " %t Type in hex\n" \
3389 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003390 )
3391
Eric Andersenef5e8f82002-11-07 02:09:37 +00003392#define strings_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003393 "[-afo] [-n length] [file ...]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003394#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003395 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003396 "\n\nOptions:" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003397 "\n -a Scan whole file (default)" \
3398 "\n -f Precede strings with filenames" \
3399 "\n -n N At least N characters form a string (default 4)" \
3400 "\n -o Precede strings with decimal offsets"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003401
Eric Andersen7e9276b2001-02-22 01:15:47 +00003402#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003403 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003404#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003405 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003406 "and deviations from stty sane" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003407 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003408 "\n -F DEVICE Open device instead of stdin" \
3409 "\n -a Print all current settings in human-readable form" \
3410 "\n -g Print in stty-readable form" \
3411 "\n [SETTING] See manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003412
Robert Griebl1fca5582002-06-04 20:45:46 +00003413#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003414 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003415#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003416 "Change user id or become root" \
3417 "\n\nOptions:" \
3418 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003419 "\n -c Command to pass to 'sh -c'" \
3420 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00003421
Eric Andersen27f64e12002-06-23 04:24:25 +00003422#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003423 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003424#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003425 "Single user login" \
3426 "\n\nOptions:" \
3427 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00003428
Mike Frysinger95d3c452005-04-21 23:29:24 +00003429#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003430 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003431#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003432 "Checksum and count the blocks in a file" \
3433 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003434 " -r Use BSD sum algorithm (1K blocks)\n" \
3435 " -s Use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003436
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003437#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003438 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003439#define sv_full_usage \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003440 "Control services monitored by runsv supervisor.\n" \
3441 "Commands (only first character is enough):\n" \
3442 "\n" \
3443 "status: query service status\n" \
3444 "up: if service isn't running, start it. If service stops, restart it\n" \
3445 "once: like 'up', but if service stops, don't restart it\n" \
3446 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3447 " if it exists. After it stops, do not restart service\n" \
3448 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3449 " runsv exits too\n" \
3450 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
3451 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003452
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003453#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003454 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003455#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003456 "Continuously read log data from standard input, optionally " \
3457 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003458 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003459
Eric Andersen7e9276b2001-02-22 01:15:47 +00003460#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003461 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003462#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003463 "Stop swapping virtual memory pages on DEVICE" \
3464 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003465 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003466
Eric Andersen7e9276b2001-02-22 01:15:47 +00003467#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003468 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003469#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003470 "Start swapping virtual memory pages on DEVICE" \
3471 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003472 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003473
Rob Landley0f34a822005-10-27 22:55:50 +00003474#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003475 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003476#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003477 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003478 "and exec NEW_INIT" \
3479 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003480 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00003481
Eric Andersen7e9276b2001-02-22 01:15:47 +00003482#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003483 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003484#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003485 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003486
Eric Andersenb9050282003-12-24 06:02:11 +00003487#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003488 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003489#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003490 "Configure kernel parameters at runtime" \
3491 "\n\nOptions:\n" \
Denis Vlasenkof9566d82007-10-11 10:07:24 +00003492 " -n Disable printing of key names\n" \
3493 " -w Change sysctl setting\n" \
3494 " -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)\n" \
3495 " -a Display all values\n" \
3496 " -A Display all values in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003497#define sysctl_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003498 "sysctl [-n] variable ...\n" \
3499 "sysctl [-n] -w variable=value ...\n" \
3500 "sysctl [-n] -a\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003501 "sysctl [-n] -p file (default /etc/sysctl.conf)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003502 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003503
Eric Andersen7e9276b2001-02-22 01:15:47 +00003504#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003505 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003506#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003507 "System logging utility.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003508 "Note that this version of syslogd ignores /etc/syslog.conf." \
3509 "\n\nOptions:" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003510 "\n -n Run in foreground" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003511 "\n -O FILE Log to given file (default=/var/log/messages)" \
3512 "\n -l n Set local log level" \
3513 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003514 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003515 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3516 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003517 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003518 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003519 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003520 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003521 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)")
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003522 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003523/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003524#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003525 "$ syslogd -R masterlog:514\n" \
3526 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003527
Eric Andersen7e9276b2001-02-22 01:15:47 +00003528#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003529 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003530#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003531 "Print last 10 lines of each FILE to standard output.\n" \
3532 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003533 "file name. With no FILE, or when FILE is -, read standard input." \
3534 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003535 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003536 "\n -c N[kbm] Output the last N bytes") \
3537 "\n -n N[kbm] Print last N lines instead of last 10" \
3538 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003539 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003540 "\n -q Never output headers giving file names" \
3541 "\n -s SEC Wait SEC seconds between reads with -f" \
3542 "\n -v Always output headers giving file names" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003543 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003544 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3545 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3546 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003547#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003548 "$ tail -n 1 /etc/resolv.conf\n" \
3549 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003550
Eric Andersen7e9276b2001-02-22 01:15:47 +00003551#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003552 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003553 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3554 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003555 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003556 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003557#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003558 "Create, extract, or list files from a tar file" \
3559 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003560 USE_FEATURE_TAR_CREATE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003561 " c Create\n") \
3562 " x Extract\n" \
3563 " t List\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003564 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003565 USE_FEATURE_TAR_GZIP( \
3566 " z Filter the archive through gzip\n") \
3567 USE_FEATURE_TAR_BZIP2( \
3568 " j Filter the archive through bzip2\n") \
3569 USE_FEATURE_TAR_LZMA( \
3570 " a Filter the archive through lzma\n") \
3571 USE_FEATURE_TAR_COMPRESS( \
3572 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003573 "\nFile selection:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003574 " f Name of TARFILE or \"-\" for stdin\n" \
3575 " O Extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003576 USE_FEATURE_TAR_FROM( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003577 " exclude File to exclude\n" \
3578 " X File with names to exclude\n") \
3579 " C Change to directory DIR before operation\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003580 " v Verbose"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003581#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003582 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3583 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003584
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003585#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003586 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003587#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003588 "Set or get CPU affinity" \
3589 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003590 " -p Operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003591#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003592 "$ taskset 0x7 ./dgemm_test&\n" \
3593 "$ taskset -p 0x1 $!\n" \
3594 "pid 4790's current affinity mask: 7\n" \
3595 "pid 4790's new affinity mask: 1\n" \
3596 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3597 "pid 6671's current affinity mask: 1\n" \
3598 "pid 6671's new affinity mask: 1\n" \
3599 "$ taskset -p 1\n" \
3600 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003601
Eric Andersen7e9276b2001-02-22 01:15:47 +00003602#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003603 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003604#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003605 "Copy standard input to each FILE, and also to standard output" \
3606 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003607 " -a Append to the given FILEs, do not overwrite\n" \
3608 " -i Ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003609#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003610 "$ echo \"Hello\" | tee /tmp/foo\n" \
3611 "$ cat /tmp/foo\n" \
3612 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003613
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003614#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003615#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003616 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003617#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003618 "Connect to remote telnet server" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003619 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003620 " -a Attempt an automatic login with the USER variable\n" \
3621 " -l USER Attempt an automatic login with the USER argument\n" \
3622 " HOST The official name, alias or the IP address of the\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00003623 " remote host\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003624 " PORT The remote port number to connect to. If it is not\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003625 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003626#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003627#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003628 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003629#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003630 "Connect to remote telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003631#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003632
Eric Andersen08a72202002-09-30 20:52:10 +00003633#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003634 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003635#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003636 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003637 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3638 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003639 "\n -l LOGIN Exec LOGIN on connect" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003640 "\n -f issue_file Display issue_file instead of /etc/issue" \
Denis Vlasenko2450c452007-10-15 22:09:15 +00003641 "\n -K Close connection as soon as login exits" \
3642 "\n (normally wait until all programs close slave pty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003643 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003644 "\n -p PORT Port to listen to" \
3645 "\n -b ADDR Address to bind to" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003646 "\n -F Run in foreground" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003647 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003648 )
Eric Andersen08a72202002-09-30 20:52:10 +00003649
Eric Andersen7e9276b2001-02-22 01:15:47 +00003650#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003651 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003652#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003653 "Check file types and compares values returning an exit code\n" \
3654 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003655#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003656 "$ test 1 -eq 2\n" \
3657 "$ echo $?\n" \
3658 "1\n" \
3659 "$ test 1 -eq 1\n" \
3660 "$ echo $?\n" \
3661 "0\n" \
3662 "$ [ -d /etc ]\n" \
3663 "$ echo $?\n" \
3664 "0\n" \
3665 "$ [ -d /junk ]\n" \
3666 "$ echo $?\n" \
3667 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003668
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003669#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003670 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003671/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003672/* "[-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 +00003673#define tcpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003674 "Creates TCP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003675 "for incoming connections. For each connection it runs prog." \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003676 "\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003677 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003678 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003679 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003680 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3681 "\n-u user[:group] Change to user/group after bind" \
3682 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003683 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003684 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3685 "\n New connections from this IP address are closed" \
3686 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003687 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003688 "\n-E Do not set up environment variables" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003689 "\n-v Verbose"
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003690
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003691#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003692 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003693#define udpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003694 "Creates UDP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003695 "for incoming packets. For each packet it runs prog\n" \
3696 "(redirecting all further packets with same peer ip:port to it)." \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003697 "\n" \
3698 "\nip IP to listen on. '0' = all" \
3699 "\nport Port to listen on" \
3700 "\nprog [arg] Program to run" \
3701 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3702 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003703 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003704 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003705 "\n-E Do not set up environment variables" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003706 "\n-v Verbose"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003707
Mark Whitley450736c2001-03-02 19:08:50 +00003708#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003709 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003710#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003711 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003712 "\n\nOptions:" \
3713 "\n -l FILE Local FILE" \
3714 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003715 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003716 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003717 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003718 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003719 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003720 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003721 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003722 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003723 )
Eric Andersenc3657422001-11-30 07:54:32 +00003724#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003725 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003726#define time_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003727 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003728 "COMMAND's resource usage information is displayed." \
3729 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003730 " -v Verbose"
Mark Whitley450736c2001-03-02 19:08:50 +00003731
Eric Andersen420b2082002-09-17 22:14:58 +00003732#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003733 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003734#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003735 "Provide a view of process activity in real time.\n" \
3736 "Read the status of all processes from /proc each <seconds>\n" \
3737 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003738
Eric Andersen7e9276b2001-02-22 01:15:47 +00003739#define touch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003740 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003741#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003742 "Update the last-modified date on the given FILE[s]" \
3743 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003744 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003745#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003746 "$ ls -l /tmp/foo\n" \
3747 "/bin/ls: /tmp/foo: No such file or directory\n" \
3748 "$ touch /tmp/foo\n" \
3749 "$ ls -l /tmp/foo\n" \
3750 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003751
3752#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003753 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003754#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003755 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003756 "standard input, writing to standard output" \
3757 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003758 " -c Take complement of STRING1\n" \
3759 " -d Delete input characters coded STRING1\n" \
3760 " -s Squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003761#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003762 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3763 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003764
Eric Andersen5c58d282001-07-10 16:29:00 +00003765#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003766 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3767 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3768 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003769#define traceroute_full_usage \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003770 "Trace the route to \"host\"" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003771 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003772 " -F Set the don't fragment bit\n" \
3773 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3774 " -l Display the ttl value of the returned packet\n" \
3775 " -d Set SO_DEBUG options to socket\n" \
3776 " -n Print hop addresses numerically rather than symbolically\n" \
3777 " -r Bypass the normal routing tables and send directly to a host\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003778 " -v Verbose\n" \
3779 " -m max_ttl Max time-to-live (max number of hops)\n" \
3780 " -p port# Base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003781 " (default is 33434)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003782 " -q nqueries Number of probes per 'ttl' (default 3)\n" \
3783 " -s src_addr IP address to use as the source address\n" \
3784 " -t tos Type-of-service in probe packets (default 0)\n" \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003785 " -w wait Time in seconds to wait for a response\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003786 " (default 3 sec)\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003787 " -g Loose source route gateway (8 max)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003788
Eric Andersen7e9276b2001-02-22 01:15:47 +00003789#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003790 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003791#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003792 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003793#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003794 "$ true\n" \
3795 "$ echo $?\n" \
3796 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003797
Eric Andersen7e9276b2001-02-22 01:15:47 +00003798#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003799 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003800#define tty_full_usage \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003801 "Print file name of standard input's terminal" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003802 USE_INCLUDE_SUSv2( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003803 "\n\nOptions:\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003804 " -s Print nothing, only return exit status")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003805#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003806 "$ tty\n" \
3807 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003808
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003809#define ttysize_trivial_usage \
3810 "[w] [h]"
3811#define ttysize_full_usage \
3812 "Print dimension(s) of standard input's terminal, on error return 80x25"
3813
Mike Frysinger174808c2005-06-11 01:14:09 +00003814#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003815 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3816 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3817 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3818 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3819 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3820 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003821#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003822 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00003823
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003824#define udhcpc_trivial_usage \
Denis Vlasenkoc82b5102007-07-01 17:05:57 +00003825 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
3826 " [-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003827#define udhcpc_full_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00003828 USE_GETOPT_LONG( \
Denis Vlasenko72d260d2007-08-17 08:45:58 +00003829 " -V,--vendorclass=CLASSID Set vendor class identifier" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003830 "\n -i,--interface=INTERFACE Interface to use (default: eth0)" \
3831 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
3832 "\n -c,--clientid=CLIENTID Set client identifier" \
3833 "\n -C,--clientid-none Suppress default client identifier" \
3834 "\n -p,--pidfile=file Store process ID of daemon in file" \
3835 "\n -r,--request=IP IP address to request" \
3836 "\n -s,--script=file Run file at dhcp events (default: /usr/share/udhcpc/default.script)" \
3837 "\n -t,--retries=N Send up to N request packets"\
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003838 "\n -f,--foreground Run in foreground" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003839 "\n -b,--background Background if lease cannot be immediately negotiated" \
3840 "\n -S,--syslog Log to syslog too" \
3841 "\n -n,--now Exit with failure if lease cannot be immediately negotiated" \
3842 "\n -q,--quit Quit after obtaining lease" \
3843 "\n -R,--release Release IP on quit" \
3844 "\n -v,--version Display version" \
Denis Vlasenko03630782007-10-18 11:11:12 +00003845 ) \
3846 SKIP_GETOPT_LONG( \
3847 " -V CLASSID Set vendor class identifier" \
3848 "\n -i INTERFACE Interface to use (default: eth0)" \
3849 "\n -H,-h HOSTNAME Client hostname" \
3850 "\n -c CLIENTID Set client identifier" \
3851 "\n -C Suppress default client identifier" \
3852 "\n -p file Store process ID of daemon in file" \
3853 "\n -r IP IP address to request" \
3854 "\n -s file Run file at dhcp events (default: /usr/share/udhcpc/default.script)" \
3855 "\n -t N Send up to N request packets"\
3856 "\n -f Run in foreground" \
3857 "\n -b Background if lease cannot be immediately negotiated" \
3858 "\n -S Log to syslog too" \
3859 "\n -n Exit with failure if lease cannot be immediately negotiated" \
3860 "\n -q Quit after obtaining lease" \
3861 "\n -R Release IP on quit" \
3862 "\n -v Display version" \
3863 )
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003864
Russ Dill61fb4892002-10-14 21:41:28 +00003865#define udhcpd_trivial_usage \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003866 "[-fS] [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00003867
3868#define udhcpd_full_usage \
Denis Vlasenko9f7b92a2007-08-15 20:03:36 +00003869 "DHCP server" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00003870 "\n -f Run in foreground" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003871 "\n -S Log to syslog too"
Russ Dill61fb4892002-10-14 21:41:28 +00003872
Eric Andersen7e9276b2001-02-22 01:15:47 +00003873#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003874 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003875#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003876 "Unmount file systems" \
3877 "\n\nOptions:\n" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00003878 USE_FEATURE_UMOUNT_ALL( \
3879 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab")) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003880 USE_FEATURE_MTAB_SUPPORT( \
3881 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003882 "\n -r Try to remount devices as read-only if mount is busy" \
3883 "\n -l Lazy umount (detach filesystem)" \
3884 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003885 USE_FEATURE_MOUNT_LOOP( \
3886 "\n -D Do not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003887#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003888 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003889
3890#define uname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003891 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003892#define uname_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003893 "Print certain system information. With no OPTION, same as -s." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003894 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003895 " -a Print all information\n" \
3896 " -m The machine (hardware) type\n" \
Denis Vlasenko7930bcf2007-10-07 19:13:55 +00003897 " -n Print machine's hostname\n" \
3898 " -r Print OS release\n" \
3899 " -s Print OS name\n" \
3900 " -p Print host processor type\n" \
3901 " -v Print OS version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003902#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003903 "$ uname -a\n" \
3904 "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 +00003905
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003906#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003907 "[-c] [-f] [name...]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003908#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003909 "Uncompress .Z file[s]" \
3910 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003911 " -c Extract to stdout\n" \
3912 " -f Force overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003913
Denis Vlasenko3952f202007-08-13 14:10:24 +00003914#define unexpand_trivial_usage \
3915 "[-f][-a][-t NUM] [FILE|-]"
3916#define unexpand_full_usage \
3917 "Convert spaces to tabs, writing to standard output." \
3918 "\n\nOptions:" \
Denis Vlasenko99014e82007-10-20 14:54:58 +00003919 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
3920 "\n -a,--all Convert all blanks" \
3921 "\n -f,--first-only Convert only leading blanks" \
3922 "\n -t,--tabs=N Tabstops every N chars" \
3923 ) \
3924 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
3925 "\n -a Convert all blanks" \
3926 "\n -f Convert only leading blanks" \
3927 "\n -t N Tabstops every N chars" \
3928 )
Denis Vlasenko3952f202007-08-13 14:10:24 +00003929
Eric Andersen7e9276b2001-02-22 01:15:47 +00003930#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003931 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003932#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003933 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003934 "(or standard input), writing to OUTPUT (or standard output)" \
3935 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003936 " -c Prefix lines by the number of occurrences\n" \
3937 " -d Only print duplicate lines\n" \
3938 " -u Only print unique lines\n" \
3939 " -f N Skip the first N fields\n" \
3940 " -s N Skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003941#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003942 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3943 "a\n" \
3944 "b\n" \
3945 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003946
3947#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003948 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003949#define unix2dos_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003950 "Convert FILE from unix format to dos format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003951 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003952 "When no file is given, use stdin/stdout." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003953 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003954 " -u Output will be in UNIX format\n" \
3955 " -d Output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003956
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003957#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003958 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003959#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003960 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003961 "\n\nOptions:\n" \
Paul Fox9382b382007-09-07 20:28:25 +00003962 " -l List archive contents (with -q for short form)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003963 " -n Never overwrite existing files (default)\n" \
3964 " -o Overwrite files without prompting\n" \
3965 " -p Send output to stdout\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003966 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003967 " -x Exclude these files\n" \
3968 " -d Extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003969
Eric Andersen7e9276b2001-02-22 01:15:47 +00003970#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003971 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003972#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003973 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003974#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003975 "$ uptime\n" \
3976 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003977
3978#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003979 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003980#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003981 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003982#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003983 "$ usleep 1000000\n" \
3984 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003985
3986#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00003987 "[-o outfile] [infile]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003988#define uudecode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00003989 "Uudecode a file\n" \
3990 "NB: finds outfile name in uuencoded source unless -o is given"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003991#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003992 "$ uudecode -o busybox busybox.uu\n" \
3993 "$ ls -l busybox\n" \
3994 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003995
3996#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00003997 "[-m] [infile] stored_filename"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003998#define uuencode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00003999 "Uuencode a file to stdout" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004000 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004001 " -m Use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004002#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004003 "$ uuencode busybox busybox\n" \
4004 "begin 755 busybox\n" \
4005 "<encoded file snipped>\n" \
4006 "$ uudecode busybox busybox > busybox.uu\n" \
4007 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004008
Eric Andersen853c4942003-01-23 05:59:32 +00004009#define vconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004010 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00004011#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004012 "Create and remove virtual ethernet devices" \
4013 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004014 " add [interface-name] [vlan_id]\n" \
4015 " rem [vlan-name]\n" \
4016 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
4017 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4018 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4019 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00004020
Eric Andersen3f980402001-04-04 17:31:15 +00004021#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004022 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00004023#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004024 "Edit FILE" \
4025 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004026 " -R Read-only - do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00004027
Eric Andersen27f64e12002-06-23 04:24:25 +00004028#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004029 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00004030#define vlock_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004031 "Lock a virtual terminal. A password is required to unlock." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004032 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004033 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00004034
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004035#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00004036 "[-n seconds] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004037#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004038 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004039 "\n\nOptions:\n" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004040 " -n Loop period in seconds (default 2)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004041 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004042#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004043 "$ watch date\n" \
4044 "Mon Dec 17 10:31:40 GMT 2000\n" \
4045 "Mon Dec 17 10:31:42 GMT 2000\n" \
4046 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00004047
Eric Andersen7e9276b2001-02-22 01:15:47 +00004048#define watchdog_trivial_usage \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004049 "[-t N[ms]] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004050#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004051 "Periodically write to watchdog device DEV" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004052 "\n\nOptions:" \
4053 "\n -t N Timer period (default 30)" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004054 "\n -F Run in foreground" \
Denis Vlasenko3638cc42007-09-05 12:13:51 +00004055 "\n" \
4056 "\nUse -t 500ms to specify period in milliseconds"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004057
4058#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004059 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004060#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004061 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00004062 "more than one FILE is specified. With no FILE, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004063 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004064 " -c Print the byte counts\n" \
4065 " -l Print the newline counts\n" \
4066 " -L Print the length of the longest line\n" \
4067 " -w Print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004068#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004069 "$ wc /etc/passwd\n" \
4070 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004071
4072#define wget_trivial_usage \
Denis Vlasenko03630782007-10-18 11:11:12 +00004073 USE_GETOPT_LONG( \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004074 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko03630782007-10-18 11:11:12 +00004075 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4076 " [-U|--user-agent agent] url" \
4077 ) \
4078 SKIP_GETOPT_LONG( \
4079 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4080 )
Eric Andersen7e9276b2001-02-22 01:15:47 +00004081#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004082 "Retrieve files via HTTP or FTP" \
4083 "\n\nOptions:\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00004084 " -s Spider mode - only check file existence\n" \
4085 " -c Continue retrieval of aborted transfer\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00004086 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004087 " -P Set directory prefix to DIR\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00004088 " -O Save to filename ('-' for stdout)\n" \
4089 " -U Adjust 'User-Agent' field\n" \
4090 " -Y Use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004091
4092#define which_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004093 "[COMMAND ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004094#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004095 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004096#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004097 "$ which login\n" \
4098 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00004099
Eric Andersen00a6a752002-04-26 23:53:10 +00004100#define who_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004101 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00004102#define who_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004103 "Print the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004104
4105#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004106 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00004107#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004108 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004109
4110#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004111 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004112#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004113 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004114 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004115 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
4116 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004117 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00004118 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4119 " -x Exit if the size is exceeded\n") \
4120 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
4121 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004122 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00004123#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004124 "$ ls | xargs gzip\n" \
4125 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004126
4127#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004128 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00004129#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004130 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00004131
Eric Andersen7e9276b2001-02-22 01:15:47 +00004132#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004133 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00004134#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00004135 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00004136
Rob Landleyad8071f2005-04-30 03:49:37 +00004137#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00004138 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00004139#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00004140 "Manage a ZeroConf IPv4 link-local address" \
4141 "\n\nOptions:\n" \
Denis Vlasenkocef23e02007-09-05 15:45:51 +00004142 " -f Run in foreground\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00004143 " -q Quit after address (no daemon)\n" \
4144 " -r 169.254.x.x Request this address first\n" \
4145 " -v Verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00004146
Eric Andersen178de172004-04-06 16:36:20 +00004147#endif /* __BB_USAGE_H__ */