blob: d196afcbf6bca0a5600aeb60297f2961adadc37d [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 Vlasenkod63c3a02006-12-25 15:10:32 +000019 " -g GID Specify gid"
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 Vlasenko1fffe382006-11-28 00:06:39 +000026 " -h DIR Assign home directory DIR\n" \
27 " -g GECOS Assign gecos field GECOS\n" \
28 " -s SHELL Assign login shell SHELL\n" \
29 " -G Add the user to existing group GROUP\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000030 " -S Create a system user (ignored)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000031 " -D Do not assign a password (logins still possible via ssh)\n" \
32 " -H Do not create the 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 Vlasenko1fffe382006-11-28 00:06:39 +000043 " (positive values make the system clock run fast)\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" \
73 "\n -i if Specify network interface (e.g. eth0)" \
74 "\n -D Read <hwaddr> from given device" \
75 "\n -A, -p Specify protocol family" \
76 "\n -H hwtype Specify hardware address type"
77
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" \
91 " -i device Outgoing interface name, default is eth0\n" \
92 " -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 Vlasenkod63c3a02006-12-25 15:10:32 +0000105 " -v var=val Assign value 'val' to variable 'var'\n" \
106 " -F sep Use 'sep' as field separator\n" \
107 " -f progname Read program source from file 'progname'"
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
Rob Landley6130b9b2006-01-23 21:10:38 +0000130#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000131 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000132
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000133#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000134 "FILE"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000135#define bzcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000136 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000137
Rob Landleyc1d69902006-01-20 18:28:50 +0000138#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000139 "[OPTION]... [FILE]"
Rob Landleyc1d69902006-01-20 18:28:50 +0000140#define unlzma_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000141 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
142 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000143 " -c Write output to standard output\n" \
144 " -f Force"
Rob Landleyc1d69902006-01-20 18:28:50 +0000145
146#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000147 "FILE"
Rob Landleyc1d69902006-01-20 18:28:50 +0000148#define lzmacat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000149 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000150
Eric Andersenc98c0622001-12-06 15:16:43 +0000151#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000152 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000153#define cal_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000154 "Display a calendar" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000155 "\n\nOptions:" \
156 "\n -j Use julian dates" \
157 "\n -y Display the entire year"
Eric Andersenc98c0622001-12-06 15:16:43 +0000158
Eric Andersen7e9276b2001-02-22 01:15:47 +0000159#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000160 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000161#define cat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000162 "Concatenate FILE(s) and print them to stdout" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000163 "\n\nOptions:" \
164 "\n -u Ignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000165#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000166 "$ cat /proc/uptime\n" \
167 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000168
Rob Landley8abbee42006-05-31 19:36:04 +0000169#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000170 "[-etv] [FILE]..."
Rob Landley8abbee42006-05-31 19:36:04 +0000171#define catv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000172 "Display nonprinting characters as ^x or M-x" \
173 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000174 " -e End each line with $\n" \
175 " -t Show tabs as ^I\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000176 " -v Don't use ^x or M-x escapes"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000177#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000178 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000179#define chattr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000180 "Change file attributes on an ext2 fs\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000181 "Modifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000182 " - Remove attributes\n" \
183 " + Add attributes\n" \
184 " = Set attributes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000185 "Attributes:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000186 " A Don't track atime\n" \
187 " a Append mode only\n" \
188 " c Enable compress\n" \
189 " D Write dir contents synchronously\n" \
190 " d Do not backup with dump\n" \
191 " i Cannot be modified (immutable)\n" \
192 " j Write all data to journal first\n" \
193 " s Zero disk storage when deleted\n" \
194 " S Write file contents synchronously\n" \
195 " t Disable tail-merging of partial blocks with other files\n" \
196 " u Allow file to be undeleted\n" \
Denis Vlasenko5dd7ef02006-12-26 03:36:28 +0000197 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000198 " -R Recursively list subdirectories\n" \
199 " -v Set the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000200
Denis Vlasenko49622d72007-03-10 16:58:49 +0000201#define chcon_trivial_usage \
202 "[OPTIONS] CONTEXT FILE...\n" \
203 " chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE...\n" \
204 " chcon [OPTIONS] --reference=RFILE FILE...\n"
205#define chcon_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000206 "Change the security context of each FILE to CONTEXT\n" \
207 "\n -v, --verbose Verbose" \
208 "\n -c, --changes Report changes made" \
209 "\n -h, --no-dereference Affect symlinks instead of their targets" \
210 "\n -f, --silent, --quiet Suppress most error messages" \
211 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
212 "\n -u, --user=USER Set user USER in the target security context" \
213 "\n -r, --role=ROLE Set role ROLE in the target security context" \
214 "\n -t, --type=TYPE Set type TYPE in the target security context" \
215 "\n -l, --range=RANGE Set range RANGE in the target security context" \
216 "\n -R, --recursive Recurse subdirectories" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000217
Eric Andersen7e9276b2001-02-22 01:15:47 +0000218#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000219 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000220#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000221 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000222 "symbols +-= and one or more of the letters rwxst" \
223 "\n\nOptions:" \
224 "\n -R Changes files and directories recursively" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000225 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000226 "\n -c List changed files" \
227 "\n -v List all files" \
228 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000229 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000230#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000231 "$ ls -l /tmp/foo\n" \
232 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
233 "$ chmod u+x /tmp/foo\n" \
234 "$ ls -l /tmp/foo\n" \
235 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
236 "$ chmod 444 /tmp/foo\n" \
237 "$ ls -l /tmp/foo\n" \
238 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000239
Denis Vlasenko081ef792007-03-17 16:38:21 +0000240#define chgrp_trivial_usage \
241 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
242#define chgrp_full_usage \
243 "Change the group membership of each FILE to GROUP" \
244 "\n\nOptions:" \
245 "\n -R Recurse directories" \
246 "\n -h Affect symlinks instead of symlink targets" \
247 "\n -L Traverse all symlinks to directories" \
248 "\n -H Traverse symlinks on command line only" \
249 "\n -P Do not traverse symlinks (default)" \
250 USE_DESKTOP( \
251 "\n -c List changed files" \
252 "\n -v Verbose" \
253 "\n -f Hide errors" \
254 )
255#define chgrp_example_usage \
256 "$ ls -l /tmp/foo\n" \
257 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
258 "$ chgrp root /tmp/foo\n" \
259 "$ ls -l /tmp/foo\n" \
260 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
261
Eric Andersen7e9276b2001-02-22 01:15:47 +0000262#define chown_trivial_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000263 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000264#define chown_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000265 "Change the owner and/or group of each FILE to OWNER and/or GROUP" \
266 "\n\nOptions:" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000267 "\n -R Recurse directories" \
268 "\n -h Affect symlinks instead of symlink targets" \
269 "\n -L Traverse all symlinks to directories" \
270 "\n -H Traverse symlinks on command line only" \
271 "\n -P Do not traverse symlinks (default)" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000272 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000273 "\n -c List changed files" \
274 "\n -v List all files" \
275 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000276 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000277#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000278 "$ ls -l /tmp/foo\n" \
279 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
280 "$ chown root /tmp/foo\n" \
281 "$ ls -l /tmp/foo\n" \
282 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
283 "$ chown root.root /tmp/foo\n" \
284 "ls -l /tmp/foo\n" \
285 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000286
Denis Vlasenkofe544582006-10-03 15:57:40 +0000287#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000288 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
289 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
290 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000291#define chpst_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000292 "Change the process state and run specified program" \
293 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000294 " -u user[:grp] Set uid and gid\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +0000295 " -U user[:grp] Set environment variables UID and GID\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000296 " -e dir Set environment variables as specified by files\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000297 " in the directory: file=1st_line_of_file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000298 " -/ dir Chroot to dir\n" \
299 " -n inc Add inc to nice value\n" \
300 " -m bytes Limit data segment, stack segment, locked physical pages,\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000301 " and total of all segment per process to bytes bytes each\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000302 " -d bytes Limit data segment\n" \
303 " -o n Limit the number of open file descriptors per process to n\n" \
304 " -p n Limit number of processes per uid to n\n" \
305 " -f bytes Limit output file size to bytes bytes\n" \
306 " -c bytes Limit core file size to bytes bytes\n" \
307 " -v Verbose\n" \
308 " -P Run prog in a new process group\n" \
309 " -0 Close standard input\n" \
310 " -1 Close standard output\n" \
311 " -2 Close standard error"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000312#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000313 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000314#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000315 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
316 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000317#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000318 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000319#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000320 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000321#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000322 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000323#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000324 "Set various environment variables as specified by files\n" \
325 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000326#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000327 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
328 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
329 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000330#define softlimit_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000331 "Set soft resource limits, then run prog" \
332 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000333 " -m n Same as -d n -s n -l n -a n\n" \
334 " -d n Limit the data segment per process to n bytes\n" \
335 " -s n Limit the stack segment per process to n bytes\n" \
336 " -l n Limit the locked physical pages per process to n bytes\n" \
337 " -a n Limit the total of all segments per process to n bytes\n" \
338 " -o n Limit the number of open file descriptors per process to n\n" \
339 " -p n Limit the number of processes per uid to n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000340 "Options controlling file sizes:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000341 " -f n Limit output file sizes to n bytes\n" \
342 " -c n Limit core file sizes to n bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000343 "Efficiency opts:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000344 " -r n Limit the resident set size to n bytes. This limit is not\n" \
345 " enforced unless physical memory is full\n" \
346 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
347 " except that the process receives a SIGXCPU signal after n seconds\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000348 "\n" \
349 "Some options may have no effect on some operating systems\n" \
350 "n may be =, indicating that soft limit should be set equal to hard limit"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000351
Eric Andersen7e9276b2001-02-22 01:15:47 +0000352#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000353 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000354#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000355 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000356#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000357 "$ ls -l /bin/ls\n" \
358 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
359 "# mount /dev/hdc1 /mnt -t minix\n" \
360 "# chroot /mnt\n" \
361 "# ls -l /bin/ls\n" \
362 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000363
Eric Andersen7e9276b2001-02-22 01:15:47 +0000364#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000365 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000366#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000367 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000368
Rob Landley856489b2006-04-18 20:57:28 +0000369#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000370 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000371#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000372 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000373
Eric Andersen7e9276b2001-02-22 01:15:47 +0000374#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000375 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000376#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000377 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000378
Eric Andersen7e9276b2001-02-22 01:15:47 +0000379#define cmp_trivial_usage \
Denis Vlasenko9a1fa8c2007-03-21 22:30:14 +0000380 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000381#define cmp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000382 "Compares FILE1 vs stdin if FILE2 is not specified" \
383 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000384 " -l Write the byte numbers (decimal) and values (octal)\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000385 " for all differing bytes\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000386 " -s Quiet"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000387
Rob Landley2acfd7b2005-05-11 23:12:49 +0000388#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000389 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000390#define comm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000391 "Compare FILE1 to FILE2, or to stdin if - is specified" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000392 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000393 " -1 Suppress lines unique to FILE1\n" \
394 " -2 Suppress lines unique to FILE2\n" \
395 " -3 Suppress lines common to both files"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000396
Paul Fox79c142d2005-08-01 16:04:40 +0000397#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000398 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000399#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000400 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000401
Rob Landley69674942006-09-11 00:34:01 +0000402#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000403 "[FILE]...\n" \
404 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000405#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000406 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000407
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000408#define chrt_trivial_usage \
409 "[OPTION]... [prio] [pid | command [arg]...]"
410#define chrt_full_usage \
411 "manipulate real-time attributes of a process" \
412 "\n\nOptions:\n" \
413 " -p operate on pid\n" \
414 " -r set scheduling policy to SCHED_RR\n" \
415 " -f set scheduling policy to SCHED_FIFO\n" \
416 " -o set scheduling policy to SCHED_OTHER\n" \
417 " -m show min and max priorities"
418
419#define chrt_example_usage \
420 "$ chrt -r 4 sleep 900 ; x=$!\n" \
421 "$ chrt -f -p 3 $x\n" \
422 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
423
Eric Andersen7e9276b2001-02-22 01:15:47 +0000424#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000425 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000426#define cp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000427 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000428 "\n\nOptions:" \
429 "\n -a Same as -dpR" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000430 USE_SELINUX( \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000431 "\n -c Preserves security context" \
Denis Vlasenko49622d72007-03-10 16:58:49 +0000432 ) \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000433 "\n -d,-P Preserve links" \
434 "\n -H,-L Dereference all symlinks (default)" \
435 "\n -p Preserve file attributes if possible" \
436 "\n -f Force overwrite" \
437 "\n -i Prompt before overwrite" \
438 "\n -R,-r Recurse directories" \
439 "\n -l,-s Create (sym)links"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000440
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000441#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000442 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000443#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000444 "Extract or list files from a cpio archive\n" \
445 "Main operation mode:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000446 " d Make leading directories\n" \
447 " i Extract\n" \
448 " m Preserve mtime\n" \
449 " t List\n" \
450 " v Verbose\n" \
451 " u Unconditional overwrite\n" \
452 " F Input from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000453
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000454#define crond_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000455 "-d[#] -c <crondir> -f -b"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000456#define crond_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000457 " -d [#] -l [#] -S -L logfile -f -b -c dir\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000458 " -d num Debug level\n" \
459 " -l num Log level (8 - default)\n" \
460 " -S Log to syslogd (default)\n" \
461 " -L file Log to file\n" \
462 " -f Run in foreground\n" \
463 " -b Run in background (default)\n" \
464 " -c dir Working dir"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000465
466#define crontab_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000467 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000468#define crontab_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000469 " File <opts> replace crontab from file\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000470 " - <opts> replace crontab from stdin\n" \
471 " -u user specify user\n" \
472 " -l [user] list crontab for user\n" \
473 " -e [user] edit crontab for user\n" \
474 " -d [user] delete crontab for user\n" \
475 " -c dir specify crontab directory"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000476
477
Eric Andersen7e9276b2001-02-22 01:15:47 +0000478#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000479 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000480#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000481 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000482 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000483 " -b LIST Output only bytes from LIST\n" \
484 " -c LIST Output only characters from LIST\n" \
485 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
486 " -s Output only the lines containing delimiter\n" \
487 " -f N Print only these fields\n" \
488 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000489#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000490 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
491 "Hello\n" \
492 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
493 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000494
Eric Andersen7e9276b2001-02-22 01:15:47 +0000495#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000496 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000497#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000498 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000499 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000500 " -R Outputs RFC-822 compliant date string\n" \
501 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000502 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000503 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
504 " TIMESPEC='date' (or missing) for date only,\n" \
505 " 'hours', 'minutes', or 'seconds' for date and,\n" \
506 " time to the indicated precision\n" \
507 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000508 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000509 " -s Sets time described by STRING\n" \
510 " -r FILE Displays the last modification time of FILE\n" \
511 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000512#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000513 "$ date\n" \
514 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000515
Eric Andersen7e9276b2001-02-22 01:15:47 +0000516#define dc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000517 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000518#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000519 "This is a Tiny RPN calculator that understands the\n" \
520 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
521 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000522 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
523 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000524 "p - Prints the value on the top of the stack, without altering the stack\n" \
525 "f - Prints the entire contents of the stack without altering anything\n" \
526 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
527 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000528#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000529 "$ dc 2 2 + p\n" \
530 "4\n" \
531 "$ dc 8 8 \\* 2 2 + / p\n" \
532 "16\n" \
533 "$ dc 0 1 and p\n" \
534 "0\n" \
535 "$ dc 0 1 or p\n" \
536 "1\n" \
537 "$ echo 72 9 div 8 mul p | dc\n" \
538 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000539
Eric Andersen7e9276b2001-02-22 01:15:47 +0000540#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000541 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
542 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000543#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000544 "Copy a file with converting and formatting" \
545 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000546 " if=FILE Read from FILE instead of stdin\n" \
547 " of=FILE Write to FILE instead of stdout\n" \
548 " bs=N Read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000549 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000550 " ibs=N Read N bytes at a time\n") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000551 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000552 " obs=N Write N bytes at a time\n") \
553 " count=N Copy only N input blocks\n" \
554 " skip=N Skip N input blocks\n" \
555 " seek=N Skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000556 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000557 " conv=notrunc Don't truncate output file\n" \
558 " conv=noerror Continue after read errors\n" \
559 " conv=sync Pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000560 "\n" \
561 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
562 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000563#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000564 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
565 "4+0 records in\n" \
566 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000567
Eric Andersen7e9276b2001-02-22 01:15:47 +0000568#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000569 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000570#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000571 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000572
Eric Andersenf349e972001-08-21 16:18:59 +0000573#define delgroup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000574 "GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000575#define delgroup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000576 "Delete group GROUP from the system"
Eric Andersenf349e972001-08-21 16:18:59 +0000577
578#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000579 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000580#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000581 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000582
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000583#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000584 "mntpnt [-v]" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000585 USE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000586#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000587 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000588 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000589 "\n mntpnt The mount point where devfs is mounted" \
590 "\n -v Print the protocol version numbers for devfsd" \
591 "\n and the kernel-side protocol version and exits" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000592 USE_DEVFSD_FG_NP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000593 "\n -fg Run the daemon in the foreground" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000594 "\n -np Exit after parsing the configuration file" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000595 "\n and processing synthetic REGISTER events," \
596 "\n do not poll for events")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000597
Eric Andersen7e9276b2001-02-22 01:15:47 +0000598#define df_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000599 "[-" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000600#define df_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000601 "Print the filesystem space used and space available" \
602 "\n\nOptions:\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000603 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000604 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
605 " -m Print sizes in megabytes\n" \
606 " -k Print sizes in kilobytes(default)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000607 SKIP_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000608 "\n -k Ignored")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000609#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000610 "$ df\n" \
611 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
612 "/dev/sda3 8690864 8553540 137324 98% /\n" \
613 "/dev/sda1 64216 36364 27852 57% /boot\n" \
614 "$ df /dev/sda3\n" \
615 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
616 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000617
Denis Vlasenko736230e2006-11-20 19:40:36 +0000618#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000619 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000620#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000621 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000622
623#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000624 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000625#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000626 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000627
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000628#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000629 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000630#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000631 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000632 "This diff implementation only supports unified diffs." \
633 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000634 " -a Treat all files as text\n" \
635 " -b Ignore changes in the amount of whitespace\n" \
636 " -d Try hard to find a smaller set of changes\n" \
637 " -i Ignore case differences\n" \
638 " -L Use LABEL instead of the filename in the unified header\n" \
639 " -N Treat absent files as empty\n" \
640 " -q Output only whether files differ\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +0000641 " -r Recursively compare subdirectories\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000642 " -S Start with FILE when comparing directories\n" \
643 " -T Make tabs line up by prefixing a tab when necessary\n" \
644 " -s Report when two files are the same\n" \
645 " -t Expand tabs to spaces in output\n" \
646 " -U Output LINES lines of context\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000647 " -w Ignore all whitespace"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000648
Eric Andersen7e9276b2001-02-22 01:15:47 +0000649#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000650 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000651#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000652 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000653#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000654 "$ dirname /tmp/foo\n" \
655 "/tmp\n" \
656 "$ dirname /tmp/foo/\n" \
657 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000658
Eric Andersen7e9276b2001-02-22 01:15:47 +0000659#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000660 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000661#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000662 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000663 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000664 " -c Clears the ring buffer's contents after printing\n" \
665 " -n LEVEL Sets console logging level\n" \
666 " -s SIZE Use a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000667
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000668#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000669 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000670#define dnsd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000671 "Small and static DNS server daemon" \
672 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000673 " -c Config filename\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000674 " -t TTL in seconds\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000675 " -p Listening port\n" \
Denis Vlasenkod3bac032007-03-24 12:13:04 +0000676 " -i Listening ip (default all)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000677 " -d Daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000678
Eric Andersen7e9276b2001-02-22 01:15:47 +0000679#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000680 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000681#define dos2unix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000682 "Convert FILE from dos format to unix format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000683 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000684 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000685 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000686 " -u Output will be in UNIX format\n" \
687 " -d Output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000688
Eric Andersen7e9276b2001-02-22 01:15:47 +0000689#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000690 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000691#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000692 "Install, remove and manage Debian packages" \
693 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000694 " -i Install the package\n" \
695 " -l List of installed packages\n" \
696 " -C Configure an unpackaged package\n" \
697 " -F depends Ignore dependency problems\n" \
698 " -P Purge all files of a package\n" \
699 " -r Remove all but the configuration files for a package\n" \
700 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000701
Eric Andersen7e9276b2001-02-22 01:15:47 +0000702#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000703 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000704#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000705 "Perform actions on Debian packages (.debs)" \
706 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000707 " -c List contents of filesystem tree\n" \
708 " -e Extract control files to [argument] directory\n" \
709 " -f Display control field name starting with [argument]\n" \
710 " -x Extract packages filesystem tree to directory\n" \
711 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000712#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000713 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000714
Eric Andersen7e9276b2001-02-22 01:15:47 +0000715#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000716 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000717#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000718 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000719 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000720 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
721 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000722 " bytes." \
723 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000724 " -a Show sizes of files in addition to directories\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000725 " -H Follow symlinks that are FILE command line args\n" \
726 " -L Follow all symlinks encountered\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000727 " -d N Limit output to directories (and files with -a) of depth < N\n" \
728 " -c Output a grand total\n" \
729 " -l Count sizes many times if hard linked\n" \
730 " -s Display only a total for each argument\n" \
731 " -x Skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000732 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000733 " -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
734 " -m Print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000735 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000736 " -k Print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000737 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000738#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000739 "$ du\n" \
740 "16 ./CVS\n" \
741 "12 ./kernel-patches/CVS\n" \
742 "80 ./kernel-patches\n" \
743 "12 ./tests/CVS\n" \
744 "36 ./tests\n" \
745 "12 ./scripts/CVS\n" \
746 "16 ./scripts\n" \
747 "12 ./docs/CVS\n" \
748 "104 ./docs\n" \
749 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000750
Eric Andersen7e9276b2001-02-22 01:15:47 +0000751#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000752 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000753#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000754 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000755#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000756 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000757
Russ Dill61fb4892002-10-14 21:41:28 +0000758#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000759 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000760#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000761 "Display DHCP leases granted by udhcpd" \
762 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000763 " -f, --file=FILENAME Leases file to load\n" \
764 " -r, --remaining Interpret lease times as time remaining\n" \
765 " -a, --absolute Interpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000766
Mike Frysinger51a43b42005-09-24 07:11:16 +0000767#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000768 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
769 "[-I inode_buffer_blocks] [-P process_inode_size] " \
770 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
771 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000772#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000773 "Check ext2/ext3 file system" \
774 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000775 " -p Automatic repair (no questions)\n" \
776 " -n Make no changes to the filesystem\n" \
777 " -y Assume 'yes' to all questions\n" \
778 " -c Check for bad blocks and add them to the badblock list\n" \
779 " -f Force checking even if filesystem is marked clean\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000780 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000781 " -b superblock Use alternative superblock\n" \
782 " -B blocksize Force blocksize when looking for superblock\n" \
783 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000784 " -l file Add to badblocks list\n" \
785 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000786
Eric Andersen7e9276b2001-02-22 01:15:47 +0000787#define echo_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000788 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000789#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000790 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000791 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000792 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000793 " -n Suppress trailing newline\n" \
794 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
795 " -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000796 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000797#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000798 "$ echo \"Erik is cool\"\n" \
799 "Erik is cool\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000800 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000801 "Erik\n" \
802 "is\n" \
803 "cool\n" \
804 "$ echo \"Erik\\nis\\ncool\"\n" \
805 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000806
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000807#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000808 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000809#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000810 "Eject specified DEVICE (or default /dev/cdrom)" \
811 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000812 " -t Close tray\n" \
813 " -T Open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000814
Rob Landley3b890392006-05-04 20:56:43 +0000815#define ed_trivial_usage ""
816#define ed_full_usage ""
817
Eric Andersen84e229c2001-03-29 22:48:33 +0000818#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000819 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000820#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000821 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000822 "up the specified environment" \
823 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000824 " -, -i Start with an empty environment\n" \
825 " -u Remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000826
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000827#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000828 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000829#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000830 "Send a magic packet to wake up sleeping machines.\n" \
831 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000832 "a hostname with a known 'ethers' entry." \
833 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000834 " -b Send wake-up packet to the broadcast address\n" \
835 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000836 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000837
Eric Andersen7e9276b2001-02-22 01:15:47 +0000838#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000839 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000840#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000841 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000842 "EXPRESSION may be:\n" \
843 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
844 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
845 " ARG1 < ARG2 ARG1 is less than ARG2\n" \
846 " ARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
847 " ARG1 = ARG2 ARG1 is equal to ARG2\n" \
848 " ARG1 != ARG2 ARG1 is unequal to ARG2\n" \
849 " ARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
850 " ARG1 > ARG2 ARG1 is greater than ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000851 " ARG1 + ARG2 Sum of ARG1 and ARG2\n" \
852 " ARG1 - ARG2 Difference of ARG1 and ARG2\n" \
853 " ARG1 * ARG2 Product of ARG1 and ARG2\n" \
854 " ARG1 / ARG2 Quotient of ARG1 divided by ARG2\n" \
855 " ARG1 % ARG2 Remainder of ARG1 divided by ARG2\n" \
856 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
857 " match STRING REGEXP Same as STRING : REGEXP\n" \
858 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
859 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
860 " length STRING Length of STRING\n" \
861 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000862 " it is a keyword like 'match' or an\n" \
863 " operator like '/'\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000864 " (EXPRESSION) Value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000865 "Beware that many operators need to be escaped or quoted for shells.\n" \
866 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
867 "lexicographical. Pattern matches return the string matched between\n" \
868 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
869 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000870
Mike Frysingerfa69f112005-04-17 07:24:19 +0000871#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000872 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000873#define fakeidentd_full_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000874 "Provide fake ident (auth) service" \
875 "\n\nOptions:" \
876 "\n -f Run in foreground" \
877 "\n -i Inetd mode" \
878 "\n -w Inetd 'wait' mode" \
879 "\n -b ADDR Bind to specified address" \
880 "\n STRING Ident answer string (default is 'nobody')"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000881
Eric Andersen7e9276b2001-02-22 01:15:47 +0000882#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000883 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000884#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000885 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000886#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000887 "$ false\n" \
888 "$ echo $?\n" \
889 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000890
891#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000892 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000893#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000894 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000895#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000896 "$ fbset\n" \
897 "mode \"1024x768-76\"\n" \
898 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
899 " geometry 1024 768 1024 768 16\n" \
900 " timings 12714 128 32 16 4 128 4\n" \
901 " accel false\n" \
902 " rgba 5/11,6/5,5/0,0/0\n" \
903 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000904
Eric Andersen7e9276b2001-02-22 01:15:47 +0000905#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000906 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000907#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000908 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000909
Eric Andersen01c3d402003-07-05 07:51:31 +0000910#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000911 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +0000912#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000913 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000914 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000915 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +0000916
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000917#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000918 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000919#define fdisk_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000920 "Change partition table" \
921 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000922 " -l List partition table(s)\n" \
923 " -u Give Start and End in sector (instead of cylinder) units\n" \
924 " -s PARTITION Give partition size(s) in blocks\n" \
925 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
926 " -C CYLINDERS Set the number of cylinders\n" \
927 " -H HEADS Set the number of heads\n" \
928 " -S SECTORS Set the number of sectors\n" \
929 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000930
Eric Andersen7e9276b2001-02-22 01:15:47 +0000931#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000932 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000933#define find_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000934 "Search for files in a directory hierarchy. The default PATH is\n" \
935 "the current directory; default EXPRESSION is '-print'\n" \
936 "\nEXPRESSION may consist of:\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000937 " -follow Dereference symlinks\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000938 " -name PATTERN File name (leading directories removed) matches PATTERN\n" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000939 " -print Print (default and assumed)" \
Paul Foxd7384292006-05-12 14:47:20 +0000940 USE_FEATURE_FIND_PRINT0( \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000941 "\n -print0 Delimit output with null characters rather than" \
942 "\n newlines" \
943 ) USE_FEATURE_FIND_TYPE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000944 "\n -type X Filetype matches X (where X is one of: f,d,l,b,c,...)" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000945 ) USE_FEATURE_FIND_PERM( \
946 "\n -perm PERMS Permissions match any of (+NNN); all of (-NNN);" \
947 "\n or exactly (NNN)" \
948 ) USE_FEATURE_FIND_MTIME( \
949 "\n -mtime DAYS Modified time is greater than (+N); less than (-N);" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000950 "\n Or exactly (N) days" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000951 ) USE_FEATURE_FIND_MMIN( \
952 "\n -mmin MINS Modified time is greater than (+N); less than (-N);" \
953 "\n or exactly (N) minutes" \
954 ) USE_FEATURE_FIND_NEWER( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000955 "\n -newer FILE Modified time is more recent than FILE's" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000956 ) USE_FEATURE_FIND_INUM( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000957 "\n -inum N File has inode number N" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000958 ) USE_FEATURE_FIND_EXEC( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000959 "\n -exec CMD Execute CMD with all instances of {} replaced by the" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000960 "\n files matching EXPRESSION" \
Denis Vlasenko2f7b9232007-04-05 21:01:06 +0000961 ) USE_FEATURE_FIND_USER( \
962 "\n -user NAME File is owned by user NAME (numeric user ID allowed)" \
963 ) USE_FEATURE_FIND_GROUP( \
964 "\n -group NAME File belongs to group NAME (numeric group ID allowed)" \
965 ) USE_FEATURE_FIND_DEPTH( \
966 "\n -depth Process directory after traversing it" \
Denis Vlasenko56fce002007-04-04 23:41:35 +0000967 ) USE_FEATURE_FIND_SIZE( \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000968 "\n -size N File size is N" \
Denis Vlasenko56fce002007-04-04 23:41:35 +0000969 ) USE_FEATURE_FIND_PRUNE( \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000970 "\n -prune Stop traversing current subtree" \
Denis Vlasenko56fce002007-04-04 23:41:35 +0000971 ) USE_FEATURE_FIND_PAREN( \
Denis Vlasenko2f7b9232007-04-05 21:01:06 +0000972 "\n (EXPR) Group an expression" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000973 )
Rob Landley5d3a0e82005-10-04 03:34:39 +0000974
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000975#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000976 "$ find / -name passwd\n" \
977 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000978
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000979#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000980 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000981#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000982 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000983 "standard output" \
984 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000985 " -b Count bytes rather than columns\n" \
986 " -s Break at spaces\n" \
987 " -w Use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000988
Eric Andersen7e9276b2001-02-22 01:15:47 +0000989#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000990 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000991#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000992 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000993#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000994 "$ free\n" \
995 " total used free shared buffers\n" \
996 " Mem: 257628 248724 8904 59644 93124\n" \
997 " Swap: 128516 8404 120112\n" \
998 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000999
Eric Andersen7e9276b2001-02-22 01:15:47 +00001000#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001001 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001002#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001003 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001004#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001005 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001006
Mike Frysinger51a43b42005-09-24 07:11:16 +00001007#define fsck_trivial_usage \
Denis Vlasenko0de93752006-12-26 02:51:29 +00001008 "[-ANPRTV] [ -C fd ] [-t fstype] [fs-options] [filesys ...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001009#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001010 "Check and repair filesystems" \
1011 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001012 " -A Walk /etc/fstab and check all filesystems\n" \
1013 " -N Don't execute, just show what would be done\n" \
1014 " -P When using -A, check filesystems in parallel\n" \
1015 " -R When using -A, skip the root filesystem\n" \
1016 " -T Don't show title on startup\n" \
Denis Vlasenko0de93752006-12-26 02:51:29 +00001017 " -V Verbose\n" \
1018 " -C n Write status information to specified filedescriptor\n" \
1019 " -t type List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001020
Eric Andersen7e9276b2001-02-22 01:15:47 +00001021#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001022 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001023#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001024 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001025 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001026 " -l Lists all filenames\n" \
1027 " -r Perform interactive repairs\n" \
1028 " -a Perform automatic repairs\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001029 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001030 " -s Outputs super-block information\n" \
1031 " -m Activates MINIX-like \"mode not cleared\" warnings\n" \
1032 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001033
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001034#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001035 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001036#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001037 "Retrieve a remote file via FTP" \
1038 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001039 " -c, --continue Continue a previous transfer\n" \
1040 " -v, --verbose Verbose\n" \
1041 " -u, --username Username to be used\n" \
1042 " -p, --password Password to be used\n" \
1043 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001044
1045#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001046 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001047#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001048 "Store a local file on a remote machine via FTP" \
1049 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001050 " -v, --verbose Verbose\n" \
1051 " -u, --username Username to be used\n" \
1052 " -p, --password Password to be used\n" \
1053 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001054
Rob Landleyaa872762005-10-28 13:05:12 +00001055#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001056 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +00001057#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001058 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001059 " -m Show all processes on the same mounted fs\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001060 " -k Kill all processes that match\n" \
1061 " -s Don't print or kill anything\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001062 " -4 When using port/proto only search IPv4 space\n" \
1063 " -6 When using port/proto only search IPv6 space\n" \
1064 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001065
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001066#define getenforce_trivial_usage
1067#define getenforce_full_usage
1068
Eric Andersen7e9276b2001-02-22 01:15:47 +00001069#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001070 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001071#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001072 "Parse command options\n" \
1073 " -a, --alternative Allow long options starting with single -\n" \
1074 " -l, --longoptions=longopts Long options to be recognized\n" \
1075 " -n, --name=progname The name under which errors are reported\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001076 " -o, --options=optstring Short options to be recognized\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001077 " -q, --quiet Disable error reporting by getopt(3)\n" \
1078 " -Q, --quiet-output No normal output\n" \
1079 " -s, --shell=shell Set shell quoting conventions\n" \
1080 " -T, --test Test for getopt(1) version\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001081 " -u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001082#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001083 "$ cat getopt.test\n" \
1084 "#!/bin/sh\n" \
1085 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1086 " -n 'example.busybox' -- \"$@\"`\n" \
1087 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
1088 "eval set -- \"$GETOPT\"\n" \
1089 "while true ; do\n" \
1090 " case $1 in\n" \
1091 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
1092 " -b|--b-long) echo \"Option b, argument '$2'\" ; shift 2 ;;\n" \
1093 " -c|--c-long)\n" \
1094 " case \"$2\" in\n" \
1095 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
1096 " *) echo \"Option c, argument '$2'\" ; shift 2 ;;\n" \
1097 " esac ;;\n" \
1098 " --) shift ; break ;;\n" \
1099 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
1100 " esac\n" \
1101 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001102
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001103#define getsebool_trivial_usage \
1104 "-a or getsebool boolean..."
1105#define getsebool_full_usage \
1106 " -a Show all SELinux booleans"
1107
Eric Andersenf349e972001-08-21 16:18:59 +00001108#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001109 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001110#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001111 "Open a tty, prompt for a login name, then invoke /bin/login" \
1112 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001113 " -h Enable hardware (RTS/CTS) flow control\n" \
1114 " -i Do not display /etc/issue before running login\n" \
1115 " -L Local line, so do not do carrier detect\n" \
1116 " -m Get baud rate from modem's CONNECT status message\n" \
1117 " -w Wait for a CR or LF before sending /etc/issue\n" \
1118 " -n Do not prompt the user for a login name\n" \
1119 " -f issue_file Display issue_file instead of /etc/issue\n" \
1120 " -l login_app Invoke login_app instead of /bin/login\n" \
1121 " -t timeout Terminate after timeout if no username is read\n" \
1122 " -I initstring Sets the init string to send before anything else\n" \
1123 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001124
Eric Andersen7e9276b2001-02-22 01:15:47 +00001125#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001126 "[-HhrilLnqvso" \
1127 USE_DESKTOP("w") \
1128 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001129 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1130 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001131 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001132#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001133 "Search for PATTERN in each FILE or standard input" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001134 "\n\nOptions:" \
1135 "\n -H Prefix output lines with filename where match was found" \
1136 "\n -h Suppress the prefixing filename on output" \
1137 "\n -r Recurse subdirectories" \
1138 "\n -i Ignore case distinctions" \
1139 "\n -l List names of files that match" \
1140 "\n -L List names of files that do not match" \
1141 "\n -n Print line number with output lines" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001142 "\n -q Quiet. Returns 0 if PATTERN was found, 1 otherwise" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001143 "\n -v Select non-matching lines" \
1144 "\n -s Suppress file open/read error messages" \
1145 "\n -c Only print count of matching lines" \
1146 "\n -f Read PATTERN from file" \
1147 "\n -o Show only the part of a line that matches PATTERN" \
1148 USE_DESKTOP( \
1149 "\n -w Match whole words only") \
1150 "\n -e PATTERN is a regular expression" \
1151 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001152 USE_FEATURE_GREP_EGREP_ALIAS( \
1153 "\n -E PATTERN is an extended regular expression") \
1154 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001155 "\n -A Print NUM lines of trailing context" \
1156 "\n -B Print NUM lines of leading context" \
1157 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001158
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001159#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001160 "$ grep root /etc/passwd\n" \
1161 "root:x:0:0:root:/root:/bin/bash\n" \
1162 "$ grep ^[rR]oo. /etc/passwd\n" \
1163 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001164
Eric Andersen7e9276b2001-02-22 01:15:47 +00001165#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001166 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001167#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001168 "Uncompress FILE (or standard input if FILE is '-')" \
1169 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001170 " -c Write output to standard output\n" \
1171 " -f Force read when source is a terminal\n" \
1172 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001173#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001174 "$ ls -la /tmp/BusyBox*\n" \
1175 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1176 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1177 "$ ls -la /tmp/BusyBox*\n" \
1178 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001179
1180#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001181 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001182#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001183 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001184 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
1185 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001186 " -c Write output to standard output instead of FILE.gz\n" \
1187 " -d Decompress\n" \
1188 " -f Force write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001189#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001190 "$ ls -la /tmp/busybox*\n" \
1191 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1192 "$ gzip /tmp/busybox.tar\n" \
1193 "$ ls -la /tmp/busybox*\n" \
1194 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001195
1196#define halt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001197 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001198#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001199 "Halt the system" \
1200 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001201 " -d Delay interval for halting\n" \
1202 " -n No call to sync()\n" \
1203 " -f Force halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001204
Eric Andersen3443bd72003-07-22 07:30:36 +00001205#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001206 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001207#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001208 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001209 "If no device name is specified try to read from stdin.\n\n") \
1210 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001211 " -a Get/set fs readahead\n" \
1212 " -A Set drive read-lookahead flag (0/1)\n" \
1213 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1214 " -B Set Advanced Power Management setting (1-255)\n" \
1215 " -c Get/set IDE 32-bit IO setting\n" \
1216 " -C Check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001217 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001218 " -d Get/set using_dma flag\n") \
1219 " -D Enable/disable drive defect-mgmt\n" \
1220 " -f Flush buffer cache for device on exit\n" \
1221 " -g Display drive geometry\n" \
1222 " -h Display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001223 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001224 " -i Display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001225 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001226 " -I Detailed/current information directly from drive\n") \
1227 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1228 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1229 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1230 " -m Get/set multiple sector count\n" \
1231 " -n Get/set ignore-write-errors flag (0/1)\n" \
1232 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1233 " -P Set drive prefetch count\n" \
1234 " -q Change next setting quietly\n" \
1235 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1236 " -r Get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001237 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001238 " -R Register an IDE interface (DANGEROUS)\n") \
1239 " -S Set standby (spindown) timeout\n" \
1240 " -t Perform device read timings\n" \
1241 " -T Perform cache read timings\n" \
1242 " -u Get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001243 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001244 " -U Un-register an IDE interface (DANGEROUS)\n") \
1245 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1246 " -V Display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001247 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001248 " -w Perform device reset (DANGEROUS)\n") \
1249 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001250 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001251 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1252 " -X Set IDE xfer mode (DANGEROUS)\n" \
1253 " -y Put IDE drive in standby mode\n" \
1254 " -Y Put IDE drive to sleep\n" \
1255 " -Z Disable Seagate auto-powersaving mode\n" \
1256 " -z Re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001257
Eric Andersen7e9276b2001-02-22 01:15:47 +00001258#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001259 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001260#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001261 "Print first 10 lines of each FILE to standard output.\n" \
1262 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001263 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001264 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001265 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001266 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001267 "\n -c NUM Output the first NUM bytes" \
1268 "\n -q Never output headers giving file names" \
1269 "\n -v Always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001270#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001271 "$ head -n 2 /etc/passwd\n" \
1272 "root:x:0:0:root:/root:/bin/bash\n" \
1273 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001274
Glenn L McGrath60281112001-11-02 11:39:46 +00001275#define hexdump_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001276 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001277#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001278 "Display file(s) or standard input in a user specified format" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001279 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001280 " -b One-byte octal display\n" \
1281 " -c One-byte character display\n" \
1282 " -C Canonical hex+ASCII, 16 bytes per line\n" \
1283 " -d Two-byte decimal display\n" \
1284 " -e FORMAT STRING\n" \
1285 " -f FORMAT FILE\n" \
1286 " -n LENGTH Interpret only length bytes of input\n" \
1287 " -o Two-byte octal display\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001288 " -s OFFSET Skip offset bytes\n" \
1289 " -v Display all input data\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001290 " -x Two-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001291
Eric Andersen7e9276b2001-02-22 01:15:47 +00001292#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001293 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001294#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001295 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001296
1297#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001298 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001299#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001300 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001301 "(or FILE with the -F parameter), the host name will be set." \
1302 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001303 " -s Short\n" \
1304 " -i Addresses for the hostname\n" \
1305 " -d DNS domain name\n" \
1306 " -f Fully qualified domain name\n" \
1307 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001308#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001309 "$ hostname\n" \
1310 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001311
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001312#define httpd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001313 "[-c <conf file>]" \
1314 " [-p <port>]" \
1315 " [-i] [-f]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001316 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001317 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1318 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001319 " [-h home]" \
1320 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001321#define httpd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001322 "Listen for incoming http server requests" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001323 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001324 " -c FILE Specifies configuration file. (default httpd.conf)\n" \
1325 " -p PORT Server port (default 80)\n" \
1326 " -i Assume that we are started from inetd\n" \
1327 " -f Do not daemonize\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001328 USE_FEATURE_HTTPD_SETUID( \
1329 " -u USER[:GRP] Set uid/gid after binding to port\n") \
1330 USE_FEATURE_HTTPD_BASIC_AUTH( \
1331 " -r REALM Authentication Realm for Basic Authentication\n") \
1332 USE_FEATURE_HTTPD_AUTH_MD5( \
1333 " -m PASS Crypt PASS with md5 algorithm\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001334 " -h HOME Specifies http HOME directory (default ./)\n" \
1335 " -e STRING HTML encode STRING\n" \
1336 " -d STRING URL decode STRING"
Eric Andersen40520512003-07-28 09:59:05 +00001337
Robert Griebl1cd04452002-07-21 16:50:49 +00001338#define hwclock_trivial_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001339 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1340 " [-l|--localtime] [-u|--utc]" \
1341 " [-f FILE]"
Robert Griebl1cd04452002-07-21 16:50:49 +00001342#define hwclock_full_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001343 "Query and set a hardware clock (RTC)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001344 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001345 " -r Read hardware clock and print result\n" \
1346 " -s Set the system time from the hardware clock\n" \
1347 " -w Set the hardware clock to the current system time\n" \
1348 " -u The hardware clock is kept in coordinated universal time\n" \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001349 " -l The hardware clock is kept in local time\n" \
1350 " -f FILE Use the specified clock (e.g. /dev/rtc2)"
Robert Griebl1cd04452002-07-21 16:50:49 +00001351
Eric Andersen7e9276b2001-02-22 01:15:47 +00001352#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001353 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001354#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001355 "Print information for USERNAME or the current user" \
1356 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001357 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001358 " -Z prints only the security context\n" \
1359 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001360 " -g Prints only the group ID\n" \
1361 " -u Prints only the user ID\n" \
1362 " -n Print a name instead of a number\n" \
1363 " -r Prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001364#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001365 "$ id\n" \
1366 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001367
Eric Andersen7e9276b2001-02-22 01:15:47 +00001368#define ifconfig_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001369 USE_FEATURE_IFCONFIG_STATUS("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001370#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001371 "Configure a network interface" \
1372 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001373 USE_FEATURE_IPV6( \
1374 " [add <address>[/<prefixlen>]]\n") \
1375 USE_FEATURE_IPV6( \
1376 " [del <address>[/<prefixlen>]]\n") \
1377 " [[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
1378 " [netmask <address>] [dstaddr <address>]\n" \
1379 USE_FEATURE_IFCONFIG_SLIP( \
1380 " [outfill <NN>] [keepalive <NN>]\n") \
1381 " " USE_FEATURE_IFCONFIG_HW("[hw ether <address>] ") "[metric <NN>] [mtu <NN>]\n" \
1382 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
1383 " [multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1384 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
1385 " [mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001386 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001387
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001388#define ifup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001389 "<-ahinv> <ifaces...>"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001390#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001391 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001392 " -a De/configure all interfaces automatically\n" \
1393 " -i FILE Use FILE for interface definitions\n" \
1394 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001395 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001396 " -v Print out what would happen before doing it\n" \
1397 " -m Don't run any mappings\n" \
1398 " -f Force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001399
1400#define ifdown_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001401 "<-ahinv> <ifaces...>"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001402#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001403 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001404 " -a De/configure all interfaces automatically\n" \
1405 " -i FILE Use FILE for interface definitions\n" \
1406 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001407 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001408 " -v Print out what would happen before doing it\n" \
1409 " -m Don't run any mappings\n" \
1410 " -f Force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001411
Glenn L McGrath06e95652003-02-09 06:51:14 +00001412#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001413 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001414#define inetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001415 "Listen for network connections and launch programs" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001416 "\n\nOptions:\n" \
Denis Vlasenko886bb0d2007-01-09 23:48:46 +00001417 " -f Run in foreground\n" \
1418 " -q N Set the size of the socket listen queue to N\n" \
1419 " (default: 128)"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001420
Eric Andersen7e9276b2001-02-22 01:15:47 +00001421#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001422 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001423#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001424 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001425#define init_notes_usage \
1426"This version of init is designed to be run only by the kernel.\n" \
1427"\n" \
1428"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001429"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001430"runlevels, use sysvinit.\n" \
1431"\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001432"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001433"it has the following default behavior:\n" \
1434"\n" \
1435" ::sysinit:/etc/init.d/rcS\n" \
1436" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001437" ::ctrlaltdel:/sbin/reboot\n" \
1438" ::shutdown:/sbin/swapoff -a\n" \
1439" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001440" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001441"\n" \
1442"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1443"\n" \
1444" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001445" tty3::askfirst:/bin/sh\n" \
1446" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001447"\n" \
1448"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1449"\n" \
1450" <id>:<runlevels>:<action>:<process>\n" \
1451"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001452" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001453"\n" \
1454" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1455" The id field is used by BusyBox init to specify the controlling tty for\n" \
1456" the specified process to run on. The contents of this field are\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001457" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001458" be unique, although if it isn't you may have strange results. If this\n" \
1459" field is left blank, the controlling tty is set to the console. Also\n" \
1460" note that if BusyBox detects that a serial console is in use, then only\n" \
1461" entries whose controlling tty is either the serial console or /dev/null\n" \
1462" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1463" stinkin' utmp.\n" \
1464"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001465" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001466"\n" \
1467" The runlevels field is completely ignored.\n" \
1468"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001469" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001470"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001471" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001472" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001473"\n" \
1474" The available actions can be classified into two groups: actions\n" \
1475" that are run only once, and actions that are re-run when the specified\n" \
1476" process exits.\n" \
1477"\n" \
1478" Run only-once actions:\n" \
1479"\n" \
1480" 'sysinit' is the first item run on boot. init waits until all\n" \
1481" sysinit actions are completed before continuing. Following the\n" \
1482" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001483" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001484" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001485" therefore, init does not wait for them to complete. 'restart' is\n" \
1486" the action taken to restart the init process. By default this should\n" \
1487" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1488" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001489" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001490" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1491" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001492" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001493" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1494" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001495"\n" \
1496" Run repeatedly actions:\n" \
1497"\n" \
1498" 'respawn' actions are run after the 'once' actions. When a process\n" \
1499" started with a 'respawn' action exits, init automatically restarts\n" \
1500" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1501" respawning out of control. The 'askfirst' actions acts just like\n" \
1502" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001503" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001504" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001505" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001506"\n" \
1507" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1508" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001509" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001510"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001511" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001512"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001513" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001514"\n" \
1515"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001516"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001517" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001518" #\n" \
1519" ::sysinit:/etc/init.d/rcS\n" \
1520" \n" \
1521" # /bin/sh invocations on selected ttys\n" \
1522" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001523" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001524" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001525" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001526" tty2::askfirst:-/bin/sh\n" \
1527" tty3::askfirst:-/bin/sh\n" \
1528" tty4::askfirst:-/bin/sh\n" \
1529" \n" \
1530" # /sbin/getty invocations for selected ttys\n" \
1531" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001532" tty4::respawn:/sbin/getty 38400 tty4\n" \
1533" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001534" \n" \
1535" \n" \
1536" # Example of how to put a getty on a serial line (for a terminal)\n" \
1537" #\n" \
1538" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1539" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1540" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001541" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001542" #::respawn:/sbin/getty 57600 ttyS2\n" \
1543" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001544" # Stuff to do when restarting the init process\n" \
1545" ::restart:/sbin/init\n" \
1546" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001547" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001548" ::ctrlaltdel:/sbin/reboot\n" \
1549" ::shutdown:/bin/umount -a -r\n" \
1550" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001551
1552#define insmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001553 "[OPTION]... MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001554#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001555 "Load the specified kernel modules into the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001556 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001557 " -f Force module to load into the wrong kernel version\n" \
1558 " -k Make module autoclean-able\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001559 " -v Verbose\n" \
1560 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001561 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001562 USE_FEATURE_INSMOD_LOAD_MAP( \
1563 " -m Output load map to stdout\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001564 " -o NAME Set internal module name to NAME\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001565 " -x Do not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001566
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001567#define install_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001568 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001569#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001570 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001571 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001572 " -c Copy the file, default\n" \
1573 " -d Create directories\n" \
1574 " -g Set group ownership\n" \
1575 " -m Set permission modes\n" \
1576 " -o Set ownership\n" \
1577 " -p Preserve date\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001578 " -s Strip symbol tables" \
1579 USE_SELINUX( \
1580 "\n -Z Set security context of copy" \
1581 )
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001582/* would need to make the " | " optional depending on more than one selected */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001583#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001584 "[OPTIONS] {" \
1585 USE_FEATURE_IP_ADDRESS("address | ") \
1586 USE_FEATURE_IP_ROUTE("route | ") \
1587 USE_FEATURE_IP_LINK("link | ") \
1588 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1589 USE_FEATURE_IP_RULE("rule") \
1590 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001591#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001592 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001593 "where OBJECT := {" \
1594 USE_FEATURE_IP_ADDRESS("address | ") \
1595 USE_FEATURE_IP_ROUTE("route | ") \
1596 USE_FEATURE_IP_LINK("link | ") \
1597 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1598 USE_FEATURE_IP_RULE("rule") \
1599 "}\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001600 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001601
1602#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001603 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1604 " [ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001605#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001606 "ipaddr {add|delete} IFADDR dev STRING\n" \
1607 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001608 " [ to PREFIX ] [ label PATTERN ]\n" \
1609 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
1610 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1611 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1612 " SCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001613
Eric Andersende4f07e2003-12-11 01:18:07 +00001614#define ipcalc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001615 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001616#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001617 "Calculate IP network settings from a IP address" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001618 "\n\nOptions:" \
1619 "\n -b --broadcast Display calculated broadcast address" \
1620 "\n -n --network Display calculated network address" \
1621 "\n -m --netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001622 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001623 "\n -p --prefix Display the prefix for IP/NETMASK" \
1624 "\n -h --hostname Display first resolved host name" \
1625 "\n -s --silent Don't ever display error messages")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001626
Rob Landley6eb1e412005-06-20 04:30:36 +00001627#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001628 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001629#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001630 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1631 "segment by a shmkey value. The lower-case options mqs are used\n" \
1632 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001633 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001634 " -[mM] Remove the memory segment after the last detach\n" \
1635 " -[qQ] Remove the message queue\n" \
1636 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001637
1638#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001639 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001640#define ipcs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001641 " -i Specify a specific resource id\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001642 "Resource specification:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001643 " -m Shared memory segments\n" \
1644 " -q Message queues\n" \
1645 " -s Semaphore arrays\n" \
1646 " -a All (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001647 "Output format:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001648 " -t Time\n" \
1649 " -c Creator\n" \
1650 " -p Pid\n" \
1651 " -l Limits\n" \
1652 " -u Summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001653
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001654#define iplink_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001655 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001656#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001657 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001658 " dynamic { on | off } |\n" \
1659 " mtu MTU }\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001660 "iplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001661
1662#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001663 "{ list | flush | { add | del | change | append |\n" \
1664 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001665#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001666 "iproute { list | flush } SELECTOR\n" \
1667 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1668 " [ oif STRING ] [ tos TOS ]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001669 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001670 " SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1671 " ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001672
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001673#define iprule_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001674 "{[ list | add | del ] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001675#define iprule_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001676 "iprule [ list | add | del ] SELECTOR ACTION\n" \
1677 " SELECTOR := [ from PREFIX ] [ to PREFIX ] [ tos TOS ] [ fwmark FWMARK ]\n" \
1678 " [ dev STRING ] [ pref NUMBER ]\n" \
1679 " ACTION := [ table TABLE_ID ] [ nat ADDRESS ]\n" \
1680 " [ prohibit | reject | unreachable ]\n" \
1681 " [ realms [SRCREALM/]DSTREALM ]\n" \
1682 " TABLE_ID := [ local | main | default | NUMBER ]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001683
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001684#define iptunnel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001685 "{ add | change | del | show } [ NAME ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001686 " [ mode { ipip | gre | sit } ]\n" \
1687 " [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001688#define iptunnel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001689 "iptunnel { add | change | del | show } [ NAME ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001690 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1691 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1692 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001693
Eric Andersen7e9276b2001-02-22 01:15:47 +00001694#define kill_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001695 "[-l] [-signal] process-id [process-id ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001696#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001697 "Send a signal (default is TERM) to the specified process(es)" \
1698 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001699 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001700#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001701 "$ ps | grep apache\n" \
1702 "252 root root S [apache]\n" \
1703 "263 www-data www-data S [apache]\n" \
1704 "264 www-data www-data S [apache]\n" \
1705 "265 www-data www-data S [apache]\n" \
1706 "266 www-data www-data S [apache]\n" \
1707 "267 www-data www-data S [apache]\n" \
1708 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001709
1710#define killall_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001711 "[-l] [-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001712#define killall_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001713 "Send a signal (default is TERM) to the specified process(es)" \
1714 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001715 " -l List all signal names and numbers\n" \
1716 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001717#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001718 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001719
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001720#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001721 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001722#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001723 "Send a signal (default is TERM) to all processes outside current session" \
1724 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001725 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001726
Mark Whitley6317c4b2001-03-12 22:51:50 +00001727#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001728 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001729#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001730 "Kernel logger" \
1731 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001732 " -c n Sets the default log level of console messages to n\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00001733 " -n Run as foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001734
Eric Andersen7e9276b2001-02-22 01:15:47 +00001735#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001736 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001737#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001738 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001739#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001740 "$ length Hello\n" \
1741 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001742
Rob Landley9200e792005-09-15 19:26:59 +00001743#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001744 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001745#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001746 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001747 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001748 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001749 " -E Quit once the end of a file is reached\n" \
1750 " -M Display a status line containing the current line numbers\n" \
1751 " and the percentage through the file\n" \
1752 " -N Prefix line numbers to each line\n" \
1753 " -m Display a status line containing the percentage through the\n" \
1754 " file\n" \
1755 " -~ Suppress ~s displayed when input past the end of the file is\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001756 " reached"
Rob Landley9200e792005-09-15 19:26:59 +00001757
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001758#define setarch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001759 "<personality> <program> [args ...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001760#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001761 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001762 " linux32 Set 32bit uname emulation\n" \
1763 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001764
Eric Andersen7e9276b2001-02-22 01:15:47 +00001765#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001766 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001767#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001768 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1769 "You may use '--' to indicate that all following arguments are non-options." \
1770 "\n\nOptions:\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00001771 " -s Make symlinks instead of hardlinks\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001772 " -f Remove existing destination files\n" \
1773 " -n No dereference symlinks - treat like normal file\n" \
1774 " -b Make a backup of the target (if exists) before link operation\n" \
1775 " -S suf Use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001776#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001777 "$ ln -s BusyBox /tmp/ls\n" \
1778 "$ ls -l /tmp/ls\n" \
1779 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001780
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00001781#define load_policy_trivial_usage \
1782 "[FILE]"
1783#define load_policy_full_usage
1784
Eric Andersen7e9276b2001-02-22 01:15:47 +00001785#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001786 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001787#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001788 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001789#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001790 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001791
1792#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001793 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001794#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001795 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001796#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001797 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001798
1799#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001800 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001801#define logger_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001802 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
1803 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001804 " -s Log to stderr as well as the system log\n" \
1805 " -t TAG Log using the specified tag (defaults to user name)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001806 " -p PRIO Enter the message with the specified priority.\n" \
1807 " This may be numerical or a 'facility.level' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001808#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001809 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001810
Robert Griebl1fca5582002-06-04 20:45:46 +00001811#define login_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001812 "[OPTION]... [username] [ENV=VAR ...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00001813#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001814 "Begin a new session on the system" \
1815 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001816 " -f Do not authenticate (user already authenticated)\n" \
1817 " -h Name of the remote host for this login\n" \
1818 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001819
Eric Andersen7e9276b2001-02-22 01:15:47 +00001820#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001821 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001822#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001823 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001824#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001825 "$ logname\n" \
1826 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001827
Mark Whitley6317c4b2001-03-12 22:51:50 +00001828#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001829 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001830#define logread_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001831 "Show the messages from syslogd (using circular buffer)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001832 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001833 " -f Output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001834
Matt Kraai83788da2002-03-20 17:38:37 +00001835#define losetup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001836 "[-o OFFSET] [-d] LOOPDEVICE [FILE]]"
Matt Kraai83788da2002-03-20 17:38:37 +00001837#define losetup_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001838 "(Dis)associate LOOPDEVICE with FILE, or display current associations" \
1839 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001840 " -d Disassociate LOOPDEVICE\n" \
1841 " -o OFFSET Start OFFSET bytes into FILE"
Rob Landley1d589b22005-11-29 23:47:10 +00001842#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001843 "No arguments will display all current associations.\n" \
1844 "One argument (losetup /dev/loop1) will display the current association\n" \
1845 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1846 "and filename of the file the loop device is currently bound to.\n\n" \
1847 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1848 "with an optional offset (-o 12345). Encryption is not yet supported.\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001849
Eric Andersen7e9276b2001-02-22 01:15:47 +00001850#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001851 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00001852 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001853 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
1854 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
1855 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
1856 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
1857 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
1858 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001859#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001860 "List directory contents" \
1861 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001862 "\n -1 List files in a single column" \
1863 "\n -A Do not list implied . and .." \
1864 "\n -a Do not hide entries starting with ." \
1865 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001866 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001867 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001868 USE_FEATURE_LS_COLOR( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001869 "\n --color[={always,never,auto}] Control coloring") \
1870 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001871 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001872 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001873 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001874 "\n -F Append indicator (one of */=@|) to entries") \
1875 "\n -i List the i-node for each file" \
1876 "\n -l Use a long listing format" \
1877 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001878 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001879 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001880 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko081ef792007-03-17 16:38:21 +00001881 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001882 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001883 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001884 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001885 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001886 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001887 "\n -S Sort the listing by file size") \
1888 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001889 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001890 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001891 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001892 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001893 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001894 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001895 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001896 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001897 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001898 "\n -w NUM Assume the terminal is NUM columns wide") \
1899 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001900 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001901 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001902 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001903 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001904 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001905 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001906 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001907 "\n -K Print security context in long format") \
1908 USE_SELINUX( \
1909 "\n -Z Print security context and permission")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001910
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001911#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001912 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001913#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001914 "List file attributes on an ext2 fs" \
1915 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001916 " -R Recursively list subdirectories\n" \
1917 " -a Do not hide entries starting with .\n" \
1918 " -d List directory entries instead of contents\n" \
1919 " -l Print long flag names\n" \
1920 " -v List the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001921
Eric Andersen7e9276b2001-02-22 01:15:47 +00001922#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001923 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001924#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001925 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001926
Eric Andersen3d925622005-06-09 10:16:02 +00001927#ifdef CONFIG_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001928#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001929 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001930#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001931 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001932 "TYPEs include:\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001933 " b: Make a block (buffered) device\n" \
1934 " c or u: Make a character (un-buffered) device\n" \
1935 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
1936 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001937 "FIRST specifies the number appended to NAME to create the first device.\n" \
1938 "LAST specifies the number of the last item that should be created\n" \
1939 "If 's' is the last argument, the base device is created as well.\n\n" \
1940 "For example:\n" \
1941 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
1942 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001943#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001944 "# makedevs /dev/ttyS c 4 66 2 63\n" \
1945 "[creates ttyS2-ttyS63]\n" \
1946 "# makedevs /dev/hda b 3 0 0 8 s\n" \
1947 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001948#endif
1949
1950#ifdef CONFIG_FEATURE_MAKEDEVS_TABLE
1951#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001952 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001953#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001954 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001955 "Device table entries take the form of:\n" \
1956 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001957 "Where name is the file name, type can be one of:\n" \
1958 " f A regular file\n" \
1959 " d Directory\n" \
1960 " c Character special device file\n" \
1961 " b Block special device file\n" \
1962 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001963 "uid is the user id for the target file, gid is the group id for the\n" \
1964 "target file. The rest of the entries (major, minor, etc) apply to\n" \
1965 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00001966#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001967 "For example:\n" \
1968 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1969 "/dev d 755 0 0 - - - - -\n" \
1970 "/dev/console c 666 0 0 5 1 - - -\n" \
1971 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1972 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1973 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1974 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1975 "Will Produce:\n" \
1976 "/dev\n" \
1977 "/dev/console\n" \
1978 "/dev/null\n" \
1979 "/dev/zero\n" \
1980 "/dev/hda\n" \
1981 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001982#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001983
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001984#define matchpathcon_trivial_usage \
1985 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
1986#define matchpathcon_full_usage \
1987 " -n Do not display path" \
1988 "\n -N Do not use translations" \
1989 "\n -f Use alternate file_context file" \
1990 "\n -p Use prefix to speed translations" \
1991 "\n -V Verify file context on disk matches defaults"
1992
Eric Andersen7e9276b2001-02-22 01:15:47 +00001993#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001994 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001995 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001996#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001997 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
1998 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001999 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002000 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002001 " -c Check MD5 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002002 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002003 " -s Don't output anything, status code shows success\n" \
2004 " -w Warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002005#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002006 "$ md5sum < busybox\n" \
2007 "6fd11e98b98a58f64ff3398d7b324003\n" \
2008 "$ md5sum busybox\n" \
2009 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2010 "$ md5sum -c -\n" \
2011 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2012 "busybox: OK\n" \
2013 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002014
Rob Landley70f7ef72005-12-13 08:21:33 +00002015#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002016 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002017#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002018 " -s Scan /sys and populate /dev during system boot\n\n" \
2019 "Called with no options (via hotplug) it uses environment variables\n" \
2020 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00002021#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002022 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002023 "The mdev config file contains lines that look like:\n" \
2024 " hd[a-z][0-9]* 0:3 660\n\n" \
2025 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002026 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002027 "Optionally, that can be followed (on the same line) by a special character\n" \
2028 "and a command line to run after creating/before deleting the corresponding\n" \
2029 "device(s). The environment variable $MDEV indicates the active device node\n" \
2030 "(which is useful if it's a regex match). For example:\n\n" \
2031 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2032 "The special characters are @ (run after creating), $ (run before deleting),\n" \
2033 "and * (run both after creating and before deleting). The commands run in\n" \
2034 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002035 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002036 "Config file parsing stops on the first matching line. If no config\n"\
2037 "entry is matched, devices are created with default 0:0 660. (Make\n"\
2038 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002039 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002040
Glenn L McGrath061c9002002-09-16 04:21:46 +00002041#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002042 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002043#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002044 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002045 " y Allow write access to your terminal\n" \
2046 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002047
Eric Andersen7e9276b2001-02-22 01:15:47 +00002048#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002049 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002050#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002051 "Create the DIRECTORY(ies) if they do not already exist" \
2052 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002053 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002054 " -p No error if existing, make parent directories as needed" \
2055 USE_SELINUX( \
2056 "\n -Z Set security context" \
2057 )
2058
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002059#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002060 "$ mkdir /tmp/foo\n" \
2061 "$ mkdir /tmp/foo\n" \
2062 "/tmp/foo: File exists\n" \
2063 "$ mkdir /tmp/foo/bar/baz\n" \
2064 "/tmp/foo/bar/baz: No such file or directory\n" \
2065 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002066
Mike Frysinger6447ac02005-06-11 05:29:40 +00002067#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002068 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2069 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2070 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2071 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2072 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2073 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002074#define mke2fs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002075 " -b size Block size in bytes\n" \
2076 " -c Check for bad blocks before creating\n" \
2077 " -E opts Set extended options\n" \
2078 " -f size Fragment size in bytes\n" \
2079 " -F Force (ignore sanity checks)\n" \
2080 " -g num Number of blocks in a block group\n" \
2081 " -i ratio The bytes/inode ratio\n" \
2082 " -j Create a journal (ext3)\n" \
2083 " -J opts Set journal options (size/device)\n" \
2084 " -l file Read bad blocks list from file\n" \
2085 " -L lbl Set the volume label\n" \
2086 " -m percent Percent of fs blocks to reserve for admin\n" \
2087 " -M dir Set last mounted directory\n" \
2088 " -n Do not actually create anything\n" \
2089 " -N num Number of inodes to create\n" \
2090 " -o os Set the 'creator os' field\n" \
2091 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002092 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002093 " -r rev Set filesystem revision\n" \
2094 " -S Write superblock and group descriptors only\n" \
2095 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002096 " -v Verbose"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002097
Eric Andersen7e9276b2001-02-22 01:15:47 +00002098#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002099 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002100#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002101 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002102 "\n\nOptions:\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002103 " -m Create the pipe using the specified mode (default a=rw)" \
2104 USE_SELINUX( \
2105 "\n -Z Set security context" \
2106 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002107
Eric Andersen7e9276b2001-02-22 01:15:47 +00002108#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002109 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002110#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002111 "Make a MINIX filesystem" \
2112 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002113 " -c Check the device for bad blocks\n" \
2114 " -n [14|30] Specify the maximum length of filenames\n" \
2115 " -i INODES Specify the number of inodes for the filesystem\n" \
2116 " -l FILENAME Read the bad blocks list from FILENAME\n" \
2117 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002118
Eric Andersen7e9276b2001-02-22 01:15:47 +00002119#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002120 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002121#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002122 "Create a special file (block, character, or pipe)" \
2123 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002124 " -m Create the special file using the specified mode (default a=rw)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002125 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002126 " b: Make a block (buffered) device\n" \
2127 " c or u: Make a character (un-buffered) device\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002128 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes" \
2129 USE_SELINUX( \
2130 "\n -Z Set security context" \
2131 )
2132
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002133#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002134 "$ mknod /dev/fd0 b 2 0\n" \
2135 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002136
Eric Andersen7e9276b2001-02-22 01:15:47 +00002137#define mkswap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002138 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002139#define mkswap_full_usage \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00002140 "Prepare a disk partition to be used as swap partition" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002141 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002142 " -c Check for read-ability\n" \
2143 " -v0 Make version 0 swap [max 128 Megs]\n" \
2144 " -v1 Make version 1 swap [big!] (default for kernels > 2.1.117)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002145 " block-count Number of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002146
Eric Andersen7e9276b2001-02-22 01:15:47 +00002147#define mktemp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002148 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002149#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002150 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002151 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2152 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002153 " -d Make a directory instead of a file\n" \
2154 " -q Fail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002155#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002156 "$ mktemp /tmp/temp.XXXXXX\n" \
2157 "/tmp/temp.mWiLjM\n" \
2158 "$ ls -la /tmp/temp.mWiLjM\n" \
2159 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002160
Eric Andersen8d79ce82001-07-22 23:00:15 +00002161#define modprobe_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002162 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002163#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002164 "Options:\n" \
2165 " -k Make module autoclean-able\n" \
2166 " -n Just show what would be done\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002167 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002168 " -r Remove module (stacks) or do autoclean\n" \
2169 " -s Report via syslog instead of stderr\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002170 " -v Verbose"
Rob Landley9c32a152005-12-11 20:12:24 +00002171#define modprobe_notes_usage \
2172"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2173"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2174"pass each module it loads.\n" \
2175"\n" \
2176"The configuration file is searched (in order) amongst:\n" \
2177"\n" \
2178" /etc/modprobe.conf (2.6 only)\n" \
2179" /etc/modules.conf\n" \
2180" /etc/conf.modules (deprecated)\n" \
2181"\n" \
2182"They all have the same syntax (see below). If none is present, it is\n" \
2183"_not_ an error; each loaded module is then expected to load without\n" \
2184"options. Once a file is found, the others are tested for.\n" \
2185"\n" \
2186"/etc/modules.conf entry format:\n" \
2187"\n" \
2188" alias <alias_name> <mod_name>\n" \
2189" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002190" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002191" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2192" This makes it also possible to use a different set of options (below) for\n" \
2193" the module and the alias.\n" \
2194" A module can be aliased more than once.\n" \
2195"\n" \
2196" options <mod_name|alias_name> <symbol=value ...>\n" \
2197" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2198" the \"symbol=value\" pairs as option to that module.\n" \
2199"\n" \
2200"Sample /etc/modules.conf file:\n" \
2201"\n" \
2202" options tulip irq=3\n" \
2203" alias tulip tulip2\n" \
2204" options tulip2 irq=4 io=0x308\n" \
2205"\n" \
2206"Other functionality offered by 'classic' modprobe is not available in\n" \
2207"this implementation.\n" \
2208"\n" \
2209"If module options are present both in the config file, and on the command line,\n" \
2210"then the options from the command line will be passed to the module _after_\n" \
2211"the options from the config file. That way, you can have defaults in the config\n" \
2212"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002213#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002214 "(with the above /etc/modules.conf):\n\n" \
2215 "$ modprobe tulip\n" \
2216 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2217 "$ modprobe tulip irq=5\n" \
2218 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2219 "$ modprobe tulip2\n" \
2220 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2221 " which are the default for alias 'tulip2'\n\n" \
2222 "$ modprobe tulip2 irq=8\n" \
2223 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2224 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2225 " from the command line\n\n" \
2226 "$ modprobe tulip2 irq=2 io=0x210\n" \
2227 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2228 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2229 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002230
Eric Andersen7e9276b2001-02-22 01:15:47 +00002231#define more_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002232 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002233#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002234 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002235#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002236 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002237
Eric Andersen7e9276b2001-02-22 01:15:47 +00002238#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002239 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002240#define mount_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002241 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2242 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002243 " -a Mount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002244 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002245 " -f \"Fake\" Add entry to mount table but don't mount it\n" \
2246 " -n Don't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002247 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002248 " -o option One of many filesystem options, listed below\n" \
2249 " -r Mount the filesystem read-only\n" \
2250 " -t fs-type Specify the filesystem type\n" \
2251 " -w Mount for reading and writing (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002252 "\n" \
2253 "Options for use with the \"-o\" flag:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002254 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002255 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002256 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002257 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002258 " [a]sync Writes are asynchronous / synchronous\n" \
2259 " [no]atime Disable / enable updates to inode access times\n" \
2260 " [no]diratime Disable / enable atime updates to directories\n" \
2261 " [no]dev Allow use of special device files / disallow them\n" \
2262 " [no]exec Allow use of executable files / disallow them\n" \
2263 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2264 " [r]shared Convert [recursively] to a shared subtree\n" \
2265 " [r]slave Convert [recursively] to a slave subtree\n" \
2266 " [r]private Convert [recursively] to a private subtree\n" \
2267 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2268 " bind Bind a directory to an additional location\n" \
2269 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002270 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002271 " remount Remount a mounted filesystem, changing its flags\n" \
2272 " ro/rw Mount for read-only / read-write\n" \
2273 "\n" \
2274 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002275 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002276#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002277 "$ mount\n" \
2278 "/dev/hda3 on / type minix (rw)\n" \
2279 "proc on /proc type proc (rw)\n" \
2280 "devpts on /dev/pts type devpts (rw)\n" \
2281 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2282 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2283 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002284#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002285 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002286
Rob Landleyd00b3a52005-08-20 05:07:08 +00002287#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002288 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002289#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002290 "mountpoint checks if the directory is a mountpoint" \
2291 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002292 " -q Quiet\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002293 " -d Print major/minor device number of the filesystem\n" \
2294 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002295#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002296 "$ mountpoint /proc\n" \
2297 "/proc is not a mountpoint\n" \
2298 "$ mountpoint /sys\n" \
2299 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002300
Eric Andersen7e9276b2001-02-22 01:15:47 +00002301#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002302 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002303#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002304 "Control magnetic tape drive operation\n" \
2305 "\nAvailable Opcodes:\n\n" \
2306 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2307 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2308 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2309 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002310
Eric Andersen7e9276b2001-02-22 01:15:47 +00002311#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002312 "[OPTION]... SOURCE DEST\n" \
2313 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002314#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002315 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2316 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002317 " -f Don't prompt before overwriting\n" \
2318 " -i Interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002319#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002320 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002321
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002322#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002323 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002324#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002325 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002326 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002327 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2328 " -s Use syslog (LOCAL0 facility)\n" \
2329 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002330#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002331 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2332 " or\n" \
2333 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002334
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002335#if !ENABLE_DESKTOP
2336
Rob Landley1cca9482006-07-10 19:45:20 +00002337#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002338#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002339#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002340#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002341#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002342
Eric Andersen7e9276b2001-02-22 01:15:47 +00002343#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002344 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002345 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002346#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002347 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002348 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002349 USE_NC_EXTRA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002350 "\n -e Exec rest of command line after connect" \
2351 "\n -i SECS Delay interval for lines sent" \
2352 "\n -w SECS Timeout for connect" \
Denis Vlasenko5d687242007-01-12 20:59:31 +00002353 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002354 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002355 USE_NC_SERVER( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002356 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002357 USE_NC_EXTRA( \
2358 "\n (use -l twice with -e for persistent server)") \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002359 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002360 )
2361
Rob Landley1cca9482006-07-10 19:45:20 +00002362#define nc_notes_usage "" \
2363 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002364 "To use netcat as a terminal emulator on a serial port:\n\n" \
2365 "$ stty 115200 -F /dev/ttyS0\n" \
2366 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2367 )
Rob Landley1cca9482006-07-10 19:45:20 +00002368
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002369#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002370 "$ nc foobar.somedomain.com 25\n" \
2371 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2372 "help\n" \
2373 "214-Commands supported:\n" \
2374 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2375 "214 NOOP QUIT RSET HELP\n" \
2376 "quit\n" \
2377 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002378
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002379#else /* DESKTOP nc - much more compatible with nc 1.10 */
2380
2381#define nc_trivial_usage \
2382 "[-options] hostname port - connect" \
2383 USE_NC_SERVER("\nnc [-options] -l -p port [hostname] [port] - listen")
2384#define nc_full_usage \
2385 USE_NC_SERVER( \
2386 "-l Listen mode, for inbound connects\n" \
2387 ) \
2388 "-n Do not do DNS resolution" \
2389 "\n-s addr Local address" \
2390 "\n-p port Local port" \
2391 "\n-u UDP mode" \
2392 "\n-v Verbose (cumulative: -vv)" \
2393 "\n-w secs Timeout for connects and final net reads" \
2394 USE_NC_EXTRA( \
2395 "\n-i sec Delay interval for lines sent" /* ", ports scanned" */ \
2396 "\n-o file Hex dump of traffic" \
2397 "\n-z Zero-I/O mode (scanning)" \
2398 ) \
2399 "\n-e prog [args] Program to exec after connect (must be last)" \
2400/* "\n-r Randomize local and remote ports" */
2401/* "\n-g gateway Source-routing hop point[s], up to 8" */
2402/* "\n-G num Source-routing pointer: 4, 8, 12, ..." */
2403/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2404
2405#endif
2406
2407
Eric Andersen1552ff72001-10-31 11:07:12 +00002408#define netstat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002409 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002410#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002411 "Display networking information" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002412 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002413 " -l Display listening server sockets\n" \
2414 " -a Display all sockets (default: connected)\n" \
2415 " -e Display other/more information\n" \
2416 " -n Don't resolve names\n" \
2417 " -r Display routing table\n" \
2418 " -t Tcp sockets\n" \
2419 " -u Udp sockets\n" \
2420 " -w Raw sockets\n" \
2421 " -x Unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00002422
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002423#define nice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002424 "[-n ADJUST] [COMMAND [ARG] ...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002425#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002426 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002427 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002428 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002429
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002430#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002431 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002432#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002433 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002434 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002435 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002436 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002437 "%[niface] Monitor network interface 'iface'\n" \
2438 "%m Monitor allocated memory\n" \
2439 "%[mf] Monitor free memory\n" \
2440 "%[mt] Monitor total memory\n" \
2441 "%s Monitor allocated swap\n" \
2442 "%f Monitor number of used file descriptors\n" \
2443 "%Ni Monitor total/specific IRQ rate\n" \
2444 "%x Monitor context switch rate\n" \
2445 "%p Monitor forks\n" \
2446 "%[pn] Monitor # of processes\n" \
2447 "%b Monitor block io\n" \
2448 "%Nt Show time (with N decimal points)\n" \
2449 "%Nd Milliseconds between updates (default=1000)\n" \
2450 "%r Print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002451#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002452 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002453
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002454#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002455 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002456#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002457 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002458#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002459 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002460
Eric Andersen7e9276b2001-02-22 01:15:47 +00002461#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002462 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002463#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002464 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002465 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002466#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002467 "$ nslookup localhost\n" \
2468 "Server: default\n" \
2469 "Address: default\n" \
2470 "\n" \
2471 "Name: debian\n" \
2472 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002473
Glenn L McGrath60281112001-11-02 11:39:46 +00002474#define od_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002475 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002476#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002477 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
2478 "to standard output. With no FILE, or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002479
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002480#define openvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002481 "<vtnum> <COMMAND> [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002482#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002483 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002484#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002485 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002486
Eric Andersen27f64e12002-06-23 04:24:25 +00002487#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002488 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002489#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002490 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002491 "changes the password for the current user." \
2492 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002493 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002494 " (choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002495 " -d Delete the password for the specified user account\n" \
2496 " -l Locks (disables) the specified user account\n" \
2497 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002498
Glenn L McGrath655d8142003-06-22 15:32:41 +00002499#define patch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002500 "[-p<num>] [-i <diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002501#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002502 " -p NUM Strip NUM leading components from file names\n" \
2503 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002504#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002505 "$ patch -p1 < example.diff\n" \
2506 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002507
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002508#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2509#define USAGE_PIDOF "Options:"
2510#else
Denis Vlasenko765996a2006-12-24 16:59:27 +00002511#define USAGE_PIDOF "\nThis version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002512#endif
2513
Eric Andersen221b2ea2001-07-31 19:06:07 +00002514#define pidof_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002515 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002516
Eric Andersen221b2ea2001-07-31 19:06:07 +00002517#define pidof_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002518 "List the PIDs of all processes with names that match the\n" \
2519 "names on the command line\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002520 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002521 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002522 "\n -s Display only a single PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002523 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002524 "\n -o Omit given pid") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002525 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002526 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002527#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002528 "$ pidof init\n" \
2529 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002530 USE_FEATURE_PIDOF_OMIT( \
2531 "$ pidof /bin/sh\n20351 5973 5950\n") \
2532 USE_FEATURE_PIDOF_OMIT( \
2533 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002534
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002535#ifndef CONFIG_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002536#define ping_trivial_usage \
2537 "host"
2538#define ping_full_usage \
2539 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002540#define ping6_trivial_usage \
2541 "host"
2542#define ping6_full_usage \
2543 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002544#else
2545#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002546 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002547#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002548 "Send ICMP ECHO_REQUEST packets to network hosts" \
2549 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002550 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2551 " -c CNT Send only CNT pings\n" \
2552 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2553 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002554 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002555 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002556#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002557 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002558#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002559 "Send ICMP ECHO_REQUEST packets to network hosts" \
2560 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002561 " -c CNT Send only CNT pings\n" \
2562 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2563 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002564 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002565 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002566#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002567#define ping_example_usage \
2568 "$ ping localhost\n" \
2569 "PING slag (127.0.0.1): 56 data bytes\n" \
2570 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2571 "\n" \
2572 "--- debian ping statistics ---\n" \
2573 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2574 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002575#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002576 "$ ping6 ip6-localhost\n" \
2577 "PING ip6-localhost (::1): 56 data bytes\n" \
2578 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2579 "\n" \
2580 "--- ip6-localhost ping statistics ---\n" \
2581 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2582 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002583
Eric Andersen7e9276b2001-02-22 01:15:47 +00002584#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002585 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002586#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002587 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002588 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002589
Eric Andersen7e9276b2001-02-22 01:15:47 +00002590#define poweroff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002591 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002592#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002593 "Halt and shut off power" \
2594 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002595 " -d Delay interval for halting\n" \
2596 " -n No call to sync()\n" \
2597 " -f Force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002598
Mike Frysinger95d3c452005-04-21 23:29:24 +00002599#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002600 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002601#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002602 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002603 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002604
Eric Andersen7e9276b2001-02-22 01:15:47 +00002605#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002606 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002607#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002608 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002609 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002610#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002611 "$ printf \"Val=%d\\n\" 5\n" \
2612 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002613
Denis Vlasenko94949192006-11-05 00:45:47 +00002614
2615#if ENABLE_DESKTOP
2616
2617#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002618 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002619#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002620 "Report process status" \
2621 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002622 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002623
2624#else /* !ENABLE_DESKTOP */
2625
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002626#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002627#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002628#else
2629#define USAGE_PS "\nOptions:"
2630#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002631
Eric Andersen7e9276b2001-02-22 01:15:47 +00002632#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002633 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002634#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002635 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002636 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002637 USE_SELINUX( \
Bernhard Reutner-Fischer26a80162007-03-14 08:52:28 +00002638 "\n -Z Show SE Linux context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002639 USE_FEATURE_PS_WIDE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002640 "\n w Wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002641
Denis Vlasenko94949192006-11-05 00:45:47 +00002642#endif /* ENABLE_DESKTOP */
2643
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002644#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002645 "$ ps\n" \
2646 " PID Uid Gid State Command\n" \
2647 " 1 root root S init\n" \
2648 " 2 root root S [kflushd]\n" \
2649 " 3 root root S [kupdate]\n" \
2650 " 4 root root S [kpiod]\n" \
2651 " 5 root root S [kswapd]\n" \
2652 " 742 andersen andersen S [bash]\n" \
2653 " 743 andersen andersen S -bash\n" \
2654 " 745 root root S [getty]\n" \
2655 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002656
Denis Vlasenko94949192006-11-05 00:45:47 +00002657
Eric Andersen7e9276b2001-02-22 01:15:47 +00002658#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002659 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002660#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002661 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002662#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002663 "$ pwd\n" \
2664 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002665
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002666#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002667 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002668#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002669 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002670#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002671 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002672
Eric Andersen7e9276b2001-02-22 01:15:47 +00002673#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002674 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002675#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002676 "Get and possibly set the system date and time from a remote HOST" \
2677 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002678 " -s Set the system date and time (default)\n" \
2679 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002680
Rob Landley0e4690d2006-08-20 22:12:18 +00002681#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002682 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002683#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002684 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2685 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00002686
Eric Andersen7e9276b2001-02-22 01:15:47 +00002687#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002688 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002689#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002690 "Display the value of a symlink" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002691 USE_FEATURE_READLINK_FOLLOW( \
2692 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002693 " -f Canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002694
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002695#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002696 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002697#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002698 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002699 " -m <mapfile> (Default: /boot/System.map)\n" \
2700 " -p <profile> (Default: /proc/profile)\n" \
2701 " -M <mult> Set the profiling multiplier to <mult>\n" \
2702 " -i Print only info about the sampling step\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002703 " -v Verbose\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002704 " -a Print all symbols, even if count is 0\n" \
2705 " -b Print individual histogram-bin counts\n" \
2706 " -s Print individual counters within functions\n" \
2707 " -r Reset all the counters (root only)\n" \
2708 " -n Disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002709
Glenn L McGrath62fae302002-12-10 00:14:33 +00002710#define realpath_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002711 "pathname ..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00002712#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002713 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00002714
Eric Andersen7e9276b2001-02-22 01:15:47 +00002715#define reboot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002716 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002717#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002718 "Reboot the system" \
2719 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002720 " -d Delay interval for rebooting\n" \
2721 " -n No call to sync()\n" \
2722 " -f Force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002723
2724#define renice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002725 "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002726#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002727 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002728 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002729 " -n Adjusts current nice value (smaller is faster)\n" \
2730 " -p Process id(s) (default)\n" \
2731 " -g Process group id(s)\n" \
2732 " -u Process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002733
Eric Andersen7e9276b2001-02-22 01:15:47 +00002734#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002735 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002736#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002737 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002738
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002739#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002740 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002741#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002742 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002743
Eric Andersen7e9276b2001-02-22 01:15:47 +00002744#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002745 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002746#define rm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002747 "Remove (unlink) the FILE(s). You may use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002748 "indicate that all following arguments are non-options." \
2749 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002750 " -i Always prompt before removing each destination\n" \
2751 " -f Remove existing destinations, never prompt\n" \
2752 " -r,-R Remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002753#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002754 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002755
Eric Andersen7e9276b2001-02-22 01:15:47 +00002756#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002757 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002758#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002759 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002760#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002761 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002762
Eric Andersen7e9276b2001-02-22 01:15:47 +00002763#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002764 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002765#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002766 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002767 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002768 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002769#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002770 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002771
Eric Andersen7e9276b2001-02-22 01:15:47 +00002772#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002773 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002774#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002775 "Edit the kernel's routing tables" \
2776 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002777 " -n Dont resolve names\n" \
2778 " -e Display other/more information\n" \
2779 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002780
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002781#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002782 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002783#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002784 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002785 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002786 "\n -i Install package" \
2787 "\n -q Query package" \
2788 "\n -p Query uninstalled package" \
2789 "\n -i Show information" \
2790 "\n -l List contents" \
2791 "\n -d List documents" \
2792 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002793
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002794#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002795 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002796#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002797 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002798
Denis Vlasenko49622d72007-03-10 16:58:49 +00002799#define runcon_trivial_usage \
2800 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
2801 " runcon CONTEXT COMMAND [args]"
2802#define runcon_full_usage \
2803 "runcon [-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
2804 "runcon CONTEXT COMMAND [args]\n" \
2805 "Run a program in a different security context\n\n" \
2806 " CONTEXT Complete security context\n" \
2807 " -c, --compute Compute process transition context before modifying\n" \
2808 " -t, --type=TYPE Type (for same role as parent)\n" \
2809 " -u, --user=USER User identity\n" \
2810 " -r, --role=ROLE Role\n" \
2811 " -l, --range=RNG Levelrange" \
2812
Eric Andersen6cf47a72001-10-31 10:24:36 +00002813#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00002814 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002815#define run_parts_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002816 "Run a bunch of scripts in a directory" \
2817 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002818 " -t Prints what would be run, but does not actually run anything\n" \
2819 " -a ARG Pass ARG as an argument for every program invoked\n" \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00002820 " -u MASK Set the umask to MASK before executing every program" \
2821USE_FEATURE_RUN_PARTS_FANCY("\n -l Prints names of all matching files even when they are not executable")
2822
2823#define run_parts_example_usage \
2824 "$ run-parts -a start /etc/init.d\n" \
2825 "$ run-parts -a stop=now /etc/init.d\n\n" \
2826 "Let's assume you have a script foo/dosomething:\n" \
2827 "#!/bin/sh\n" \
2828 "for i in $*; do eval $i; done ; unset i\n" \
2829 "case \"$1\" in\n" \
2830 "start*) echo starting something ;;\n" \
2831 "stop*) set -x ; shutdown -h $stop ;;\n" \
2832 "esac\n\n" \
2833 "Running this yields:\n" \
2834 "$run-parts -a stop=+4m foo/\n" \
2835 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002836
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002837#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002838 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002839#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002840 "Find the current and previous system runlevel.\n\n" \
2841 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002842 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002843#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002844 "$ runlevel /var/run/utmp\n" \
2845 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002846
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002847#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002848 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002849#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002850 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002851
2852#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002853 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002854#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002855 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002856
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002857#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002858 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002859#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002860 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002861#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002862 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002863
Eric Andersen7e9276b2001-02-22 01:15:47 +00002864#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002865 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002866#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002867 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002868 " -e script Add the script to the commands to be executed\n" \
2869 " -f scriptfile Add script-file contents to the\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002870 " commands to be executed\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002871 " -i Edit files in-place\n" \
2872 " -n Suppress automatic printing of pattern space\n" \
2873 " -r Use extended regular expression syntax\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002874 "\n" \
2875 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2876 "script to interpret. All remaining arguments are names of input files; if no\n" \
2877 "input files are specified, then the standard input is read. Source files\n" \
2878 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00002879
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002880#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002881 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2882 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002883
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002884#define selinuxenabled_trivial_usage
2885#define selinuxenabled_full_usage
2886
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002887#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002888 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002889#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002890 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002891 "FIRST, INCREMENT default to 1" \
2892 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002893 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002894 " FIRST LAST\n" \
2895 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002896
Paul Foxfc2256a2005-08-01 18:12:30 +00002897#define setconsole_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002898 "[-r|--reset] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00002899#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002900 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002901 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002902 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00002903
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002904#define setenforce_trivial_usage \
2905 "[ Enforcing | Permissive | 1 | 0 ]"
2906#define setenforce_full_usage
2907
Eric Andersen7e9276b2001-02-22 01:15:47 +00002908#define setkeycodes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002909 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002910#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002911 "Set entries into the kernel's scancode-to-keycode map,\n" \
2912 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2913 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
2914 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002915#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002916 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002917
Rob Landley87848d92006-03-27 23:23:43 +00002918#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002919 "N"
Rob Landley87848d92006-03-27 23:23:43 +00002920#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002921 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00002922
Paul Fox42403642005-08-01 22:52:09 +00002923#define setsid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002924 "program [arg ...]"
Paul Fox42403642005-08-01 22:52:09 +00002925#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002926 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002927 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00002928
Matt Kraai2d91deb2001-08-01 17:21:35 +00002929#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002930 "[FILE]...\n" \
2931 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002932#define lash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002933 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002934#define lash_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002935 "This command does not yet have proper documentation.\n\n" \
2936 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2937 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2938 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2939 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
2940 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2941 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002942
Eric Andersen2e9c2572003-08-08 22:26:06 +00002943#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002944 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00002945#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002946 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00002947
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002948#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002949 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002950 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002951#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002952 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002953 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002954 "\n\nOptions:\n" \
2955 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002956 " -c Check SHA1 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002957 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002958 " -s Don't output anything, status code shows success\n" \
2959 " -w Warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002960
Eric Andersen7e9276b2001-02-22 01:15:47 +00002961#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002962 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002963#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002964 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002965 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002966 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002967 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002968#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002969 "$ sleep 2\n" \
2970 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002971 USE_FEATURE_FANCY_SLEEP( \
2972 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002973 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002974
Eric Andersen7e9276b2001-02-22 01:15:47 +00002975#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002976 "[-nru" \
2977 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") \
2978 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002979#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002980 "Sort lines of text in the specified files" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002981 "\n\nOptions:\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002982 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002983 " -b Ignore leading blanks\n" \
2984 " -c Check whether input is sorted\n" \
2985 " -d Dictionary order (blank or alphanumeric only)\n" \
2986 " -f Ignore case\n" \
2987 " -g General numerical sort\n" \
2988 " -i Ignore unprintable characters\n" \
2989 " -k Specify sort key\n" \
2990 " -M Sort month\n") \
2991 " -n Sort numbers\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002992 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002993 " -o Output to file\n" \
2994 " -k Sort by key\n" \
2995 " -t Use key separator other than whitespace\n") \
2996 " -r Reverse sort order\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002997 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002998 " -s Stable (don't sort ties alphabetically)\n") \
2999 " -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003000 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003001 "\n -z Input terminated by nulls, not newlines\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003002 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003003 " -mST Ignored for GNU compatibility") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003004 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003005#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003006 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3007 "a\n" \
3008 "b\n" \
3009 "c\n" \
3010 "d\n" \
3011 "e\n" \
3012 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003013 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003014 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3015 "d 2\n" \
3016 "b 2\n" \
3017 "c 3\n" \
3018 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003019 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003020
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003021#define split_trivial_usage \
3022 "[OPTION] [INPUT [PREFIX]]"
3023#define split_full_usage \
3024 "Options:" \
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003025 "\n -b n[k|m] Split by bytes" \
3026 "\n -l n Split by lines" \
3027 "\n -a n Use n letters as suffix"
3028#define split_example_usage \
3029 "$ split TODO foo\n" \
3030 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003031
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003032#define start_stop_daemon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003033 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003034#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003035 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003036 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003037 "\n -S|--start Start" \
3038 "\n -K|--stop Stop" \
3039 "\n -a|--startas <pathname> Starts process specified by pathname" \
3040 "\n -b|--background Force process into background" \
3041 "\n -u|--user <username>|<uid> Stop this user's processes" \
3042 "\n -x|--exec <executable> Program to either start or check" \
3043 "\n -m|--make-pidfile Create the -p file and enter pid in it" \
3044 "\n -n|--name <process-name> Stop processes with this name" \
3045 "\n -p|--pidfile <pid-file> Save or load pid using a pid-file" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003046 "\n -q|--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003047 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003048 "\n -o|--oknodo Exit status 0 if nothing done" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003049 "\n -v|--verbose Verbose" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003050 "\n -N|--nicelevel <N> Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003051 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003052 "\n -s|--signal <signal> Signal to send (default TERM)" \
Denis Vlasenkocce38582007-02-26 22:47:42 +00003053 "\n -c|--chuid <user>[:[<group>]] Change to specified user/group"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003054
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003055#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003056 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003057#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003058 "Display file (default) or filesystem status" \
3059 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003060 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003061 " -c fmt Use the specified format\n") \
3062 " -f Display filesystem status\n" \
3063 " -L,-l Dereference links\n" \
3064 " -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003065 USE_SELINUX( \
3066 "\n -Z Print security context" \
3067 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003068 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003069 "\n\nValid format sequences for files:\n" \
3070 " %a Access rights in octal\n" \
3071 " %A Access rights in human readable form\n" \
3072 " %b Number of blocks allocated (see %B)\n" \
3073 " %B The size in bytes of each block reported by %b\n" \
3074 " %d Device number in decimal\n" \
3075 " %D Device number in hex\n" \
3076 " %f Raw mode in hex\n" \
3077 " %F File type\n" \
3078 " %g Group ID of owner\n" \
3079 " %G Group name of owner\n" \
3080 " %h Number of hard links\n" \
3081 " %i Inode number\n" \
3082 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003083 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003084 " %o I/O block size\n" \
3085 " %s Total size, in bytes\n" \
3086 " %t Major device type in hex\n" \
3087 " %T Minor device type in hex\n" \
3088 " %u User ID of owner\n" \
3089 " %U User name of owner\n" \
3090 " %x Time of last access\n" \
3091 " %X Time of last access as seconds since Epoch\n" \
3092 " %y Time of last modification\n" \
3093 " %Y Time of last modification as seconds since Epoch\n" \
3094 " %z Time of last change\n" \
3095 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003096 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003097 " %a Free blocks available to non-superuser\n" \
3098 " %b Total data blocks in file system\n" \
3099 " %c Total file nodes in file system\n" \
3100 " %d Free file nodes in file system\n" \
3101 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003102 USE_SELINUX( \
3103 " %C Security context in SELinux\n" \
3104 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003105 " %i File System ID in hex\n" \
3106 " %l Maximum length of filenames\n" \
3107 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003108 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003109 " %S Fundamental block size (for block counts)\n" \
3110 " %t Type in hex\n" \
3111 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003112 )
3113
Eric Andersenef5e8f82002-11-07 02:09:37 +00003114#define strings_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003115 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003116#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003117 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003118 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003119 "\n -a Scan the whole files (this is the default)" \
3120 "\n -f Precede each string with the name of the file where it was found" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003121 "\n -n N Specifies that at least N characters forms a sequence (default 4)" \
3122 "\n -o Each string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003123
Eric Andersen7e9276b2001-02-22 01:15:47 +00003124#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003125 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003126#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003127 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003128 "and deviations from stty sane" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003129 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003130 "\n -F DEVICE Open device instead of stdin" \
3131 "\n -a Print all current settings in human-readable form" \
3132 "\n -g Print in stty-readable form" \
3133 "\n [SETTING] See manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003134
Robert Griebl1fca5582002-06-04 20:45:46 +00003135#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003136 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003137#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003138 "Change user id or become root" \
3139 "\n\nOptions:" \
3140 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003141 "\n -c Command to pass to 'sh -c'" \
3142 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00003143
Eric Andersen27f64e12002-06-23 04:24:25 +00003144#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003145 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003146#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003147 "Single user login" \
3148 "\n\nOptions:" \
3149 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00003150
Mike Frysinger95d3c452005-04-21 23:29:24 +00003151#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003152 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003153#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003154 "Checksum and count the blocks in a file" \
3155 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003156 " -r Use BSD sum algorithm (1K blocks)\n" \
3157 " -s Use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003158
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003159#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003160 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003161#define sv_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003162 "Report the current status and control the state of services " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003163 "monitored by the runsv supervisor"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003164
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003165#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003166 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003167#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003168 "Continuously read log data from standard input, optionally " \
3169 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003170 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003171
Eric Andersen7e9276b2001-02-22 01:15:47 +00003172#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003173 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003174#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003175 "Stop swapping virtual memory pages on DEVICE" \
3176 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003177 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003178
Eric Andersen7e9276b2001-02-22 01:15:47 +00003179#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003180 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003181#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003182 "Start swapping virtual memory pages on DEVICE" \
3183 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003184 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003185
Rob Landley0f34a822005-10-27 22:55:50 +00003186#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003187 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003188#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003189 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003190 "and exec NEW_INIT" \
3191 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003192 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00003193
Eric Andersen7e9276b2001-02-22 01:15:47 +00003194#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003195 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003196#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003197 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003198
Eric Andersenb9050282003-12-24 06:02:11 +00003199#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003200 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003201#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003202 "Configure kernel parameters at runtime" \
3203 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003204 " -n Use this option to disable printing of the key name when printing values\n" \
3205 " -w Use this option when you want to change a sysctl setting\n" \
3206 " -p Load in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
3207 " -a Display all values currently available\n" \
3208 " -A Display all values currently available in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003209#define sysctl_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003210 "sysctl [-n] variable ...\n" \
3211 "sysctl [-n] -w variable=value ...\n" \
3212 "sysctl [-n] -a\n" \
3213 "sysctl [-n] -p <file> (default /etc/sysctl.conf)\n" \
3214 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003215
Eric Andersen7e9276b2001-02-22 01:15:47 +00003216#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003217 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003218#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003219 "System logging utility.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003220 "Note that this version of syslogd ignores /etc/syslog.conf." \
3221 "\n\nOptions:" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00003222 "\n -n Run as foreground process" \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003223 "\n -O FILE Use an alternate log file (default=/var/log/messages)" \
3224 "\n -l n Sets the local log level of messages to n" \
3225 "\n -S Make logging output smaller" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003226 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003227 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3228 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003229 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003230 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003231 "\n -L Log locally and via network logging (default is network only)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003232 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003233 "\n -C[size(KiB)] Log to a shared mem buffer (read the buffer using logread)")
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003234 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenko4998c812007-02-14 20:51:46 +00003235/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003236#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003237 "$ syslogd -R masterlog:514\n" \
3238 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003239
Eric Andersen7e9276b2001-02-22 01:15:47 +00003240#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003241 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003242#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003243 "Print last 10 lines of each FILE to standard output.\n" \
3244 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003245 "file name. With no FILE, or when FILE is -, read standard input." \
3246 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003247 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003248 "\n -c N[kbm] Output the last N bytes") \
3249 "\n -n N[kbm] Print last N lines instead of last 10" \
3250 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003251 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003252 "\n -q Never output headers giving file names" \
3253 "\n -s SEC Wait SEC seconds between reads with -f" \
3254 "\n -v Always output headers giving file names" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003255 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003256 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3257 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3258 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003259#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003260 "$ tail -n 1 /etc/resolv.conf\n" \
3261 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003262
Eric Andersen7e9276b2001-02-22 01:15:47 +00003263#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003264 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003265 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3266 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003267 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003268 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003269#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003270 "Create, extract, or list files from a tar file" \
3271 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003272 USE_FEATURE_TAR_CREATE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003273 " c Create\n") \
3274 " x Extract\n" \
3275 " t List\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003276 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003277 USE_FEATURE_TAR_GZIP( \
3278 " z Filter the archive through gzip\n") \
3279 USE_FEATURE_TAR_BZIP2( \
3280 " j Filter the archive through bzip2\n") \
3281 USE_FEATURE_TAR_LZMA( \
3282 " a Filter the archive through lzma\n") \
3283 USE_FEATURE_TAR_COMPRESS( \
3284 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003285 "\nFile selection:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003286 " f Name of TARFILE or \"-\" for stdin\n" \
3287 " O Extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003288 USE_FEATURE_TAR_FROM( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003289 " exclude File to exclude\n" \
3290 " X File with names to exclude\n") \
3291 " C Change to directory DIR before operation\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003292 " v Verbose"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003293#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003294 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3295 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003296
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003297#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003298 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003299#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003300 "Set or get CPU affinity" \
3301 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003302 " -p Operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003303#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003304 "$ taskset 0x7 ./dgemm_test&\n" \
3305 "$ taskset -p 0x1 $!\n" \
3306 "pid 4790's current affinity mask: 7\n" \
3307 "pid 4790's new affinity mask: 1\n" \
3308 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3309 "pid 6671's current affinity mask: 1\n" \
3310 "pid 6671's new affinity mask: 1\n" \
3311 "$ taskset -p 1\n" \
3312 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003313
Eric Andersen7e9276b2001-02-22 01:15:47 +00003314#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003315 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003316#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003317 "Copy standard input to each FILE, and also to standard output" \
3318 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003319 " -a Append to the given FILEs, do not overwrite\n" \
3320 " -i Ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003321#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003322 "$ echo \"Hello\" | tee /tmp/foo\n" \
3323 "$ cat /tmp/foo\n" \
3324 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003325
Eric Andersen539ffc92004-02-22 12:25:47 +00003326#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
3327#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003328 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003329#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003330 "Connect to remote telnet server" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003331 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003332 " -a Attempt an automatic login with the USER variable\n" \
3333 " -l USER Attempt an automatic login with the USER argument\n" \
3334 " HOST The official name, alias or the IP address of the\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00003335 " remote host\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003336 " PORT The remote port number to connect to. If it is not\n" \
3337 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003338#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003339#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003340 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003341#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003342 "Connect to remote telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003343#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003344
Eric Andersen08a72202002-09-30 20:52:10 +00003345#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003346 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003347#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003348 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003349 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3350 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003351 "\n -l LOGIN Exec LOGIN on connect" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003352 "\n -f issue_file Display issue_file instead of /etc/issue" \
3353 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003354 "\n -p PORT Port to listen to" \
3355 "\n -b ADDR Address to bind to" \
3356 "\n -F Stay in foreground" \
3357 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003358 )
Eric Andersen08a72202002-09-30 20:52:10 +00003359
Eric Andersen7e9276b2001-02-22 01:15:47 +00003360#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003361 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003362#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003363 "Check file types and compares values returning an exit code\n" \
3364 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003365#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003366 "$ test 1 -eq 2\n" \
3367 "$ echo $?\n" \
3368 "1\n" \
3369 "$ test 1 -eq 1\n" \
3370 "$ echo $?\n" \
3371 "0\n" \
3372 "$ [ -d /etc ]\n" \
3373 "$ echo $?\n" \
3374 "0\n" \
3375 "$ [ -d /junk ]\n" \
3376 "$ echo $?\n" \
3377 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003378
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003379#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003380 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003381/* with not-implemented options: */
3382/* "[-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 +00003383#define tcpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003384 "Creates TCP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003385 "for incoming connections. For each connection it runs prog." \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003386 "\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003387 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003388 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003389 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003390 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3391 "\n-u user[:group] Change to user/group after bind" \
3392 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003393 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003394 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3395 "\n New connections from this IP address are closed" \
3396 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003397 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003398 "\n-E Do not set up environment variables" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003399 "\n-v Verbose"
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003400
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003401#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003402 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003403#define udpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003404 "Creates UDP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003405 "for incoming packets. For each packet it runs prog\n" \
3406 "(redirecting all further packets with same peer ip:port to it)." \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003407 "\n" \
3408 "\nip IP to listen on. '0' = all" \
3409 "\nport Port to listen on" \
3410 "\nprog [arg] Program to run" \
3411 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3412 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003413 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003414 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003415 "\n-E Do not set up environment variables" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003416 "\n-v Verbose"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003417
Mark Whitley450736c2001-03-02 19:08:50 +00003418#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003419 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003420#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003421 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003422 "\n\nOptions:" \
3423 "\n -l FILE Local FILE" \
3424 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003425 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003426 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003427 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003428 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003429 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003430 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003431 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003432 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003433 )
Eric Andersenc3657422001-11-30 07:54:32 +00003434#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003435 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003436#define time_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003437 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003438 "COMMAND's resource usage information is displayed." \
3439 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003440 " -v Verbose"
Mark Whitley450736c2001-03-02 19:08:50 +00003441
Eric Andersen420b2082002-09-17 22:14:58 +00003442#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003443 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003444#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003445 "Provide a view of process activity in real time.\n" \
3446 "Read the status of all processes from /proc each <seconds>\n" \
3447 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003448
Eric Andersen7e9276b2001-02-22 01:15:47 +00003449#define touch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003450 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003451#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003452 "Update the last-modified date on the given FILE[s]" \
3453 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003454 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003455#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003456 "$ ls -l /tmp/foo\n" \
3457 "/bin/ls: /tmp/foo: No such file or directory\n" \
3458 "$ touch /tmp/foo\n" \
3459 "$ ls -l /tmp/foo\n" \
3460 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003461
3462#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003463 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003464#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003465 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003466 "standard input, writing to standard output" \
3467 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003468 " -c Take complement of STRING1\n" \
3469 " -d Delete input characters coded STRING1\n" \
3470 " -s Squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003471#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003472 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3473 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003474
Eric Andersen5c58d282001-07-10 16:29:00 +00003475#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003476 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3477 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3478 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003479#define traceroute_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003480 "Trace the route ip packets follow going to \"host\"" \
3481 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003482 " -F Set the don't fragment bit\n" \
3483 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3484 " -l Display the ttl value of the returned packet\n" \
3485 " -d Set SO_DEBUG options to socket\n" \
3486 " -n Print hop addresses numerically rather than symbolically\n" \
3487 " -r Bypass the normal routing tables and send directly to a host\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003488 " -v Verbose\n" \
3489 " -m max_ttl Max time-to-live (max number of hops)\n" \
3490 " -p port# Base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003491 " (default is 33434)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003492 " -q nqueries Number of probes per 'ttl' (default 3)\n" \
3493 " -s src_addr IP address to use as the source address\n" \
3494 " -t tos Type-of-service in probe packets (default 0)\n" \
3495 " -w wait Time in seconds to wait for a response to a probe\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003496 " (default 3 sec)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003497 " -g Specify a loose source route gateway (8 max)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003498
3499
Eric Andersen7e9276b2001-02-22 01:15:47 +00003500#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003501 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003502#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003503 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003504#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003505 "$ true\n" \
3506 "$ echo $?\n" \
3507 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003508
Eric Andersen7e9276b2001-02-22 01:15:47 +00003509#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003510 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003511#define tty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003512 "Print the file name of the terminal connected to standard input" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003513 USE_INCLUDE_SUSv2( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003514 "\n\nOptions:\n" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003515 " -s Print nothing, only return an exit status")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003516#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003517 "$ tty\n" \
3518 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003519
Mike Frysinger174808c2005-06-11 01:14:09 +00003520#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003521 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3522 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3523 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3524 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3525 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3526 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003527#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003528 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00003529
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003530#define udhcpc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003531 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003532#define udhcpc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003533 " -V,--vendorclass=CLASSID Set vendor class identifier\n" \
3534 " -i,--interface=INTERFACE Interface to use (default: eth0)\n" \
3535 " -H,-h,--hostname=HOSTNAME Client hostname\n" \
3536 " -c,--clientid=CLIENTID Set client identifier\n" \
3537 " -C,--clientid-none Suppress default client identifier\n" \
3538 " -p,--pidfile=file Store process ID of daemon in file\n" \
3539 " -r,--request=IP IP address to request (default: none)\n" \
3540 " -s,--script=file Run file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
3541 " -t,--retries=NUM Send up to NUM request packets\n"\
3542 " -f,--foreground Do not fork after getting lease\n" \
3543 " -b,--background Fork to background if lease cannot be immediately negotiated\n" \
3544 " -n,--now Exit with failure if lease cannot be immediately negotiated\n" \
3545 " -q,--quit Quit after obtaining lease\n" \
3546 " -R,--release Release IP on quit\n" \
3547 " -v,--version Display version" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003548
Russ Dill61fb4892002-10-14 21:41:28 +00003549#define udhcpd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003550 "[configfile]\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00003551
3552#define udhcpd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003553 ""
Russ Dill61fb4892002-10-14 21:41:28 +00003554
Eric Andersen7e9276b2001-02-22 01:15:47 +00003555#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003556 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003557#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003558 "Unmount file systems" \
3559 "\n\nOptions:\n" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00003560 USE_FEATURE_UMOUNT_ALL( \
3561 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab")) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003562 USE_FEATURE_MTAB_SUPPORT( \
3563 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003564 "\n -r Try to remount devices as read-only if mount is busy" \
3565 "\n -l Lazy umount (detach filesystem)" \
3566 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003567 USE_FEATURE_MOUNT_LOOP( \
3568 "\n -D Do not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003569#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003570 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003571
3572#define uname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003573 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003574#define uname_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003575 "Print certain system information. With no OPTION, same as -s." \
3576 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003577 " -a Print all information\n" \
3578 " -m The machine (hardware) type\n" \
3579 " -n Print the machine's network node hostname\n" \
3580 " -r Print the operating system release\n" \
3581 " -s Print the operating system name\n" \
3582 " -p Print the host processor type\n" \
3583 " -v Print the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003584#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003585 "$ uname -a\n" \
3586 "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 +00003587
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003588#define uncompress_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003589 "[-c] [-f] [ name ... ]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003590#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003591 "Uncompress .Z file[s]" \
3592 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003593 " -c Extract to stdout\n" \
3594 " -f Force overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003595
Eric Andersen7e9276b2001-02-22 01:15:47 +00003596#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003597 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003598#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003599 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003600 "(or standard input), writing to OUTPUT (or standard output)" \
3601 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003602 " -c Prefix lines by the number of occurrences\n" \
3603 " -d Only print duplicate lines\n" \
3604 " -u Only print unique lines\n" \
3605 " -f N Skip the first N fields\n" \
3606 " -s N Skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003607#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003608 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3609 "a\n" \
3610 "b\n" \
3611 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003612
3613#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003614 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003615#define unix2dos_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003616 "Convert FILE from unix format to dos format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003617 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003618 "When no file is given, use stdin/stdout." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003619 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003620 " -u Output will be in UNIX format\n" \
3621 " -d Output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003622
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003623#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003624 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003625#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003626 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003627 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003628 " -l List archive contents (short form)\n" \
3629 " -n Never overwrite existing files (default)\n" \
3630 " -o Overwrite files without prompting\n" \
3631 " -p Send output to stdout\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003632 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003633 " -x Exclude these files\n" \
3634 " -d Extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003635
Eric Andersen7e9276b2001-02-22 01:15:47 +00003636#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003637 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003638#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003639 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003640#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003641 "$ uptime\n" \
3642 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003643
3644#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003645 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003646#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003647 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003648#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003649 "$ usleep 1000000\n" \
3650 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003651
3652#define uudecode_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003653 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003654#define uudecode_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003655 "Uudecode a file" \
3656 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003657 " -o FILE Direct output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003658#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003659 "$ uudecode -o busybox busybox.uu\n" \
3660 "$ ls -l busybox\n" \
3661 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003662
3663#define uuencode_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003664 "[OPTION] [INFILE] REMOTEFILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003665#define uuencode_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003666 "Uuencode a file" \
3667 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003668 " -m Use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003669#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003670 "$ uuencode busybox busybox\n" \
3671 "begin 755 busybox\n" \
3672 "<encoded file snipped>\n" \
3673 "$ uudecode busybox busybox > busybox.uu\n" \
3674 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003675
Eric Andersen853c4942003-01-23 05:59:32 +00003676#define vconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003677 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003678#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003679 "Create and remove virtual ethernet devices" \
3680 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003681 " add [interface-name] [vlan_id]\n" \
3682 " rem [vlan-name]\n" \
3683 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
3684 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3685 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3686 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003687
Eric Andersen3f980402001-04-04 17:31:15 +00003688#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003689 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00003690#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003691 "Edit FILE" \
3692 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003693 " -R Read-only - do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003694
Eric Andersen27f64e12002-06-23 04:24:25 +00003695#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003696 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003697#define vlock_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003698 "Lock a virtual terminal. A password is required to unlock." \
3699 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003700 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00003701
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003702#define watch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003703 "[-n <seconds>] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003704#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003705 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003706 "\n\nOptions:\n" \
3707 " -n Loop period in seconds - default is 2\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003708 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003709#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003710 "$ watch date\n" \
3711 "Mon Dec 17 10:31:40 GMT 2000\n" \
3712 "Mon Dec 17 10:31:42 GMT 2000\n" \
3713 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003714
Eric Andersen7e9276b2001-02-22 01:15:47 +00003715#define watchdog_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003716 "[-t <seconds>] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003717#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003718 "Periodically write to watchdog device DEV" \
3719 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003720 " -t Timer period in seconds - default is 30\n" \
3721 " -F Stay in the foreground and don't fork"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003722
3723#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003724 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003725#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003726 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003727 "more than one FILE is specified. With no FILE, read standard input." \
3728 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003729 " -c Print the byte counts\n" \
3730 " -l Print the newline counts\n" \
3731 " -L Print the length of the longest line\n" \
3732 " -w Print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003733#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003734 "$ wc /etc/passwd\n" \
3735 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003736
3737#define wget_trivial_usage \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003738 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003739 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
3740 " [-U|--user-agent agent] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003741#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003742 "Retrieve files via HTTP or FTP" \
3743 "\n\nOptions:\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003744 " -s Spider mode - only check file existence\n" \
3745 " -c Continue retrieval of aborted transfer\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003746 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003747 " -P Set directory prefix to DIR\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003748 " -O Save to filename ('-' for stdout)\n" \
3749 " -U Adjust 'User-Agent' field\n" \
3750 " -Y Use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003751
3752#define which_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003753 "[COMMAND ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003754#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003755 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003756#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003757 "$ which login\n" \
3758 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003759
Eric Andersen00a6a752002-04-26 23:53:10 +00003760#define who_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003761 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003762#define who_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003763 "Print the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003764
3765#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003766 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003767#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003768 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003769
3770#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003771 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003772#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003773 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003774 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003775 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
3776 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003777 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003778 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
3779 " -x Exit if the size is exceeded\n") \
3780 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
3781 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003782 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003783#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003784 "$ ls | xargs gzip\n" \
3785 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003786
3787#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003788 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003789#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003790 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003791
Eric Andersen7e9276b2001-02-22 01:15:47 +00003792#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003793 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003794#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003795 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00003796
Rob Landleyad8071f2005-04-30 03:49:37 +00003797#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003798 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00003799#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003800 "Manage a ZeroConf IPv4 link-local address" \
3801 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003802 " -f Foreground mode\n" \
3803 " -q Quit after address (no daemon)\n" \
3804 " -r 169.254.x.x Request this address first\n" \
3805 " -v Verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00003806
Eric Andersen178de172004-04-06 16:36:20 +00003807#endif /* __BB_USAGE_H__ */