blob: 5073c9b8abbbb022d70a872770f5501ebafd9217 [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 \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000015 "[-g GID] group_name [user_name]"
Eric Andersenf349e972001-08-21 16:18:59 +000016#define addgroup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +000017 "Add a group to the system" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000018 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000019 " -g GID Specify gid"
Eric Andersenf349e972001-08-21 16:18:59 +000020
21#define adduser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000022 "[OPTIONS] user_name"
Eric Andersenf349e972001-08-21 16:18:59 +000023#define adduser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +000024 "Add a user to the system" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000025 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000026 " -h DIR Assign home directory DIR\n" \
27 " -g GECOS Assign gecos field GECOS\n" \
28 " -s SHELL Assign login shell SHELL\n" \
29 " -G Add the user to existing group GROUP\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000030 " -S Create a system user (ignored)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000031 " -D Do not assign a password (logins still possible via ssh)\n" \
32 " -H Do not create the home directory"
Eric Andersenf349e972001-08-21 16:18:59 +000033
Mark Whitley6f932772001-03-20 19:18:10 +000034#define adjtimex_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000035 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
Mark Whitley6f932772001-03-20 19:18:10 +000036#define adjtimex_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +000037 "Read and optionally set system timebase parameters.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000038 "See adjtimex(2)." \
39 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000040 " -q Quiet mode - do not print\n" \
41 " -o offset Time offset, microseconds\n" \
42 " -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000043 " (positive values make the system clock run fast)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000044 " -t tick Microseconds per tick, usually 10000\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000045 " -p timeconstant"
Mark Whitley6f932772001-03-20 19:18:10 +000046
Eric Andersen7e9276b2001-02-22 01:15:47 +000047#define ar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000048 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
Eric Andersen7e9276b2001-02-22 01:15:47 +000049#define ar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +000050 "Extract or list FILES from an ar archive" \
51 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +000052 " -o Preserve original dates\n" \
53 " -p Extract to stdout\n" \
54 " -t List\n" \
55 " -x Extract\n" \
56 " -v Verbosely list files processed"
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" \
84 " -q Be quiet\n" \
85 " -b Keep broadcasting, don't go unicast\n" \
86 " -D Duplicated address detection mode\n" \
87 " -U Unsolicited ARP mode, update your neighbours\n" \
88 " -A ARP answer mode, update your neighbours\n" \
89 " -c count Stop after sending count ARP request packets\n" \
90 " -w timeout Time to wait for ARP reply, in seconds\n" \
91 " -i device Outgoing interface name, default is eth0\n" \
92 " -s sender Set specific sender IP address\n" \
93 " target Target IP address of ARP request"
Glenn L McGrath9e598412003-01-09 10:06:01 +000094
Eric Andersen08f59e32004-03-12 22:07:10 +000095#define ash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000096 "[FILE]...\n" \
97 "or: ash -c command [args]..."
Eric Andersen08f59e32004-03-12 22:07:10 +000098#define ash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000099 "The ash shell (command interpreter)"
Eric Andersen08f59e32004-03-12 22:07:10 +0000100
101#define awk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000102 "[OPTION]... [program-text] [FILE ...]"
Eric Andersen08f59e32004-03-12 22:07:10 +0000103#define awk_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000104 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000105 " -v var=val Assign value 'val' to variable 'var'\n" \
106 " -F sep Use 'sep' as field separator\n" \
107 " -f progname Read program source from file 'progname'"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +0000108
Eric Andersen7e9276b2001-02-22 01:15:47 +0000109#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000110 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000111#define basename_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000112 "Strip directory path and suffixes from FILE.\n" \
113 "If specified, also remove any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000114#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000115 "$ basename /usr/local/bin/foo\n" \
116 "foo\n" \
117 "$ basename /usr/local/bin/\n" \
118 "bin\n" \
119 "$ basename /foo/bar.txt .txt\n" \
120 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000121
Glenn L McGrath24e28332001-10-05 03:48:57 +0000122#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000123 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000124#define bunzip2_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000125 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
126 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000127 " -c Write output to standard output\n" \
128 " -f Force"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000129
Rob Landley6130b9b2006-01-23 21:10:38 +0000130#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000131 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000132
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000133#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000134 "FILE"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000135#define bzcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000136 "Uncompress to stdout"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000137
Rob Landleyc1d69902006-01-20 18:28:50 +0000138#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000139 "[OPTION]... [FILE]"
Rob Landleyc1d69902006-01-20 18:28:50 +0000140#define unlzma_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000141 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
142 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000143 " -c Write output to standard output\n" \
144 " -f Force"
Rob Landleyc1d69902006-01-20 18:28:50 +0000145
146#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000147 "FILE"
Rob Landleyc1d69902006-01-20 18:28:50 +0000148#define lzmacat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000149 "Uncompress to stdout"
Rob Landleyc1d69902006-01-20 18:28:50 +0000150
Eric Andersenc98c0622001-12-06 15:16:43 +0000151#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000152 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000153#define cal_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000154 "Display a calendar" \
155 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000156 " -j Use julian dates\n" \
157 " -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 Vlasenko765996a2006-12-24 16:59:27 +0000163 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000164 " -u Ignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000165#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000166 "$ cat /proc/uptime\n" \
167 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000168
Rob Landley8abbee42006-05-31 19:36:04 +0000169#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000170 "[-etv] [FILE]..."
Rob Landley8abbee42006-05-31 19:36:04 +0000171#define catv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000172 "Display nonprinting characters as ^x or M-x" \
173 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000174 " -e End each line with $\n" \
175 " -t Show tabs as ^I\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000176 " -v Don't use ^x or M-x escapes"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000177#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000178 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000179#define chattr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000180 "Change file attributes on an ext2 fs\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000181 "Modifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000182 " - Remove attributes\n" \
183 " + Add attributes\n" \
184 " = Set attributes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000185 "Attributes:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000186 " A Don't track atime\n" \
187 " a Append mode only\n" \
188 " c Enable compress\n" \
189 " D Write dir contents synchronously\n" \
190 " d Do not backup with dump\n" \
191 " i Cannot be modified (immutable)\n" \
192 " j Write all data to journal first\n" \
193 " s Zero disk storage when deleted\n" \
194 " S Write file contents synchronously\n" \
195 " t Disable tail-merging of partial blocks with other files\n" \
196 " u Allow file to be undeleted\n" \
Denis Vlasenko5dd7ef02006-12-26 03:36:28 +0000197 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000198 " -R Recursively list subdirectories\n" \
199 " -v Set the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000200
Eric Andersen7e9276b2001-02-22 01:15:47 +0000201#define chgrp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000202 "[-Rh"USE_DESKTOP("cvf")"]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000203#define chgrp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000204 "Change the group membership of each FILE to GROUP" \
205 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000206 " -R Changes files and directories recursively\n" \
207 " -h Do not dereference symbolic links" \
Denis Vlasenkoe80e2a32006-10-27 23:28:38 +0000208 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000209 "\n -c List changed files" \
210 "\n -v List all files" \
211 "\n -f Hide errors" \
Denis Vlasenkoe80e2a32006-10-27 23:28:38 +0000212 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000213#define chgrp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000214 "$ ls -l /tmp/foo\n" \
215 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
216 "$ chgrp root /tmp/foo\n" \
217 "$ ls -l /tmp/foo\n" \
218 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000219
Eric Andersen7e9276b2001-02-22 01:15:47 +0000220#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000221 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000222#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000223 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000224 "symbols +-= and one or more of the letters rwxst" \
225 "\n\nOptions:" \
226 "\n -R Changes files and directories recursively" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000227 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000228 "\n -c List changed files" \
229 "\n -v List all files" \
230 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000231 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000232#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000233 "$ ls -l /tmp/foo\n" \
234 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
235 "$ chmod u+x /tmp/foo\n" \
236 "$ ls -l /tmp/foo\n" \
237 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
238 "$ chmod 444 /tmp/foo\n" \
239 "$ ls -l /tmp/foo\n" \
240 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000241
Eric Andersen7e9276b2001-02-22 01:15:47 +0000242#define chown_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000243 "[-Rh"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000244#define chown_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000245 "Change the owner and/or group of each FILE to OWNER and/or GROUP" \
246 "\n\nOptions:" \
247 "\n -R Changes files and directories recursively" \
248 "\n -h Do not dereference symbolic links" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000249 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000250 "\n -c List changed files" \
251 "\n -v List all files" \
252 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000253 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000254#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000255 "$ ls -l /tmp/foo\n" \
256 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
257 "$ chown root /tmp/foo\n" \
258 "$ ls -l /tmp/foo\n" \
259 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
260 "$ chown root.root /tmp/foo\n" \
261 "ls -l /tmp/foo\n" \
262 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000263
Denis Vlasenkofe544582006-10-03 15:57:40 +0000264#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000265 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
266 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
267 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000268#define chpst_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000269 "Change the process state and run specified program" \
270 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000271 " -u user[:grp] Set uid and gid\n" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +0000272 " -U user[:grp] Set environment variables UID and GID\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000273 " -e dir Set environment variables as specified by files\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000274 " in the directory: file=1st_line_of_file\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000275 " -/ dir Chroot to dir\n" \
276 " -n inc Add inc to nice value\n" \
277 " -m bytes Limit data segment, stack segment, locked physical pages,\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000278 " and total of all segment per process to bytes bytes each\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000279 " -d bytes Limit data segment\n" \
280 " -o n Limit the number of open file descriptors per process to n\n" \
281 " -p n Limit number of processes per uid to n\n" \
282 " -f bytes Limit output file size to bytes bytes\n" \
283 " -c bytes Limit core file size to bytes bytes\n" \
284 " -v Verbose\n" \
285 " -P Run prog in a new process group\n" \
286 " -0 Close standard input\n" \
287 " -1 Close standard output\n" \
288 " -2 Close standard error"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000289#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000290 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000291#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000292 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
293 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000294#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000295 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000296#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000297 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000298#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000299 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000300#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000301 "Set various environment variables as specified by files\n" \
302 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000303#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000304 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
305 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
306 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000307#define softlimit_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000308 "Set soft resource limits, then run prog" \
309 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000310 " -m n Same as -d n -s n -l n -a n\n" \
311 " -d n Limit the data segment per process to n bytes\n" \
312 " -s n Limit the stack segment per process to n bytes\n" \
313 " -l n Limit the locked physical pages per process to n bytes\n" \
314 " -a n Limit the total of all segments per process to n bytes\n" \
315 " -o n Limit the number of open file descriptors per process to n\n" \
316 " -p n Limit the number of processes per uid to n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000317 "Options controlling file sizes:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000318 " -f n Limit output file sizes to n bytes\n" \
319 " -c n Limit core file sizes to n bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000320 "Efficiency opts:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000321 " -r n Limit the resident set size to n bytes. This limit is not\n" \
322 " enforced unless physical memory is full\n" \
323 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
324 " except that the process receives a SIGXCPU signal after n seconds\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000325 "\n" \
326 "Some options may have no effect on some operating systems\n" \
327 "n may be =, indicating that soft limit should be set equal to hard limit"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000328
Eric Andersen7e9276b2001-02-22 01:15:47 +0000329#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000330 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000331#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000332 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000333#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000334 "$ ls -l /bin/ls\n" \
335 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
336 "# mount /dev/hdc1 /mnt -t minix\n" \
337 "# chroot /mnt\n" \
338 "# ls -l /bin/ls\n" \
339 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000340
Eric Andersen7e9276b2001-02-22 01:15:47 +0000341#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000342 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000343#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000344 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000345
Rob Landley856489b2006-04-18 20:57:28 +0000346#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000347 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000348#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000349 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000350
Eric Andersen7e9276b2001-02-22 01:15:47 +0000351#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000352 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000353#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000354 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000355
Eric Andersen7e9276b2001-02-22 01:15:47 +0000356#define cmp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000357 "[-l] [-s] FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000358#define cmp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000359 "Compares FILE1 vs stdin if FILE2 is not specified" \
360 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000361 " -l Write the byte numbers (decimal) and values (octal)\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000362 " for all differing bytes\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000363 " -s Quiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000364
Rob Landley2acfd7b2005-05-11 23:12:49 +0000365#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000366 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000367#define comm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000368 "Compare FILE1 to FILE2, or to stdin if - is specified" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000369 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000370 " -1 Suppress lines unique to FILE1\n" \
371 " -2 Suppress lines unique to FILE2\n" \
372 " -3 Suppress lines common to both files"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000373
Paul Fox79c142d2005-08-01 16:04:40 +0000374#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000375 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000376#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000377 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000378
Rob Landley69674942006-09-11 00:34:01 +0000379#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000380 "[FILE]...\n" \
381 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000382#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000383 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000384
Eric Andersen7e9276b2001-02-22 01:15:47 +0000385#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000386 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000387#define cp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000388 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY" \
389 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000390 " -a Same as -dpR\n" \
391 " -d,-P Preserve links\n" \
392 " -H,-L Dereference all symlinks (implied by default)\n" \
393 " -p Preserve file attributes if possible\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000394 " -f Force, overwrite\n" \
395 " -i Interactive, prompt before overwrite\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000396 " -R,-r Copy directories recursively\n" \
397 " -l,-s Create (sym)links"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000398
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000399#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000400 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000401#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000402 "Extract or list files from a cpio archive\n" \
403 "Main operation mode:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000404 " d Make leading directories\n" \
405 " i Extract\n" \
406 " m Preserve mtime\n" \
407 " t List\n" \
408 " v Verbose\n" \
409 " u Unconditional overwrite\n" \
410 " F Input from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000411
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000412#define crond_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000413 "-d[#] -c <crondir> -f -b"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000414#define crond_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000415 " -d [#] -l [#] -S -L logfile -f -b -c dir\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000416 " -d num Debug level\n" \
417 " -l num Log level (8 - default)\n" \
418 " -S Log to syslogd (default)\n" \
419 " -L file Log to file\n" \
420 " -f Run in foreground\n" \
421 " -b Run in background (default)\n" \
422 " -c dir Working dir"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000423
424#define crontab_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000425 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000426#define crontab_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000427 " File <opts> replace crontab from file\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000428 " - <opts> replace crontab from stdin\n" \
429 " -u user specify user\n" \
430 " -l [user] list crontab for user\n" \
431 " -e [user] edit crontab for user\n" \
432 " -d [user] delete crontab for user\n" \
433 " -c dir specify crontab directory"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000434
435
Eric Andersen7e9276b2001-02-22 01:15:47 +0000436#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000437 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000438#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000439 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000440 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000441 " -b LIST Output only bytes from LIST\n" \
442 " -c LIST Output only characters from LIST\n" \
443 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
444 " -s Output only the lines containing delimiter\n" \
445 " -f N Print only these fields\n" \
446 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000447#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000448 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
449 "Hello\n" \
450 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
451 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000452
Eric Andersen7e9276b2001-02-22 01:15:47 +0000453#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000454 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000455#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000456 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000457 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000458 " -R Outputs RFC-822 compliant date string\n" \
459 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000460 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000461 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
462 " TIMESPEC='date' (or missing) for date only,\n" \
463 " 'hours', 'minutes', or 'seconds' for date and,\n" \
464 " time to the indicated precision\n" \
465 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000466 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000467 " -s Sets time described by STRING\n" \
468 " -r FILE Displays the last modification time of FILE\n" \
469 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000470#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000471 "$ date\n" \
472 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000473
Eric Andersen7e9276b2001-02-22 01:15:47 +0000474#define dc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000475 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000476#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000477 "This is a Tiny RPN calculator that understands the\n" \
478 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
479 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000480 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
481 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000482 "p - Prints the value on the top of the stack, without altering the stack\n" \
483 "f - Prints the entire contents of the stack without altering anything\n" \
484 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
485 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000486#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000487 "$ dc 2 2 + p\n" \
488 "4\n" \
489 "$ dc 8 8 \\* 2 2 + / p\n" \
490 "16\n" \
491 "$ dc 0 1 and p\n" \
492 "0\n" \
493 "$ dc 0 1 or p\n" \
494 "1\n" \
495 "$ echo 72 9 div 8 mul p | dc\n" \
496 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000497
Eric Andersen7e9276b2001-02-22 01:15:47 +0000498#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000499 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
500 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000501#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000502 "Copy a file with converting and formatting" \
503 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000504 " if=FILE Read from FILE instead of stdin\n" \
505 " of=FILE Write to FILE instead of stdout\n" \
506 " bs=N Read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000507 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000508 " ibs=N Read N bytes at a time\n") \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000509 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000510 " obs=N Write N bytes at a time\n") \
511 " count=N Copy only N input blocks\n" \
512 " skip=N Skip N input blocks\n" \
513 " seek=N Skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000514 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000515 " conv=notrunc Don't truncate output file\n" \
516 " conv=noerror Continue after read errors\n" \
517 " conv=sync Pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000518 "\n" \
519 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
520 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000521#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000522 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
523 "4+0 records in\n" \
524 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000525
Eric Andersen7e9276b2001-02-22 01:15:47 +0000526#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000527 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000528#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000529 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000530
Eric Andersenf349e972001-08-21 16:18:59 +0000531#define delgroup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000532 "GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000533#define delgroup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000534 "Delete group GROUP from the system"
Eric Andersenf349e972001-08-21 16:18:59 +0000535
536#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000537 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000538#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000539 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000540
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000541#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000542 "mntpnt [-v]" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000543 USE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000544#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000545 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000546 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000547 "\n mntpnt The mount point where devfs is mounted" \
548 "\n -v Print the protocol version numbers for devfsd" \
549 "\n and the kernel-side protocol version and exits" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000550 USE_DEVFSD_FG_NP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000551 "\n -fg Run the daemon in the foreground" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000552 "\n -np Exit after parsing the configuration file" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000553 "\n and processing synthetic REGISTER events," \
554 "\n do not poll for events")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000555
Eric Andersen7e9276b2001-02-22 01:15:47 +0000556#define df_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000557 "[-" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000558#define df_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000559 "Print the filesystem space used and space available" \
560 "\n\nOptions:\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000561 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000562 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
563 " -m Print sizes in megabytes\n" \
564 " -k Print sizes in kilobytes(default)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000565 SKIP_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000566 "\n -k Ignored")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000567#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000568 "$ df\n" \
569 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
570 "/dev/sda3 8690864 8553540 137324 98% /\n" \
571 "/dev/sda1 64216 36364 27852 57% /boot\n" \
572 "$ df /dev/sda3\n" \
573 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
574 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000575
Denis Vlasenko736230e2006-11-20 19:40:36 +0000576#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000577 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000578#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000579 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000580
581#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000582 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000583#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000584 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000585
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000586#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000587 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000588#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000589 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000590 "This diff implementation only supports unified diffs." \
591 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000592 " -a Treat all files as text\n" \
593 " -b Ignore changes in the amount of whitespace\n" \
594 " -d Try hard to find a smaller set of changes\n" \
595 " -i Ignore case differences\n" \
596 " -L Use LABEL instead of the filename in the unified header\n" \
597 " -N Treat absent files as empty\n" \
598 " -q Output only whether files differ\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +0000599 " -r Recursively compare subdirectories\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000600 " -S Start with FILE when comparing directories\n" \
601 " -T Make tabs line up by prefixing a tab when necessary\n" \
602 " -s Report when two files are the same\n" \
603 " -t Expand tabs to spaces in output\n" \
604 " -U Output LINES lines of context\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000605 " -w Ignore all whitespace"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000606
Eric Andersen7e9276b2001-02-22 01:15:47 +0000607#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000608 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000609#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000610 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000611#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000612 "$ dirname /tmp/foo\n" \
613 "/tmp\n" \
614 "$ dirname /tmp/foo/\n" \
615 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000616
Eric Andersen7e9276b2001-02-22 01:15:47 +0000617#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000618 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000619#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000620 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000621 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000622 " -c Clears the ring buffer's contents after printing\n" \
623 " -n LEVEL Sets console logging level\n" \
624 " -s SIZE Use a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000625
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000626#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000627 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000628#define dnsd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000629 "Small and static DNS server daemon" \
630 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000631 " -c Config filename\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000632 " -t TTL in seconds\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000633 " -p Listening port\n" \
634 " -i Listening iface ip (default all)\n" \
635 " -d Daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000636
Eric Andersen7e9276b2001-02-22 01:15:47 +0000637#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000638 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000639#define dos2unix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000640 "Convert FILE from dos format to unix format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000641 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000642 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000643 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000644 " -u Output will be in UNIX format\n" \
645 " -d Output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000646
Eric Andersen7e9276b2001-02-22 01:15:47 +0000647#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000648 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000649#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000650 "Install, remove and manage Debian packages" \
651 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000652 " -i Install the package\n" \
653 " -l List of installed packages\n" \
654 " -C Configure an unpackaged package\n" \
655 " -F depends Ignore dependency problems\n" \
656 " -P Purge all files of a package\n" \
657 " -r Remove all but the configuration files for a package\n" \
658 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000659
Eric Andersen7e9276b2001-02-22 01:15:47 +0000660#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000661 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000662#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000663 "Perform actions on Debian packages (.debs)" \
664 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000665 " -c List contents of filesystem tree\n" \
666 " -e Extract control files to [argument] directory\n" \
667 " -f Display control field name starting with [argument]\n" \
668 " -x Extract packages filesystem tree to directory\n" \
669 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000670#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000671 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000672
Eric Andersen7e9276b2001-02-22 01:15:47 +0000673#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000674 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000675#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000676 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000677 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000678 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
679 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000680 " bytes." \
681 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000682 " -a Show sizes of files in addition to directories\n" \
683 " -H Follow symbolic links that are FILE command line args\n" \
684 " -L Follow all symbolic links encountered\n" \
685 " -d N Limit output to directories (and files with -a) of depth < N\n" \
686 " -c Output a grand total\n" \
687 " -l Count sizes many times if hard linked\n" \
688 " -s Display only a total for each argument\n" \
689 " -x Skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000690 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000691 " -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
692 " -m Print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000693 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000694 " -k Print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000695 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000696#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000697 "$ du\n" \
698 "16 ./CVS\n" \
699 "12 ./kernel-patches/CVS\n" \
700 "80 ./kernel-patches\n" \
701 "12 ./tests/CVS\n" \
702 "36 ./tests\n" \
703 "12 ./scripts/CVS\n" \
704 "16 ./scripts\n" \
705 "12 ./docs/CVS\n" \
706 "104 ./docs\n" \
707 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000708
Eric Andersen7e9276b2001-02-22 01:15:47 +0000709#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000710 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000711#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000712 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000713#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000714 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000715
Russ Dill61fb4892002-10-14 21:41:28 +0000716#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000717 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000718#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000719 "Display DHCP leases granted by udhcpd" \
720 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000721 " -f, --file=FILENAME Leases file to load\n" \
722 " -r, --remaining Interpret lease times as time remaining\n" \
723 " -a, --absolute Interpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000724
Mike Frysinger51a43b42005-09-24 07:11:16 +0000725#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000726 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
727 "[-I inode_buffer_blocks] [-P process_inode_size] " \
728 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
729 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000730#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000731 "Check ext2/ext3 file system" \
732 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000733 " -p Automatic repair (no questions)\n" \
734 " -n Make no changes to the filesystem\n" \
735 " -y Assume 'yes' to all questions\n" \
736 " -c Check for bad blocks and add them to the badblock list\n" \
737 " -f Force checking even if filesystem is marked clean\n" \
738 " -v Be verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000739 " -b superblock Use alternative superblock\n" \
740 " -B blocksize Force blocksize when looking for superblock\n" \
741 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000742 " -l file Add to badblocks list\n" \
743 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000744
Eric Andersen7e9276b2001-02-22 01:15:47 +0000745#define echo_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000746 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000747#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000748 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000749 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000750 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000751 " -n Suppress trailing newline\n" \
752 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
753 " -E Disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000754 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000755#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000756 "$ echo \"Erik is cool\"\n" \
757 "Erik is cool\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000758 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000759 "Erik\n" \
760 "is\n" \
761 "cool\n" \
762 "$ echo \"Erik\\nis\\ncool\"\n" \
763 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000764
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000765#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000766 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000767#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000768 "Eject specified DEVICE (or default /dev/cdrom)" \
769 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000770 " -t Close tray\n" \
771 " -T Open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000772
Rob Landley3b890392006-05-04 20:56:43 +0000773#define ed_trivial_usage ""
774#define ed_full_usage ""
775
Eric Andersen84e229c2001-03-29 22:48:33 +0000776#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000777 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000778#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000779 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000780 "up the specified environment" \
781 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000782 " -, -i Start with an empty environment\n" \
783 " -u Remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000784
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000785#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000786 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000787#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000788 "Send a magic packet to wake up sleeping machines.\n" \
789 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000790 "a hostname with a known 'ethers' entry." \
791 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000792 " -b Send wake-up packet to the broadcast address\n" \
793 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000794 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000795
Eric Andersen7e9276b2001-02-22 01:15:47 +0000796#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000797 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000798#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000799 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000800 "EXPRESSION may be:\n" \
801 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
802 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
803 " ARG1 < ARG2 ARG1 is less than ARG2\n" \
804 " ARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
805 " ARG1 = ARG2 ARG1 is equal to ARG2\n" \
806 " ARG1 != ARG2 ARG1 is unequal to ARG2\n" \
807 " ARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
808 " ARG1 > ARG2 ARG1 is greater than ARG2\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000809 " ARG1 + ARG2 Sum of ARG1 and ARG2\n" \
810 " ARG1 - ARG2 Difference of ARG1 and ARG2\n" \
811 " ARG1 * ARG2 Product of ARG1 and ARG2\n" \
812 " ARG1 / ARG2 Quotient of ARG1 divided by ARG2\n" \
813 " ARG1 % ARG2 Remainder of ARG1 divided by ARG2\n" \
814 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
815 " match STRING REGEXP Same as STRING : REGEXP\n" \
816 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
817 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
818 " length STRING Length of STRING\n" \
819 " quote TOKEN Interpret TOKEN as a string, even if\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000820 " it is a keyword like 'match' or an\n" \
821 " operator like '/'\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000822 " (EXPRESSION) Value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000823 "Beware that many operators need to be escaped or quoted for shells.\n" \
824 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
825 "lexicographical. Pattern matches return the string matched between\n" \
826 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
827 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000828
Mike Frysingerfa69f112005-04-17 07:24:19 +0000829#define fakeidentd_trivial_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000830 "[-fiw] [-b ADDR] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000831#define fakeidentd_full_usage \
Denis Vlasenko7a431b32007-01-14 01:29:06 +0000832 "Provide fake ident (auth) service" \
833 "\n\nOptions:" \
834 "\n -f Run in foreground" \
835 "\n -i Inetd mode" \
836 "\n -w Inetd 'wait' mode" \
837 "\n -b ADDR Bind to specified address" \
838 "\n STRING Ident answer string (default is 'nobody')"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000839
Eric Andersen7e9276b2001-02-22 01:15:47 +0000840#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000841 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000842#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000843 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000844#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000845 "$ false\n" \
846 "$ echo $?\n" \
847 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000848
849#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000850 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000851#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000852 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000853#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000854 "$ fbset\n" \
855 "mode \"1024x768-76\"\n" \
856 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
857 " geometry 1024 768 1024 768 16\n" \
858 " timings 12714 128 32 16 4 128 4\n" \
859 " accel false\n" \
860 " rgba 5/11,6/5,5/0,0/0\n" \
861 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000862
Eric Andersen7e9276b2001-02-22 01:15:47 +0000863#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000864 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000865#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000866 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000867
Eric Andersen01c3d402003-07-05 07:51:31 +0000868#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000869 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +0000870#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000871 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000872 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000873 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +0000874
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000875#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000876 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000877#define fdisk_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000878 "Change partition table" \
879 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000880 " -l List partition table(s)\n" \
881 " -u Give Start and End in sector (instead of cylinder) units\n" \
882 " -s PARTITION Give partition size(s) in blocks\n" \
883 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
884 " -C CYLINDERS Set the number of cylinders\n" \
885 " -H HEADS Set the number of heads\n" \
886 " -S SECTORS Set the number of sectors\n" \
887 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000888
Eric Andersen7e9276b2001-02-22 01:15:47 +0000889#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000890 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000891#define find_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000892 "Search for files in a directory hierarchy. The default PATH is\n" \
893 "the current directory; default EXPRESSION is '-print'\n" \
894 "\nEXPRESSION may consist of:\n" \
895 " -follow Dereference symbolic links\n" \
896 " -name PATTERN File name (leading directories removed) matches PATTERN\n" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000897 " -print Print (default and assumed)" \
Paul Foxd7384292006-05-12 14:47:20 +0000898 USE_FEATURE_FIND_PRINT0( \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000899 "\n -print0 Delimit output with null characters rather than" \
900 "\n newlines" \
901 ) USE_FEATURE_FIND_TYPE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000902 "\n -type X Filetype matches X (where X is one of: f,d,l,b,c,...)" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000903 ) USE_FEATURE_FIND_PERM( \
904 "\n -perm PERMS Permissions match any of (+NNN); all of (-NNN);" \
905 "\n or exactly (NNN)" \
906 ) USE_FEATURE_FIND_MTIME( \
907 "\n -mtime DAYS Modified time is greater than (+N); less than (-N);" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000908 "\n Or exactly (N) days" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000909 ) USE_FEATURE_FIND_MMIN( \
910 "\n -mmin MINS Modified time is greater than (+N); less than (-N);" \
911 "\n or exactly (N) minutes" \
912 ) USE_FEATURE_FIND_NEWER( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000913 "\n -newer FILE Modified time is more recent than FILE's" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000914 ) USE_FEATURE_FIND_INUM( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000915 "\n -inum N File has inode number N" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000916 ) USE_FEATURE_FIND_EXEC( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000917 "\n -exec CMD Execute CMD with all instances of {} replaced by the" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000918 "\n files matching EXPRESSION" \
919 ) USE_DESKTOP( \
920 "\n -size N File size is N" \
921 "\n -prune Stop traversing current subtree" \
922 "\n (expr) Group" \
923 )
Rob Landley5d3a0e82005-10-04 03:34:39 +0000924
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000925#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000926 "$ find / -name passwd\n" \
927 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000928
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000929#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000930 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000931#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000932 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000933 "standard output" \
934 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000935 " -b Count bytes rather than columns\n" \
936 " -s Break at spaces\n" \
937 " -w Use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000938
Eric Andersen7e9276b2001-02-22 01:15:47 +0000939#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000940 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000941#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000942 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000943#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000944 "$ free\n" \
945 " total used free shared buffers\n" \
946 " Mem: 257628 248724 8904 59644 93124\n" \
947 " Swap: 128516 8404 120112\n" \
948 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000949
Eric Andersen7e9276b2001-02-22 01:15:47 +0000950#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000951 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000952#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000953 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000954#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000955 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000956
Mike Frysinger51a43b42005-09-24 07:11:16 +0000957#define fsck_trivial_usage \
Denis Vlasenko0de93752006-12-26 02:51:29 +0000958 "[-ANPRTV] [ -C fd ] [-t fstype] [fs-options] [filesys ...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000959#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000960 "Check and repair filesystems" \
961 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000962 " -A Walk /etc/fstab and check all filesystems\n" \
963 " -N Don't execute, just show what would be done\n" \
964 " -P When using -A, check filesystems in parallel\n" \
965 " -R When using -A, skip the root filesystem\n" \
966 " -T Don't show title on startup\n" \
Denis Vlasenko0de93752006-12-26 02:51:29 +0000967 " -V Verbose\n" \
968 " -C n Write status information to specified filedescriptor\n" \
969 " -t type List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000970
Eric Andersen7e9276b2001-02-22 01:15:47 +0000971#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000972 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000973#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000974 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000975 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000976 " -l Lists all filenames\n" \
977 " -r Perform interactive repairs\n" \
978 " -a Perform automatic repairs\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +0000979 " -v Verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000980 " -s Outputs super-block information\n" \
981 " -m Activates MINIX-like \"mode not cleared\" warnings\n" \
982 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000983
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000984#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000985 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000986#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000987 "Retrieve a remote file via FTP" \
988 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000989 " -c, --continue Continue a previous transfer\n" \
990 " -v, --verbose Verbose\n" \
991 " -u, --username Username to be used\n" \
992 " -p, --password Password to be used\n" \
993 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000994
995#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000996 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000997#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000998 "Store a local file on a remote machine via FTP" \
999 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001000 " -v, --verbose Verbose\n" \
1001 " -u, --username Username to be used\n" \
1002 " -p, --password Password to be used\n" \
1003 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +00001004
Rob Landleyaa872762005-10-28 13:05:12 +00001005#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001006 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +00001007#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001008 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001009 " -m Show all processes on the same mounted fs\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001010 " -k Kill all processes that match\n" \
1011 " -s Don't print or kill anything\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001012 " -4 When using port/proto only search IPv4 space\n" \
1013 " -6 When using port/proto only search IPv6 space\n" \
1014 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +00001015
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001016#define getenforce_trivial_usage
1017#define getenforce_full_usage
1018
Eric Andersen7e9276b2001-02-22 01:15:47 +00001019#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001020 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001021#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001022 "Parse command options\n" \
1023 " -a, --alternative Allow long options starting with single -\n" \
1024 " -l, --longoptions=longopts Long options to be recognized\n" \
1025 " -n, --name=progname The name under which errors are reported\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001026 " -o, --options=optstring Short options to be recognized\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001027 " -q, --quiet Disable error reporting by getopt(3)\n" \
1028 " -Q, --quiet-output No normal output\n" \
1029 " -s, --shell=shell Set shell quoting conventions\n" \
1030 " -T, --test Test for getopt(1) version\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001031 " -u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001032#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001033 "$ cat getopt.test\n" \
1034 "#!/bin/sh\n" \
1035 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1036 " -n 'example.busybox' -- \"$@\"`\n" \
1037 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
1038 "eval set -- \"$GETOPT\"\n" \
1039 "while true ; do\n" \
1040 " case $1 in\n" \
1041 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
1042 " -b|--b-long) echo \"Option b, argument '$2'\" ; shift 2 ;;\n" \
1043 " -c|--c-long)\n" \
1044 " case \"$2\" in\n" \
1045 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
1046 " *) echo \"Option c, argument '$2'\" ; shift 2 ;;\n" \
1047 " esac ;;\n" \
1048 " --) shift ; break ;;\n" \
1049 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
1050 " esac\n" \
1051 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001052
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001053#define getsebool_trivial_usage \
1054 "-a or getsebool boolean..."
1055#define getsebool_full_usage \
1056 " -a Show all SELinux booleans"
1057
Eric Andersenf349e972001-08-21 16:18:59 +00001058#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001059 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001060#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001061 "Open a tty, prompt for a login name, then invoke /bin/login" \
1062 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001063 " -h Enable hardware (RTS/CTS) flow control\n" \
1064 " -i Do not display /etc/issue before running login\n" \
1065 " -L Local line, so do not do carrier detect\n" \
1066 " -m Get baud rate from modem's CONNECT status message\n" \
1067 " -w Wait for a CR or LF before sending /etc/issue\n" \
1068 " -n Do not prompt the user for a login name\n" \
1069 " -f issue_file Display issue_file instead of /etc/issue\n" \
1070 " -l login_app Invoke login_app instead of /bin/login\n" \
1071 " -t timeout Terminate after timeout if no username is read\n" \
1072 " -I initstring Sets the init string to send before anything else\n" \
1073 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001074
Eric Andersen7e9276b2001-02-22 01:15:47 +00001075#define grep_trivial_usage \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001076 "[-HhrilLnqvso" \
1077 USE_DESKTOP("w") \
1078 "eF" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001079 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1080 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001081 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001082#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001083 "Search for PATTERN in each FILE or standard input" \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001084 "\n\nOptions:" \
1085 "\n -H Prefix output lines with filename where match was found" \
1086 "\n -h Suppress the prefixing filename on output" \
1087 "\n -r Recurse subdirectories" \
1088 "\n -i Ignore case distinctions" \
1089 "\n -l List names of files that match" \
1090 "\n -L List names of files that do not match" \
1091 "\n -n Print line number with output lines" \
1092 "\n -q Be quiet. Returns 0 if PATTERN was found, 1 otherwise" \
1093 "\n -v Select non-matching lines" \
1094 "\n -s Suppress file open/read error messages" \
1095 "\n -c Only print count of matching lines" \
1096 "\n -f Read PATTERN from file" \
1097 "\n -o Show only the part of a line that matches PATTERN" \
1098 USE_DESKTOP( \
1099 "\n -w Match whole words only") \
1100 "\n -e PATTERN is a regular expression" \
1101 "\n -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001102 USE_FEATURE_GREP_EGREP_ALIAS( \
1103 "\n -E PATTERN is an extended regular expression") \
1104 USE_FEATURE_GREP_CONTEXT( \
Denis Vlasenkof8ea0f32007-02-25 02:38:54 +00001105 "\n -A Print NUM lines of trailing context" \
1106 "\n -B Print NUM lines of leading context" \
1107 "\n -C Print NUM lines of output context") \
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001108
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001109#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001110 "$ grep root /etc/passwd\n" \
1111 "root:x:0:0:root:/root:/bin/bash\n" \
1112 "$ grep ^[rR]oo. /etc/passwd\n" \
1113 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001114
Eric Andersen7e9276b2001-02-22 01:15:47 +00001115#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001116 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001117#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001118 "Uncompress FILE (or standard input if FILE is '-')" \
1119 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001120 " -c Write output to standard output\n" \
1121 " -f Force read when source is a terminal\n" \
1122 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001123#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001124 "$ ls -la /tmp/BusyBox*\n" \
1125 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1126 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1127 "$ ls -la /tmp/BusyBox*\n" \
1128 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001129
1130#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001131 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001132#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001133 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001134 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
1135 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001136 " -c Write output to standard output instead of FILE.gz\n" \
1137 " -d Decompress\n" \
1138 " -f Force write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001139#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001140 "$ ls -la /tmp/busybox*\n" \
1141 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1142 "$ gzip /tmp/busybox.tar\n" \
1143 "$ ls -la /tmp/busybox*\n" \
1144 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001145
1146#define halt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001147 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001148#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001149 "Halt the system" \
1150 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001151 " -d Delay interval for halting\n" \
1152 " -n No call to sync()\n" \
1153 " -f Force halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001154
Eric Andersen3443bd72003-07-22 07:30:36 +00001155#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001156 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001157#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001158 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001159 "If no device name is specified try to read from stdin.\n\n") \
1160 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001161 " -a Get/set fs readahead\n" \
1162 " -A Set drive read-lookahead flag (0/1)\n" \
1163 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1164 " -B Set Advanced Power Management setting (1-255)\n" \
1165 " -c Get/set IDE 32-bit IO setting\n" \
1166 " -C Check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001167 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001168 " -d Get/set using_dma flag\n") \
1169 " -D Enable/disable drive defect-mgmt\n" \
1170 " -f Flush buffer cache for device on exit\n" \
1171 " -g Display drive geometry\n" \
1172 " -h Display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001173 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001174 " -i Display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001175 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001176 " -I Detailed/current information directly from drive\n") \
1177 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1178 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1179 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1180 " -m Get/set multiple sector count\n" \
1181 " -n Get/set ignore-write-errors flag (0/1)\n" \
1182 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1183 " -P Set drive prefetch count\n" \
1184 " -q Change next setting quietly\n" \
1185 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1186 " -r Get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001187 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001188 " -R Register an IDE interface (DANGEROUS)\n") \
1189 " -S Set standby (spindown) timeout\n" \
1190 " -t Perform device read timings\n" \
1191 " -T Perform cache read timings\n" \
1192 " -u Get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001193 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001194 " -U Un-register an IDE interface (DANGEROUS)\n") \
1195 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1196 " -V Display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001197 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001198 " -w Perform device reset (DANGEROUS)\n") \
1199 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001200 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001201 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1202 " -X Set IDE xfer mode (DANGEROUS)\n" \
1203 " -y Put IDE drive in standby mode\n" \
1204 " -Y Put IDE drive to sleep\n" \
1205 " -Z Disable Seagate auto-powersaving mode\n" \
1206 " -z Re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001207
Eric Andersen7e9276b2001-02-22 01:15:47 +00001208#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001209 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001210#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001211 "Print first 10 lines of each FILE to standard output.\n" \
1212 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001213 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001214 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001215 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001216 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001217 "\n -c NUM Output the first NUM bytes" \
1218 "\n -q Never output headers giving file names" \
1219 "\n -v Always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001220#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001221 "$ head -n 2 /etc/passwd\n" \
1222 "root:x:0:0:root:/root:/bin/bash\n" \
1223 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001224
Glenn L McGrath60281112001-11-02 11:39:46 +00001225#define hexdump_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001226 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001227#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001228 "Display file(s) or standard input in a user specified format" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001229 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001230 " -b One-byte octal display\n" \
1231 " -c One-byte character display\n" \
1232 " -C Canonical hex+ASCII, 16 bytes per line\n" \
1233 " -d Two-byte decimal display\n" \
1234 " -e FORMAT STRING\n" \
1235 " -f FORMAT FILE\n" \
1236 " -n LENGTH Interpret only length bytes of input\n" \
1237 " -o Two-byte octal display\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001238 " -s OFFSET Skip offset bytes\n" \
1239 " -v Display all input data\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001240 " -x Two-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001241
Eric Andersen7e9276b2001-02-22 01:15:47 +00001242#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001243 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001244#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001245 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001246
1247#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001248 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001249#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001250 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001251 "(or FILE with the -F parameter), the host name will be set." \
1252 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001253 " -s Short\n" \
1254 " -i Addresses for the hostname\n" \
1255 " -d DNS domain name\n" \
1256 " -f Fully qualified domain name\n" \
1257 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001258#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001259 "$ hostname\n" \
1260 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001261
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001262#define httpd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001263 "[-c <conf file>]" \
1264 " [-p <port>]" \
1265 " [-i] [-f]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001266 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001267 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1268 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001269 " [-h home]" \
1270 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001271#define httpd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001272 "Listen for incoming http server requests" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001273 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001274 " -c FILE Specifies configuration file. (default httpd.conf)\n" \
1275 " -p PORT Server port (default 80)\n" \
1276 " -i Assume that we are started from inetd\n" \
1277 " -f Do not daemonize\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001278 USE_FEATURE_HTTPD_SETUID( \
1279 " -u USER[:GRP] Set uid/gid after binding to port\n") \
1280 USE_FEATURE_HTTPD_BASIC_AUTH( \
1281 " -r REALM Authentication Realm for Basic Authentication\n") \
1282 USE_FEATURE_HTTPD_AUTH_MD5( \
1283 " -m PASS Crypt PASS with md5 algorithm\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001284 " -h HOME Specifies http HOME directory (default ./)\n" \
1285 " -e STRING HTML encode STRING\n" \
1286 " -d STRING URL decode STRING"
Eric Andersen40520512003-07-28 09:59:05 +00001287
Robert Griebl1cd04452002-07-21 16:50:49 +00001288#define hwclock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001289 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
Robert Griebl1cd04452002-07-21 16:50:49 +00001290#define hwclock_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001291 "Query and set the hardware clock (RTC)" \
1292 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001293 " -r Read hardware clock and print result\n" \
1294 " -s Set the system time from the hardware clock\n" \
1295 " -w Set the hardware clock to the current system time\n" \
1296 " -u The hardware clock is kept in coordinated universal time\n" \
1297 " -l The hardware clock is kept in local time"
Robert Griebl1cd04452002-07-21 16:50:49 +00001298
Eric Andersen7e9276b2001-02-22 01:15:47 +00001299#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001300 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001301#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001302 "Print information for USERNAME or the current user" \
1303 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001304 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001305 " -c Prints only the security context\n") \
1306 " -g Prints only the group ID\n" \
1307 " -u Prints only the user ID\n" \
1308 " -n Print a name instead of a number\n" \
1309 " -r Prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001310#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001311 "$ id\n" \
1312 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001313
Eric Andersen7e9276b2001-02-22 01:15:47 +00001314#define ifconfig_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001315 USE_FEATURE_IFCONFIG_STATUS("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001316#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001317 "Configure a network interface" \
1318 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001319 USE_FEATURE_IPV6( \
1320 " [add <address>[/<prefixlen>]]\n") \
1321 USE_FEATURE_IPV6( \
1322 " [del <address>[/<prefixlen>]]\n") \
1323 " [[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
1324 " [netmask <address>] [dstaddr <address>]\n" \
1325 USE_FEATURE_IFCONFIG_SLIP( \
1326 " [outfill <NN>] [keepalive <NN>]\n") \
1327 " " USE_FEATURE_IFCONFIG_HW("[hw ether <address>] ") "[metric <NN>] [mtu <NN>]\n" \
1328 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
1329 " [multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1330 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
1331 " [mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001332 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001333
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001334#define ifup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001335 "<-ahinv> <ifaces...>"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001336#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001337 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001338 " -a De/configure all interfaces automatically\n" \
1339 " -i FILE Use FILE for interface definitions\n" \
1340 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001341 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001342 " -v Print out what would happen before doing it\n" \
1343 " -m Don't run any mappings\n" \
1344 " -f Force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001345
1346#define ifdown_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001347 "<-ahinv> <ifaces...>"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001348#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001349 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001350 " -a De/configure all interfaces automatically\n" \
1351 " -i FILE Use FILE for interface definitions\n" \
1352 " -n Print out what would happen, but don't do it\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001353 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001354 " -v Print out what would happen before doing it\n" \
1355 " -m Don't run any mappings\n" \
1356 " -f Force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001357
Glenn L McGrath06e95652003-02-09 06:51:14 +00001358#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001359 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001360#define inetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001361 "Listen for network connections and launch programs" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001362 "\n\nOptions:\n" \
Denis Vlasenko886bb0d2007-01-09 23:48:46 +00001363 " -f Run in foreground\n" \
1364 " -q N Set the size of the socket listen queue to N\n" \
1365 " (default: 128)"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001366
Eric Andersen7e9276b2001-02-22 01:15:47 +00001367#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001368 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001369#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001370 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001371#define init_notes_usage \
1372"This version of init is designed to be run only by the kernel.\n" \
1373"\n" \
1374"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001375"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001376"runlevels, use sysvinit.\n" \
1377"\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001378"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001379"it has the following default behavior:\n" \
1380"\n" \
1381" ::sysinit:/etc/init.d/rcS\n" \
1382" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001383" ::ctrlaltdel:/sbin/reboot\n" \
1384" ::shutdown:/sbin/swapoff -a\n" \
1385" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001386" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001387"\n" \
1388"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1389"\n" \
1390" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001391" tty3::askfirst:/bin/sh\n" \
1392" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001393"\n" \
1394"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1395"\n" \
1396" <id>:<runlevels>:<action>:<process>\n" \
1397"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001398" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001399"\n" \
1400" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1401" The id field is used by BusyBox init to specify the controlling tty for\n" \
1402" the specified process to run on. The contents of this field are\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001403" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001404" be unique, although if it isn't you may have strange results. If this\n" \
1405" field is left blank, the controlling tty is set to the console. Also\n" \
1406" note that if BusyBox detects that a serial console is in use, then only\n" \
1407" entries whose controlling tty is either the serial console or /dev/null\n" \
1408" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1409" stinkin' utmp.\n" \
1410"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001411" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001412"\n" \
1413" The runlevels field is completely ignored.\n" \
1414"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001415" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001416"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001417" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001418" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001419"\n" \
1420" The available actions can be classified into two groups: actions\n" \
1421" that are run only once, and actions that are re-run when the specified\n" \
1422" process exits.\n" \
1423"\n" \
1424" Run only-once actions:\n" \
1425"\n" \
1426" 'sysinit' is the first item run on boot. init waits until all\n" \
1427" sysinit actions are completed before continuing. Following the\n" \
1428" completion of all sysinit actions, all 'wait' actions are run.\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001429" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001430" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001431" therefore, init does not wait for them to complete. 'restart' is\n" \
1432" the action taken to restart the init process. By default this should\n" \
1433" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1434" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001435" actions are run when the system detects that someone on the system\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001436" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1437" wants to run 'reboot' at this point to cause the system to reboot.\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001438" Finally the 'shutdown' action specifies the actions to taken when\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001439" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1440" is a very good here.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001441"\n" \
1442" Run repeatedly actions:\n" \
1443"\n" \
1444" 'respawn' actions are run after the 'once' actions. When a process\n" \
1445" started with a 'respawn' action exits, init automatically restarts\n" \
1446" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1447" respawning out of control. The 'askfirst' actions acts just like\n" \
1448" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001449" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001450" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001451" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001452"\n" \
1453" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1454" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001455" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001456"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001457" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001458"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001459" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001460"\n" \
1461"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001462"\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001463" # This is run first except when booting in single-user mode\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001464" #\n" \
1465" ::sysinit:/etc/init.d/rcS\n" \
1466" \n" \
1467" # /bin/sh invocations on selected ttys\n" \
1468" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001469" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001470" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001471" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001472" tty2::askfirst:-/bin/sh\n" \
1473" tty3::askfirst:-/bin/sh\n" \
1474" tty4::askfirst:-/bin/sh\n" \
1475" \n" \
1476" # /sbin/getty invocations for selected ttys\n" \
1477" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001478" tty4::respawn:/sbin/getty 38400 tty4\n" \
1479" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001480" \n" \
1481" \n" \
1482" # Example of how to put a getty on a serial line (for a terminal)\n" \
1483" #\n" \
1484" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1485" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1486" #\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001487" # Example how to put a getty on a modem line\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001488" #::respawn:/sbin/getty 57600 ttyS2\n" \
1489" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001490" # Stuff to do when restarting the init process\n" \
1491" ::restart:/sbin/init\n" \
1492" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001493" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001494" ::ctrlaltdel:/sbin/reboot\n" \
1495" ::shutdown:/bin/umount -a -r\n" \
1496" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001497
1498#define insmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001499 "[OPTION]... MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001500#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001501 "Load the specified kernel modules into the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001502 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001503 " -f Force module to load into the wrong kernel version\n" \
1504 " -k Make module autoclean-able\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001505 " -v Verbose output\n" \
1506 " -q Quiet output\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001507 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001508 USE_FEATURE_INSMOD_LOAD_MAP( \
1509 " -m Output load map to stdout\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001510 " -o NAME Set internal module name to NAME\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001511 " -x Do not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001512
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001513#define install_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001514 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001515#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001516 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001517 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001518 " -c Copy the file, default\n" \
1519 " -d Create directories\n" \
1520 " -g Set group ownership\n" \
1521 " -m Set permission modes\n" \
1522 " -o Set ownership\n" \
1523 " -p Preserve date\n" \
1524 " -s Strip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001525
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001526#define ip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001527 "[OPTIONS] {address | link | route | tunnel | rule} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001528#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001529 "ip [OPTIONS] OBJECT {COMMAND}\n" \
1530 "where OBJECT := {link | addr | route | tunnel |rule}\n" \
1531 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001532
1533#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001534 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1535 " [ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001536#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001537 "ipaddr {add|delete} IFADDR dev STRING\n" \
1538 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001539 " [ to PREFIX ] [ label PATTERN ]\n" \
1540 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
1541 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1542 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1543 " SCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001544
Eric Andersende4f07e2003-12-11 01:18:07 +00001545#define ipcalc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001546 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001547#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001548 "Calculate IP network settings from a IP address" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001549 "\n\nOptions:" \
1550 "\n -b --broadcast Display calculated broadcast address" \
1551 "\n -n --network Display calculated network address" \
1552 "\n -m --netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001553 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001554 "\n -p --prefix Display the prefix for IP/NETMASK" \
1555 "\n -h --hostname Display first resolved host name" \
1556 "\n -s --silent Don't ever display error messages")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001557
Rob Landley6eb1e412005-06-20 04:30:36 +00001558#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001559 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001560#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001561 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1562 "segment by a shmkey value. The lower-case options mqs are used\n" \
1563 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001564 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001565 " -[mM] Remove the memory segment after the last detach\n" \
1566 " -[qQ] Remove the message queue\n" \
1567 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001568
1569#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001570 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001571#define ipcs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001572 " -i Specify a specific resource id\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001573 "Resource specification:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001574 " -m Shared memory segments\n" \
1575 " -q Message queues\n" \
1576 " -s Semaphore arrays\n" \
1577 " -a All (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001578 "Output format:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001579 " -t Time\n" \
1580 " -c Creator\n" \
1581 " -p Pid\n" \
1582 " -l Limits\n" \
1583 " -u Summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001584
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001585#define iplink_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001586 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001587#define iplink_full_usage \
Bernhard Reutner-Fischer8ca35d22007-01-28 00:39:30 +00001588 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001589 " dynamic { on | off } |\n" \
1590 " mtu MTU }\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001591 "iplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001592
1593#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001594 "{ list | flush | { add | del | change | append |\n" \
1595 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001596#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001597 "iproute { list | flush } SELECTOR\n" \
1598 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1599 " [ oif STRING ] [ tos TOS ]\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001600 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001601 " SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1602 " ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001603
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001604#define iprule_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001605 "{[ list | add | del ] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001606#define iprule_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001607 "iprule [ list | add | del ] SELECTOR ACTION\n" \
1608 " SELECTOR := [ from PREFIX ] [ to PREFIX ] [ tos TOS ] [ fwmark FWMARK ]\n" \
1609 " [ dev STRING ] [ pref NUMBER ]\n" \
1610 " ACTION := [ table TABLE_ID ] [ nat ADDRESS ]\n" \
1611 " [ prohibit | reject | unreachable ]\n" \
1612 " [ realms [SRCREALM/]DSTREALM ]\n" \
1613 " TABLE_ID := [ local | main | default | NUMBER ]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001614
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001615#define iptunnel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001616 "{ add | change | del | show } [ NAME ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001617 " [ mode { ipip | gre | sit } ]\n" \
1618 " [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001619#define iptunnel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001620 "iptunnel { add | change | del | show } [ NAME ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001621 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1622 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1623 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001624
Eric Andersen7e9276b2001-02-22 01:15:47 +00001625#define kill_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001626 "[-l] [-signal] process-id [process-id ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001627#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001628 "Send a signal (default is TERM) to the specified process(es)" \
1629 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001630 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001631#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001632 "$ ps | grep apache\n" \
1633 "252 root root S [apache]\n" \
1634 "263 www-data www-data S [apache]\n" \
1635 "264 www-data www-data S [apache]\n" \
1636 "265 www-data www-data S [apache]\n" \
1637 "266 www-data www-data S [apache]\n" \
1638 "267 www-data www-data S [apache]\n" \
1639 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001640
1641#define killall_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001642 "[-l] [-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001643#define killall_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001644 "Send a signal (default is TERM) to the specified process(es)" \
1645 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001646 " -l List all signal names and numbers\n" \
1647 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001648#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001649 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001650
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001651#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001652 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001653#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001654 "Send a signal (default is TERM) to all processes outside current session" \
1655 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001656 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001657
Mark Whitley6317c4b2001-03-12 22:51:50 +00001658#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001659 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001660#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001661 "Kernel logger" \
1662 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001663 " -c n Sets the default log level of console messages to n\n" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00001664 " -n Run as foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001665
Eric Andersen7e9276b2001-02-22 01:15:47 +00001666#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001667 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001668#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001669 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001670#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001671 "$ length Hello\n" \
1672 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001673
Rob Landley9200e792005-09-15 19:26:59 +00001674#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001675 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001676#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001677 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001678 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001679 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001680 " -E Quit once the end of a file is reached\n" \
1681 " -M Display a status line containing the current line numbers\n" \
1682 " and the percentage through the file\n" \
1683 " -N Prefix line numbers to each line\n" \
1684 " -m Display a status line containing the percentage through the\n" \
1685 " file\n" \
1686 " -~ Suppress ~s displayed when input past the end of the file is\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001687 " reached"
Rob Landley9200e792005-09-15 19:26:59 +00001688
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001689#define setarch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001690 "<personality> <program> [args ...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001691#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001692 "Personality may be:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001693 " linux32 Set 32bit uname emulation\n" \
1694 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001695
Eric Andersen7e9276b2001-02-22 01:15:47 +00001696#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001697 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001699 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1700 "You may use '--' to indicate that all following arguments are non-options." \
1701 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001702 " -s Make symbolic links instead of hard links\n" \
1703 " -f Remove existing destination files\n" \
1704 " -n No dereference symlinks - treat like normal file\n" \
1705 " -b Make a backup of the target (if exists) before link operation\n" \
1706 " -S suf Use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001707#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001708 "$ ln -s BusyBox /tmp/ls\n" \
1709 "$ ls -l /tmp/ls\n" \
1710 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001711
Eric Andersen7e9276b2001-02-22 01:15:47 +00001712#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001713 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001714#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001715 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001716#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001717 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001718
1719#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001720 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001721#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001722 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001723#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001724 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001725
1726#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001727 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001728#define logger_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001729 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
1730 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001731 " -s Log to stderr as well as the system log\n" \
1732 " -t TAG Log using the specified tag (defaults to user name)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001733 " -p PRIO Enter the message with the specified priority.\n" \
1734 " This may be numerical or a 'facility.level' pair."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001735#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001736 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001737
Robert Griebl1fca5582002-06-04 20:45:46 +00001738#define login_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001739 "[OPTION]... [username] [ENV=VAR ...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00001740#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001741 "Begin a new session on the system" \
1742 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001743 " -f Do not authenticate (user already authenticated)\n" \
1744 " -h Name of the remote host for this login\n" \
1745 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001746
Eric Andersen7e9276b2001-02-22 01:15:47 +00001747#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001748 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001749#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001750 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001751#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001752 "$ logname\n" \
1753 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001754
Mark Whitley6317c4b2001-03-12 22:51:50 +00001755#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001756 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001757#define logread_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001758 "Show the messages from syslogd (using circular buffer)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001759 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001760 " -f Output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001761
Matt Kraai83788da2002-03-20 17:38:37 +00001762#define losetup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001763 "[-o OFFSET] [-d] LOOPDEVICE [FILE]]"
Matt Kraai83788da2002-03-20 17:38:37 +00001764#define losetup_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001765 "(Dis)associate LOOPDEVICE with FILE, or display current associations" \
1766 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001767 " -d Disassociate LOOPDEVICE\n" \
1768 " -o OFFSET Start OFFSET bytes into FILE"
Rob Landley1d589b22005-11-29 23:47:10 +00001769#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001770 "No arguments will display all current associations.\n" \
1771 "One argument (losetup /dev/loop1) will display the current association\n" \
1772 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1773 "and filename of the file the loop device is currently bound to.\n\n" \
1774 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1775 "with an optional offset (-o 12345). Encryption is not yet supported.\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001776
Eric Andersen7e9276b2001-02-22 01:15:47 +00001777#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001778 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenko8e858e22007-03-07 09:35:43 +00001779 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001780 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
1781 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
1782 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
1783 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
1784 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
1785 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001786#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001787 "List directory contents" \
1788 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001789 "\n -1 List files in a single column" \
1790 "\n -A Do not list implied . and .." \
1791 "\n -a Do not hide entries starting with ." \
1792 "\n -C List entries by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001793 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001794 "\n -c With -l: show ctime") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001795 USE_FEATURE_LS_COLOR( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001796 "\n --color[={always,never,auto}] Control coloring") \
1797 "\n -d List directory entries instead of contents" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001798 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001799 "\n -e List both full date and full time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001800 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001801 "\n -F Append indicator (one of */=@|) to entries") \
1802 "\n -i List the i-node for each file" \
1803 "\n -l Use a long listing format" \
1804 "\n -n List numeric UIDs and GIDs instead of names" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001805 USE_FEATURE_LS_FILETYPES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001806 "\n -p Append indicator (one of /=@|) to entries") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001807 USE_FEATURE_LS_FOLLOWLINKS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001808 "\n -L List entries pointed to by symbolic links") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001809 USE_FEATURE_LS_RECURSIVE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001810 "\n -R List subdirectories recursively") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001811 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001812 "\n -r Sort the listing in reverse order") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001813 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001814 "\n -S Sort the listing by file size") \
1815 "\n -s List the size of each file, in blocks" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001816 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001817 "\n -T NUM Assume Tabstop every NUM columns") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001818 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001819 "\n -t With -l: show modification time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001820 USE_FEATURE_LS_TIMESTAMPS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001821 "\n -u With -l: show access time") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001822 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001823 "\n -v Sort the listing by version") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001824 USE_FEATURE_AUTOWIDTH( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001825 "\n -w NUM Assume the terminal is NUM columns wide") \
1826 "\n -x List entries by lines instead of by columns" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001827 USE_FEATURE_LS_SORTFILES( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001828 "\n -X Sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001829 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001830 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001831 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001832 "\n -k Print security context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001833 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001834 "\n -K Print security context in long format")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001835
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001836#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001837 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001838#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001839 "List file attributes on an ext2 fs" \
1840 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001841 " -R Recursively list subdirectories\n" \
1842 " -a Do not hide entries starting with .\n" \
1843 " -d List directory entries instead of contents\n" \
1844 " -l Print long flag names\n" \
1845 " -v List the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001846
Eric Andersen7e9276b2001-02-22 01:15:47 +00001847#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001848 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001849#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001850 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001851
Eric Andersen3d925622005-06-09 10:16:02 +00001852#ifdef CONFIG_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001853#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001854 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001855#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001856 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001857 "TYPEs include:\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00001858 " b: Make a block (buffered) device\n" \
1859 " c or u: Make a character (un-buffered) device\n" \
1860 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
1861 "\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001862 "FIRST specifies the number appended to NAME to create the first device.\n" \
1863 "LAST specifies the number of the last item that should be created\n" \
1864 "If 's' is the last argument, the base device is created as well.\n\n" \
1865 "For example:\n" \
1866 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
1867 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001868#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001869 "# makedevs /dev/ttyS c 4 66 2 63\n" \
1870 "[creates ttyS2-ttyS63]\n" \
1871 "# makedevs /dev/hda b 3 0 0 8 s\n" \
1872 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001873#endif
1874
1875#ifdef CONFIG_FEATURE_MAKEDEVS_TABLE
1876#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001877 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001878#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001879 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001880 "Device table entries take the form of:\n" \
1881 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001882 "Where name is the file name, type can be one of:\n" \
1883 " f A regular file\n" \
1884 " d Directory\n" \
1885 " c Character special device file\n" \
1886 " b Block special device file\n" \
1887 " p Fifo (named pipe)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001888 "uid is the user id for the target file, gid is the group id for the\n" \
1889 "target file. The rest of the entries (major, minor, etc) apply to\n" \
1890 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00001891#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001892 "For example:\n" \
1893 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1894 "/dev d 755 0 0 - - - - -\n" \
1895 "/dev/console c 666 0 0 5 1 - - -\n" \
1896 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1897 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1898 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1899 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1900 "Will Produce:\n" \
1901 "/dev\n" \
1902 "/dev/console\n" \
1903 "/dev/null\n" \
1904 "/dev/zero\n" \
1905 "/dev/hda\n" \
1906 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001907#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001908
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00001909#define matchpathcon_trivial_usage \
1910 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
1911#define matchpathcon_full_usage \
1912 " -n Do not display path" \
1913 "\n -N Do not use translations" \
1914 "\n -f Use alternate file_context file" \
1915 "\n -p Use prefix to speed translations" \
1916 "\n -V Verify file context on disk matches defaults"
1917
Eric Andersen7e9276b2001-02-22 01:15:47 +00001918#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001919 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001920 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001921#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001922 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
1923 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001924 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001925 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001926 " -c Check MD5 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001927 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001928 " -s Don't output anything, status code shows success\n" \
1929 " -w Warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001930#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001931 "$ md5sum < busybox\n" \
1932 "6fd11e98b98a58f64ff3398d7b324003\n" \
1933 "$ md5sum busybox\n" \
1934 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1935 "$ md5sum -c -\n" \
1936 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1937 "busybox: OK\n" \
1938 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001939
Rob Landley70f7ef72005-12-13 08:21:33 +00001940#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001941 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00001942#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001943 " -s Scan /sys and populate /dev during system boot\n\n" \
1944 "Called with no options (via hotplug) it uses environment variables\n" \
1945 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00001946#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001947 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001948 "The mdev config file contains lines that look like:\n" \
1949 " hd[a-z][0-9]* 0:3 660\n\n" \
1950 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00001951 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001952 "Optionally, that can be followed (on the same line) by a special character\n" \
1953 "and a command line to run after creating/before deleting the corresponding\n" \
1954 "device(s). The environment variable $MDEV indicates the active device node\n" \
1955 "(which is useful if it's a regex match). For example:\n\n" \
1956 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
1957 "The special characters are @ (run after creating), $ (run before deleting),\n" \
1958 "and * (run both after creating and before deleting). The commands run in\n" \
1959 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00001960 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001961 "Config file parsing stops on the first matching line. If no config\n"\
1962 "entry is matched, devices are created with default 0:0 660. (Make\n"\
1963 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001964 )
Rob Landley70f7ef72005-12-13 08:21:33 +00001965
Glenn L McGrath061c9002002-09-16 04:21:46 +00001966#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001967 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001968#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001969 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001970 " y Allow write access to your terminal\n" \
1971 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001972
Eric Andersen7e9276b2001-02-22 01:15:47 +00001973#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001974 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001975#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001976 "Create the DIRECTORY(ies) if they do not already exist" \
1977 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001978 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
1979 " -p No error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001980#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001981 "$ mkdir /tmp/foo\n" \
1982 "$ mkdir /tmp/foo\n" \
1983 "/tmp/foo: File exists\n" \
1984 "$ mkdir /tmp/foo/bar/baz\n" \
1985 "/tmp/foo/bar/baz: No such file or directory\n" \
1986 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001987
Mike Frysinger6447ac02005-06-11 05:29:40 +00001988#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001989 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
1990 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
1991 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
1992 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
1993 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
1994 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00001995#define mke2fs_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00001996 " -b size Block size in bytes\n" \
1997 " -c Check for bad blocks before creating\n" \
1998 " -E opts Set extended options\n" \
1999 " -f size Fragment size in bytes\n" \
2000 " -F Force (ignore sanity checks)\n" \
2001 " -g num Number of blocks in a block group\n" \
2002 " -i ratio The bytes/inode ratio\n" \
2003 " -j Create a journal (ext3)\n" \
2004 " -J opts Set journal options (size/device)\n" \
2005 " -l file Read bad blocks list from file\n" \
2006 " -L lbl Set the volume label\n" \
2007 " -m percent Percent of fs blocks to reserve for admin\n" \
2008 " -M dir Set last mounted directory\n" \
2009 " -n Do not actually create anything\n" \
2010 " -N num Number of inodes to create\n" \
2011 " -o os Set the 'creator os' field\n" \
2012 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
2013 " -q Quiet execution\n" \
2014 " -r rev Set filesystem revision\n" \
2015 " -S Write superblock and group descriptors only\n" \
2016 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
2017 " -v Verbose execution"
Mike Frysinger6447ac02005-06-11 05:29:40 +00002018
Eric Andersen7e9276b2001-02-22 01:15:47 +00002019#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002020 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002021#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002022 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002023 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002024 " -m Create the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002025
Eric Andersen7e9276b2001-02-22 01:15:47 +00002026#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002027 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002028#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002029 "Make a MINIX filesystem" \
2030 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002031 " -c Check the device for bad blocks\n" \
2032 " -n [14|30] Specify the maximum length of filenames\n" \
2033 " -i INODES Specify the number of inodes for the filesystem\n" \
2034 " -l FILENAME Read the bad blocks list from FILENAME\n" \
2035 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002036
Eric Andersen7e9276b2001-02-22 01:15:47 +00002037#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002038 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002039#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002040 "Create a special file (block, character, or pipe)" \
2041 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002042 " -m Create the special file using the specified mode (default a=rw)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002043 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002044 " b: Make a block (buffered) device\n" \
2045 " c or u: Make a character (un-buffered) device\n" \
2046 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002047#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002048 "$ mknod /dev/fd0 b 2 0\n" \
2049 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002050
Eric Andersen7e9276b2001-02-22 01:15:47 +00002051#define mkswap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002052 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002053#define mkswap_full_usage \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00002054 "Prepare a disk partition to be used as swap partition" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002055 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002056 " -c Check for read-ability\n" \
2057 " -v0 Make version 0 swap [max 128 Megs]\n" \
2058 " -v1 Make version 1 swap [big!] (default for kernels > 2.1.117)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002059 " block-count Number of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002060
Eric Andersen7e9276b2001-02-22 01:15:47 +00002061#define mktemp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002062 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002063#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002064 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002065 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2066 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002067 " -d Make a directory instead of a file\n" \
2068 " -q Fail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002069#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002070 "$ mktemp /tmp/temp.XXXXXX\n" \
2071 "/tmp/temp.mWiLjM\n" \
2072 "$ ls -la /tmp/temp.mWiLjM\n" \
2073 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002074
Eric Andersen8d79ce82001-07-22 23:00:15 +00002075#define modprobe_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002076 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002077#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002078 "Options:\n" \
2079 " -k Make module autoclean-able\n" \
2080 " -n Just show what would be done\n" \
2081 " -q Quiet output\n" \
2082 " -r Remove module (stacks) or do autoclean\n" \
2083 " -s Report via syslog instead of stderr\n" \
2084 " -v Verbose output"
Rob Landley9c32a152005-12-11 20:12:24 +00002085#define modprobe_notes_usage \
2086"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2087"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2088"pass each module it loads.\n" \
2089"\n" \
2090"The configuration file is searched (in order) amongst:\n" \
2091"\n" \
2092" /etc/modprobe.conf (2.6 only)\n" \
2093" /etc/modules.conf\n" \
2094" /etc/conf.modules (deprecated)\n" \
2095"\n" \
2096"They all have the same syntax (see below). If none is present, it is\n" \
2097"_not_ an error; each loaded module is then expected to load without\n" \
2098"options. Once a file is found, the others are tested for.\n" \
2099"\n" \
2100"/etc/modules.conf entry format:\n" \
2101"\n" \
2102" alias <alias_name> <mod_name>\n" \
2103" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002104" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002105" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2106" This makes it also possible to use a different set of options (below) for\n" \
2107" the module and the alias.\n" \
2108" A module can be aliased more than once.\n" \
2109"\n" \
2110" options <mod_name|alias_name> <symbol=value ...>\n" \
2111" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2112" the \"symbol=value\" pairs as option to that module.\n" \
2113"\n" \
2114"Sample /etc/modules.conf file:\n" \
2115"\n" \
2116" options tulip irq=3\n" \
2117" alias tulip tulip2\n" \
2118" options tulip2 irq=4 io=0x308\n" \
2119"\n" \
2120"Other functionality offered by 'classic' modprobe is not available in\n" \
2121"this implementation.\n" \
2122"\n" \
2123"If module options are present both in the config file, and on the command line,\n" \
2124"then the options from the command line will be passed to the module _after_\n" \
2125"the options from the config file. That way, you can have defaults in the config\n" \
2126"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002127#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002128 "(with the above /etc/modules.conf):\n\n" \
2129 "$ modprobe tulip\n" \
2130 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2131 "$ modprobe tulip irq=5\n" \
2132 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2133 "$ modprobe tulip2\n" \
2134 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2135 " which are the default for alias 'tulip2'\n\n" \
2136 "$ modprobe tulip2 irq=8\n" \
2137 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2138 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2139 " from the command line\n\n" \
2140 "$ modprobe tulip2 irq=2 io=0x210\n" \
2141 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2142 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2143 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002144
Eric Andersen7e9276b2001-02-22 01:15:47 +00002145#define more_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002146 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002147#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002148 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002149#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002150 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002151
Eric Andersen7e9276b2001-02-22 01:15:47 +00002152#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002153 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002154#define mount_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002155 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2156 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002157 " -a Mount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002158 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002159 " -f \"Fake\" Add entry to mount table but don't mount it\n" \
2160 " -n Don't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002161 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002162 " -o option One of many filesystem options, listed below\n" \
2163 " -r Mount the filesystem read-only\n" \
2164 " -t fs-type Specify the filesystem type\n" \
2165 " -w Mount for reading and writing (default)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002166 "\n" \
2167 "Options for use with the \"-o\" flag:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002168 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002169 " loop Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002170 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002171 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002172 " [a]sync Writes are asynchronous / synchronous\n" \
2173 " [no]atime Disable / enable updates to inode access times\n" \
2174 " [no]diratime Disable / enable atime updates to directories\n" \
2175 " [no]dev Allow use of special device files / disallow them\n" \
2176 " [no]exec Allow use of executable files / disallow them\n" \
2177 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2178 " [r]shared Convert [recursively] to a shared subtree\n" \
2179 " [r]slave Convert [recursively] to a slave subtree\n" \
2180 " [r]private Convert [recursively] to a private subtree\n" \
2181 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2182 " bind Bind a directory to an additional location\n" \
2183 " move Relocate an existing mount point\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002184 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002185 " remount Remount a mounted filesystem, changing its flags\n" \
2186 " ro/rw Mount for read-only / read-write\n" \
2187 "\n" \
2188 "There are EVEN MORE flags that are specific to each filesystem\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002189 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002190#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002191 "$ mount\n" \
2192 "/dev/hda3 on / type minix (rw)\n" \
2193 "proc on /proc type proc (rw)\n" \
2194 "devpts on /dev/pts type devpts (rw)\n" \
2195 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2196 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2197 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002198#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002199 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002200
Rob Landleyd00b3a52005-08-20 05:07:08 +00002201#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002202 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002203#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002204 "mountpoint checks if the directory is a mountpoint" \
2205 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002206 " -q Be more quiet\n" \
2207 " -d Print major/minor device number of the filesystem\n" \
2208 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002209#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002210 "$ mountpoint /proc\n" \
2211 "/proc is not a mountpoint\n" \
2212 "$ mountpoint /sys\n" \
2213 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002214
Eric Andersen7e9276b2001-02-22 01:15:47 +00002215#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002216 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002217#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002218 "Control magnetic tape drive operation\n" \
2219 "\nAvailable Opcodes:\n\n" \
2220 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2221 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2222 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2223 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002224
Eric Andersen7e9276b2001-02-22 01:15:47 +00002225#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002226 "[OPTION]... SOURCE DEST\n" \
2227 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002228#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002229 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2230 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002231 " -f Don't prompt before overwriting\n" \
2232 " -i Interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002233#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002234 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002235
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002236#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002237 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002238#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002239 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002240 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002241 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2242 " -s Use syslog (LOCAL0 facility)\n" \
2243 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002244#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002245 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2246 " or\n" \
2247 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002248
Rob Landley1cca9482006-07-10 19:45:20 +00002249#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002250#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002251#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002252#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002253#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002254
Eric Andersen7e9276b2001-02-22 01:15:47 +00002255#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002256 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002257 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002258#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002259 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002260 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002261 USE_NC_EXTRA( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002262 "\n -e Exec rest of command line after connect" \
2263 "\n -i SECS Delay interval for lines sent" \
2264 "\n -w SECS Timeout for connect" \
Denis Vlasenko5d687242007-01-12 20:59:31 +00002265 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002266 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002267 USE_NC_SERVER( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002268 "\n -l Listen mode, for inbound connects" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002269 USE_NC_EXTRA( \
2270 "\n (use -l twice with -e for persistent server)") \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002271 "\n -p PORT Local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002272 )
2273
Rob Landley1cca9482006-07-10 19:45:20 +00002274#define nc_notes_usage "" \
2275 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002276 "To use netcat as a terminal emulator on a serial port:\n\n" \
2277 "$ stty 115200 -F /dev/ttyS0\n" \
2278 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2279 )
Rob Landley1cca9482006-07-10 19:45:20 +00002280
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002281#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002282 "$ nc foobar.somedomain.com 25\n" \
2283 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2284 "help\n" \
2285 "214-Commands supported:\n" \
2286 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2287 "214 NOOP QUIT RSET HELP\n" \
2288 "quit\n" \
2289 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002290
Eric Andersen1552ff72001-10-31 11:07:12 +00002291#define netstat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002292 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002293#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002294 "Display networking information" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002295 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002296 " -l Display listening server sockets\n" \
2297 " -a Display all sockets (default: connected)\n" \
2298 " -e Display other/more information\n" \
2299 " -n Don't resolve names\n" \
2300 " -r Display routing table\n" \
2301 " -t Tcp sockets\n" \
2302 " -u Udp sockets\n" \
2303 " -w Raw sockets\n" \
2304 " -x Unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00002305
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002306#define nice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002307 "[-n ADJUST] [COMMAND [ARG] ...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002308#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002309 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002310 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002311 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002312
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002313#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002314 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002315#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002316 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002317 "Format specifiers:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002318 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002319 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002320 "%[niface] Monitor network interface 'iface'\n" \
2321 "%m Monitor allocated memory\n" \
2322 "%[mf] Monitor free memory\n" \
2323 "%[mt] Monitor total memory\n" \
2324 "%s Monitor allocated swap\n" \
2325 "%f Monitor number of used file descriptors\n" \
2326 "%Ni Monitor total/specific IRQ rate\n" \
2327 "%x Monitor context switch rate\n" \
2328 "%p Monitor forks\n" \
2329 "%[pn] Monitor # of processes\n" \
2330 "%b Monitor block io\n" \
2331 "%Nt Show time (with N decimal points)\n" \
2332 "%Nd Milliseconds between updates (default=1000)\n" \
2333 "%r Print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002334#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002335 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002336
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002337#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002338 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002339#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002340 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002341#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002342 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002343
Eric Andersen7e9276b2001-02-22 01:15:47 +00002344#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002345 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002346#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002347 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002348 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002349#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002350 "$ nslookup localhost\n" \
2351 "Server: default\n" \
2352 "Address: default\n" \
2353 "\n" \
2354 "Name: debian\n" \
2355 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002356
Glenn L McGrath60281112001-11-02 11:39:46 +00002357#define od_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002358 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002359#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002360 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
2361 "to standard output. With no FILE, or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002362
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002363#define openvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002364 "<vtnum> <COMMAND> [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002365#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002366 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002367#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002368 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002369
Eric Andersen27f64e12002-06-23 04:24:25 +00002370#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002371 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002372#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002373 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002374 "changes the password for the current user." \
2375 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002376 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002377 " (choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002378 " -d Delete the password for the specified user account\n" \
2379 " -l Locks (disables) the specified user account\n" \
2380 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002381
Glenn L McGrath655d8142003-06-22 15:32:41 +00002382#define patch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002383 "[-p<num>] [-i <diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002384#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002385 " -p NUM Strip NUM leading components from file names\n" \
2386 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002387#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002388 "$ patch -p1 < example.diff\n" \
2389 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002390
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002391#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2392#define USAGE_PIDOF "Options:"
2393#else
Denis Vlasenko765996a2006-12-24 16:59:27 +00002394#define USAGE_PIDOF "\nThis version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002395#endif
2396
Eric Andersen221b2ea2001-07-31 19:06:07 +00002397#define pidof_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002398 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002399
Eric Andersen221b2ea2001-07-31 19:06:07 +00002400#define pidof_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002401 "List the PIDs of all processes with names that match the\n" \
2402 "names on the command line\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002403 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002404 USE_FEATURE_PIDOF_SINGLE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002405 "\n -s Display only a single PID") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002406 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002407 "\n -o Omit given pid") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002408 USE_FEATURE_PIDOF_OMIT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002409 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002410#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002411 "$ pidof init\n" \
2412 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002413 USE_FEATURE_PIDOF_OMIT( \
2414 "$ pidof /bin/sh\n20351 5973 5950\n") \
2415 USE_FEATURE_PIDOF_OMIT( \
2416 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002417
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002418#ifndef CONFIG_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002419#define ping_trivial_usage \
2420 "host"
2421#define ping_full_usage \
2422 "Send ICMP ECHO_REQUEST packets to network hosts"
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002423#define ping6_trivial_usage \
2424 "host"
2425#define ping6_full_usage \
2426 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002427#else
2428#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002429 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002430#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002431 "Send ICMP ECHO_REQUEST packets to network hosts" \
2432 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002433 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2434 " -c CNT Send only CNT pings\n" \
2435 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2436 " -I iface/IP Use interface or IP address as source\n" \
2437 " -q Quiet mode, only displays output at start\n" \
2438 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002439#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002440 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002441#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002442 "Send ICMP ECHO_REQUEST packets to network hosts" \
2443 "\n\nOptions:\n" \
Denis Vlasenko9ca26d32007-02-09 17:32:16 +00002444 " -c CNT Send only CNT pings\n" \
2445 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2446 " -I iface/IP Use interface or IP address as source\n" \
2447 " -q Quiet mode, only displays output at start\n" \
2448 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002449#endif
Denis Vlasenkob9a279b2007-01-24 23:53:22 +00002450#define ping_example_usage \
2451 "$ ping localhost\n" \
2452 "PING slag (127.0.0.1): 56 data bytes\n" \
2453 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2454 "\n" \
2455 "--- debian ping statistics ---\n" \
2456 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2457 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002458#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002459 "$ ping6 ip6-localhost\n" \
2460 "PING ip6-localhost (::1): 56 data bytes\n" \
2461 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2462 "\n" \
2463 "--- ip6-localhost ping statistics ---\n" \
2464 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2465 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002466
Eric Andersen7e9276b2001-02-22 01:15:47 +00002467#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002468 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002469#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002470 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002471 "the new root file system"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002472
Eric Andersen7e9276b2001-02-22 01:15:47 +00002473#define poweroff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002474 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002475#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002476 "Halt and shut off power" \
2477 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002478 " -d Delay interval for halting\n" \
2479 " -n No call to sync()\n" \
2480 " -f Force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002481
Mike Frysinger95d3c452005-04-21 23:29:24 +00002482#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002483 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002484#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002485 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002486 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002487
Eric Andersen7e9276b2001-02-22 01:15:47 +00002488#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002489 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002490#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002491 "Format and print ARGUMENT(s) according to FORMAT,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002492 "where FORMAT controls the output exactly as in C printf"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002493#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002494 "$ printf \"Val=%d\\n\" 5\n" \
2495 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002496
Denis Vlasenko94949192006-11-05 00:45:47 +00002497
2498#if ENABLE_DESKTOP
2499
2500#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002501 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002502#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002503 "Report process status" \
2504 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002505 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002506
2507#else /* !ENABLE_DESKTOP */
2508
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002509#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002510#define USAGE_PS "\nThis version of ps accepts no options"
Rob Landley6eb1e412005-06-20 04:30:36 +00002511#else
2512#define USAGE_PS "\nOptions:"
2513#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002514
Eric Andersen7e9276b2001-02-22 01:15:47 +00002515#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002516 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002517#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002518 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002519 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002520 USE_SELINUX( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002521 "\n -c Show SE Linux context") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002522 USE_FEATURE_PS_WIDE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002523 "\n w Wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002524
Denis Vlasenko94949192006-11-05 00:45:47 +00002525#endif /* ENABLE_DESKTOP */
2526
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002527#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002528 "$ ps\n" \
2529 " PID Uid Gid State Command\n" \
2530 " 1 root root S init\n" \
2531 " 2 root root S [kflushd]\n" \
2532 " 3 root root S [kupdate]\n" \
2533 " 4 root root S [kpiod]\n" \
2534 " 5 root root S [kswapd]\n" \
2535 " 742 andersen andersen S [bash]\n" \
2536 " 743 andersen andersen S -bash\n" \
2537 " 745 root root S [getty]\n" \
2538 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002539
Denis Vlasenko94949192006-11-05 00:45:47 +00002540
Eric Andersen7e9276b2001-02-22 01:15:47 +00002541#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002542 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002543#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002544 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002545#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002546 "$ pwd\n" \
2547 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002548
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002549#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002550 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002551#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002552 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002553#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002554 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002555
Eric Andersen7e9276b2001-02-22 01:15:47 +00002556#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002557 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002558#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002559 "Get and possibly set the system date and time from a remote HOST" \
2560 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002561 " -s Set the system date and time (default)\n" \
2562 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002563
Rob Landley0e4690d2006-08-20 22:12:18 +00002564#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002565 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002566#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002567 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2568 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00002569
Eric Andersen7e9276b2001-02-22 01:15:47 +00002570#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002571 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002572#define readlink_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002573 "Display the value of a symbolic link" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002574 USE_FEATURE_READLINK_FOLLOW( \
2575 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002576 " -f Canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002577
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002578#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002579 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002580#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002581 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002582 " -m <mapfile> (Default: /boot/System.map)\n" \
2583 " -p <profile> (Default: /proc/profile)\n" \
2584 " -M <mult> Set the profiling multiplier to <mult>\n" \
2585 " -i Print only info about the sampling step\n" \
2586 " -v Print verbose data\n" \
2587 " -a Print all symbols, even if count is 0\n" \
2588 " -b Print individual histogram-bin counts\n" \
2589 " -s Print individual counters within functions\n" \
2590 " -r Reset all the counters (root only)\n" \
2591 " -n Disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002592
Glenn L McGrath62fae302002-12-10 00:14:33 +00002593#define realpath_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002594 "pathname ..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00002595#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002596 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00002597
Eric Andersen7e9276b2001-02-22 01:15:47 +00002598#define reboot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002599 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002600#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002601 "Reboot the system" \
2602 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002603 " -d Delay interval for rebooting\n" \
2604 " -n No call to sync()\n" \
2605 " -f Force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002606
2607#define renice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002608 "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002609#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002610 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002611 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002612 " -n Adjusts current nice value (smaller is faster)\n" \
2613 " -p Process id(s) (default)\n" \
2614 " -g Process group id(s)\n" \
2615 " -u Process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002616
Eric Andersen7e9276b2001-02-22 01:15:47 +00002617#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002618 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002619#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002620 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002621
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002622#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002623 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002624#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002625 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002626
Eric Andersen7e9276b2001-02-22 01:15:47 +00002627#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002628 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002629#define rm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002630 "Remove (unlink) the FILE(s). You may use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002631 "indicate that all following arguments are non-options." \
2632 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002633 " -i Always prompt before removing each destination\n" \
2634 " -f Remove existing destinations, never prompt\n" \
2635 " -r,-R Remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002636#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002637 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002638
Eric Andersen7e9276b2001-02-22 01:15:47 +00002639#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002640 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002641#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002642 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002643#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002644 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002645
Eric Andersen7e9276b2001-02-22 01:15:47 +00002646#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002647 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002648#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002649 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002650 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002651 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002652#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002653 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002654
Eric Andersen7e9276b2001-02-22 01:15:47 +00002655#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002656 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002657#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002658 "Edit the kernel's routing tables" \
2659 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002660 " -n Dont resolve names\n" \
2661 " -e Display other/more information\n" \
2662 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002663
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002664#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002665 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002666#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002667 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002668 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002669 "\n -i Install package" \
2670 "\n -q Query package" \
2671 "\n -p Query uninstalled package" \
2672 "\n -i Show information" \
2673 "\n -l List contents" \
2674 "\n -d List documents" \
2675 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002676
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002677#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002678 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002679#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002680 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002681
Eric Andersen6cf47a72001-10-31 10:24:36 +00002682#define run_parts_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002683 "[-t] [-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002684#define run_parts_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002685 "Run a bunch of scripts in a directory" \
2686 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002687 " -t Prints what would be run, but does not actually run anything\n" \
2688 " -a ARG Pass ARG as an argument for every program invoked\n" \
2689 " -u MASK Set the umask to MASK before executing every program"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002690
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002691#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002692 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002693#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002694 "Find the current and previous system runlevel.\n\n" \
2695 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002696 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002697#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002698 "$ runlevel /var/run/utmp\n" \
2699 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002700
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002701#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002702 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002703#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002704 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002705
2706#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002707 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002708#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002709 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002710
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002711#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002712 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002713#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002714 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002715#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002716 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002717
Eric Andersen7e9276b2001-02-22 01:15:47 +00002718#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002719 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002720#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002721 "Options:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002722 " -e script Add the script to the commands to be executed\n" \
2723 " -f scriptfile Add script-file contents to the\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002724 " commands to be executed\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002725 " -i Edit files in-place\n" \
2726 " -n Suppress automatic printing of pattern space\n" \
2727 " -r Use extended regular expression syntax\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002728 "\n" \
2729 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2730 "script to interpret. All remaining arguments are names of input files; if no\n" \
2731 "input files are specified, then the standard input is read. Source files\n" \
2732 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00002733
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002734#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002735 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2736 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002737
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002738#define selinuxenabled_trivial_usage
2739#define selinuxenabled_full_usage
2740
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002741#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002742 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002743#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002744 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002745 "FIRST, INCREMENT default to 1" \
2746 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002747 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002748 " FIRST LAST\n" \
2749 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002750
Paul Foxfc2256a2005-08-01 18:12:30 +00002751#define setconsole_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002752 "[-r|--reset] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00002753#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002754 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002755 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002756 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00002757
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00002758#define setenforce_trivial_usage \
2759 "[ Enforcing | Permissive | 1 | 0 ]"
2760#define setenforce_full_usage
2761
Eric Andersen7e9276b2001-02-22 01:15:47 +00002762#define setkeycodes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002763 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002764#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002765 "Set entries into the kernel's scancode-to-keycode map,\n" \
2766 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2767 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
2768 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002769#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002770 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002771
Rob Landley87848d92006-03-27 23:23:43 +00002772#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002773 "N"
Rob Landley87848d92006-03-27 23:23:43 +00002774#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002775 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00002776
Paul Fox42403642005-08-01 22:52:09 +00002777#define setsid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002778 "program [arg ...]"
Paul Fox42403642005-08-01 22:52:09 +00002779#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002780 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002781 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00002782
Matt Kraai2d91deb2001-08-01 17:21:35 +00002783#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002784 "[FILE]...\n" \
2785 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002786#define lash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002787 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002788#define lash_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002789 "This command does not yet have proper documentation.\n\n" \
2790 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2791 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2792 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2793 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
2794 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2795 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002796
Eric Andersen2e9c2572003-08-08 22:26:06 +00002797#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002798 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00002799#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002800 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00002801
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002802#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002803 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002804 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002805#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002806 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002807 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002808 "\n\nOptions:\n" \
2809 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002810 " -c Check SHA1 sums against given list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002811 "\nThe following two options are useful only when verifying checksums:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002812 " -s Don't output anything, status code shows success\n" \
2813 " -w Warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002814
Eric Andersen7e9276b2001-02-22 01:15:47 +00002815#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002816 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002817#define sleep_full_usage \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002818 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002819 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002820 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002821 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002822#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002823 "$ sleep 2\n" \
2824 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002825 USE_FEATURE_FANCY_SLEEP( \
2826 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002827 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002828
Eric Andersen7e9276b2001-02-22 01:15:47 +00002829#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002830 "[-nru" \
2831 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") \
2832 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002833#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002834 "Sort lines of text in the specified files" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002835 "\n\nOptions:\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002836 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002837 " -b Ignore leading blanks\n" \
2838 " -c Check whether input is sorted\n" \
2839 " -d Dictionary order (blank or alphanumeric only)\n" \
2840 " -f Ignore case\n" \
2841 " -g General numerical sort\n" \
2842 " -i Ignore unprintable characters\n" \
2843 " -k Specify sort key\n" \
2844 " -M Sort month\n") \
2845 " -n Sort numbers\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002846 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002847 " -o Output to file\n" \
2848 " -k Sort by key\n" \
2849 " -t Use key separator other than whitespace\n") \
2850 " -r Reverse sort order\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002851 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002852 " -s Stable (don't sort ties alphabetically)\n") \
2853 " -u Suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002854 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002855 "\n -z Input terminated by nulls, not newlines\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002856 USE_FEATURE_SORT_BIG( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002857 " -mST Ignored for GNU compatibility") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002858 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002859#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002860 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
2861 "a\n" \
2862 "b\n" \
2863 "c\n" \
2864 "d\n" \
2865 "e\n" \
2866 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002867 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002868 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2869 "d 2\n" \
2870 "b 2\n" \
2871 "c 3\n" \
2872 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002873 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002874
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002875#define start_stop_daemon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002876 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002877#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002878 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002879 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002880 "\n -S|--start Start" \
2881 "\n -K|--stop Stop" \
2882 "\n -a|--startas <pathname> Starts process specified by pathname" \
2883 "\n -b|--background Force process into background" \
2884 "\n -u|--user <username>|<uid> Stop this user's processes" \
2885 "\n -x|--exec <executable> Program to either start or check" \
2886 "\n -m|--make-pidfile Create the -p file and enter pid in it" \
2887 "\n -n|--name <process-name> Stop processes with this name" \
2888 "\n -p|--pidfile <pid-file> Save or load pid using a pid-file" \
2889 "\n -q|--quiet Be quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002890 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002891 "\n -o|--oknodo Exit status 0 if nothing done" \
2892 "\n -v|--verbose Be verbose" \
2893 "\n -N|--nicelevel <N> Add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002894 ) \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002895 "\n -s|--signal <signal> Signal to send (default TERM)" \
Denis Vlasenkocce38582007-02-26 22:47:42 +00002896 "\n -c|--chuid <user>[:[<group>]] Change to specified user/group"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002897
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002898#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002899 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002900#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002901 "Display file (default) or filesystem status" \
2902 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002903 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002904 " -c fmt Use the specified format\n") \
2905 " -f Display filesystem status\n" \
2906 " -L,-l Dereference links\n" \
2907 " -t Display info in terse form" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002908 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002909 "\n\nValid format sequences for files:\n" \
2910 " %a Access rights in octal\n" \
2911 " %A Access rights in human readable form\n" \
2912 " %b Number of blocks allocated (see %B)\n" \
2913 " %B The size in bytes of each block reported by %b\n" \
2914 " %d Device number in decimal\n" \
2915 " %D Device number in hex\n" \
2916 " %f Raw mode in hex\n" \
2917 " %F File type\n" \
2918 " %g Group ID of owner\n" \
2919 " %G Group name of owner\n" \
2920 " %h Number of hard links\n" \
2921 " %i Inode number\n" \
2922 " %n File name\n" \
2923 " %N Quoted file name with dereference if symbolic link\n" \
2924 " %o I/O block size\n" \
2925 " %s Total size, in bytes\n" \
2926 " %t Major device type in hex\n" \
2927 " %T Minor device type in hex\n" \
2928 " %u User ID of owner\n" \
2929 " %U User name of owner\n" \
2930 " %x Time of last access\n" \
2931 " %X Time of last access as seconds since Epoch\n" \
2932 " %y Time of last modification\n" \
2933 " %Y Time of last modification as seconds since Epoch\n" \
2934 " %z Time of last change\n" \
2935 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002936 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002937 " %a Free blocks available to non-superuser\n" \
2938 " %b Total data blocks in file system\n" \
2939 " %c Total file nodes in file system\n" \
2940 " %d Free file nodes in file system\n" \
2941 " %f Free blocks in file system\n" \
2942 " %i File System ID in hex\n" \
2943 " %l Maximum length of filenames\n" \
2944 " %n File name\n" \
2945 " %s Block size (for faster transfers)\n" \
2946 " %S Fundamental block size (for block counts)\n" \
2947 " %t Type in hex\n" \
2948 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002949 )
2950
Eric Andersenef5e8f82002-11-07 02:09:37 +00002951#define strings_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002952 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002953#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002954 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002955 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002956 "\n -a Scan the whole files (this is the default)" \
2957 "\n -f Precede each string with the name of the file where it was found" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002958 "\n -n N Specifies that at least N characters forms a sequence (default 4)" \
2959 "\n -o Each string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002960
Eric Andersen7e9276b2001-02-22 01:15:47 +00002961#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002962 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002963#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002964 "Without arguments, prints baud rate, line discipline,\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002965 "and deviations from stty sane" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002966 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002967 "\n -F DEVICE Open device instead of stdin" \
2968 "\n -a Print all current settings in human-readable form" \
2969 "\n -g Print in stty-readable form" \
2970 "\n [SETTING] See manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002971
Robert Griebl1fca5582002-06-04 20:45:46 +00002972#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002973 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00002974#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002975 "Change user id or become root" \
2976 "\n\nOptions:" \
2977 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002978 "\n -c Command to pass to 'sh -c'" \
2979 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00002980
Eric Andersen27f64e12002-06-23 04:24:25 +00002981#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002982 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002983#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002984 "Single user login" \
2985 "\n\nOptions:" \
2986 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00002987
Mike Frysinger95d3c452005-04-21 23:29:24 +00002988#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002989 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002990#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002991 "Checksum and count the blocks in a file" \
2992 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00002993 " -r Use BSD sum algorithm (1K blocks)\n" \
2994 " -s Use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002995
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002996#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002997 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002998#define sv_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002999 "Report the current status and control the state of services " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003000 "monitored by the runsv supervisor"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00003001
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003002#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003003 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003004#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003005 "Continuously read log data from standard input, optionally " \
3006 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003007 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00003008
Eric Andersen7e9276b2001-02-22 01:15:47 +00003009#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003010 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003011#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003012 "Stop swapping virtual memory pages on DEVICE" \
3013 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003014 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003015
Eric Andersen7e9276b2001-02-22 01:15:47 +00003016#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003017 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003018#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003019 "Start swapping virtual memory pages on DEVICE" \
3020 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003021 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003022
Rob Landley0f34a822005-10-27 22:55:50 +00003023#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003024 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00003025#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003026 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003027 "and exec NEW_INIT" \
3028 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003029 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00003030
Eric Andersen7e9276b2001-02-22 01:15:47 +00003031#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003032 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003033#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003034 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003035
Eric Andersenb9050282003-12-24 06:02:11 +00003036#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003037 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003038#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003039 "Configure kernel parameters at runtime" \
3040 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003041 " -n Use this option to disable printing of the key name when printing values\n" \
3042 " -w Use this option when you want to change a sysctl setting\n" \
3043 " -p Load in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
3044 " -a Display all values currently available\n" \
3045 " -A Display all values currently available in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003046#define sysctl_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003047 "sysctl [-n] variable ...\n" \
3048 "sysctl [-n] -w variable=value ...\n" \
3049 "sysctl [-n] -a\n" \
3050 "sysctl [-n] -p <file> (default /etc/sysctl.conf)\n" \
3051 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003052
Eric Andersen7e9276b2001-02-22 01:15:47 +00003053#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003054 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003055#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003056 "System logging utility.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003057 "Note that this version of syslogd ignores /etc/syslog.conf." \
3058 "\n\nOptions:" \
Bernhard Reutner-Fischer5568b722007-01-07 15:53:18 +00003059 "\n -n Run as foreground process" \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003060 "\n -O FILE Use an alternate log file (default=/var/log/messages)" \
3061 "\n -l n Sets the local log level of messages to n" \
3062 "\n -S Make logging output smaller" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003063 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003064 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3065 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003066 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003067 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003068 "\n -L Log locally and via network logging (default is network only)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003069 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenkoa0e2a0a2007-01-04 21:22:11 +00003070 "\n -C[size(KiB)] Log to a shared mem buffer (read the buffer using logread)")
Denis Vlasenkoa9b60e92007-01-04 17:59:59 +00003071 /* NB: -Csize shouldn't have space (because size is optional) */
Denis Vlasenko4998c812007-02-14 20:51:46 +00003072/* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003073#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003074 "$ syslogd -R masterlog:514\n" \
3075 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003076
Eric Andersen7e9276b2001-02-22 01:15:47 +00003077#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003078 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003079#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003080 "Print last 10 lines of each FILE to standard output.\n" \
3081 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003082 "file name. With no FILE, or when FILE is -, read standard input." \
3083 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003084 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003085 "\n -c N[kbm] Output the last N bytes") \
3086 "\n -n N[kbm] Print last N lines instead of last 10" \
3087 "\n -f Output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003088 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003089 "\n -q Never output headers giving file names" \
3090 "\n -s SEC Wait SEC seconds between reads with -f" \
3091 "\n -v Always output headers giving file names" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003092 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003093 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3094 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3095 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003096#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003097 "$ tail -n 1 /etc/resolv.conf\n" \
3098 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003099
Eric Andersen7e9276b2001-02-22 01:15:47 +00003100#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003101 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003102 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3103 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003104 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003105 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003106#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003107 "Create, extract, or list files from a tar file" \
3108 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003109 USE_FEATURE_TAR_CREATE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003110 " c Create\n") \
3111 " x Extract\n" \
3112 " t List\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003113 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003114 USE_FEATURE_TAR_GZIP( \
3115 " z Filter the archive through gzip\n") \
3116 USE_FEATURE_TAR_BZIP2( \
3117 " j Filter the archive through bzip2\n") \
3118 USE_FEATURE_TAR_LZMA( \
3119 " a Filter the archive through lzma\n") \
3120 USE_FEATURE_TAR_COMPRESS( \
3121 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003122 "\nFile selection:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003123 " f Name of TARFILE or \"-\" for stdin\n" \
3124 " O Extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003125 USE_FEATURE_TAR_FROM( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003126 " exclude File to exclude\n" \
3127 " X File with names to exclude\n") \
3128 " C Change to directory DIR before operation\n" \
3129 " v Verbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003130#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003131 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3132 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003133
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003134#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003135 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003136#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003137 "Set or get CPU affinity" \
3138 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003139 " -p Operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003140#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003141 "$ taskset 0x7 ./dgemm_test&\n" \
3142 "$ taskset -p 0x1 $!\n" \
3143 "pid 4790's current affinity mask: 7\n" \
3144 "pid 4790's new affinity mask: 1\n" \
3145 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3146 "pid 6671's current affinity mask: 1\n" \
3147 "pid 6671's new affinity mask: 1\n" \
3148 "$ taskset -p 1\n" \
3149 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003150
Eric Andersen7e9276b2001-02-22 01:15:47 +00003151#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003152 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003153#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003154 "Copy standard input to each FILE, and also to standard output" \
3155 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003156 " -a Append to the given FILEs, do not overwrite\n" \
3157 " -i Ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003158#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003159 "$ echo \"Hello\" | tee /tmp/foo\n" \
3160 "$ cat /tmp/foo\n" \
3161 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003162
Eric Andersen539ffc92004-02-22 12:25:47 +00003163#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
3164#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003165 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003166#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003167 "Connect to remote telnet server" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003168 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003169 " -a Attempt an automatic login with the USER variable\n" \
3170 " -l USER Attempt an automatic login with the USER argument\n" \
3171 " HOST The official name, alias or the IP address of the\n" \
Denis Vlasenkob6488c12006-12-25 14:25:14 +00003172 " remote host\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003173 " PORT The remote port number to connect to. If it is not\n" \
3174 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003175#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003176#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003177 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003178#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003179 "Connect to remote telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003180#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003181
Eric Andersen08a72202002-09-30 20:52:10 +00003182#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003183 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003184#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003185 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003186 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3187 "\n\nOptions:" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003188 "\n -l LOGIN Exec LOGIN on connect" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003189 "\n -f issue_file Display issue_file instead of /etc/issue" \
3190 USE_FEATURE_TELNETD_STANDALONE( \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003191 "\n -p PORT Port to listen to" \
3192 "\n -b ADDR Address to bind to" \
3193 "\n -F Stay in foreground" \
3194 "\n -i Run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003195 )
Eric Andersen08a72202002-09-30 20:52:10 +00003196
Eric Andersen7e9276b2001-02-22 01:15:47 +00003197#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003198 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003199#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003200 "Check file types and compares values returning an exit code\n" \
3201 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003202#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003203 "$ test 1 -eq 2\n" \
3204 "$ echo $?\n" \
3205 "1\n" \
3206 "$ test 1 -eq 1\n" \
3207 "$ echo $?\n" \
3208 "0\n" \
3209 "$ [ -d /etc ]\n" \
3210 "$ echo $?\n" \
3211 "0\n" \
3212 "$ [ -d /junk ]\n" \
3213 "$ echo $?\n" \
3214 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003215
Mark Whitley450736c2001-03-02 19:08:50 +00003216#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003217 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003218#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003219 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003220 "\n\nOptions:" \
3221 "\n -l FILE Local FILE" \
3222 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003223 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003224 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003225 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003226 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003227 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003228 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003229 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003230 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003231 )
Eric Andersenc3657422001-11-30 07:54:32 +00003232#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003233 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003234#define time_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003235 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003236 "COMMAND's resource usage information is displayed." \
3237 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003238 " -v Display verbose resource usage information"
Mark Whitley450736c2001-03-02 19:08:50 +00003239
Eric Andersen420b2082002-09-17 22:14:58 +00003240#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003241 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003242#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003243 "Provide a view of process activity in real time.\n" \
3244 "Read the status of all processes from /proc each <seconds>\n" \
3245 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003246
Eric Andersen7e9276b2001-02-22 01:15:47 +00003247#define touch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003248 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003249#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003250 "Update the last-modified date on the given FILE[s]" \
3251 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003252 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003253#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003254 "$ ls -l /tmp/foo\n" \
3255 "/bin/ls: /tmp/foo: No such file or directory\n" \
3256 "$ touch /tmp/foo\n" \
3257 "$ ls -l /tmp/foo\n" \
3258 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003259
3260#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003261 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003262#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003263 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003264 "standard input, writing to standard output" \
3265 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003266 " -c Take complement of STRING1\n" \
3267 " -d Delete input characters coded STRING1\n" \
3268 " -s Squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003269#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003270 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3271 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003272
Eric Andersen5c58d282001-07-10 16:29:00 +00003273#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003274 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3275 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3276 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003277#define traceroute_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003278 "Trace the route ip packets follow going to \"host\"" \
3279 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003280 " -F Set the don't fragment bit\n" \
3281 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3282 " -l Display the ttl value of the returned packet\n" \
3283 " -d Set SO_DEBUG options to socket\n" \
3284 " -n Print hop addresses numerically rather than symbolically\n" \
3285 " -r Bypass the normal routing tables and send directly to a host\n" \
3286 " -v Verbose output\n" \
3287 " -m max_ttl Set the max time-to-live (max number of hops)\n" \
3288 " -p port# Set the base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003289 " (default is 33434)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003290 " -q nqueries Set the number of probes per 'ttl' to nqueries\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003291 " (default is 3)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003292 " -s src_addr Use the following IP address as the source address\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003293 " -t tos Set the type-of-service in probe packets to the following value\n" \
3294 " (default 0)\n" \
3295 " -w wait Set the time (in seconds) to wait for a response to a probe\n" \
3296 " (default 3 sec)\n" \
3297 " -g Specify a loose source route gateway (8 maximum)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003298
3299
Eric Andersen7e9276b2001-02-22 01:15:47 +00003300#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003301 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003302#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003303 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003304#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003305 "$ true\n" \
3306 "$ echo $?\n" \
3307 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003308
Eric Andersen7e9276b2001-02-22 01:15:47 +00003309#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003310 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003311#define tty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003312 "Print the file name of the terminal connected to standard input" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003313 USE_INCLUDE_SUSv2( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003314 "\n\nOptions:\n" \
Bernhard Reutner-Fischer12f96c12007-01-20 21:34:24 +00003315 " -s Print nothing, only return an exit status")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003316#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003317 "$ tty\n" \
3318 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003319
Mike Frysinger174808c2005-06-11 01:14:09 +00003320#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003321 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3322 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3323 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3324 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3325 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3326 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003327#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003328 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00003329
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003330#define udhcpc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003331 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003332#define udhcpc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003333 " -V,--vendorclass=CLASSID Set vendor class identifier\n" \
3334 " -i,--interface=INTERFACE Interface to use (default: eth0)\n" \
3335 " -H,-h,--hostname=HOSTNAME Client hostname\n" \
3336 " -c,--clientid=CLIENTID Set client identifier\n" \
3337 " -C,--clientid-none Suppress default client identifier\n" \
3338 " -p,--pidfile=file Store process ID of daemon in file\n" \
3339 " -r,--request=IP IP address to request (default: none)\n" \
3340 " -s,--script=file Run file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
3341 " -t,--retries=NUM Send up to NUM request packets\n"\
3342 " -f,--foreground Do not fork after getting lease\n" \
3343 " -b,--background Fork to background if lease cannot be immediately negotiated\n" \
3344 " -n,--now Exit with failure if lease cannot be immediately negotiated\n" \
3345 " -q,--quit Quit after obtaining lease\n" \
3346 " -R,--release Release IP on quit\n" \
3347 " -v,--version Display version" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003348
Russ Dill61fb4892002-10-14 21:41:28 +00003349#define udhcpd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003350 "[configfile]\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00003351
3352#define udhcpd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003353 ""
Russ Dill61fb4892002-10-14 21:41:28 +00003354
Eric Andersen7e9276b2001-02-22 01:15:47 +00003355#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003356 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003357#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003358 "Unmount file systems" \
3359 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003360 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
3361 USE_FEATURE_MTAB_SUPPORT( \
3362 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003363 "\n -r Try to remount devices as read-only if mount is busy" \
3364 "\n -l Lazy umount (detach filesystem)" \
3365 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003366 USE_FEATURE_MOUNT_LOOP( \
3367 "\n -D Do not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003368#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003369 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003370
3371#define uname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003372 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003373#define uname_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003374 "Print certain system information. With no OPTION, same as -s." \
3375 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003376 " -a Print all information\n" \
3377 " -m The machine (hardware) type\n" \
3378 " -n Print the machine's network node hostname\n" \
3379 " -r Print the operating system release\n" \
3380 " -s Print the operating system name\n" \
3381 " -p Print the host processor type\n" \
3382 " -v Print the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003383#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003384 "$ uname -a\n" \
3385 "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 +00003386
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003387#define uncompress_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003388 "[-c] [-f] [ name ... ]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003389#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003390 "Uncompress .Z file[s]" \
3391 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003392 " -c Extract to stdout\n" \
3393 " -f Force overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003394
Eric Andersen7e9276b2001-02-22 01:15:47 +00003395#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003396 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003397#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003398 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003399 "(or standard input), writing to OUTPUT (or standard output)" \
3400 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003401 " -c Prefix lines by the number of occurrences\n" \
3402 " -d Only print duplicate lines\n" \
3403 " -u Only print unique lines\n" \
3404 " -f N Skip the first N fields\n" \
3405 " -s N Skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003406#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003407 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3408 "a\n" \
3409 "b\n" \
3410 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003411
3412#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003413 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003414#define unix2dos_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003415 "Convert FILE from unix format to dos format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003416 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003417 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003418 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003419 " -u Output will be in UNIX format\n" \
3420 " -d Output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003421
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003422#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003423 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003424#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003425 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003426 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003427 " -l List archive contents (short form)\n" \
3428 " -n Never overwrite existing files (default)\n" \
3429 " -o Overwrite files without prompting\n" \
3430 " -p Send output to stdout\n" \
3431 " -q Be quiet\n" \
3432 " -x Exclude these files\n" \
3433 " -d Extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003434
Eric Andersen7e9276b2001-02-22 01:15:47 +00003435#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003436 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003437#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003438 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003439#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003440 "$ uptime\n" \
3441 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003442
3443#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003444 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003445#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003446 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003447#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003448 "$ usleep 1000000\n" \
3449 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003450
3451#define uudecode_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003452 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003453#define uudecode_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003454 "Uudecode a file" \
3455 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003456 " -o FILE Direct output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003457#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003458 "$ uudecode -o busybox busybox.uu\n" \
3459 "$ ls -l busybox\n" \
3460 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003461
3462#define uuencode_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003463 "[OPTION] [INFILE] REMOTEFILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003464#define uuencode_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003465 "Uuencode a file" \
3466 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003467 " -m Use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003468#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003469 "$ uuencode busybox busybox\n" \
3470 "begin 755 busybox\n" \
3471 "<encoded file snipped>\n" \
3472 "$ uudecode busybox busybox > busybox.uu\n" \
3473 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003474
Eric Andersen853c4942003-01-23 05:59:32 +00003475#define vconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003476 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003477#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003478 "Create and remove virtual ethernet devices" \
3479 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003480 " add [interface-name] [vlan_id]\n" \
3481 " rem [vlan-name]\n" \
3482 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
3483 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3484 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3485 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003486
Eric Andersen3f980402001-04-04 17:31:15 +00003487#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003488 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00003489#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003490 "Edit FILE" \
3491 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003492 " -R Read-only - do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003493
Eric Andersen27f64e12002-06-23 04:24:25 +00003494#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003495 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003496#define vlock_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003497 "Lock a virtual terminal. A password is required to unlock." \
3498 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003499 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00003500
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003501#define watch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003502 "[-n <seconds>] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003503#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003504 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003505 "\n\nOptions:\n" \
3506 " -n Loop period in seconds - default is 2\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003507 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003508#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003509 "$ watch date\n" \
3510 "Mon Dec 17 10:31:40 GMT 2000\n" \
3511 "Mon Dec 17 10:31:42 GMT 2000\n" \
3512 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003513
Eric Andersen7e9276b2001-02-22 01:15:47 +00003514#define watchdog_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003515 "[-t <seconds>] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003516#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003517 "Periodically write to watchdog device DEV" \
3518 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003519 " -t Timer period in seconds - default is 30\n" \
3520 " -F Stay in the foreground and don't fork"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003521
3522#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003523 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003524#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003525 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003526 "more than one FILE is specified. With no FILE, read standard input." \
3527 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003528 " -c Print the byte counts\n" \
3529 " -l Print the newline counts\n" \
3530 " -L Print the length of the longest line\n" \
3531 " -w Print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003532#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003533 "$ wc /etc/passwd\n" \
3534 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003535
3536#define wget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003537 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
3538 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
3539 " [-U|--user-agent agent] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003540#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003541 "Retrieve files via HTTP or FTP" \
3542 "\n\nOptions:\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003543 " -c Continue retrieval of aborted transfers\n" \
3544 " -q Quiet mode - do not print\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003545 " -P Set directory prefix to DIR\n" \
Denis Vlasenkod63c3a02006-12-25 15:10:32 +00003546 " -O Save to filename ('-' for stdout)\n" \
3547 " -U Adjust 'User-Agent' field\n" \
3548 " -Y Use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003549
3550#define which_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003551 "[COMMAND ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003552#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003553 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003554#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003555 "$ which login\n" \
3556 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003557
Eric Andersen00a6a752002-04-26 23:53:10 +00003558#define who_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003559 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003560#define who_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003561 "Print the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003562
3563#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003564 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003565#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003566 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003567
3568#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003569 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003570#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003571 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003572 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003573 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
3574 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003575 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003576 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
3577 " -x Exit if the size is exceeded\n") \
3578 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
3579 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003580 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003581#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003582 "$ ls | xargs gzip\n" \
3583 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003584
3585#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003586 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003587#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003588 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003589
Eric Andersen7e9276b2001-02-22 01:15:47 +00003590#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003591 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003592#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003593 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00003594
Rob Landleyad8071f2005-04-30 03:49:37 +00003595#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003596 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00003597#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003598 "Manage a ZeroConf IPv4 link-local address" \
3599 "\n\nOptions:\n" \
Denis Vlasenkod46d3c22007-02-06 19:28:50 +00003600 " -f Foreground mode\n" \
3601 " -q Quit after address (no daemon)\n" \
3602 " -r 169.254.x.x Request this address first\n" \
3603 " -v Verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00003604
Eric Andersen178de172004-04-06 16:36:20 +00003605#endif /* __BB_USAGE_H__ */