blob: e062c0c02af24c8ec7176e1d64345eee0ee3273a [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 Vlasenkob69e8722007-07-18 21:57:24 +000026 " -h DIR Home directory\n" \
27 " -g GECOS GECOS field\n" \
28 " -s SHELL Login shell\n" \
29 " -G GROUP Add user to existing group\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000030 " -S Create a system user (ignored)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000031 " -D Do not assign a password (logins still possible via ssh)\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +000032 " -H Do not create home directory"
Eric Andersenf349e972001-08-21 16:18:59 +000033
Mark Whitley6f932772001-03-20 19:18:10 +000034#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000035 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Mark Whitley6f932772001-03-20 19:18:10 +000036#define adjtimex_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +000037 "Read and optionally set system timebase parameters.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000038 "See adjtimex(2)." \
39 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +000040 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000041 " -o offset Time offset, microseconds\n" \
42 " -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +000043 " (positive values make the system clock run faster)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000044 " -t tick Microseconds per tick, usually 10000\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000045 " -p timeconstant"
Mark Whitley6f932772001-03-20 19:18:10 +000046
Eric Andersen7e9276b2001-02-22 01:15:47 +000047#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000048 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000049#define ar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +000050 "Extract or list FILES from an ar archive" \
51 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000052 " -o Preserve original dates\n" \
53 " -p Extract to stdout\n" \
54 " -t List\n" \
55 " -x Extract\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +000056 " -v Verbose"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +000057
Denis Vlasenkofa85b862007-01-07 01:24:12 +000058#define arp_trivial_usage \
59 "\n" \
60 "[-vn] [-H type] [-i if] -a [hostname]\n" \
61 "[-v] [-i if] -d hostname [pub]\n" \
62 "[-v] [-H type] [-i if] -s hostname hw_addr [temp]\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +000063 "[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub\n" \
Denis Vlasenkofa85b862007-01-07 01:24:12 +000064 "[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub\n"
65#define arp_full_usage \
66 "Manipulate the system ARP cache" \
67 "\n\nOptions:" \
68 "\n -a Display (all) hosts" \
69 "\n -s Set a new ARP entry" \
70 "\n -d Delete a specified entry" \
71 "\n -v Verbose" \
72 "\n -n Don't resolve names" \
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" \
Denis Vlasenkoea9e7982007-06-17 00:36:57 +000091 " -I device Outgoing interface name, default is eth0\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000092 " -s sender Set specific sender IP address\n" \
93 " target Target IP address of ARP request"
Glenn L McGrath9e598412003-01-09 10:06:01 +000094
Eric Andersen08f59e32004-03-12 22:07:10 +000095#define ash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000096 "[FILE]...\n" \
97 "or: ash -c command [args]..."
Eric Andersen08f59e32004-03-12 22:07:10 +000098#define ash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000099 "The ash shell (command interpreter)"
Eric Andersen08f59e32004-03-12 22:07:10 +0000100
101#define awk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000102 "[OPTION]... [program-text] [FILE ...]"
Eric Andersen08f59e32004-03-12 22:07:10 +0000103#define awk_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000104 "Options:\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000105 " -v var=val Set variable\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000106 " -F sep Use 'sep' as field separator\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000107 " -f filename Read program from file"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000108
Eric Andersen7e9276b2001-02-22 01:15:47 +0000109#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000110 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000111#define basename_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000112 "Strip directory path and suffixes from FILE.\n" \
113 "If specified, also remove any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000114#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000115 "$ basename /usr/local/bin/foo\n" \
116 "foo\n" \
117 "$ basename /usr/local/bin/\n" \
118 "bin\n" \
119 "$ basename /foo/bar.txt .txt\n" \
120 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000121
Glenn L McGrath24e28332001-10-05 03:48:57 +0000122#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000123 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000124#define bunzip2_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000125 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
126 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000127 " -c Write output to standard output\n" \
128 " -f Force"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000129
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:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000164 "\n -u Use unbuffered i/o (ignored)"
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:" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000224 "\n -R Recurse directories" \
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 Vlasenkob69e8722007-07-18 21:57:24 +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" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000338 " -o n Limit the number of open file descriptors per process to n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000339 " -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 \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000409 "[OPTION]... [prio] [pid | command [arg]...]"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000410#define chrt_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000411 "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"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000418
419#define chrt_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +0000420 "$ 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"
Bernhard Reutner-Fischer71bc71a2007-03-09 16:56:38 +0000423
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 Vlasenko21d10142007-07-20 21:28:41 +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 Vlasenko21d10142007-07-20 21:28:41 +0000469 " file [opts] Replace crontab from file\n" \
470 " - [opts] Replace crontab from stdin\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000471 " -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
Denis Vlasenko7e84e532007-05-08 17:52:17 +0000477#define cryptpw_trivial_usage \
478 "[-a des|md5] [string]"
479#define cryptpw_full_usage \
480 "Outputs crypted string.\n" \
481 "If string isn't supplied on cmdline, reads it from stdin.\n" \
482 "\nOptions:" \
483 "\n -a Algorithm to use (default: md5)"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000484
Eric Andersen7e9276b2001-02-22 01:15:47 +0000485#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000486 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000487#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000488 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000489 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000490 " -b LIST Output only bytes from LIST\n" \
491 " -c LIST Output only characters from LIST\n" \
492 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
493 " -s Output only the lines containing delimiter\n" \
494 " -f N Print only these fields\n" \
495 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000496#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000497 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
498 "Hello\n" \
499 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
500 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000501
Eric Andersen7e9276b2001-02-22 01:15:47 +0000502#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000503 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000504#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000505 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000506 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000507 " -R Outputs RFC-822 compliant date string\n" \
508 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000509 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000510 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
511 " TIMESPEC='date' (or missing) for date only,\n" \
512 " 'hours', 'minutes', or 'seconds' for date and,\n" \
513 " time to the indicated precision\n" \
514 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000515 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000516 " -s Sets time described by STRING\n" \
517 " -r FILE Displays the last modification time of FILE\n" \
518 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000519#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000520 "$ date\n" \
521 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000522
Eric Andersen7e9276b2001-02-22 01:15:47 +0000523#define dc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000524 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000525#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000526 "This is a Tiny RPN calculator that understands the\n" \
527 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
528 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000529 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
530 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000531 "p - Prints the value on the top of the stack, without altering the stack\n" \
532 "f - Prints the entire contents of the stack without altering anything\n" \
533 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
534 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000535#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000536 "$ dc 2 2 + p\n" \
537 "4\n" \
538 "$ dc 8 8 \\* 2 2 + / p\n" \
539 "16\n" \
540 "$ dc 0 1 and p\n" \
541 "0\n" \
542 "$ dc 0 1 or p\n" \
543 "1\n" \
544 "$ echo 72 9 div 8 mul p | dc\n" \
545 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000546
Eric Andersen7e9276b2001-02-22 01:15:47 +0000547#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000548 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000549 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000550#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000551 "Copy a file with converting and formatting" \
552 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000553 " if=FILE Read from FILE instead of stdin\n" \
554 " of=FILE Write to FILE instead of stdout\n" \
555 " bs=N Read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000556 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000557 " ibs=N Read N bytes at a time\n") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000558 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000559 " obs=N Write N bytes at a time\n") \
560 " count=N Copy only N input blocks\n" \
561 " skip=N Skip N input blocks\n" \
562 " seek=N Skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000563 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000564 " conv=notrunc Don't truncate output file\n" \
565 " conv=noerror Continue after read errors\n" \
566 " conv=sync Pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000567 "\n" \
568 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
569 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000570#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000571 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
572 "4+0 records in\n" \
573 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000574
Eric Andersen7e9276b2001-02-22 01:15:47 +0000575#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000576 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000577#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000578 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000579
Eric Andersenf349e972001-08-21 16:18:59 +0000580#define delgroup_trivial_usage \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000581 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000582#define delgroup_full_usage \
Denis Vlasenkobe1a9d42007-04-15 08:43:23 +0000583 "Delete group GROUP from the system" \
Denis Vlasenko4b924f32007-05-30 00:29:55 +0000584 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
Eric Andersenf349e972001-08-21 16:18:59 +0000585
586#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000587 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000588#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000589 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000590
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000591#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000592 "mntpnt [-v]" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000593 USE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000594#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000595 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000596 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000597 "\n mntpnt The mount point where devfs is mounted" \
598 "\n -v Print the protocol version numbers for devfsd" \
599 "\n and the kernel-side protocol version and exits" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000600 USE_DEVFSD_FG_NP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000601 "\n -fg Run the daemon in the foreground" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000602 "\n -np Exit after parsing the configuration file" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000603 "\n and processing synthetic REGISTER events," \
604 "\n do not poll for events")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000605
Eric Andersen7e9276b2001-02-22 01:15:47 +0000606#define df_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000607 "[-" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000608#define df_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000609 "Print the filesystem space used and space available" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000610 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko08294db2007-08-13 12:27:49 +0000611 "\n\nOptions control size display:" \
612 "\n -h Human readable (e.g. 1K 243M 2G)" \
613 "\n -m 1024*1024 blocks" \
614 "\n -k 1024 blocks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000615 SKIP_FEATURE_HUMAN_READABLE( \
Denis Vlasenko08294db2007-08-13 12:27:49 +0000616 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000617 "\n -k Ignored")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000618#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000619 "$ df\n" \
620 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
621 "/dev/sda3 8690864 8553540 137324 98% /\n" \
622 "/dev/sda1 64216 36364 27852 57% /boot\n" \
623 "$ df /dev/sda3\n" \
624 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
625 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000626
Denis Vlasenko736230e2006-11-20 19:40:36 +0000627#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000628 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000629#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000630 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000631
632#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000633 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000634#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000635 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000636
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000637#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000638 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000639#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000640 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000641 "This diff implementation only supports unified diffs." \
642 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000643 " -a Treat all files as text\n" \
644 " -b Ignore changes in the amount of whitespace\n" \
645 " -d Try hard to find a smaller set of changes\n" \
646 " -i Ignore case differences\n" \
647 " -L Use LABEL instead of the filename in the unified header\n" \
648 " -N Treat absent files as empty\n" \
649 " -q Output only whether files differ\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +0000650 " -r Recursively compare subdirectories\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000651 " -S Start with FILE when comparing directories\n" \
652 " -T Make tabs line up by prefixing a tab when necessary\n" \
653 " -s Report when two files are the same\n" \
654 " -t Expand tabs to spaces in output\n" \
655 " -U Output LINES lines of context\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000656 " -w Ignore all whitespace"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000657
Eric Andersen7e9276b2001-02-22 01:15:47 +0000658#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000659 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000660#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000661 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000662#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000663 "$ dirname /tmp/foo\n" \
664 "/tmp\n" \
665 "$ dirname /tmp/foo/\n" \
666 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000667
Eric Andersen7e9276b2001-02-22 01:15:47 +0000668#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000669 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000670#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000671 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000672 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000673 " -c Clears the ring buffer's contents after printing\n" \
674 " -n LEVEL Sets console logging level\n" \
675 " -s SIZE Use a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000676
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000677#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000678 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000679#define dnsd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000680 "Small and static DNS server daemon" \
681 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000682 " -c Config filename\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000683 " -t TTL in seconds\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000684 " -p Listening port\n" \
Denis Vlasenkod3bac032007-03-24 12:13:04 +0000685 " -i Listening ip (default all)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000686 " -d Daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000687
Eric Andersen7e9276b2001-02-22 01:15:47 +0000688#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000689 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000690#define dos2unix_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000691 "Convert FILE from dos format to unix format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000692 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000693 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000694 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000695 " -u Output will be in UNIX format\n" \
696 " -d Output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000697
Eric Andersen7e9276b2001-02-22 01:15:47 +0000698#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000699 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000700#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000701 "Install, remove and manage Debian packages" \
702 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000703 " -i Install the package\n" \
704 " -l List of installed packages\n" \
705 " -C Configure an unpackaged package\n" \
706 " -F depends Ignore dependency problems\n" \
707 " -P Purge all files of a package\n" \
708 " -r Remove all but the configuration files for a package\n" \
709 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000710
Eric Andersen7e9276b2001-02-22 01:15:47 +0000711#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000712 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000713#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000714 "Perform actions on Debian packages (.debs)" \
715 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000716 " -c List contents of filesystem tree\n" \
717 " -e Extract control files to [argument] directory\n" \
718 " -f Display control field name starting with [argument]\n" \
719 " -x Extract packages filesystem tree to directory\n" \
720 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000721#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000722 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000723
Eric Andersen7e9276b2001-02-22 01:15:47 +0000724#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000725 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000726#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000727 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000728 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000729 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
730 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000731 " bytes." \
732 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000733 " -a Show sizes of files in addition to directories\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +0000734 " -H Follow symlinks that are FILE command line args\n" \
735 " -L Follow all symlinks encountered\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000736 " -d N Limit output to directories (and files with -a) of depth < N\n" \
737 " -c Output a grand total\n" \
738 " -l Count sizes many times if hard linked\n" \
739 " -s Display only a total for each argument\n" \
740 " -x Skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000741 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000742 " -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
743 " -m Print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000744 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000745 " -k Print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000746 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000747#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000748 "$ du\n" \
749 "16 ./CVS\n" \
750 "12 ./kernel-patches/CVS\n" \
751 "80 ./kernel-patches\n" \
752 "12 ./tests/CVS\n" \
753 "36 ./tests\n" \
754 "12 ./scripts/CVS\n" \
755 "16 ./scripts\n" \
756 "12 ./docs/CVS\n" \
757 "104 ./docs\n" \
758 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000759
Eric Andersen7e9276b2001-02-22 01:15:47 +0000760#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000761 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000762#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000763 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000764#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000765 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000766
Russ Dill61fb4892002-10-14 21:41:28 +0000767#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000768 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000769#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000770 "Display DHCP leases granted by udhcpd" \
771 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000772 " -f, --file=FILENAME Leases file to load\n" \
773 " -r, --remaining Interpret lease times as time remaining\n" \
774 " -a, --absolute Interpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000775
Mike Frysinger51a43b42005-09-24 07:11:16 +0000776#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000777 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
778 "[-I inode_buffer_blocks] [-P process_inode_size] " \
779 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
780 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000781#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000782 "Check ext2/ext3 file system" \
783 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000784 " -p Automatic repair (no questions)\n" \
785 " -n Make no changes to the filesystem\n" \
786 " -y Assume 'yes' to all questions\n" \
787 " -c Check for bad blocks and add them to the badblock list\n" \
788 " -f Force checking even if filesystem is marked clean\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +0000789 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000790 " -b superblock Use alternative superblock\n" \
791 " -B blocksize Force blocksize when looking for superblock\n" \
792 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000793 " -l file Add to badblocks list\n" \
794 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000795
Eric Andersen7e9276b2001-02-22 01:15:47 +0000796#define echo_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000797 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000798#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000799 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000800 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000801 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000802 " -n Suppress trailing newline\n" \
803 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
804 " -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000805 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000806#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000807 "$ echo \"Erik is cool\"\n" \
808 "Erik is cool\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000809 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000810 "Erik\n" \
811 "is\n" \
812 "cool\n" \
813 "$ echo \"Erik\\nis\\ncool\"\n" \
814 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000815
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000816#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000817 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000818#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000819 "Eject specified DEVICE (or default /dev/cdrom)" \
820 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000821 " -t Close tray\n" \
822 " -T Open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000823
Rob Landley3b890392006-05-04 20:56:43 +0000824#define ed_trivial_usage ""
825#define ed_full_usage ""
826
Eric Andersen84e229c2001-03-29 22:48:33 +0000827#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000828 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000829#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000830 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000831 "up the specified environment" \
832 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000833 " -, -i Start with an empty environment\n" \
834 " -u Remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000835
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000836#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000837 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000838#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000839 "Send a magic packet to wake up sleeping machines.\n" \
840 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000841 "a hostname with a known 'ethers' entry." \
842 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000843 " -b Send wake-up packet to the broadcast address\n" \
844 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000845 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000846
Denis Vlasenko3952f202007-08-13 14:10:24 +0000847#define expand_trivial_usage \
848 "[-i] [-t NUM] [FILE|-]"
849#define expand_full_usage \
850 "Convert tabs to spaces, writing to standard output." \
851 "\n\nOptions:" \
852 "\n -i" USE_FEATURE_EXPAND_LONG_OPTIONS(",--initial") \
853 " Do not convert tabs after non blanks" \
854 "\n -t" USE_FEATURE_EXPAND_LONG_OPTIONS(",--tabs=N") \
855 " Tabstops every N chars"
856
Eric Andersen7e9276b2001-02-22 01:15:47 +0000857#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000858 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000859#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000860 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000861 "EXPRESSION may be:\n" \
862 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
863 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
864 " ARG1 < ARG2 ARG1 is less than ARG2\n" \
865 " ARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
866 " ARG1 = ARG2 ARG1 is equal to ARG2\n" \
867 " ARG1 != ARG2 ARG1 is unequal to ARG2\n" \
868 " ARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
869 " ARG1 > ARG2 ARG1 is greater than ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000870 " ARG1 + ARG2 Sum of ARG1 and ARG2\n" \
871 " ARG1 - ARG2 Difference of ARG1 and ARG2\n" \
872 " ARG1 * ARG2 Product of ARG1 and ARG2\n" \
873 " ARG1 / ARG2 Quotient of ARG1 divided by ARG2\n" \
874 " ARG1 % ARG2 Remainder of ARG1 divided by ARG2\n" \
875 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
876 " match STRING REGEXP Same as STRING : REGEXP\n" \
877 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
878 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
879 " length STRING Length of STRING\n" \
880 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000881 " it is a keyword like 'match' or an\n" \
882 " operator like '/'\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000883 " (EXPRESSION) Value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000884 "Beware that many operators need to be escaped or quoted for shells.\n" \
885 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000886 "lexicographical. Pattern matches return the string matched between\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000887 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
888 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000889
Mike Frysingerfa69f112005-04-17 07:24:19 +0000890#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000891 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000892#define fakeidentd_full_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000893 "Provide fake ident (auth) service" \
894 "\n\nOptions:" \
895 "\n -f Run in foreground" \
896 "\n -i Inetd mode" \
897 "\n -w Inetd 'wait' mode" \
898 "\n -b ADDR Bind to specified address" \
899 "\n STRING Ident answer string (default is 'nobody')"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000900
Eric Andersen7e9276b2001-02-22 01:15:47 +0000901#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000902 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000903#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000904 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000905#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000906 "$ false\n" \
907 "$ echo $?\n" \
908 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000909
910#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000911 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000912#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000913 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000914#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000915 "$ fbset\n" \
916 "mode \"1024x768-76\"\n" \
917 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
918 " geometry 1024 768 1024 768 16\n" \
919 " timings 12714 128 32 16 4 128 4\n" \
920 " accel false\n" \
921 " rgba 5/11,6/5,5/0,0/0\n" \
922 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000923
Eric Andersen7e9276b2001-02-22 01:15:47 +0000924#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000925 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000926#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000927 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000928
Eric Andersen01c3d402003-07-05 07:51:31 +0000929#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000930 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +0000931#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000932 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000933 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000934 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +0000935
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000936#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000937 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000938#define fdisk_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000939 "Change partition table" \
940 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000941 " -l List partition table(s)\n" \
942 " -u Give Start and End in sector (instead of cylinder) units\n" \
943 " -s PARTITION Give partition size(s) in blocks\n" \
944 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
945 " -C CYLINDERS Set the number of cylinders\n" \
946 " -H HEADS Set the number of heads\n" \
947 " -S SECTORS Set the number of sectors\n" \
948 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000949
Eric Andersen7e9276b2001-02-22 01:15:47 +0000950#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000951 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000952#define find_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +0000953 "Search for files in a directory hierarchy. The default PATH is\n" \
Denis Vlasenkod786cc52007-06-15 21:17:21 +0000954 "the current directory, default EXPRESSION is '-print'\n" \
955 "\nEXPRESSION may consist of:" \
956 "\n -follow Dereference symlinks" \
Denis Vlasenkob9411292007-06-15 23:43:11 +0000957 USE_FEATURE_FIND_XDEV( \
958 "\n -xdev Don't descend directories on other filesystems") \
959 USE_FEATURE_FIND_MAXDEPTH( \
960 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
961 "\n tests/actions to command line arguments only") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +0000962 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
963 USE_FEATURE_FIND_PATH( \
964 "\n -path PATTERN Path matches PATTERN") \
965 USE_FEATURE_FIND_REGEX( \
966 "\n -regex PATTERN Path matches regex PATTERN") \
Denis Vlasenkob9411292007-06-15 23:43:11 +0000967 USE_FEATURE_FIND_TYPE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +0000968 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
Denis Vlasenkob9411292007-06-15 23:43:11 +0000969 USE_FEATURE_FIND_PERM( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +0000970 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +0000971 "\n or exactly (NNN)") \
972 USE_FEATURE_FIND_MTIME( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +0000973 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +0000974 "\n or exactly (N) days") \
975 USE_FEATURE_FIND_MMIN( \
Denis Vlasenkod786cc52007-06-15 21:17:21 +0000976 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
Denis Vlasenkob9411292007-06-15 23:43:11 +0000977 "\n or exactly (N) minutes") \
978 USE_FEATURE_FIND_NEWER( \
979 "\n -newer FILE Modified time is more recent than FILE's") \
980 USE_FEATURE_FIND_INUM( \
981 "\n -inum N File has inode number N") \
Denis Vlasenkob9411292007-06-15 23:43:11 +0000982 USE_FEATURE_FIND_USER( \
983 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
984 USE_FEATURE_FIND_GROUP( \
985 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
986 USE_FEATURE_FIND_DEPTH( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +0000987 "\n -depth Process directory name after traversing it") \
Denis Vlasenkob9411292007-06-15 23:43:11 +0000988 USE_FEATURE_FIND_SIZE( \
Denis Vlasenko53a0e972007-06-16 00:30:52 +0000989 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
990 "\n +/-N: file size is bigger/smaller than N") \
991 "\n -print Print (default and assumed)" \
992 USE_FEATURE_FIND_PRINT0( \
993 "\n -print0 Delimit output with null characters rather than" \
994 "\n newlines") \
Denis Vlasenkoa19faf82007-06-19 22:22:57 +0000995 USE_FEATURE_FIND_CONTEXT ( \
996 "\n -context File has specified security context") \
Denis Vlasenko53a0e972007-06-16 00:30:52 +0000997 USE_FEATURE_FIND_EXEC( \
998 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
999 "\n matching files") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001000 USE_FEATURE_FIND_PRUNE( \
1001 "\n -prune Stop traversing current subtree") \
1002 USE_FEATURE_FIND_DELETE( \
1003 "\n -delete Delete files, turns on -depth option") \
Denis Vlasenkob9411292007-06-15 23:43:11 +00001004 USE_FEATURE_FIND_PAREN( \
1005 "\n (EXPR) Group an expression") \
Rob Landley5d3a0e82005-10-04 03:34:39 +00001006
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001007#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001008 "$ find / -name passwd\n" \
1009 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001010
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001011#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001012 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001013#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001014 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001015 "standard output" \
1016 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001017 " -b Count bytes rather than columns\n" \
1018 " -s Break at spaces\n" \
1019 " -w Use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +00001020
Eric Andersen7e9276b2001-02-22 01:15:47 +00001021#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001022 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001023#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001024 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001025#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001026 "$ free\n" \
1027 " total used free shared buffers\n" \
1028 " Mem: 257628 248724 8904 59644 93124\n" \
1029 " Swap: 128516 8404 120112\n" \
1030 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001031
Eric Andersen7e9276b2001-02-22 01:15:47 +00001032#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001033 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001034#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001035 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001036#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001037 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001038
Mike Frysinger51a43b42005-09-24 07:11:16 +00001039#define fsck_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001040 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys ...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001041#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001042 "Check and repair filesystems" \
1043 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001044 " -A Walk /etc/fstab and check all filesystems\n" \
1045 " -N Don't execute, just show what would be done\n" \
1046 " -P When using -A, check filesystems in parallel\n" \
1047 " -R When using -A, skip the root filesystem\n" \
1048 " -T Don't show title on startup\n" \
Denis Vlasenko0de93752006-12-26 02:51:29 +00001049 " -V Verbose\n" \
1050 " -C n Write status information to specified filedescriptor\n" \
1051 " -t type List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +00001052
Eric Andersen7e9276b2001-02-22 01:15:47 +00001053#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001054 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001055#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001056 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001057 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001058 " -l Lists all filenames\n" \
1059 " -r Perform interactive repairs\n" \
1060 " -a Perform automatic repairs\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001061 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001062 " -s Outputs super-block information\n" \
1063 " -m Activates MINIX-like \"mode not cleared\" warnings\n" \
1064 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001065
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001066#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001067 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001068#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001069 "Retrieve a remote file via FTP" \
1070 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001071 " -c, --continue Continue a previous transfer\n" \
1072 " -v, --verbose Verbose\n" \
1073 " -u, --username Username to be used\n" \
1074 " -p, --password Password to be used\n" \
1075 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001076
1077#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001078 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001079#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001080 "Store a local file on a remote machine via FTP" \
1081 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001082 " -v, --verbose Verbose\n" \
1083 " -u, --username Username to be used\n" \
1084 " -p, --password Password to be used\n" \
1085 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001086
Rob Landleyaa872762005-10-28 13:05:12 +00001087#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001088 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +00001089#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001090 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001091 " -m Show all processes on the same mounted fs\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001092 " -k Kill all processes that match\n" \
1093 " -s Don't print or kill anything\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001094 " -4 When using port/proto only search IPv4 space\n" \
1095 " -6 When using port/proto only search IPv6 space\n" \
1096 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001097
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001098#define getenforce_trivial_usage
1099#define getenforce_full_usage
1100
Eric Andersen7e9276b2001-02-22 01:15:47 +00001101#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001102 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001103#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001104 "Parse command options\n" \
1105 " -a, --alternative Allow long options starting with single -\n" \
1106 " -l, --longoptions=longopts Long options to be recognized\n" \
1107 " -n, --name=progname The name under which errors are reported\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001108 " -o, --options=optstring Short options to be recognized\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001109 " -q, --quiet Disable error reporting by getopt(3)\n" \
1110 " -Q, --quiet-output No normal output\n" \
1111 " -s, --shell=shell Set shell quoting conventions\n" \
1112 " -T, --test Test for getopt(1) version\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001113 " -u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001114#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001115 "$ cat getopt.test\n" \
1116 "#!/bin/sh\n" \
1117 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1118 " -n 'example.busybox' -- \"$@\"`\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001119 "if [ $? != 0 ]; then exit 1; fi\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001120 "eval set -- \"$GETOPT\"\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001121 "while true; do\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001122 " case $1 in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001123 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1124 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001125 " -c|--c-long)\n" \
1126 " case \"$2\" in\n" \
Denis Vlasenkob71c6682007-07-21 15:08:09 +00001127 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1128 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1129 " esac;;\n" \
1130 " --) shift; break;;\n" \
1131 " *) echo \"Internal error!\"; exit 1;;\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001132 " esac\n" \
1133 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001134
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001135#define getsebool_trivial_usage \
1136 "-a or getsebool boolean..."
1137#define getsebool_full_usage \
1138 " -a Show all SELinux booleans"
1139
Eric Andersenf349e972001-08-21 16:18:59 +00001140#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001141 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001142#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001143 "Open a tty, prompt for a login name, then invoke /bin/login" \
1144 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001145 " -h Enable hardware (RTS/CTS) flow control\n" \
1146 " -i Do not display /etc/issue before running login\n" \
1147 " -L Local line, so do not do carrier detect\n" \
1148 " -m Get baud rate from modem's CONNECT status message\n" \
1149 " -w Wait for a CR or LF before sending /etc/issue\n" \
1150 " -n Do not prompt the user for a login name\n" \
1151 " -f issue_file Display issue_file instead of /etc/issue\n" \
1152 " -l login_app Invoke login_app instead of /bin/login\n" \
1153 " -t timeout Terminate after timeout if no username is read\n" \
1154 " -I initstring Sets the init string to send before anything else\n" \
1155 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001156
Eric Andersen7e9276b2001-02-22 01:15:47 +00001157#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001158 "[-HhrilLnqvso" \
1159 USE_DESKTOP("w") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001160 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001161 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1162 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001163 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001164#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001165 "Search for PATTERN in each FILE or standard input" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001166 "\n\nOptions:" \
1167 "\n -H Prefix output lines with filename where match was found" \
1168 "\n -h Suppress the prefixing filename on output" \
1169 "\n -r Recurse subdirectories" \
1170 "\n -i Ignore case distinctions" \
1171 "\n -l List names of files that match" \
1172 "\n -L List names of files that do not match" \
1173 "\n -n Print line number with output lines" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001174 "\n -q Quiet. Returns 0 if PATTERN was found, 1 otherwise" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001175 "\n -v Select non-matching lines" \
1176 "\n -s Suppress file open/read error messages" \
1177 "\n -c Only print count of matching lines" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001178 "\n -o Show only the part of a line that matches PATTERN" \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001179 "\n -m MAX Match up to MAX times per file" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001180 USE_DESKTOP( \
1181 "\n -w Match whole words only") \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001182 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001183 USE_FEATURE_GREP_EGREP_ALIAS( \
1184 "\n -E PATTERN is an extended regular expression") \
Denis Vlasenko4652daa2007-07-15 12:39:08 +00001185 "\n -e PTRN Pattern to match" \
1186 "\n -f FILE Read pattern from file" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001187 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001188 "\n -A Print NUM lines of trailing context" \
1189 "\n -B Print NUM lines of leading context" \
1190 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001191
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001192#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001193 "$ grep root /etc/passwd\n" \
1194 "root:x:0:0:root:/root:/bin/bash\n" \
1195 "$ grep ^[rR]oo. /etc/passwd\n" \
1196 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001197
Eric Andersen7e9276b2001-02-22 01:15:47 +00001198#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001199 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001200#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001201 "Uncompress FILE (or standard input if FILE is '-')" \
1202 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001203 " -c Write output to standard output\n" \
1204 " -f Force read when source is a terminal\n" \
1205 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001206#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001207 "$ ls -la /tmp/BusyBox*\n" \
1208 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1209 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1210 "$ ls -la /tmp/BusyBox*\n" \
1211 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001212
1213#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001214 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001215#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001216 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001217 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001218 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001219 " -c Write output to standard output instead of FILE.gz\n" \
1220 " -d Decompress\n" \
1221 " -f Force write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001222#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001223 "$ ls -la /tmp/busybox*\n" \
1224 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1225 "$ gzip /tmp/busybox.tar\n" \
1226 "$ ls -la /tmp/busybox*\n" \
1227 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001228
1229#define halt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001230 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001231#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001232 "Halt the system" \
1233 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001234 " -d Delay interval for halting\n" \
1235 " -n No call to sync()\n" \
1236 " -f Force halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001237
Eric Andersen3443bd72003-07-22 07:30:36 +00001238#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001239 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001240#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001241 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001242 "If no device name is specified try to read from stdin.\n\n") \
1243 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001244 " -a Get/set fs readahead\n" \
1245 " -A Set drive read-lookahead flag (0/1)\n" \
1246 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1247 " -B Set Advanced Power Management setting (1-255)\n" \
1248 " -c Get/set IDE 32-bit IO setting\n" \
1249 " -C Check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001250 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001251 " -d Get/set using_dma flag\n") \
1252 " -D Enable/disable drive defect-mgmt\n" \
1253 " -f Flush buffer cache for device on exit\n" \
1254 " -g Display drive geometry\n" \
1255 " -h Display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001256 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001257 " -i Display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001258 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001259 " -I Detailed/current information directly from drive\n") \
1260 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1261 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1262 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1263 " -m Get/set multiple sector count\n" \
1264 " -n Get/set ignore-write-errors flag (0/1)\n" \
1265 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1266 " -P Set drive prefetch count\n" \
1267 " -q Change next setting quietly\n" \
1268 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1269 " -r Get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001270 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001271 " -R Register an IDE interface (DANGEROUS)\n") \
1272 " -S Set standby (spindown) timeout\n" \
1273 " -t Perform device read timings\n" \
1274 " -T Perform cache read timings\n" \
1275 " -u Get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001276 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001277 " -U Un-register an IDE interface (DANGEROUS)\n") \
1278 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1279 " -V Display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001280 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001281 " -w Perform device reset (DANGEROUS)\n") \
1282 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001283 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001284 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1285 " -X Set IDE xfer mode (DANGEROUS)\n" \
1286 " -y Put IDE drive in standby mode\n" \
1287 " -Y Put IDE drive to sleep\n" \
1288 " -Z Disable Seagate auto-powersaving mode\n" \
1289 " -z Re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001290
Eric Andersen7e9276b2001-02-22 01:15:47 +00001291#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001292 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001293#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001294 "Print first 10 lines of each FILE to standard output.\n" \
1295 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001296 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001297 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001298 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001299 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001300 "\n -c NUM Output the first NUM bytes" \
1301 "\n -q Never output headers giving file names" \
1302 "\n -v Always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001303#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001304 "$ head -n 2 /etc/passwd\n" \
1305 "root:x:0:0:root:/root:/bin/bash\n" \
1306 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001307
Glenn L McGrath60281112001-11-02 11:39:46 +00001308#define hexdump_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001309 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001310#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001311 "Display file(s) or standard input in a user specified format" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001312 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001313 " -b One-byte octal display\n" \
1314 " -c One-byte character display\n" \
1315 " -C Canonical hex+ASCII, 16 bytes per line\n" \
1316 " -d Two-byte decimal display\n" \
1317 " -e FORMAT STRING\n" \
1318 " -f FORMAT FILE\n" \
1319 " -n LENGTH Interpret only length bytes of input\n" \
1320 " -o Two-byte octal display\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001321 " -s OFFSET Skip offset bytes\n" \
1322 " -v Display all input data\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001323 " -x Two-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001324
Eric Andersen7e9276b2001-02-22 01:15:47 +00001325#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001326 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001327#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001328 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001329
1330#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001331 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001332#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001333 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001334 "(or FILE with the -F parameter), the host name will be set." \
1335 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001336 " -s Short\n" \
1337 " -i Addresses for the hostname\n" \
1338 " -d DNS domain name\n" \
1339 " -f Fully qualified domain name\n" \
1340 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001341#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001342 "$ hostname\n" \
1343 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001344
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001345#define httpd_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001346 "[-c conffile]" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001347 " [-p [ip:]port]" \
1348 " [-i] [-f] [-v[v]]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001349 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001350 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001351 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001352 " [-h home]" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001353 " [-d/-e string]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001354#define httpd_full_usage \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001355 "Listen for incoming HTTP requests" \
1356 "\n\nOptions:" \
1357 "\n -c FILE Configuration file (default httpd.conf)" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001358 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001359 "\n -i Inetd mode" \
1360 "\n -f Do not daemonize" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001361 "\n -v[v] Verbose" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001362 USE_FEATURE_HTTPD_SETUID( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001363 "\n -u USER[:GRP] Set uid/gid after binding to port") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001364 USE_FEATURE_HTTPD_BASIC_AUTH( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001365 "\n -r REALM Authentication Realm for Basic Authentication") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001366 USE_FEATURE_HTTPD_AUTH_MD5( \
Denis Vlasenko0372f0f2007-08-14 16:50:01 +00001367 "\n -m PASS Crypt PASS with md5 algorithm") \
1368 "\n -h HOME Home directory (default .)" \
1369 "\n -e STRING HTML encode STRING" \
Denis Vlasenko384b1d12007-08-14 16:55:01 +00001370 "\n -d STRING URL decode STRING" \
Eric Andersen40520512003-07-28 09:59:05 +00001371
Robert Griebl1cd04452002-07-21 16:50:49 +00001372#define hwclock_trivial_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001373 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1374 " [-l|--localtime] [-u|--utc]" \
1375 " [-f FILE]"
Robert Griebl1cd04452002-07-21 16:50:49 +00001376#define hwclock_full_usage \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001377 "Query and set a hardware clock (RTC)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001378 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001379 " -r Read hardware clock and print result\n" \
1380 " -s Set the system time from the hardware clock\n" \
1381 " -w Set the hardware clock to the current system time\n" \
1382 " -u The hardware clock is kept in coordinated universal time\n" \
Denis Vlasenko673d4bb2007-03-07 23:02:50 +00001383 " -l The hardware clock is kept in local time\n" \
1384 " -f FILE Use the specified clock (e.g. /dev/rtc2)"
Robert Griebl1cd04452002-07-21 16:50:49 +00001385
Eric Andersen7e9276b2001-02-22 01:15:47 +00001386#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001387 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001388#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001389 "Print information for USERNAME or the current user" \
1390 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001391 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001392 " -Z prints only the security context\n" \
1393 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001394 " -g Prints only the group ID\n" \
1395 " -u Prints only the user ID\n" \
1396 " -n Print a name instead of a number\n" \
1397 " -r Prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001398#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001399 "$ id\n" \
1400 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001401
Eric Andersen7e9276b2001-02-22 01:15:47 +00001402#define ifconfig_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001403 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001404#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001405 "Configure a network interface" \
1406 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001407 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001408 " [add ADDRESS[/PREFIXLEN]]\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001409 USE_FEATURE_IPV6( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001410 " [del ADDRESS[/PREFIXLEN]]\n") \
1411 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1412 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001413 USE_FEATURE_IFCONFIG_SLIP( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001414 " [outfill NN] [keepalive NN]\n") \
1415 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001416 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001417 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001418 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001419 " [mem_start NN] [io_addr NN] [irq NN]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001420 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001421
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001422#define ifup_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001423 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001424#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001425 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001426 " -a De/configure all interfaces automatically\n" \
1427 " -i FILE Use FILE for interface definitions\n" \
1428 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001429 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001430 " -v Print out what would happen before doing it\n" \
1431 " -m Don't run any mappings\n" \
1432 " -f Force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001433
1434#define ifdown_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001435 "[-ahinv] ifaces..."
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001436#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001437 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001438 " -a De/configure all interfaces automatically\n" \
1439 " -i FILE Use FILE for interface definitions\n" \
1440 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001441 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001442 " -v Print out what would happen before doing it\n" \
1443 " -m Don't run any mappings\n" \
1444 " -f Force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001445
Glenn L McGrath06e95652003-02-09 06:51:14 +00001446#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001447 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001448#define inetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001449 "Listen for network connections and launch programs" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001450 "\n\nOptions:\n" \
Denis Vlasenko886bb0d2007-01-09 23:48:46 +00001451 " -f Run in foreground\n" \
1452 " -q N Set the size of the socket listen queue to N\n" \
1453 " (default: 128)"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001454
Eric Andersen7e9276b2001-02-22 01:15:47 +00001455#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001456 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001457#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001458 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001459#define init_notes_usage \
1460"This version of init is designed to be run only by the kernel.\n" \
1461"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001462"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001463"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001464"runlevels, use sysvinit.\n" \
1465"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001466"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001467"it has the following default behavior:\n" \
1468"\n" \
1469" ::sysinit:/etc/init.d/rcS\n" \
1470" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001471" ::ctrlaltdel:/sbin/reboot\n" \
1472" ::shutdown:/sbin/swapoff -a\n" \
1473" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001474" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001475"\n" \
1476"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1477"\n" \
1478" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001479" tty3::askfirst:/bin/sh\n" \
1480" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001481"\n" \
1482"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1483"\n" \
1484" <id>:<runlevels>:<action>:<process>\n" \
1485"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001486" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001487"\n" \
1488" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1489" The id field is used by BusyBox init to specify the controlling tty for\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001490" the specified process to run on. The contents of this field are\n" \
1491" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1492" be unique, although if it isn't you may have strange results. If this\n" \
1493" field is left blank, the controlling tty is set to the console. Also\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001494" note that if BusyBox detects that a serial console is in use, then only\n" \
1495" entries whose controlling tty is either the serial console or /dev/null\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001496" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001497" stinkin' utmp.\n" \
1498"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001499" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001500"\n" \
1501" The runlevels field is completely ignored.\n" \
1502"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001503" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001504"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001505" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001506" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001507"\n" \
1508" The available actions can be classified into two groups: actions\n" \
1509" that are run only once, and actions that are re-run when the specified\n" \
1510" process exits.\n" \
1511"\n" \
1512" Run only-once actions:\n" \
1513"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001514" 'sysinit' is the first item run on boot. init waits until all\n" \
1515" sysinit actions are completed before continuing. Following the\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001516" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001517" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001518" the specified task completes. 'once' actions are asynchronous,\n" \
1519" therefore, init does not wait for them to complete. 'restart' is\n" \
1520" the action taken to restart the init process. By default this should\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001521" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001522" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001523" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001524" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001525" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001526" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001527" init is told to reboot. Unmounting filesystems and disabling swap\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001528" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001529"\n" \
1530" Run repeatedly actions:\n" \
1531"\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001532" 'respawn' actions are run after the 'once' actions. When a process\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001533" started with a 'respawn' action exits, init automatically restarts\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001534" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1535" respawning out of control. The 'askfirst' actions acts just like\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001536" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001537" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001538" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001539" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001540"\n" \
1541" Unrecognized actions (like initdefault) will cause init to emit an\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001542" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001543" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001544"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001545" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001546"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001547" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001548"\n" \
1549"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001550"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001551" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001552" #\n" \
1553" ::sysinit:/etc/init.d/rcS\n" \
1554" \n" \
1555" # /bin/sh invocations on selected ttys\n" \
1556" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001557" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001558" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001559" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001560" tty2::askfirst:-/bin/sh\n" \
1561" tty3::askfirst:-/bin/sh\n" \
1562" tty4::askfirst:-/bin/sh\n" \
1563" \n" \
1564" # /sbin/getty invocations for selected ttys\n" \
1565" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001566" tty4::respawn:/sbin/getty 38400 tty4\n" \
1567" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001568" \n" \
1569" \n" \
1570" # Example of how to put a getty on a serial line (for a terminal)\n" \
1571" #\n" \
1572" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1573" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1574" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001575" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001576" #::respawn:/sbin/getty 57600 ttyS2\n" \
1577" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001578" # Stuff to do when restarting the init process\n" \
1579" ::restart:/sbin/init\n" \
1580" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001581" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001582" ::ctrlaltdel:/sbin/reboot\n" \
1583" ::shutdown:/bin/umount -a -r\n" \
1584" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001585
1586#define insmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001587 "[OPTION]... MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001588#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001589 "Load the specified kernel modules into the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001590 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001591 " -f Force module to load into the wrong kernel version\n" \
1592 " -k Make module autoclean-able\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001593 " -v Verbose\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00001594 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001595 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001596 USE_FEATURE_INSMOD_LOAD_MAP( \
1597 " -m Output load map to stdout\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001598 " -o NAME Set internal module name to NAME\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001599 " -x Do not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001600
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001601#define install_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001602 "[-cgmops] [sources] dest|directory"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001603#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001604 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001605 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001606 " -c Copy the file, default\n" \
1607 " -d Create directories\n" \
1608 " -g Set group ownership\n" \
1609 " -m Set permission modes\n" \
1610 " -o Set ownership\n" \
1611 " -p Preserve date\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001612 " -s Strip symbol tables" \
1613 USE_SELINUX( \
1614 "\n -Z Set security context of copy" \
1615 )
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001616/* would need to make the " | " optional depending on more than one selected */
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001617#define ip_trivial_usage \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001618 "[OPTIONS] {" \
1619 USE_FEATURE_IP_ADDRESS("address | ") \
1620 USE_FEATURE_IP_ROUTE("route | ") \
1621 USE_FEATURE_IP_LINK("link | ") \
1622 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1623 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001624 "} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001625#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001626 "ip [OPTIONS] OBJECT {COMMAND}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001627 "where OBJECT := {" \
Bernhard Reutner-Fischerf73cac82007-04-10 19:00:08 +00001628 USE_FEATURE_IP_ADDRESS("address | ") \
1629 USE_FEATURE_IP_ROUTE("route | ") \
1630 USE_FEATURE_IP_LINK("link | ") \
1631 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1632 USE_FEATURE_IP_RULE("rule") \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00001633 "}\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001634 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001635
1636#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001637 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001638 " [dev STRING] [to PREFIX] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001639#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001640 "ipaddr {add|delete} IFADDR dev STRING\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001641 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1642 " [to PREFIX] [label PATTERN]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001643 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001644 " [broadcast ADDR] [anycast ADDR]\n" \
1645 " [label STRING] [scope SCOPE-ID]\n" \
1646 " SCOPE-ID := [host | link | global | NUMBER]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001647
Eric Andersende4f07e2003-12-11 01:18:07 +00001648#define ipcalc_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001649 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001650#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001651 "Calculate IP network settings from a IP address" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001652 "\n\nOptions:" \
1653 "\n -b --broadcast Display calculated broadcast address" \
1654 "\n -n --network Display calculated network address" \
1655 "\n -m --netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001656 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001657 "\n -p --prefix Display the prefix for IP/NETMASK" \
1658 "\n -h --hostname Display first resolved host name" \
1659 "\n -s --silent Don't ever display error messages")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001660
Rob Landley6eb1e412005-06-20 04:30:36 +00001661#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001662 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001663#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001664 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1665 "segment by a shmkey value. The lower-case options mqs are used\n" \
1666 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001667 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001668 " -[mM] Remove the memory segment after the last detach\n" \
1669 " -[qQ] Remove the message queue\n" \
1670 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001671
1672#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001673 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001674#define ipcs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001675 " -i Specify a specific resource id\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001676 "Resource specification:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001677 " -m Shared memory segments\n" \
1678 " -q Message queues\n" \
1679 " -s Semaphore arrays\n" \
1680 " -a All (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001681 "Output format:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001682 " -t Time\n" \
1683 " -c Creator\n" \
1684 " -p Pid\n" \
1685 " -l Limits\n" \
1686 " -u Summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001687
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001688#define iplink_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001689 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001690#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001691 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001692 " dynamic { on | off } |\n" \
1693 " mtu MTU }\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001694 "iplink show [DEVICE]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001695
1696#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001697 "{ list | flush | { add | del | change | append |\n" \
1698 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001699#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001700 "iproute { list | flush } SELECTOR\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001701 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1702 " [oif STRING] [tos TOS]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001703 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001704 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
1705 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001706
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001707#define iprule_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001708 "{[list | add | del] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001709#define iprule_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001710 "iprule [list | add | del] SELECTOR ACTION\n" \
1711 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1712 " [dev STRING] [pref NUMBER]\n" \
1713 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1714 " [prohibit | reject | unreachable]\n" \
1715 " [realms [SRCREALM/]DSTREALM]\n" \
1716 " TABLE_ID := [local | main | default | NUMBER]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001717
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001718#define iptunnel_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001719 "{ add | change | del | show } [NAME]\n" \
1720 " [mode { ipip | gre | sit }]\n" \
1721 " [remote ADDR] [local ADDR] [ttl TTL]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001722#define iptunnel_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001723 "iptunnel { add | change | del | show } [NAME]\n" \
1724 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1725 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
1726 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001727
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728#define kill_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001729 "[-l] [-signal] process-id [process-id ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001730#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001731 "Send a signal (default is TERM) to the specified process(es)" \
1732 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001733 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001734#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001735 "$ ps | grep apache\n" \
1736 "252 root root S [apache]\n" \
1737 "263 www-data www-data S [apache]\n" \
1738 "264 www-data www-data S [apache]\n" \
1739 "265 www-data www-data S [apache]\n" \
1740 "266 www-data www-data S [apache]\n" \
1741 "267 www-data www-data S [apache]\n" \
1742 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001743
1744#define killall_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001745 "[-l] [-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001746#define killall_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001747 "Send a signal (default is TERM) to the specified process(es)" \
1748 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001749 " -l List all signal names and numbers\n" \
1750 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001751#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001752 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001753
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001754#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001755 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001756#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001757 "Send a signal (default is TERM) to all processes outside current session" \
1758 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001759 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001760
Mark Whitley6317c4b2001-03-12 22:51:50 +00001761#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001762 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001763#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001764 "Kernel logger" \
1765 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001766 " -c n Sets the default log level of console messages to n\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00001767 " -n Run as foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001768
Eric Andersen7e9276b2001-02-22 01:15:47 +00001769#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001770 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001771#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001772 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001773#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001774 "$ length Hello\n" \
1775 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001776
Rob Landley9200e792005-09-15 19:26:59 +00001777#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001778 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001779#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001780 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001781 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001782 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001783 " -E Quit once the end of a file is reached\n" \
1784 " -M Display a status line containing the current line numbers\n" \
1785 " and the percentage through the file\n" \
1786 " -N Prefix line numbers to each line\n" \
1787 " -m Display a status line containing the percentage through the\n" \
1788 " file\n" \
1789 " -~ Suppress ~s displayed when input past the end of the file is\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001790 " reached"
Rob Landley9200e792005-09-15 19:26:59 +00001791
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001792#define setarch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00001793 "personality program [args ...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001794#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001795 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001796 " linux32 Set 32bit uname emulation\n" \
1797 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001798
Eric Andersen7e9276b2001-02-22 01:15:47 +00001799#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001800 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001801#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001802 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1803 "You may use '--' to indicate that all following arguments are non-options." \
1804 "\n\nOptions:\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00001805 " -s Make symlinks instead of hardlinks\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001806 " -f Remove existing destination files\n" \
1807 " -n No dereference symlinks - treat like normal file\n" \
1808 " -b Make a backup of the target (if exists) before link operation\n" \
1809 " -S suf Use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001810#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001811 "$ ln -s BusyBox /tmp/ls\n" \
1812 "$ ls -l /tmp/ls\n" \
1813 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001814
Denis Vlasenko1fc6e562007-03-24 15:37:57 +00001815#define load_policy_trivial_usage \
1816 "[FILE]"
1817#define load_policy_full_usage
1818
Eric Andersen7e9276b2001-02-22 01:15:47 +00001819#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001820 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001821#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001822 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001823#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001824 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001825
1826#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001827 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001828#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001829 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001830#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001831 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001832
1833#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001834 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001835#define logger_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001836 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001837 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001838 " -s Log to stderr as well as the system log\n" \
1839 " -t TAG Log using the specified tag (defaults to user name)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001840 " -p PRIO Enter the message with the specified priority.\n" \
1841 " This may be numerical or a 'facility.level' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001842#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001843 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001844
Robert Griebl1fca5582002-06-04 20:45:46 +00001845#define login_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001846 "[OPTION]... [username] [ENV=VAR ...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00001847#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001848 "Begin a new session on the system" \
1849 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001850 " -f Do not authenticate (user already authenticated)\n" \
1851 " -h Name of the remote host for this login\n" \
1852 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001853
Eric Andersen7e9276b2001-02-22 01:15:47 +00001854#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001855 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001856#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001857 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001858#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001859 "$ logname\n" \
1860 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001861
Mark Whitley6317c4b2001-03-12 22:51:50 +00001862#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001863 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001864#define logread_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001865 "Show the messages from syslogd (using circular buffer)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001866 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001867 " -f Output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001868
Matt Kraai83788da2002-03-20 17:38:37 +00001869#define losetup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001870 "[-o OFFSET] [-d] LOOPDEVICE [FILE]]"
Matt Kraai83788da2002-03-20 17:38:37 +00001871#define losetup_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001872 "(Dis)associate LOOPDEVICE with FILE, or display current associations" \
1873 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001874 " -d Disassociate LOOPDEVICE\n" \
1875 " -o OFFSET Start OFFSET bytes into FILE"
Rob Landley1d589b22005-11-29 23:47:10 +00001876#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001877 "No arguments will display all current associations.\n" \
1878 "One argument (losetup /dev/loop1) will display the current association\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001879 "(if any), or disassociate it (with -d). The display shows the offset\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001880 "and filename of the file the loop device is currently bound to.\n\n" \
1881 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001882 "with an optional offset (-o 12345). Encryption is not yet supported.\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001883
Eric Andersen7e9276b2001-02-22 01:15:47 +00001884#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001885 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00001886 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001887 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
1888 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
1889 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
1890 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
1891 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
1892 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001893#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001894 "List directory contents" \
1895 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001896 "\n -1 List files in a single column" \
1897 "\n -A Do not list implied . and .." \
1898 "\n -a Do not hide entries starting with ." \
1899 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001900 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001901 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001902 USE_FEATURE_LS_COLOR( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001903 "\n --color[={always,never,auto}] Control coloring") \
1904 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001905 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001906 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001907 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001908 "\n -F Append indicator (one of */=@|) to entries") \
1909 "\n -i List the i-node for each file" \
1910 "\n -l Use a long listing format" \
1911 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001912 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001913 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001914 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenko081ef792007-03-17 16:38:21 +00001915 "\n -L List entries pointed to by symlinks") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001916 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001917 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001918 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001919 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001920 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001921 "\n -S Sort the listing by file size") \
1922 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001923 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001924 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001925 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001926 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001927 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001928 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001929 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001930 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001931 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001932 "\n -w NUM Assume the terminal is NUM columns wide") \
1933 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001934 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001935 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001936 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001937 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001938 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001939 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001940 USE_SELINUX( \
Denis Vlasenko49622d72007-03-10 16:58:49 +00001941 "\n -K Print security context in long format") \
1942 USE_SELINUX( \
1943 "\n -Z Print security context and permission")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001944
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001945#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001946 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001947#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001948 "List file attributes on an ext2 fs" \
1949 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001950 " -R Recursively list subdirectories\n" \
1951 " -a Do not hide entries starting with .\n" \
1952 " -d List directory entries instead of contents\n" \
1953 " -l Print long flag names\n" \
1954 " -v List the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001955
Eric Andersen7e9276b2001-02-22 01:15:47 +00001956#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001957 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001958#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001959 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001960
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001961#if ENABLE_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001962#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001963 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001964#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001965 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001966 "TYPEs include:\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001967 " b: Make a block (buffered) device\n" \
1968 " c or u: Make a character (un-buffered) device\n" \
1969 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
1970 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001971 "FIRST specifies the number appended to NAME to create the first device.\n" \
1972 "LAST specifies the number of the last item that should be created\n" \
1973 "If 's' is the last argument, the base device is created as well.\n\n" \
1974 "For example:\n" \
1975 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
1976 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001977#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001978 "# makedevs /dev/ttyS c 4 66 2 63\n" \
1979 "[creates ttyS2-ttyS63]\n" \
1980 "# makedevs /dev/hda b 3 0 0 8 s\n" \
1981 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001982#endif
1983
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001984#if ENABLE_FEATURE_MAKEDEVS_TABLE
Eric Andersen3d925622005-06-09 10:16:02 +00001985#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001986 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001987#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001988 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001989 "Device table entries take the form of:\n" \
1990 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001991 "Where name is the file name, type can be one of:\n" \
1992 " f A regular file\n" \
1993 " d Directory\n" \
1994 " c Character special device file\n" \
1995 " b Block special device file\n" \
1996 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001997 "uid is the user id for the target file, gid is the group id for the\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00001998 "target file. The rest of the entries (major, minor, etc) apply to\n" \
1999 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00002000#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002001 "For example:\n" \
2002 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2003 "/dev d 755 0 0 - - - - -\n" \
2004 "/dev/console c 666 0 0 5 1 - - -\n" \
2005 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2006 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2007 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2008 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2009 "Will Produce:\n" \
2010 "/dev\n" \
2011 "/dev/console\n" \
2012 "/dev/null\n" \
2013 "/dev/zero\n" \
2014 "/dev/hda\n" \
2015 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00002016#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002017
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002018#define matchpathcon_trivial_usage \
2019 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2020#define matchpathcon_full_usage \
2021 " -n Do not display path" \
2022 "\n -N Do not use translations" \
2023 "\n -f Use alternate file_context file" \
2024 "\n -p Use prefix to speed translations" \
2025 "\n -V Verify file context on disk matches defaults"
2026
Eric Andersen7e9276b2001-02-22 01:15:47 +00002027#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002028 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002029 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002030#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002031 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2032 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002033 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002034 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002035 " -c Check MD5 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002036 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002037 " -s Don't output anything, status code shows success\n" \
2038 " -w Warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002039#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002040 "$ md5sum < busybox\n" \
2041 "6fd11e98b98a58f64ff3398d7b324003\n" \
2042 "$ md5sum busybox\n" \
2043 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2044 "$ md5sum -c -\n" \
2045 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2046 "busybox: OK\n" \
2047 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002048
Rob Landley70f7ef72005-12-13 08:21:33 +00002049#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002050 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00002051#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002052 " -s Scan /sys and populate /dev during system boot\n\n" \
2053 "Called with no options (via hotplug) it uses environment variables\n" \
2054 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00002055#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002056 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002057 "The mdev config file contains lines that look like:\n" \
2058 " hd[a-z][0-9]* 0:3 660\n\n" \
2059 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002060 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002061 "Optionally, that can be followed (on the same line) by a special character\n" \
2062 "and a command line to run after creating/before deleting the corresponding\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002063 "device(s). The environment variable $MDEV indicates the active device node\n" \
2064 "(which is useful if it's a regex match). For example:\n\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002065 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2066 "The special characters are @ (run after creating), $ (run before deleting),\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002067 "and * (run both after creating and before deleting). The commands run in\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00002068 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00002069 ) \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002070 "Config file parsing stops on the first matching line. If no config\n"\
2071 "entry is matched, devices are created with default 0:0 660. (Make\n"\
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002072 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002073 )
Rob Landley70f7ef72005-12-13 08:21:33 +00002074
Glenn L McGrath061c9002002-09-16 04:21:46 +00002075#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002076 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002077#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002078 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002079 " y Allow write access to your terminal\n" \
2080 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00002081
Eric Andersen7e9276b2001-02-22 01:15:47 +00002082#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002083 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002084#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002085 "Create the DIRECTORY(ies) if they do not already exist" \
2086 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002087 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002088 " -p No error if existing, make parent directories as needed" \
2089 USE_SELINUX( \
2090 "\n -Z Set security context" \
2091 )
2092
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002093#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002094 "$ mkdir /tmp/foo\n" \
2095 "$ mkdir /tmp/foo\n" \
2096 "/tmp/foo: File exists\n" \
2097 "$ mkdir /tmp/foo/bar/baz\n" \
2098 "/tmp/foo/bar/baz: No such file or directory\n" \
2099 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002100
Mike Frysinger6447ac02005-06-11 05:29:40 +00002101#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002102 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2103 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2104 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2105 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2106 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2107 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002108#define mke2fs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002109 " -b size Block size in bytes\n" \
2110 " -c Check for bad blocks before creating\n" \
2111 " -E opts Set extended options\n" \
2112 " -f size Fragment size in bytes\n" \
2113 " -F Force (ignore sanity checks)\n" \
2114 " -g num Number of blocks in a block group\n" \
2115 " -i ratio The bytes/inode ratio\n" \
2116 " -j Create a journal (ext3)\n" \
2117 " -J opts Set journal options (size/device)\n" \
2118 " -l file Read bad blocks list from file\n" \
2119 " -L lbl Set the volume label\n" \
2120 " -m percent Percent of fs blocks to reserve for admin\n" \
2121 " -M dir Set last mounted directory\n" \
2122 " -n Do not actually create anything\n" \
2123 " -N num Number of inodes to create\n" \
2124 " -o os Set the 'creator os' field\n" \
2125 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002126 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002127 " -r rev Set filesystem revision\n" \
2128 " -S Write superblock and group descriptors only\n" \
2129 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002130 " -v Verbose"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002131
Eric Andersen7e9276b2001-02-22 01:15:47 +00002132#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002133 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002134#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002135 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002136 "\n\nOptions:\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002137 " -m Create the pipe using the specified mode (default a=rw)" \
2138 USE_SELINUX( \
2139 "\n -Z Set security context" \
2140 )
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002141
Eric Andersen7e9276b2001-02-22 01:15:47 +00002142#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002143 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002144#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002145 "Make a MINIX filesystem" \
2146 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002147 " -c Check the device for bad blocks\n" \
2148 " -n [14|30] Specify the maximum length of filenames\n" \
2149 " -i INODES Specify the number of inodes for the filesystem\n" \
2150 " -l FILENAME Read the bad blocks list from FILENAME\n" \
2151 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002152
Eric Andersen7e9276b2001-02-22 01:15:47 +00002153#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002154 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002155#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002156 "Create a special file (block, character, or pipe)" \
2157 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002158 " -m Create the special file using the specified mode (default a=rw)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002159 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002160 " b: Make a block (buffered) device\n" \
2161 " c or u: Make a character (un-buffered) device\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00002162 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes" \
2163 USE_SELINUX( \
2164 "\n -Z Set security context" \
2165 )
2166
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002167#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002168 "$ mknod /dev/fd0 b 2 0\n" \
2169 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002170
Eric Andersen7e9276b2001-02-22 01:15:47 +00002171#define mkswap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002172 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002173#define mkswap_full_usage \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00002174 "Prepare a disk partition to be used as swap partition" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002175 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002176 " -c Check for read-ability\n" \
2177 " -v0 Make version 0 swap [max 128 Megs]\n" \
2178 " -v1 Make version 1 swap [big!] (default for kernels > 2.1.117)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002179 " block-count Number of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002180
Eric Andersen7e9276b2001-02-22 01:15:47 +00002181#define mktemp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002182 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002183#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002184 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002185 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2186 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002187 " -d Make a directory instead of a file\n" \
2188 " -q Fail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002189#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002190 "$ mktemp /tmp/temp.XXXXXX\n" \
2191 "/tmp/temp.mWiLjM\n" \
2192 "$ ls -la /tmp/temp.mWiLjM\n" \
2193 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002194
Eric Andersen8d79ce82001-07-22 23:00:15 +00002195#define modprobe_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002196 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002197#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002198 "Options:\n" \
2199 " -k Make module autoclean-able\n" \
2200 " -n Just show what would be done\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002201 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002202 " -r Remove module (stacks) or do autoclean\n" \
2203 " -s Report via syslog instead of stderr\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002204 " -v Verbose"
Rob Landley9c32a152005-12-11 20:12:24 +00002205#define modprobe_notes_usage \
2206"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2207"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2208"pass each module it loads.\n" \
2209"\n" \
2210"The configuration file is searched (in order) amongst:\n" \
2211"\n" \
2212" /etc/modprobe.conf (2.6 only)\n" \
2213" /etc/modules.conf\n" \
2214" /etc/conf.modules (deprecated)\n" \
2215"\n" \
2216"They all have the same syntax (see below). If none is present, it is\n" \
2217"_not_ an error; each loaded module is then expected to load without\n" \
2218"options. Once a file is found, the others are tested for.\n" \
2219"\n" \
2220"/etc/modules.conf entry format:\n" \
2221"\n" \
2222" alias <alias_name> <mod_name>\n" \
2223" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002224" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002225" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2226" This makes it also possible to use a different set of options (below) for\n" \
2227" the module and the alias.\n" \
2228" A module can be aliased more than once.\n" \
2229"\n" \
2230" options <mod_name|alias_name> <symbol=value ...>\n" \
2231" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2232" the \"symbol=value\" pairs as option to that module.\n" \
2233"\n" \
2234"Sample /etc/modules.conf file:\n" \
2235"\n" \
2236" options tulip irq=3\n" \
2237" alias tulip tulip2\n" \
2238" options tulip2 irq=4 io=0x308\n" \
2239"\n" \
2240"Other functionality offered by 'classic' modprobe is not available in\n" \
2241"this implementation.\n" \
2242"\n" \
2243"If module options are present both in the config file, and on the command line,\n" \
2244"then the options from the command line will be passed to the module _after_\n" \
2245"the options from the config file. That way, you can have defaults in the config\n" \
2246"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002247#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002248 "(with the above /etc/modules.conf):\n\n" \
2249 "$ modprobe tulip\n" \
2250 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2251 "$ modprobe tulip irq=5\n" \
2252 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2253 "$ modprobe tulip2\n" \
2254 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2255 " which are the default for alias 'tulip2'\n\n" \
2256 "$ modprobe tulip2 irq=8\n" \
2257 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2258 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2259 " from the command line\n\n" \
2260 "$ modprobe tulip2 irq=2 io=0x210\n" \
2261 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2262 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2263 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002264
Eric Andersen7e9276b2001-02-22 01:15:47 +00002265#define more_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002266 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002267#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002268 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002269#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002270 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002271
Eric Andersen7e9276b2001-02-22 01:15:47 +00002272#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002273 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002274#define mount_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002275 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2276 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002277 " -a Mount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002278 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002279 " -f \"Fake\" Add entry to mount table but don't mount it\n" \
2280 " -n Don't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002281 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002282 " -o option One of many filesystem options, listed below\n" \
2283 " -r Mount the filesystem read-only\n" \
2284 " -t fs-type Specify the filesystem type\n" \
2285 " -w Mount for reading and writing (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002286 "\n" \
2287 "Options for use with the \"-o\" flag:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002288 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002289 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002290 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002291 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002292 " [a]sync Writes are asynchronous / synchronous\n" \
2293 " [no]atime Disable / enable updates to inode access times\n" \
2294 " [no]diratime Disable / enable atime updates to directories\n" \
2295 " [no]dev Allow use of special device files / disallow them\n" \
2296 " [no]exec Allow use of executable files / disallow them\n" \
2297 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2298 " [r]shared Convert [recursively] to a shared subtree\n" \
2299 " [r]slave Convert [recursively] to a slave subtree\n" \
2300 " [r]private Convert [recursively] to a private subtree\n" \
2301 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2302 " bind Bind a directory to an additional location\n" \
2303 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002304 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002305 " remount Remount a mounted filesystem, changing its flags\n" \
2306 " ro/rw Mount for read-only / read-write\n" \
2307 "\n" \
2308 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002309 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002310#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002311 "$ mount\n" \
2312 "/dev/hda3 on / type minix (rw)\n" \
2313 "proc on /proc type proc (rw)\n" \
2314 "devpts on /dev/pts type devpts (rw)\n" \
2315 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2316 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2317 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002318#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002319 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002320
Rob Landleyd00b3a52005-08-20 05:07:08 +00002321#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002322 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002323#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002324 "mountpoint checks if the directory is a mountpoint" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002325 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002326 " -q Quiet\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002327 " -d Print major/minor device number of the filesystem\n" \
2328 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002329#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002330 "$ mountpoint /proc\n" \
2331 "/proc is not a mountpoint\n" \
2332 "$ mountpoint /sys\n" \
2333 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002334
Eric Andersen7e9276b2001-02-22 01:15:47 +00002335#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002336 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002337#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002338 "Control magnetic tape drive operation\n" \
2339 "\nAvailable Opcodes:\n\n" \
2340 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2341 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2342 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2343 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002344
Eric Andersen7e9276b2001-02-22 01:15:47 +00002345#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002346 "[OPTION]... SOURCE DEST\n" \
2347 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002348#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002349 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2350 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002351 " -f Don't prompt before overwriting\n" \
2352 " -i Interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002353#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002354 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002355
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002356#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002357 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002358#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002359 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002360 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002361 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2362 " -s Use syslog (LOCAL0 facility)\n" \
2363 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002364#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002365 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2366 " or\n" \
2367 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002368
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002369#if !ENABLE_DESKTOP
2370
Rob Landley1cca9482006-07-10 19:45:20 +00002371#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002372#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002373#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002374#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002375#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002376
Eric Andersen7e9276b2001-02-22 01:15:47 +00002377#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002378 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002379 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002380#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002381 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002382 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002383 USE_NC_EXTRA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002384 "\n -e Exec rest of command line after connect" \
2385 "\n -i SECS Delay interval for lines sent" \
2386 "\n -w SECS Timeout for connect" \
Denis Vlasenko5d687242007-01-12 20:59:31 +00002387 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002388 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002389 USE_NC_SERVER( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002390 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002391 USE_NC_EXTRA( \
2392 "\n (use -l twice with -e for persistent server)") \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002393 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002394 )
2395
Rob Landley1cca9482006-07-10 19:45:20 +00002396#define nc_notes_usage "" \
2397 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002398 "To use netcat as a terminal emulator on a serial port:\n\n" \
2399 "$ stty 115200 -F /dev/ttyS0\n" \
2400 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2401 )
Rob Landley1cca9482006-07-10 19:45:20 +00002402
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002403#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002404 "$ nc foobar.somedomain.com 25\n" \
2405 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2406 "help\n" \
2407 "214-Commands supported:\n" \
2408 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2409 "214 NOOP QUIT RSET HELP\n" \
2410 "quit\n" \
2411 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002412
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002413#else /* DESKTOP nc - much more compatible with nc 1.10 */
2414
2415#define nc_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002416 "[-options] hostname port - connect" \
Denis Vlasenko29fe7262007-04-05 20:26:28 +00002417 USE_NC_SERVER("\nnc [-options] -l -p port [hostname] [port] - listen")
2418#define nc_full_usage \
2419 USE_NC_SERVER( \
2420 "-l Listen mode, for inbound connects\n" \
2421 ) \
2422 "-n Do not do DNS resolution" \
2423 "\n-s addr Local address" \
2424 "\n-p port Local port" \
2425 "\n-u UDP mode" \
2426 "\n-v Verbose (cumulative: -vv)" \
2427 "\n-w secs Timeout for connects and final net reads" \
2428 USE_NC_EXTRA( \
2429 "\n-i sec Delay interval for lines sent" /* ", ports scanned" */ \
2430 "\n-o file Hex dump of traffic" \
2431 "\n-z Zero-I/O mode (scanning)" \
2432 ) \
2433 "\n-e prog [args] Program to exec after connect (must be last)" \
2434/* "\n-r Randomize local and remote ports" */
2435/* "\n-g gateway Source-routing hop point[s], up to 8" */
2436/* "\n-G num Source-routing pointer: 4, 8, 12, ..." */
2437/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2438
2439#endif
2440
Eric Andersen1552ff72001-10-31 11:07:12 +00002441#define netstat_trivial_usage \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002442 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002443#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002444 "Display networking information" \
Denis Vlasenko418a7fb2007-05-15 23:57:46 +00002445 "\n\nOptions:" \
2446 "\n -l Display listening server sockets" \
2447 "\n -a Display all sockets (default: connected)" \
2448 "\n -e Display other/more information" \
2449 "\n -n Don't resolve names" \
2450 "\n -t Tcp sockets" \
2451 "\n -u Udp sockets" \
2452 "\n -w Raw sockets" \
2453 "\n -x Unix sockets" \
2454 "\n -r Display routing table" \
2455 USE_FEATURE_NETSTAT_WIDE( \
2456 "\n -W Display with no column truncation" \
2457 )
Eric Andersen1552ff72001-10-31 11:07:12 +00002458
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002459#define nice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002460 "[-n ADJUST] [COMMAND [ARG] ...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002461#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002462 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002463 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002464 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002465
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002466#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002467 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002468#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002469 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002470 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002471 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002472 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002473 "%[niface] Monitor network interface 'iface'\n" \
2474 "%m Monitor allocated memory\n" \
2475 "%[mf] Monitor free memory\n" \
2476 "%[mt] Monitor total memory\n" \
2477 "%s Monitor allocated swap\n" \
2478 "%f Monitor number of used file descriptors\n" \
2479 "%Ni Monitor total/specific IRQ rate\n" \
2480 "%x Monitor context switch rate\n" \
2481 "%p Monitor forks\n" \
2482 "%[pn] Monitor # of processes\n" \
2483 "%b Monitor block io\n" \
2484 "%Nt Show time (with N decimal points)\n" \
2485 "%Nd Milliseconds between updates (default=1000)\n" \
2486 "%r Print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002487#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002488 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002489
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002490#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002491 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002492#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002493 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002494#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002495 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002496
Eric Andersen7e9276b2001-02-22 01:15:47 +00002497#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002498 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002499#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002500 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002501 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002502#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002503 "$ nslookup localhost\n" \
2504 "Server: default\n" \
2505 "Address: default\n" \
2506 "\n" \
2507 "Name: debian\n" \
2508 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002509
Glenn L McGrath60281112001-11-02 11:39:46 +00002510#define od_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002511 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002512#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002513 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002514 "to standard output. With no FILE, or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002515
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002516#define openvt_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002517 "VTNUM COMMAND [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002518#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002519 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002520#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002521 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002522
Eric Andersen27f64e12002-06-23 04:24:25 +00002523#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002524 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002525#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002526 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002527 "changes the password for the current user." \
2528 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002529 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002530 " (choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002531 " -d Delete the password for the specified user account\n" \
2532 " -l Locks (disables) the specified user account\n" \
2533 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002534
Denis Vlasenko21d10142007-07-20 21:28:41 +00002535#define chpasswd_trivial_usage \
2536 "[--md5|--encrypt]"
2537#define chpasswd_full_usage \
2538 "Read user:password information from stdin\n" \
2539 "and update /etc/passwd accordingly." \
2540 "\n\nOptions:" \
2541 "\n -e, --encrypt Supplied passwords are in encrypted form" \
2542 "\n -m, --md5 Use MD5 encryption instead of DES"
2543
Glenn L McGrath655d8142003-06-22 15:32:41 +00002544#define patch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002545 "[-p num] [-i diff]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002546#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002547 " -p NUM Strip NUM leading components from file names\n" \
2548 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002549#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002550 "$ patch -p1 < example.diff\n" \
2551 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002552
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002553#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2554#define USAGE_PIDOF "Options:"
2555#else
Denis Vlasenko765996a2006-12-24 16:59:27 +00002556#define USAGE_PIDOF "\nThis version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002557#endif
2558
Eric Andersen221b2ea2001-07-31 19:06:07 +00002559#define pidof_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002560 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002561
Eric Andersen221b2ea2001-07-31 19:06:07 +00002562#define pidof_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002563 "List the PIDs of all processes with names that match the\n" \
2564 "names on the command line\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002565 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002566 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002567 "\n -s Display only a single PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002568 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenko198bada2007-06-23 14:56:43 +00002569 "\n -o PID Omit given pid") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002570 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002571 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002572#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002573 "$ pidof init\n" \
2574 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002575 USE_FEATURE_PIDOF_OMIT( \
2576 "$ pidof /bin/sh\n20351 5973 5950\n") \
2577 USE_FEATURE_PIDOF_OMIT( \
2578 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002579
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002580#if !ENABLE_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002581#define ping_trivial_usage \
2582 "host"
2583#define ping_full_usage \
2584 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002585#define ping6_trivial_usage \
2586 "host"
2587#define ping6_full_usage \
2588 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002589#else
2590#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002591 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002592#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002593 "Send ICMP ECHO_REQUEST packets to network hosts" \
2594 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002595 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2596 " -c CNT Send only CNT pings\n" \
2597 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2598 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002599 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002600 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002601#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002602 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002603#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002604 "Send ICMP ECHO_REQUEST packets to network hosts" \
2605 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002606 " -c CNT Send only CNT pings\n" \
2607 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2608 " -I iface/IP Use interface or IP address as source\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002609 " -q Quiet, only displays output at start\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002610 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002611#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002612#define ping_example_usage \
2613 "$ ping localhost\n" \
2614 "PING slag (127.0.0.1): 56 data bytes\n" \
2615 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2616 "\n" \
2617 "--- debian ping statistics ---\n" \
2618 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2619 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002620#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002621 "$ ping6 ip6-localhost\n" \
2622 "PING ip6-localhost (::1): 56 data bytes\n" \
2623 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2624 "\n" \
2625 "--- ip6-localhost ping statistics ---\n" \
2626 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2627 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002628
Eric Andersen7e9276b2001-02-22 01:15:47 +00002629#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002630 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002631#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002632 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002633 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002634
Eric Andersen7e9276b2001-02-22 01:15:47 +00002635#define poweroff_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002636 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002637#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002638 "Halt and shut off power" \
2639 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002640 " -d Delay interval for halting\n" \
2641 " -n No call to sync()\n" \
2642 " -f Force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002643
Mike Frysinger95d3c452005-04-21 23:29:24 +00002644#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002645 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002646#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002647 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002648 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002649
Eric Andersen7e9276b2001-02-22 01:15:47 +00002650#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002651 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002652#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002653 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002654 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002655#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002656 "$ printf \"Val=%d\\n\" 5\n" \
2657 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002658
Denis Vlasenko94949192006-11-05 00:45:47 +00002659
2660#if ENABLE_DESKTOP
2661
2662#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002663 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002664#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002665 "Report process status" \
2666 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002667 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002668
2669#else /* !ENABLE_DESKTOP */
2670
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002671#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002672#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002673#else
2674#define USAGE_PS "\nOptions:"
2675#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002676
Eric Andersen7e9276b2001-02-22 01:15:47 +00002677#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002678 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002679#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002680 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002681 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002682 USE_SELINUX( \
Bernhard Reutner-Fischer26a80162007-03-14 08:52:28 +00002683 "\n -Z Show SE Linux context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002684 USE_FEATURE_PS_WIDE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002685 "\n w Wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002686
Denis Vlasenko94949192006-11-05 00:45:47 +00002687#endif /* ENABLE_DESKTOP */
2688
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002689#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002690 "$ ps\n" \
2691 " PID Uid Gid State Command\n" \
2692 " 1 root root S init\n" \
2693 " 2 root root S [kflushd]\n" \
2694 " 3 root root S [kupdate]\n" \
2695 " 4 root root S [kpiod]\n" \
2696 " 5 root root S [kswapd]\n" \
2697 " 742 andersen andersen S [bash]\n" \
2698 " 743 andersen andersen S -bash\n" \
2699 " 745 root root S [getty]\n" \
2700 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002701
Denis Vlasenko7b72fc12007-06-16 13:37:59 +00002702#define pscan_trivial_usage \
2703 "[-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
2704#define pscan_full_usage \
2705 "Scan a host, print all open ports" \
2706 "\n\nOptions:" \
2707 "\n -p Scan from this port (default 1)" \
2708 "\n -P Scan up to this port (default 1024)" \
2709 "\n -t Timeout (default 5000 ms)" \
2710 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
2711
Eric Andersen7e9276b2001-02-22 01:15:47 +00002712#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002713 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002714#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002715 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002716#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002717 "$ pwd\n" \
2718 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002719
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002720#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002721 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002722#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002723 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002724#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002725 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002726
Eric Andersen7e9276b2001-02-22 01:15:47 +00002727#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002728 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002729#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002730 "Get and possibly set the system date and time from a remote HOST" \
2731 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002732 " -s Set the system date and time (default)\n" \
2733 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002734
Rob Landley0e4690d2006-08-20 22:12:18 +00002735#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002736 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002737#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002738 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2739 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00002740
Eric Andersen7e9276b2001-02-22 01:15:47 +00002741#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002742 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002743#define readlink_full_usage \
Denis Vlasenko081ef792007-03-17 16:38:21 +00002744 "Display the value of a symlink" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002745 USE_FEATURE_READLINK_FOLLOW( \
2746 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002747 " -f Canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002748
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002749#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002750 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002751#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002752 "Options:\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002753 " -m mapfile (Default: /boot/System.map)\n" \
2754 " -p profile (Default: /proc/profile)\n" \
2755 " -M mult Set the profiling multiplier to mult\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002756 " -i Print only info about the sampling step\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00002757 " -v Verbose\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002758 " -a Print all symbols, even if count is 0\n" \
2759 " -b Print individual histogram-bin counts\n" \
2760 " -s Print individual counters within functions\n" \
2761 " -r Reset all the counters (root only)\n" \
2762 " -n Disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002763
Glenn L McGrath62fae302002-12-10 00:14:33 +00002764#define realpath_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002765 "pathname ..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00002766#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002767 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00002768
Eric Andersen7e9276b2001-02-22 01:15:47 +00002769#define reboot_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00002770 "[-d delay] [-n] [-f]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002771#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002772 "Reboot the system" \
2773 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002774 " -d Delay interval for rebooting\n" \
2775 " -n No call to sync()\n" \
2776 " -f Force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002777
2778#define renice_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002779 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002780#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002781 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002782 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002783 " -n Adjusts current nice value (smaller is faster)\n" \
2784 " -p Process id(s) (default)\n" \
2785 " -g Process group id(s)\n" \
2786 " -u Process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002787
Eric Andersen7e9276b2001-02-22 01:15:47 +00002788#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002789 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002790#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002791 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002792
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002793#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002794 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002795#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002796 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002797
Denis Vlasenko397137b2007-07-23 14:03:30 +00002798#define restorecon_trivial_usage \
2799 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
2800#define restorecon_full_usage \
2801 "Reset security contexts of files in pathname\n" \
2802 "\n -i Ignore files that do not exist" \
2803 "\n -f filename File with list of files to process. Use - for stdin" \
2804 "\n -e directory Directory to exclude" \
2805 "\n -R,-r Recurse directories" \
2806 "\n -n Don't change any file labels" \
2807 "\n -o filename Save list of files with incorrect context" \
2808 "\n -v Verbose" \
2809 "\n -vv Show changed labels" \
2810 "\n -F Force reset of context to match file_context" \
2811 "\n for customizable files, or the user section," \
2812 "\n if it has changed"
2813
Eric Andersen7e9276b2001-02-22 01:15:47 +00002814#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002815 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002816#define rm_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002817 "Remove (unlink) the FILE(s). You may use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002818 "indicate that all following arguments are non-options." \
2819 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002820 " -i Always prompt before removing each destination\n" \
2821 " -f Remove existing destinations, never prompt\n" \
2822 " -r,-R Remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002823#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002824 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002825
Eric Andersen7e9276b2001-02-22 01:15:47 +00002826#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002827 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002828#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002829 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002830#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002831 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002832
Eric Andersen7e9276b2001-02-22 01:15:47 +00002833#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002834 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002835#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002836 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002837 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002838 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002839#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002840 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002841
Eric Andersen7e9276b2001-02-22 01:15:47 +00002842#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002843 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002844#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002845 "Edit the kernel's routing tables" \
2846 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002847 " -n Dont resolve names\n" \
2848 " -e Display other/more information\n" \
2849 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002850
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002851#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002852 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002853#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002854 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002855 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002856 "\n -i Install package" \
2857 "\n -q Query package" \
2858 "\n -p Query uninstalled package" \
2859 "\n -i Show information" \
2860 "\n -l List contents" \
2861 "\n -d List documents" \
2862 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002863
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002864#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002865 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002866#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002867 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002868
Denis Vlasenko49622d72007-03-10 16:58:49 +00002869#define runcon_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002870 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
2871 " runcon CONTEXT COMMAND [args]"
Denis Vlasenko49622d72007-03-10 16:58:49 +00002872#define runcon_full_usage \
2873 "runcon [-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
2874 "runcon CONTEXT COMMAND [args]\n" \
2875 "Run a program in a different security context\n\n" \
2876 " CONTEXT Complete security context\n" \
2877 " -c, --compute Compute process transition context before modifying\n" \
2878 " -t, --type=TYPE Type (for same role as parent)\n" \
2879 " -u, --user=USER User identity\n" \
2880 " -r, --role=ROLE Role\n" \
2881 " -l, --range=RNG Levelrange" \
2882
Eric Andersen6cf47a72001-10-31 10:24:36 +00002883#define run_parts_trivial_usage \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00002884 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002885#define run_parts_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002886 "Run a bunch of scripts in a directory" \
2887 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002888 " -t Prints what would be run, but does not actually run anything\n" \
2889 " -a ARG Pass ARG as an argument for every program invoked\n" \
Bernhard Reutner-Fischerb7cffd42007-03-28 20:35:13 +00002890 " -u MASK Set the umask to MASK before executing every program" \
2891USE_FEATURE_RUN_PARTS_FANCY("\n -l Prints names of all matching files even when they are not executable")
2892
2893#define run_parts_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00002894 "$ run-parts -a start /etc/init.d\n" \
2895 "$ run-parts -a stop=now /etc/init.d\n\n" \
2896 "Let's assume you have a script foo/dosomething:\n" \
2897 "#!/bin/sh\n" \
2898 "for i in $*; do eval $i; done; unset i\n" \
2899 "case \"$1\" in\n" \
2900 "start*) echo starting something;;\n" \
2901 "stop*) set -x; shutdown -h $stop;;\n" \
2902 "esac\n\n" \
2903 "Running this yields:\n" \
2904 "$run-parts -a stop=+4m foo/\n" \
2905 "+ shutdown -h +4m"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002906
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002907#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002908 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002909#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002910 "Find the current and previous system runlevel.\n\n" \
2911 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002912 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002913#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002914 "$ runlevel /var/run/utmp\n" \
2915 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002916
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002917#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002918 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002919#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002920 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002921
2922#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002923 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002924#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002925 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002926
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002927#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002928 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002929#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002930 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002931#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002932 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002933
Eric Andersen7e9276b2001-02-22 01:15:47 +00002934#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002935 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002936#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002937 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002938 " -e script Add the script to the commands to be executed\n" \
2939 " -f scriptfile Add script-file contents to the\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002940 " commands to be executed\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002941 " -i Edit files in-place\n" \
2942 " -n Suppress automatic printing of pattern space\n" \
2943 " -r Use extended regular expression syntax\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002944 "\n" \
2945 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2946 "script to interpret. All remaining arguments are names of input files; if no\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002947 "input files are specified, then the standard input is read. Source files\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002948 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00002949
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002950#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002951 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2952 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002953
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002954#define selinuxenabled_trivial_usage
2955#define selinuxenabled_full_usage
2956
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002957#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002958 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002959#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002960 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002961 "FIRST, INCREMENT default to 1" \
2962 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002963 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002964 " FIRST LAST\n" \
2965 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002966
Paul Foxfc2256a2005-08-01 18:12:30 +00002967#define setconsole_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002968 "[-r|--reset] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00002969#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002970 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002971 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002972 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00002973
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002974#define setenforce_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00002975 "[Enforcing | Permissive | 1 | 0]"
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002976#define setenforce_full_usage
2977
Denis Vlasenko397137b2007-07-23 14:03:30 +00002978#define setfiles_trivial_usage \
2979 "[-dnpqsvW] [-e dir]... [-o filename] [-r alt_root_path]" \
2980 USE_FEATURE_SETFILES_CHECK_OPTION( \
2981 " [-c policyfile] spec_file" \
2982 ) \
2983 " pathname"
2984
2985#define setfiles_full_usage \
2986 "Reset file contexts under pathname according to spec_file" \
2987 USE_FEATURE_SETFILES_CHECK_OPTION( \
2988 "\n -c file Check the validity of the contexts against the specified binary policy" \
2989 ) \
2990 "\n -d Show which specification matched each file" \
2991 "\n -l Log changes in file labels to syslog" \
2992 "\n -n Don't change any file labels" \
Denis Vlasenko1da77722007-07-24 06:17:43 +00002993 "\n -q Suppress warnings" \
Denis Vlasenko397137b2007-07-23 14:03:30 +00002994 "\n -r dir Use an altenate root path" \
2995 "\n -e dir Exclude directory" \
2996 "\n -F Force reset of context to match file_context for customizable files" \
2997 "\n -o file Save list of files with incorrect context" \
2998 "\n -s Take a list of files from standard input (instead of command line)" \
2999 "\n -v Show changes in file labels, if type or role are changing" \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003000 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3001 "\n -W Display warnings about entries that had no matching files"
Denis Vlasenko397137b2007-07-23 14:03:30 +00003002
Eric Andersen7e9276b2001-02-22 01:15:47 +00003003#define setkeycodes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003004 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003005#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003006 "Set entries into the kernel's scancode-to-keycode map,\n" \
3007 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3008 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
3009 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003010#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003011 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003012
Rob Landley87848d92006-03-27 23:23:43 +00003013#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003014 "N"
Rob Landley87848d92006-03-27 23:23:43 +00003015#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003016 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00003017
Paul Fox42403642005-08-01 22:52:09 +00003018#define setsid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003019 "program [arg ...]"
Paul Fox42403642005-08-01 22:52:09 +00003020#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003021 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003022 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00003023
Matt Kraai2d91deb2001-08-01 17:21:35 +00003024#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003025 "[FILE]...\n" \
3026 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00003027#define lash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003028 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00003029#define lash_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003030 "This command does not yet have proper documentation.\n\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003031 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003032 "redirects, job control, can be used as the shell for scripts, and has a\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003033 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
3034 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
3035 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003036 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003037
Eric Andersen2e9c2572003-08-08 22:26:06 +00003038#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003039 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00003040#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003041 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00003042
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003043#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003044 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003045 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003046#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003047 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003048 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003049 "\n\nOptions:\n" \
3050 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003051 " -c Check SHA1 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003052 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003053 " -s Don't output anything, status code shows success\n" \
3054 " -w Warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00003055
Denis Vlasenko14923db2007-06-20 15:23:03 +00003056#define slattach_trivial_usage \
3057 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3058#define slattach_full_usage \
3059 "Attach network interface(s) to serial line(s)\n" \
3060 "\nOptions:" \
3061 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3062 "\n -s Set line speed" \
3063 "\n -e Exit after initializing device" \
3064 "\n -h Exit when the carrier is lost" \
3065 "\n -c Execute a command when the line is hung up" \
3066 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3067 "\n -L Enable 3-wire operation" \
3068 "\n -F Disable RTS/CTS flow control" \
Denis Vlasenko49a128a2007-07-17 21:42:59 +00003069
Eric Andersen7e9276b2001-02-22 01:15:47 +00003070#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003071 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003072#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003073 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003074 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003075 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003076 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003077#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003078 "$ sleep 2\n" \
3079 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003080 USE_FEATURE_FANCY_SLEEP( \
3081 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003082 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00003083
Eric Andersen7e9276b2001-02-22 01:15:47 +00003084#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003085 "[-nru" \
3086 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") \
3087 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003088#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003089 "Sort lines of text in the specified files" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003090 "\n\nOptions:\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003091 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003092 " -b Ignore leading blanks\n" \
3093 " -c Check whether input is sorted\n" \
3094 " -d Dictionary order (blank or alphanumeric only)\n" \
3095 " -f Ignore case\n" \
3096 " -g General numerical sort\n" \
3097 " -i Ignore unprintable characters\n" \
3098 " -k Specify sort key\n" \
3099 " -M Sort month\n") \
3100 " -n Sort numbers\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003101 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003102 " -o Output to file\n" \
3103 " -k Sort by key\n" \
3104 " -t Use key separator other than whitespace\n") \
3105 " -r Reverse sort order\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003106 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003107 " -s Stable (don't sort ties alphabetically)\n") \
3108 " -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003109 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003110 "\n -z Input terminated by nulls, not newlines\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003111 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003112 " -mST Ignored for GNU compatibility") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003113 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003114#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003115 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3116 "a\n" \
3117 "b\n" \
3118 "c\n" \
3119 "d\n" \
3120 "e\n" \
3121 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00003122 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00003123 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3124 "d 2\n" \
3125 "b 2\n" \
3126 "c 3\n" \
3127 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003128 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003129
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003130#define split_trivial_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003131 "[OPTION] [INPUT [PREFIX]]"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003132#define split_full_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003133 "Options:" \
3134 "\n -b n[k|m] Split by bytes" \
3135 "\n -l n Split by lines" \
3136 "\n -a n Use n letters as suffix"
Bernhard Reutner-Fischer4e1361a2007-03-26 14:38:03 +00003137#define split_example_usage \
Denis Vlasenkof5635f42007-08-13 10:48:33 +00003138 "$ split TODO foo\n" \
3139 "$ cat TODO | split -a 2 -l 2 TODO_\n"
Bernhard Reutner-Fischer10f8f5f2007-03-25 21:50:18 +00003140
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003141#define start_stop_daemon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003142 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003143#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003144 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003145 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003146 "\n -S|--start Start" \
3147 "\n -K|--stop Stop" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003148 "\n -a|--startas pathname Starts process specified by pathname" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003149 "\n -b|--background Force process into background" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003150 "\n -u|--user username|uid Stop this user's processes" \
3151 "\n -x|--exec executable Program to either start or check" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003152 "\n -m|--make-pidfile Create the -p file and enter pid in it" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003153 "\n -n|--name process-name Stop processes with this name" \
3154 "\n -p|--pidfile pid-file Save or load pid using a pid-file" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003155 "\n -q|--quiet Quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003156 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003157 "\n -o|--oknodo Exit status 0 if nothing done" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003158 "\n -v|--verbose Verbose" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003159 "\n -N|--nicelevel N Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003160 ) \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003161 "\n -s|--signal signal Signal to send (default TERM)" \
3162 "\n -c|--chuid user[:[group]] Change to specified user/group"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00003163
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003164#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003165 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003166#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003167 "Display file (default) or filesystem status" \
3168 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003169 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003170 " -c fmt Use the specified format\n") \
3171 " -f Display filesystem status\n" \
3172 " -L,-l Dereference links\n" \
3173 " -t Display info in terse form" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003174 USE_SELINUX( \
3175 "\n -Z Print security context" \
3176 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003177 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003178 "\n\nValid format sequences for files:\n" \
3179 " %a Access rights in octal\n" \
3180 " %A Access rights in human readable form\n" \
3181 " %b Number of blocks allocated (see %B)\n" \
3182 " %B The size in bytes of each block reported by %b\n" \
3183 " %d Device number in decimal\n" \
3184 " %D Device number in hex\n" \
3185 " %f Raw mode in hex\n" \
3186 " %F File type\n" \
3187 " %g Group ID of owner\n" \
3188 " %G Group name of owner\n" \
3189 " %h Number of hard links\n" \
3190 " %i Inode number\n" \
3191 " %n File name\n" \
Denis Vlasenko081ef792007-03-17 16:38:21 +00003192 " %N Quoted file name with dereference if symlink\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003193 " %o I/O block size\n" \
3194 " %s Total size, in bytes\n" \
3195 " %t Major device type in hex\n" \
3196 " %T Minor device type in hex\n" \
3197 " %u User ID of owner\n" \
3198 " %U User name of owner\n" \
3199 " %x Time of last access\n" \
3200 " %X Time of last access as seconds since Epoch\n" \
3201 " %y Time of last modification\n" \
3202 " %Y Time of last modification as seconds since Epoch\n" \
3203 " %z Time of last change\n" \
3204 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003205 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003206 " %a Free blocks available to non-superuser\n" \
3207 " %b Total data blocks in file system\n" \
3208 " %c Total file nodes in file system\n" \
3209 " %d Free file nodes in file system\n" \
3210 " %f Free blocks in file system\n" \
Denis Vlasenko49622d72007-03-10 16:58:49 +00003211 USE_SELINUX( \
3212 " %C Security context in SELinux\n" \
3213 ) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003214 " %i File System ID in hex\n" \
3215 " %l Maximum length of filenames\n" \
3216 " %n File name\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003217 " %s Block size (for faster transfer)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003218 " %S Fundamental block size (for block counts)\n" \
3219 " %t Type in hex\n" \
3220 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00003221 )
3222
Eric Andersenef5e8f82002-11-07 02:09:37 +00003223#define strings_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003224 "[-afo] [-n length] [file ...]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003225#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003226 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003227 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003228 "\n -a Scan the whole files (this is the default)" \
3229 "\n -f Precede each string with the name of the file where it was found" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003230 "\n -n N Specifies that at least N characters forms a sequence (default 4)" \
3231 "\n -o Each string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00003232
Eric Andersen7e9276b2001-02-22 01:15:47 +00003233#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003234 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003235#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003236 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003237 "and deviations from stty sane" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003238 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003239 "\n -F DEVICE Open device instead of stdin" \
3240 "\n -a Print all current settings in human-readable form" \
3241 "\n -g Print in stty-readable form" \
3242 "\n [SETTING] See manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003243
Robert Griebl1fca5582002-06-04 20:45:46 +00003244#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003245 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00003246#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003247 "Change user id or become root" \
3248 "\n\nOptions:" \
3249 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003250 "\n -c Command to pass to 'sh -c'" \
3251 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00003252
Eric Andersen27f64e12002-06-23 04:24:25 +00003253#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003254 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003255#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003256 "Single user login" \
3257 "\n\nOptions:" \
3258 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00003259
Mike Frysinger95d3c452005-04-21 23:29:24 +00003260#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003261 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003262#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003263 "Checksum and count the blocks in a file" \
3264 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003265 " -r Use BSD sum algorithm (1K blocks)\n" \
3266 " -s Use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00003267
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003268#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003269 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003270#define sv_full_usage \
Denis Vlasenkof223efb2007-08-03 10:58:12 +00003271 "Control services monitored by runsv supervisor.\n" \
3272 "Commands (only first character is enough):\n" \
3273 "\n" \
3274 "status: query service status\n" \
3275 "up: if service isn't running, start it. If service stops, restart it\n" \
3276 "once: like 'up', but if service stops, don't restart it\n" \
3277 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3278 " if it exists. After it stops, do not restart service\n" \
3279 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3280 " runsv exits too\n" \
3281 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
3282 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003283
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003284#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003285 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003286#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003287 "Continuously read log data from standard input, optionally " \
3288 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003289 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003290
Eric Andersen7e9276b2001-02-22 01:15:47 +00003291#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003292 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003293#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003294 "Stop swapping virtual memory pages on DEVICE" \
3295 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003296 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003297
Eric Andersen7e9276b2001-02-22 01:15:47 +00003298#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003299 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003300#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003301 "Start swapping virtual memory pages on DEVICE" \
3302 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003303 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003304
Rob Landley0f34a822005-10-27 22:55:50 +00003305#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003306 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003307#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003308 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003309 "and exec NEW_INIT" \
3310 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003311 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00003312
Eric Andersen7e9276b2001-02-22 01:15:47 +00003313#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003314 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003315#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003316 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003317
Eric Andersenb9050282003-12-24 06:02:11 +00003318#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003319 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003320#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003321 "Configure kernel parameters at runtime" \
3322 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003323 " -n Use this option to disable printing of the key name when printing values\n" \
3324 " -w Use this option when you want to change a sysctl setting\n" \
3325 " -p Load in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
3326 " -a Display all values currently available\n" \
3327 " -A Display all values currently available in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003328#define sysctl_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003329 "sysctl [-n] variable ...\n" \
3330 "sysctl [-n] -w variable=value ...\n" \
3331 "sysctl [-n] -a\n" \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003332 "sysctl [-n] -p file (default /etc/sysctl.conf)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003333 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003334
Eric Andersen7e9276b2001-02-22 01:15:47 +00003335#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003336 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003337#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003338 "System logging utility.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003339 "Note that this version of syslogd ignores /etc/syslog.conf." \
3340 "\n\nOptions:" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00003341 "\n -n Run as foreground process" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003342 "\n -O FILE Log to given file (default=/var/log/messages)" \
3343 "\n -l n Set local log level" \
3344 "\n -S Smaller logging output" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003345 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003346 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3347 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003348 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003349 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003350 "\n -L Log locally and via network (default is network only if -R)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003351 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko5f1b1492007-08-12 21:33:06 +00003352 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)")
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003353 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003354/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003355#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003356 "$ syslogd -R masterlog:514\n" \
3357 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003358
Eric Andersen7e9276b2001-02-22 01:15:47 +00003359#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003360 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003361#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003362 "Print last 10 lines of each FILE to standard output.\n" \
3363 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003364 "file name. With no FILE, or when FILE is -, read standard input." \
3365 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003366 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003367 "\n -c N[kbm] Output the last N bytes") \
3368 "\n -n N[kbm] Print last N lines instead of last 10" \
3369 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003370 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003371 "\n -q Never output headers giving file names" \
3372 "\n -s SEC Wait SEC seconds between reads with -f" \
3373 "\n -v Always output headers giving file names" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003374 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003375 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3376 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3377 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003378#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003379 "$ tail -n 1 /etc/resolv.conf\n" \
3380 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003381
Eric Andersen7e9276b2001-02-22 01:15:47 +00003382#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003383 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003384 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3385 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003386 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003387 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003388#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003389 "Create, extract, or list files from a tar file" \
3390 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003391 USE_FEATURE_TAR_CREATE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003392 " c Create\n") \
3393 " x Extract\n" \
3394 " t List\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003395 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003396 USE_FEATURE_TAR_GZIP( \
3397 " z Filter the archive through gzip\n") \
3398 USE_FEATURE_TAR_BZIP2( \
3399 " j Filter the archive through bzip2\n") \
3400 USE_FEATURE_TAR_LZMA( \
3401 " a Filter the archive through lzma\n") \
3402 USE_FEATURE_TAR_COMPRESS( \
3403 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003404 "\nFile selection:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003405 " f Name of TARFILE or \"-\" for stdin\n" \
3406 " O Extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003407 USE_FEATURE_TAR_FROM( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003408 " exclude File to exclude\n" \
3409 " X File with names to exclude\n") \
3410 " C Change to directory DIR before operation\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003411 " v Verbose"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003412#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003413 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3414 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003415
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003416#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003417 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003418#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003419 "Set or get CPU affinity" \
3420 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003421 " -p Operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003422#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003423 "$ taskset 0x7 ./dgemm_test&\n" \
3424 "$ taskset -p 0x1 $!\n" \
3425 "pid 4790's current affinity mask: 7\n" \
3426 "pid 4790's new affinity mask: 1\n" \
3427 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3428 "pid 6671's current affinity mask: 1\n" \
3429 "pid 6671's new affinity mask: 1\n" \
3430 "$ taskset -p 1\n" \
3431 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003432
Eric Andersen7e9276b2001-02-22 01:15:47 +00003433#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003434 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003435#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003436 "Copy standard input to each FILE, and also to standard output" \
3437 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003438 " -a Append to the given FILEs, do not overwrite\n" \
3439 " -i Ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003440#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003441 "$ echo \"Hello\" | tee /tmp/foo\n" \
3442 "$ cat /tmp/foo\n" \
3443 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003444
Denis Vlasenkoe3241842007-08-13 10:36:25 +00003445#if ENABLE_FEATURE_TELNET_AUTOLOGIN
Eric Andersen539ffc92004-02-22 12:25:47 +00003446#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003447 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003448#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003449 "Connect to remote telnet server" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003450 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003451 " -a Attempt an automatic login with the USER variable\n" \
3452 " -l USER Attempt an automatic login with the USER argument\n" \
3453 " HOST The official name, alias or the IP address of the\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00003454 " remote host\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003455 " PORT The remote port number to connect to. If it is not\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003456 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003457#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003458#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003459 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003460#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003461 "Connect to remote telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003462#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003463
Eric Andersen08a72202002-09-30 20:52:10 +00003464#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003465 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003466#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003467 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003468 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3469 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003470 "\n -l LOGIN Exec LOGIN on connect" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003471 "\n -f issue_file Display issue_file instead of /etc/issue" \
3472 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003473 "\n -p PORT Port to listen to" \
3474 "\n -b ADDR Address to bind to" \
3475 "\n -F Stay in foreground" \
3476 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003477 )
Eric Andersen08a72202002-09-30 20:52:10 +00003478
Eric Andersen7e9276b2001-02-22 01:15:47 +00003479#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003480 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003481#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003482 "Check file types and compares values returning an exit code\n" \
3483 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003484#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003485 "$ test 1 -eq 2\n" \
3486 "$ echo $?\n" \
3487 "1\n" \
3488 "$ test 1 -eq 1\n" \
3489 "$ echo $?\n" \
3490 "0\n" \
3491 "$ [ -d /etc ]\n" \
3492 "$ echo $?\n" \
3493 "0\n" \
3494 "$ [ -d /junk ]\n" \
3495 "$ echo $?\n" \
3496 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003497
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003498#define tcpsvd_trivial_usage \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003499 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003500/* with not-implemented options: */
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003501/* "[-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 +00003502#define tcpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003503 "Creates TCP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003504 "for incoming connections. For each connection it runs prog." \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003505 "\n" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003506 "\nip IP to listen on. '0' = all" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003507 "\nport Port to listen on" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003508 "\nprog [arg] Program to run" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003509 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3510 "\n-u user[:group] Change to user/group after bind" \
3511 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003512 "\n-b n Allow a backlog of approximately n TCP SYNs" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003513 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3514 "\n New connections from this IP address are closed" \
3515 "\n immediately. 'msg' is written to the peer before close" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003516 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003517 "\n-E Do not set up environment variables" \
Denis Vlasenkoba2fb712007-04-01 09:39:03 +00003518 "\n-v Verbose"
Denis Vlasenko2856dab2007-04-01 01:18:20 +00003519
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003520#define udpsvd_trivial_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003521 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003522#define udpsvd_full_usage \
Denis Vlasenko79468792007-04-04 11:02:55 +00003523 "Creates UDP socket, binds it to ip:port and listens on it\n" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003524 "for incoming packets. For each packet it runs prog\n" \
3525 "(redirecting all further packets with same peer ip:port to it)." \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003526 "\n" \
3527 "\nip IP to listen on. '0' = all" \
3528 "\nport Port to listen on" \
3529 "\nprog [arg] Program to run" \
3530 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3531 "\n-u user[:group] Change to user/group after bind" \
Denis Vlasenko02fd6682007-04-03 23:23:10 +00003532 "\n-c n Handle up to n connections simultaneously" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003533 "\n-h Look up peer's hostname" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003534 "\n-E Do not set up environment variables" \
Denis Vlasenko992e05b2007-04-03 01:13:04 +00003535 "\n-v Verbose"
Denis Vlasenko60fadac2007-04-01 19:10:36 +00003536
Mark Whitley450736c2001-03-02 19:08:50 +00003537#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003538 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003539#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003540 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003541 "\n\nOptions:" \
3542 "\n -l FILE Local FILE" \
3543 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003544 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003545 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003546 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003547 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003548 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003549 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003550 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003551 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003552 )
Eric Andersenc3657422001-11-30 07:54:32 +00003553#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003554 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003555#define time_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003556 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003557 "COMMAND's resource usage information is displayed." \
3558 "\n\nOptions:\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003559 " -v Verbose"
Mark Whitley450736c2001-03-02 19:08:50 +00003560
Eric Andersen420b2082002-09-17 22:14:58 +00003561#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003562 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003563#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003564 "Provide a view of process activity in real time.\n" \
3565 "Read the status of all processes from /proc each <seconds>\n" \
3566 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003567
Eric Andersen7e9276b2001-02-22 01:15:47 +00003568#define touch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003569 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003570#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003571 "Update the last-modified date on the given FILE[s]" \
3572 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003573 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003574#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003575 "$ ls -l /tmp/foo\n" \
3576 "/bin/ls: /tmp/foo: No such file or directory\n" \
3577 "$ touch /tmp/foo\n" \
3578 "$ ls -l /tmp/foo\n" \
3579 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003580
3581#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003582 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003583#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003584 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003585 "standard input, writing to standard output" \
3586 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003587 " -c Take complement of STRING1\n" \
3588 " -d Delete input characters coded STRING1\n" \
3589 " -s Squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003590#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003591 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3592 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003593
Eric Andersen5c58d282001-07-10 16:29:00 +00003594#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003595 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3596 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3597 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003598#define traceroute_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003599 "Trace the route ip packets follow going to \"host\"" \
3600 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003601 " -F Set the don't fragment bit\n" \
3602 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3603 " -l Display the ttl value of the returned packet\n" \
3604 " -d Set SO_DEBUG options to socket\n" \
3605 " -n Print hop addresses numerically rather than symbolically\n" \
3606 " -r Bypass the normal routing tables and send directly to a host\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003607 " -v Verbose\n" \
3608 " -m max_ttl Max time-to-live (max number of hops)\n" \
3609 " -p port# Base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003610 " (default is 33434)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003611 " -q nqueries Number of probes per 'ttl' (default 3)\n" \
3612 " -s src_addr IP address to use as the source address\n" \
3613 " -t tos Type-of-service in probe packets (default 0)\n" \
3614 " -w wait Time in seconds to wait for a response to a probe\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003615 " (default 3 sec)\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003616 " -g Specify a loose source route gateway (8 max)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003617
3618
Eric Andersen7e9276b2001-02-22 01:15:47 +00003619#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003620 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003621#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003622 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003623#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003624 "$ true\n" \
3625 "$ echo $?\n" \
3626 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003627
Eric Andersen7e9276b2001-02-22 01:15:47 +00003628#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003629 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003630#define tty_full_usage \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003631 "Print file name of standard input's terminal" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003632 USE_INCLUDE_SUSv2( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003633 "\n\nOptions:\n" \
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003634 " -s Print nothing, only return exit status")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003635#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003636 "$ tty\n" \
3637 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003638
Denis Vlasenkoc01af952007-08-02 22:23:47 +00003639#define ttysize_trivial_usage \
3640 "[w] [h]"
3641#define ttysize_full_usage \
3642 "Print dimension(s) of standard input's terminal, on error return 80x25"
3643
Mike Frysinger174808c2005-06-11 01:14:09 +00003644#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003645 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3646 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3647 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3648 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3649 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3650 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003651#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003652 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00003653
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003654#define udhcpc_trivial_usage \
Denis Vlasenkoc82b5102007-07-01 17:05:57 +00003655 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
3656 " [-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003657#define udhcpc_full_usage \
Denis Vlasenko72d260d2007-08-17 08:45:58 +00003658 " -V,--vendorclass=CLASSID Set vendor class identifier" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003659 "\n -i,--interface=INTERFACE Interface to use (default: eth0)" \
3660 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
3661 "\n -c,--clientid=CLIENTID Set client identifier" \
3662 "\n -C,--clientid-none Suppress default client identifier" \
3663 "\n -p,--pidfile=file Store process ID of daemon in file" \
3664 "\n -r,--request=IP IP address to request" \
3665 "\n -s,--script=file Run file at dhcp events (default: /usr/share/udhcpc/default.script)" \
3666 "\n -t,--retries=N Send up to N request packets"\
3667 "\n -f,--foreground Stay in foreground" \
3668 "\n -b,--background Background if lease cannot be immediately negotiated" \
3669 "\n -S,--syslog Log to syslog too" \
3670 "\n -n,--now Exit with failure if lease cannot be immediately negotiated" \
3671 "\n -q,--quit Quit after obtaining lease" \
3672 "\n -R,--release Release IP on quit" \
3673 "\n -v,--version Display version" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003674
Russ Dill61fb4892002-10-14 21:41:28 +00003675#define udhcpd_trivial_usage \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003676 "[-fS] [configfile]" \
Russ Dill61fb4892002-10-14 21:41:28 +00003677
3678#define udhcpd_full_usage \
Denis Vlasenko9f7b92a2007-08-15 20:03:36 +00003679 "DHCP server" \
Denis Vlasenko3d17d2b2007-08-14 16:45:29 +00003680 "\n -f Stay in foreground" \
3681 "\n -S Log to syslog too"
Russ Dill61fb4892002-10-14 21:41:28 +00003682
Eric Andersen7e9276b2001-02-22 01:15:47 +00003683#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003684 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003685#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003686 "Unmount file systems" \
3687 "\n\nOptions:\n" \
Denis Vlasenko7fb8a002007-03-07 22:49:53 +00003688 USE_FEATURE_UMOUNT_ALL( \
3689 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab")) \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003690 USE_FEATURE_MTAB_SUPPORT( \
3691 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003692 "\n -r Try to remount devices as read-only if mount is busy" \
3693 "\n -l Lazy umount (detach filesystem)" \
3694 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003695 USE_FEATURE_MOUNT_LOOP( \
3696 "\n -D Do not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003697#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003698 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003699
3700#define uname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003701 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003702#define uname_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003703 "Print certain system information. With no OPTION, same as -s." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003704 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003705 " -a Print all information\n" \
3706 " -m The machine (hardware) type\n" \
3707 " -n Print the machine's network node hostname\n" \
3708 " -r Print the operating system release\n" \
3709 " -s Print the operating system name\n" \
3710 " -p Print the host processor type\n" \
3711 " -v Print the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003712#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003713 "$ uname -a\n" \
3714 "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 +00003715
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003716#define uncompress_trivial_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003717 "[-c] [-f] [name...]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003718#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003719 "Uncompress .Z file[s]" \
3720 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003721 " -c Extract to stdout\n" \
3722 " -f Force overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003723
Denis Vlasenko3952f202007-08-13 14:10:24 +00003724#define unexpand_trivial_usage \
3725 "[-f][-a][-t NUM] [FILE|-]"
3726#define unexpand_full_usage \
3727 "Convert spaces to tabs, writing to standard output." \
3728 "\n\nOptions:" \
3729 "\n -a" USE_FEATURE_UNEXPAND_LONG_OPTIONS(",--all") \
3730 " Convert all blanks" \
3731 "\n -f" USE_FEATURE_UNEXPAND_LONG_OPTIONS(",--first-only") \
3732 " Convert only leading sequences of blanks" \
3733 "\n -t" USE_FEATURE_UNEXPAND_LONG_OPTIONS(",--tabs=N") \
3734 " Tabstops every N chars"
3735
Eric Andersen7e9276b2001-02-22 01:15:47 +00003736#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003737 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003738#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003739 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003740 "(or standard input), writing to OUTPUT (or standard output)" \
3741 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003742 " -c Prefix lines by the number of occurrences\n" \
3743 " -d Only print duplicate lines\n" \
3744 " -u Only print unique lines\n" \
3745 " -f N Skip the first N fields\n" \
3746 " -s N Skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003747#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003748 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3749 "a\n" \
3750 "b\n" \
3751 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003752
3753#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003754 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003755#define unix2dos_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003756 "Convert FILE from unix format to dos format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003757 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003758 "When no file is given, use stdin/stdout." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003759 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003760 " -u Output will be in UNIX format\n" \
3761 " -d Output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003762
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003763#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003764 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003765#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003766 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003767 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003768 " -l List archive contents (short form)\n" \
3769 " -n Never overwrite existing files (default)\n" \
3770 " -o Overwrite files without prompting\n" \
3771 " -p Send output to stdout\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003772 " -q Quiet\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003773 " -x Exclude these files\n" \
3774 " -d Extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003775
Eric Andersen7e9276b2001-02-22 01:15:47 +00003776#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003777 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003778#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003779 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003780#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003781 "$ uptime\n" \
3782 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003783
3784#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003785 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003786#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003787 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003788#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003789 "$ usleep 1000000\n" \
3790 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003791
3792#define uudecode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00003793 "[-o outfile] [infile]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003794#define uudecode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00003795 "Uudecode a file\n" \
3796 "NB: finds outfile name in uuencoded source unless -o is given"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003797#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003798 "$ uudecode -o busybox busybox.uu\n" \
3799 "$ ls -l busybox\n" \
3800 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003801
3802#define uuencode_trivial_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00003803 "[-m] [infile] stored_filename"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003804#define uuencode_full_usage \
Denis Vlasenko746204b2007-06-04 23:32:35 +00003805 "Uuencode a file to stdout" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003806 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003807 " -m Use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003808#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003809 "$ uuencode busybox busybox\n" \
3810 "begin 755 busybox\n" \
3811 "<encoded file snipped>\n" \
3812 "$ uudecode busybox busybox > busybox.uu\n" \
3813 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003814
Eric Andersen853c4942003-01-23 05:59:32 +00003815#define vconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003816 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003817#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003818 "Create and remove virtual ethernet devices" \
3819 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003820 " add [interface-name] [vlan_id]\n" \
3821 " rem [vlan-name]\n" \
3822 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
3823 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3824 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3825 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003826
Eric Andersen3f980402001-04-04 17:31:15 +00003827#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003828 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00003829#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003830 "Edit FILE" \
3831 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003832 " -R Read-only - do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003833
Eric Andersen27f64e12002-06-23 04:24:25 +00003834#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003835 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003836#define vlock_full_usage \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003837 "Lock a virtual terminal. A password is required to unlock." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003838 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003839 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00003840
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003841#define watch_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003842 "[-n seconds] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003843#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003844 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003845 "\n\nOptions:\n" \
3846 " -n Loop period in seconds - default is 2\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003847 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003848#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003849 "$ watch date\n" \
3850 "Mon Dec 17 10:31:40 GMT 2000\n" \
3851 "Mon Dec 17 10:31:42 GMT 2000\n" \
3852 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003853
Eric Andersen7e9276b2001-02-22 01:15:47 +00003854#define watchdog_trivial_usage \
Denis Vlasenko21d10142007-07-20 21:28:41 +00003855 "[-t seconds] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003856#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003857 "Periodically write to watchdog device DEV" \
3858 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003859 " -t Timer period in seconds - default is 30\n" \
3860 " -F Stay in the foreground and don't fork"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003861
3862#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003863 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003864#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003865 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenkob69e8722007-07-18 21:57:24 +00003866 "more than one FILE is specified. With no FILE, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003867 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003868 " -c Print the byte counts\n" \
3869 " -l Print the newline counts\n" \
3870 " -L Print the length of the longest line\n" \
3871 " -w Print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003872#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003873 "$ wc /etc/passwd\n" \
3874 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003875
3876#define wget_trivial_usage \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003877 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003878 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
3879 " [-U|--user-agent agent] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003880#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003881 "Retrieve files via HTTP or FTP" \
3882 "\n\nOptions:\n" \
Bernhard Reutner-Fischer2e75dcc2007-04-05 10:31:47 +00003883 " -s Spider mode - only check file existence\n" \
3884 " -c Continue retrieval of aborted transfer\n" \
Denis Vlasenko79468792007-04-04 11:02:55 +00003885 " -q Quiet\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003886 " -P Set directory prefix to DIR\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003887 " -O Save to filename ('-' for stdout)\n" \
3888 " -U Adjust 'User-Agent' field\n" \
3889 " -Y Use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003890
3891#define which_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003892 "[COMMAND ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003893#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003894 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003895#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003896 "$ which login\n" \
3897 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003898
Eric Andersen00a6a752002-04-26 23:53:10 +00003899#define who_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003900 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003901#define who_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003902 "Print the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003903
3904#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003905 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003906#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003907 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003908
3909#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003910 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003911#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003912 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003913 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003914 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
3915 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003916 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003917 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
3918 " -x Exit if the size is exceeded\n") \
3919 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
3920 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003921 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003922#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003923 "$ ls | xargs gzip\n" \
3924 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003925
3926#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003927 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003928#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003929 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003930
Eric Andersen7e9276b2001-02-22 01:15:47 +00003931#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003932 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003933#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003934 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00003935
Rob Landleyad8071f2005-04-30 03:49:37 +00003936#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003937 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00003938#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003939 "Manage a ZeroConf IPv4 link-local address" \
3940 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003941 " -f Foreground mode\n" \
3942 " -q Quit after address (no daemon)\n" \
3943 " -r 169.254.x.x Request this address first\n" \
3944 " -v Verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00003945
Eric Andersen178de172004-04-06 16:36:20 +00003946#endif /* __BB_USAGE_H__ */