blob: 701b421a866a00b36ba6480b6381e6ae92cf3b08 [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 Vlasenko1fffe382006-11-28 00:06:39 +000017 "Adds a group to the system\n\n" \
18 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +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 Vlasenko1fffe382006-11-28 00:06:39 +000024 "Adds a user to the system\n\n" \
25 "Options:\n" \
26 " -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" \
30 " -S create a system user (ignored)\n" \
31 " -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 Vlasenko1fffe382006-11-28 00:06:39 +000037 "Reads and optionally sets system timebase parameters.\n" \
38 "See adjtimex(2).\n\n" \
39 "Options:\n" \
40 " -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" \
43 " (positive values make the system clock run fast)\n" \
44 " -t tick microseconds per tick, usually 10000\n" \
45 " -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 Vlasenko1fffe382006-11-28 00:06:39 +000050 "Extract or list FILES from an ar archive.\n\n" \
51 "Options:\n" \
52 " -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
Glenn L McGrath9e598412003-01-09 10:06:01 +000058#define arping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000059 "[-fqbDUA] [-c count] [-w timeout] [-i device] [-s sender] target"
Glenn L McGrath9e598412003-01-09 10:06:01 +000060#define arping_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000061 "Ping hosts by ARP requests/replies.\n\n" \
62 "Options:\n" \
63 " -f Quit on first ARP reply\n" \
64 " -q Be quiet\n" \
65 " -b Keep broadcasting, don't go unicast\n" \
66 " -D Duplicated address detection mode\n" \
67 " -U Unsolicited ARP mode, update your neighbours\n" \
68 " -A ARP answer mode, update your neighbours\n" \
69 " -c count Stop after sending count ARP request packets\n" \
70 " -w timeout Time to wait for ARP reply, in seconds\n" \
71 " -i device Outgoing interface name, default is eth0\n" \
72 " -s sender Set specific sender IP address\n" \
73 " target Target IP address of ARP request"
Glenn L McGrath9e598412003-01-09 10:06:01 +000074
Eric Andersen08f59e32004-03-12 22:07:10 +000075#define ash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000076 "[FILE]...\n" \
77 "or: ash -c command [args]..."
Eric Andersen08f59e32004-03-12 22:07:10 +000078#define ash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000079 "The ash shell (command interpreter)"
Eric Andersen08f59e32004-03-12 22:07:10 +000080
81#define awk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000082 "[OPTION]... [program-text] [FILE ...]"
Eric Andersen08f59e32004-03-12 22:07:10 +000083#define awk_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000084 "Options:\n" \
85 " -v var=val assign value 'val' to variable 'var'\n" \
86 " -F sep use 'sep' as field separator\n" \
87 " -f progname read program source from file 'progname'"
Glenn L McGrath7a32aaa2002-09-15 17:03:48 +000088
Eric Andersen7e9276b2001-02-22 01:15:47 +000089#define basename_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000090 "FILE [SUFFIX]"
Eric Andersen7e9276b2001-02-22 01:15:47 +000091#define basename_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000092 "Strips directory path and suffixes from FILE.\n" \
93 "If specified, also removes any trailing SUFFIX."
Eric Andersen0d3a02e2001-03-15 18:14:25 +000094#define basename_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000095 "$ basename /usr/local/bin/foo\n" \
96 "foo\n" \
97 "$ basename /usr/local/bin/\n" \
98 "bin\n" \
99 "$ basename /foo/bar.txt .txt\n" \
100 "bar"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000101
Glenn L McGrath24e28332001-10-05 03:48:57 +0000102#define bunzip2_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000103 "[OPTION]... [FILE]"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000104#define bunzip2_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000105 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
106 "Options:\n" \
107 " -c Write output to standard output\n" \
108 " -f Force"
Glenn L McGrath24e28332001-10-05 03:48:57 +0000109
Rob Landley6130b9b2006-01-23 21:10:38 +0000110#define busybox_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000111 "Hello world!\n"
Rob Landley6130b9b2006-01-23 21:10:38 +0000112
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000113#define bzcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000114 "FILE"
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000115#define bzcat_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000116 "Uncompress to stdout."
Glenn L McGrathfff11f12001-11-18 14:20:25 +0000117
Rob Landleyc1d69902006-01-20 18:28:50 +0000118#define unlzma_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000119 "[OPTION]... [FILE]"
Rob Landleyc1d69902006-01-20 18:28:50 +0000120#define unlzma_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000121 "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \
122 "Options:\n" \
123 " -c Write output to standard output\n" \
124 " -f Force"
Rob Landleyc1d69902006-01-20 18:28:50 +0000125
126#define lzmacat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000127 "FILE"
Rob Landleyc1d69902006-01-20 18:28:50 +0000128#define lzmacat_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000129 "Uncompress to stdout."
Rob Landleyc1d69902006-01-20 18:28:50 +0000130
Eric Andersenc98c0622001-12-06 15:16:43 +0000131#define cal_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000132 "[-jy] [[month] year]"
Eric Andersenc98c0622001-12-06 15:16:43 +0000133#define cal_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000134 "Display a calendar.\n" \
135 "\nOptions:\n" \
136 " -j Use julian dates\n" \
137 " -y Display the entire year"
Eric Andersenc98c0622001-12-06 15:16:43 +0000138
Eric Andersen7e9276b2001-02-22 01:15:47 +0000139#define cat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000140 "[-u] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000141#define cat_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000142 "Concatenates FILE(s) and prints them to stdout.\n\n" \
143 "Options:\n" \
144 " -u ignored since unbuffered i/o is always used"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000145#define cat_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000146 "$ cat /proc/uptime\n" \
147 "110716.72 17.67"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000148
Rob Landley8abbee42006-05-31 19:36:04 +0000149#define catv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000150 "[-etv] [FILE]..."
Rob Landley8abbee42006-05-31 19:36:04 +0000151#define catv_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000152 "Display nonprinting characters as ^x or M-x.\n\n"\
153 " -e End each line with $\n" \
154 " -t Show tabs as ^I\n" \
155 " -v Don't use ^x or M-x escapes."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000156#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000157 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000158#define chattr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000159 "change file attributes on an ext2 fs\n\n" \
160 "Modifiers:\n" \
161 " - remove attributes\n" \
162 " + add attributes\n" \
163 " = set attributes\n" \
164 "Attributes:\n" \
165 " A don't track atime\n" \
166 " a append mode only\n" \
167 " c enable compress\n" \
168 " D write dir contents synchronously\n" \
169 " d do not backup with dump\n" \
170 " i cannot be modified (immutable)\n" \
171 " j write all data to journal first\n" \
172 " s zero disk storage when deleted\n" \
173 " S write file contents synchronously\n" \
174 " t disable tail-merging of partial blocks with other files\n" \
175 " u allow file to be undeleted\n" \
176 "Options:\n" \
177 " -R recursively list subdirectories\n" \
178 " -v set the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000179
Eric Andersen7e9276b2001-02-22 01:15:47 +0000180#define chgrp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000181 "[-Rh"USE_DESKTOP("cvf")"]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000182#define chgrp_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000183 "Change the group membership of each FILE to GROUP.\n" \
184 "\nOptions:\n" \
185 " -R Changes files and directories recursively\n" \
186 " -h Do not dereference symbolic links" \
Denis Vlasenkoe80e2a32006-10-27 23:28:38 +0000187 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000188 "\n -c List changed files" \
189 "\n -v List all files" \
190 "\n -f Hide errors" \
Denis Vlasenkoe80e2a32006-10-27 23:28:38 +0000191 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000192#define chgrp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000193 "$ ls -l /tmp/foo\n" \
194 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
195 "$ chgrp root /tmp/foo\n" \
196 "$ ls -l /tmp/foo\n" \
197 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000198
Eric Andersen7e9276b2001-02-22 01:15:47 +0000199#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000200 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000201#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000202 "Each MODE is one or more of the letters ugoa, one of the\n" \
203 "symbols +-= and one or more of the letters rwxst.\n\n" \
204 "Options:\n" \
205 " -R Changes files and directories recursively" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000206 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000207 "\n -c List changed files" \
208 "\n -v List all files" \
209 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000210 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000211#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000212 "$ ls -l /tmp/foo\n" \
213 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
214 "$ chmod u+x /tmp/foo\n" \
215 "$ ls -l /tmp/foo\n" \
216 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
217 "$ chmod 444 /tmp/foo\n" \
218 "$ ls -l /tmp/foo\n" \
219 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000220
Eric Andersen7e9276b2001-02-22 01:15:47 +0000221#define chown_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000222 "[-Rh"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000223#define chown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000224 "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
225 "\nOptions:\n" \
226 " -R Changes files and directories recursively\n" \
227 " -h Do not dereference symbolic links" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000228 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000229 "\n -c List changed files" \
230 "\n -v List all files" \
231 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000232 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000233#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000234 "$ ls -l /tmp/foo\n" \
235 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
236 "$ chown root /tmp/foo\n" \
237 "$ ls -l /tmp/foo\n" \
238 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
239 "$ chown root.root /tmp/foo\n" \
240 "ls -l /tmp/foo\n" \
241 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000242
Denis Vlasenkofe544582006-10-03 15:57:40 +0000243#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000244 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
245 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
246 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000247#define chpst_full_usage \
248 "Change the process state and run specified program.\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000249 " -u user[:grp] set uid and gid\n" \
250 " -U user[:grp] set environment variables UID and GID\n" \
251 " -e dir set environment variables as specified by files\n" \
252 " in the directory: file=1st_line_of_file\n" \
253 " -/ dir chroot to dir\n" \
254 " -n inc add inc to nice value\n" \
255 " -m bytes limit data segment, stack segment, locked physical pages,\n" \
256 " and total of all segment per process to bytes bytes each\n" \
257 " -d bytes limit data segment\n" \
258 " -o n limit the number of open file descriptors per process to n\n" \
259 " -p n limit number of processes per uid to n\n" \
260 " -f bytes limit output file size to bytes bytes\n" \
261 " -c bytes limit core file size to bytes bytes\n" \
262 " -v verbose\n" \
263 " -P run prog in a new process group\n" \
264 " -0 close standard input\n" \
265 " -1 close standard output\n" \
266 " -2 close standard error"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000267#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000268 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000269#define setuidgid_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000270 "Sets uid and gid to account's uid and gid, removing all supplementary\n" \
271 "groups, then runs prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000272#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000273 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000274#define envuidgid_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000275 "Sets $UID to account's uid and $GID to account's gid, then runs prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000276#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000277 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000278#define envdir_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000279 "Sets various environment variables as specified by files\n" \
280 "in the directory dir, then runs prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000281#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000282 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
283 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
284 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000285#define softlimit_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000286 "Sets soft resource limits as specified by options, then runs prog\n" \
287 "\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000288 " -m n Same as -d n -s n -l n -a n\n" \
289 " -d n Limit the data segment per process to n bytes\n" \
290 " -s n Limit the stack segment per process to n bytes\n" \
291 " -l n Limit the locked physical pages per process to n bytes\n" \
292 " -a n Limit the total of all segments per process to n bytes\n" \
293 " -o n Limit the number of open file descriptors per process to n\n" \
294 " -p n Limit the number of processes per uid to n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000295 "Options controlling file sizes:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000296 " -f n Limit output file sizes to n bytes\n" \
297 " -c n Limit core file sizes to n bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000298 "Efficiency opts:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000299 " -r n Limit the resident set size to n bytes. This limit is not\n" \
300 " enforced unless physical memory is full\n" \
301 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
302 " except that the process receives a SIGXCPU signal after n seconds\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000303 "\n" \
304 "Some options may have no effect on some operating systems\n" \
305 "n may be =, indicating that soft limit should be set equal to hard limit"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000306
Eric Andersen7e9276b2001-02-22 01:15:47 +0000307#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000308 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000309#define chroot_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000310 "Run COMMAND with root directory set to NEWROOT."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000311#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000312 "$ ls -l /bin/ls\n" \
313 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
314 "# mount /dev/hdc1 /mnt -t minix\n" \
315 "# chroot /mnt\n" \
316 "# ls -l /bin/ls\n" \
317 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000318
Eric Andersen7e9276b2001-02-22 01:15:47 +0000319#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000320 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000321#define chvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000322 "Changes the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000323
Rob Landley856489b2006-04-18 20:57:28 +0000324#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000325 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000326#define cksum_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000327 "Calculates the CRC32 checksums of FILES."
Rob Landley856489b2006-04-18 20:57:28 +0000328
Eric Andersen7e9276b2001-02-22 01:15:47 +0000329#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000330 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000331#define clear_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000332 "Clear screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000333
Eric Andersen7e9276b2001-02-22 01:15:47 +0000334#define cmp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000335 "[-l] [-s] FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000336#define cmp_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000337 "Compares FILE1 vs stdin if FILE2 is not specified.\n\n" \
338 "Options:\n" \
339 " -l Write the byte numbers (decimal) and values (octal)\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000340 " for all differing bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000341 " -s quiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000342
Rob Landley2acfd7b2005-05-11 23:12:49 +0000343#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000344 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000345#define comm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000346 "Compares FILE1 to FILE2, or to stdin if = is specified.\n\n" \
347 "Options:\n" \
348 " -1 Suppress lines unique to FILE1\n" \
349 " -2 Suppress lines unique to FILE2\n" \
350 " -3 Suppress lines common to both files"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000351
Paul Fox79c142d2005-08-01 16:04:40 +0000352#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000353 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000354#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000355 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000356
Rob Landley69674942006-09-11 00:34:01 +0000357#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000358 "[FILE]...\n" \
359 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000360#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000361 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000362
Eric Andersen7e9276b2001-02-22 01:15:47 +0000363#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000364 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000365#define cp_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000366 "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \
367 "\n" \
368 " -a Same as -dpR\n" \
369 " -d,-P Preserve links\n" \
370 " -H,-L Dereference all symlinks (implied by default)\n" \
371 " -p Preserve file attributes if possible\n" \
372 " -f force, overwrite\n" \
373 " -i interactive, prompt before overwrite\n" \
374 " -R,-r Copy directories recursively\n" \
375 " -l,-s Create (sym)links"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000376
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000377#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000378 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000379#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000380 "Extract or list files from a cpio archive\n" \
381 "Main operation mode:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000382 " d make leading directories\n" \
383 " i extract\n" \
384 " m preserve mtime\n" \
385 " t list\n" \
386 " v verbose\n" \
387 " u unconditional overwrite\n" \
388 " F input from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000389
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000390#define crond_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000391 "-d[#] -c <crondir> -f -b"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000392#define crond_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000393 " -d [#] -l [#] -S -L logfile -f -b -c dir\n" \
394 " -d num debug level\n" \
395 " -l num log level (8 - default)\n" \
396 " -S log to syslogd (default)\n" \
397 " -L file log to file\n" \
398 " -f run in foreground\n" \
399 " -b run in background (default)\n" \
400 " -c dir working dir"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000401
402#define crontab_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000403 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000404#define crontab_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000405 " file <opts> replace crontab from file\n" \
406 " - <opts> replace crontab from stdin\n" \
407 " -u user specify user\n" \
408 " -l [user] list crontab for user\n" \
409 " -e [user] edit crontab for user\n" \
410 " -d [user] delete crontab for user\n" \
411 " -c dir specify crontab directory"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000412
413
Eric Andersen7e9276b2001-02-22 01:15:47 +0000414#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000415 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000416#define cut_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000417 "Prints selected fields from each input FILE to standard output.\n\n" \
418 "Options:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000419 " -b LIST Output only bytes from LIST\n" \
420 " -c LIST Output only characters from LIST\n" \
421 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
422 " -s Output only the lines containing delimiter\n" \
423 " -f N Print only these fields\n" \
424 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000425#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000426 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
427 "Hello\n" \
428 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
429 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000430
Eric Andersen7e9276b2001-02-22 01:15:47 +0000431#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000432 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000433#define date_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000434 "Displays the current time in the given FORMAT, or sets the system date.\n" \
435 "\nOptions:\n" \
436 " -R Outputs RFC-822 compliant date string\n" \
437 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000438 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000439 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
440 " TIMESPEC='date' (or missing) for date only,\n" \
441 " 'hours', 'minutes', or 'seconds' for date and,\n" \
442 " time to the indicated precision\n" \
443 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000444 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000445 " -s Sets time described by STRING\n" \
446 " -r FILE Displays the last modification time of FILE\n" \
447 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000448#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000449 "$ date\n" \
450 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000451
Eric Andersen7e9276b2001-02-22 01:15:47 +0000452#define dc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000453 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000454#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000455 "This is a Tiny RPN calculator that understands the\n" \
456 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
457 "**, exp, and, or, not, eor.\n" \
458 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \
459 "\nOptions:\n" \
460 "p - Prints the value on the top of the stack, without altering the stack\n" \
461 "f - Prints the entire contents of the stack without altering anything\n" \
462 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
463 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000464#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000465 "$ dc 2 2 + p\n" \
466 "4\n" \
467 "$ dc 8 8 \\* 2 2 + / p\n" \
468 "16\n" \
469 "$ dc 0 1 and p\n" \
470 "0\n" \
471 "$ dc 0 1 or p\n" \
472 "1\n" \
473 "$ echo 72 9 div 8 mul p | dc\n" \
474 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000475
Eric Andersen7e9276b2001-02-22 01:15:47 +0000476#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000477 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
478 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000479#define dd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000480 "Copy a file, converting and formatting according to options\n\n" \
481 " if=FILE read from FILE instead of stdin\n" \
482 " of=FILE write to FILE instead of stdout\n" \
483 " bs=N read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000484 USE_FEATURE_DD_IBS_OBS( \
485 " ibs=N read N bytes at a time\n") \
486 USE_FEATURE_DD_IBS_OBS( \
487 " obs=N write N bytes at a time\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000488 " count=N copy only N input blocks\n" \
489 " skip=N skip N input blocks\n" \
490 " seek=N skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000491 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000492 " conv=notrunc don't truncate output file\n" \
493 " conv=noerror continue after read errors\n" \
494 " conv=sync pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000495 "\n" \
496 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
497 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000498#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000499 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
500 "4+0 records in\n" \
501 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000502
Eric Andersen7e9276b2001-02-22 01:15:47 +0000503#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000504 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000505#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000506 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000507
Eric Andersenf349e972001-08-21 16:18:59 +0000508#define delgroup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000509 "GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000510#define delgroup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000511 "Deletes group GROUP from the system"
Eric Andersenf349e972001-08-21 16:18:59 +0000512
513#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000514 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000515#define deluser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000516 "Deletes user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000517
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000518#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000519 "mntpnt [-v]" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000520 USE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000521#define devfsd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000522 "Optional daemon for managing devfs permissions and old device name symlinks.\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000523 "\nOptions:" \
524 "\n mntpnt The mount point where devfs is mounted." \
525 "\n -v Print the protocol version numbers for devfsd." \
526 "\n and the kernel-side protocol version and exits." \
527 USE_DEVFSD_FG_NP( \
528 "\n -fg Run the daemon in the foreground." \
529 "\n -np Exit after parsing the configuration file" \
530 "\n and processing synthetic REGISTER events." \
531 "\n Do not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000532
Eric Andersen7e9276b2001-02-22 01:15:47 +0000533#define df_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000534 "[-" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000535#define df_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000536 "Print the filesystem space used and space available.\n\n" \
537 "Options:\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000538 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000539 "\n -h print sizes in human readable format (e.g., 1K 243M 2G )\n" \
540 " -m print sizes in megabytes\n" \
541 " -k print sizes in kilobytes(default)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000542 SKIP_FEATURE_HUMAN_READABLE( \
543 "\n -k ignored")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000544#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000545 "$ df\n" \
546 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
547 "/dev/sda3 8690864 8553540 137324 98% /\n" \
548 "/dev/sda1 64216 36364 27852 57% /boot\n" \
549 "$ df /dev/sda3\n" \
550 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
551 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000552
Denis Vlasenko736230e2006-11-20 19:40:36 +0000553#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000554 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000555#define dhcprelay_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000556 "Relays dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000557
558#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000559 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000560#define dhcprelay_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000561 "Relays dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000562
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000563#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000564 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000565#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000566 "Compare files line by line and output the differences between them.\n" \
567 "This diff implementation only supports unified diffs.\n\n" \
568 "Options:\n" \
569 " -a Treat all files as text\n" \
570 " -b Ignore changes in the amount of whitespace\n" \
571 " -d Try hard to find a smaller set of changes\n" \
572 " -i Ignore case differences\n" \
573 " -L Use LABEL instead of the filename in the unified header\n" \
574 " -N Treat absent files as empty\n" \
575 " -q Output only whether files differ\n" \
576 " -r Recursively compare any subdirectories\n" \
577 " -S Start with FILE when comparing directories\n" \
578 " -T Make tabs line up by prefixing a tab when necessary\n" \
579 " -s Report when two files are the same\n" \
580 " -t Expand tabs to spaces in output\n" \
581 " -U Output LINES lines of context\n" \
582 " -w Ignore all whitespace\n"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000583
Eric Andersen7e9276b2001-02-22 01:15:47 +0000584#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000585 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000586#define dirname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000587 "Strips non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000588#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000589 "$ dirname /tmp/foo\n" \
590 "/tmp\n" \
591 "$ dirname /tmp/foo/\n" \
592 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000593
Eric Andersen7e9276b2001-02-22 01:15:47 +0000594#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000595 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000596#define dmesg_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000597 "Prints or controls the kernel ring buffer\n\n" \
598 "Options:\n" \
599 " -c Clears the ring buffer's contents after printing\n" \
600 " -n LEVEL Sets console logging level\n" \
601 " -s SIZE Use a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000602
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000603#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000604 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000605#define dnsd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000606 "Small and static DNS server daemon\n\n" \
607 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000608 " -c config filename\n" \
609 " -t TTL in seconds\n" \
610 " -p listening port\n" \
611 " -i listening iface ip (default all)\n" \
612 " -d daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000613
Eric Andersen7e9276b2001-02-22 01:15:47 +0000614#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000615 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000616#define dos2unix_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000617 "Converts FILE from dos format to unix format. When no option\n" \
618 "is given, the input is converted to the opposite output format.\n" \
619 "When no file is given, uses stdin for input and stdout for output.\n\n" \
620 "Options:\n" \
621 " -u output will be in UNIX format\n" \
622 " -d output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000623
Eric Andersen7e9276b2001-02-22 01:15:47 +0000624#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000625 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000626#define dpkg_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000627 "dpkg is a utility to install, remove and manage Debian packages.\n\n" \
628 "Options:\n" \
629 " -i Install the package\n" \
630 " -l List of installed packages\n" \
631 " -C Configure an unpackaged package\n" \
632 " -F depends Ignore dependency problems\n" \
633 " -P Purge all files of a package\n" \
634 " -r Remove all but the configuration files for a package\n" \
635 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000636
Eric Andersen7e9276b2001-02-22 01:15:47 +0000637#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000638 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000639#define dpkg_deb_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000640 "Perform actions on Debian packages (.debs)\n\n" \
641 "Options:\n" \
642 " -c List contents of filesystem tree\n" \
643 " -e Extract control files to [argument] directory\n" \
644 " -f Display control field name starting with [argument]\n" \
645 " -x Extract packages filesystem tree to directory\n" \
646 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000647#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000648 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000649
Eric Andersen7e9276b2001-02-22 01:15:47 +0000650#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000651 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000652#define du_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000653 "Summarizes disk space used for each FILE and/or directory.\n" \
654 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000655 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
656 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000657 " bytes.\n\n" \
658 "Options:\n" \
659 " -a show sizes of files in addition to directories\n" \
660 " -H follow symbolic links that are FILE command line args\n" \
661 " -L follow all symbolic links encountered\n" \
662 " -d N limit output to directories (and files with -a) of depth < N\n" \
663 " -c output a grand total\n" \
664 " -l count sizes many times if hard linked\n" \
665 " -s display only a total for each argument\n" \
666 " -x skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000667 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000668 " -h print sizes in human readable format (e.g., 1K 243M 2G )\n" \
669 " -m print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000670 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000671 " -k print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000672 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000673#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000674 "$ du\n" \
675 "16 ./CVS\n" \
676 "12 ./kernel-patches/CVS\n" \
677 "80 ./kernel-patches\n" \
678 "12 ./tests/CVS\n" \
679 "36 ./tests\n" \
680 "12 ./scripts/CVS\n" \
681 "16 ./scripts\n" \
682 "12 ./docs/CVS\n" \
683 "104 ./docs\n" \
684 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000685
Eric Andersen7e9276b2001-02-22 01:15:47 +0000686#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000687 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000688#define dumpkmap_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000689 "Prints out a binary keyboard translation table to standard output."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000690#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000691 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000692
Russ Dill61fb4892002-10-14 21:41:28 +0000693#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000694 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000695#define dumpleases_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000696 "Displays the DHCP leases granted by udhcpd.\n\n" \
697 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000698 " -f, --file=FILENAME Leases file to load\n" \
699 " -r, --remaining Interpret lease times as time remaining\n" \
700 " -a, --absolute Interpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000701
Mike Frysinger51a43b42005-09-24 07:11:16 +0000702#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000703 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
704 "[-I inode_buffer_blocks] [-P process_inode_size] " \
705 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
706 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000707#define e2fsck_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000708 "Check a Linux ext2/ext3 file system.\n\n" \
709 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000710 " -p Automatic repair (no questions)\n" \
711 " -n Make no changes to the filesystem\n" \
712 " -y Assume 'yes' to all questions\n" \
713 " -c Check for bad blocks and add them to the badblock list\n" \
714 " -f Force checking even if filesystem is marked clean\n" \
715 " -v Be verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000716 " -b superblock Use alternative superblock\n" \
717 " -B blocksize Force blocksize when looking for superblock\n" \
718 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000719 " -l file Add to badblocks list\n" \
720 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000721
Eric Andersen7e9276b2001-02-22 01:15:47 +0000722#define echo_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000723 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000724#define echo_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000725 "Prints the specified ARGs to stdout\n\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000726 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000727 "Options:\n" \
728 " -n suppress trailing newline\n" \
729 " -e interpret backslash-escaped characters (i.e., \\t=tab)\n" \
730 " -E disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000731 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000732#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000733 "$ echo \"Erik is cool\"\n" \
734 "Erik is cool\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000735 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000736 "Erik\n" \
737 "is\n" \
738 "cool\n" \
739 "$ echo \"Erik\\nis\\ncool\"\n" \
740 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000741
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000742#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000743 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000744#define eject_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000745 "Eject specified DEVICE (or default /dev/cdrom).\n\n" \
746 "Options:\n" \
747 " -t close tray\n" \
748 " -T open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000749
Rob Landley3b890392006-05-04 20:56:43 +0000750#define ed_trivial_usage ""
751#define ed_full_usage ""
752
Eric Andersen84e229c2001-03-29 22:48:33 +0000753#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000754 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000755#define env_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000756 "Prints the current environment or runs a program after setting\n" \
757 "up the specified environment.\n\n" \
758 "Options:\n" \
759 " -, -i start with an empty environment\n" \
760 " -u remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000761
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000762#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000763 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000764#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000765 "Send a magic packet to wake up sleeping machines.\n" \
766 "MAC must be a station address (00:11:22:33:44:55) or\n" \
767 " a hostname with a known 'ethers' entry.\n\n" \
768 "Options:\n" \
769 " -b Send wake-up packet to the broadcast address\n" \
770 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000771 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000772
Eric Andersen7e9276b2001-02-22 01:15:47 +0000773#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000774 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000775#define expr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000776 "Prints the value of EXPRESSION to standard output.\n\n" \
777 "EXPRESSION may be:\n" \
778 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
779 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
780 " ARG1 < ARG2 ARG1 is less than ARG2\n" \
781 " ARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
782 " ARG1 = ARG2 ARG1 is equal to ARG2\n" \
783 " ARG1 != ARG2 ARG1 is unequal to ARG2\n" \
784 " ARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
785 " ARG1 > ARG2 ARG1 is greater than ARG2\n" \
786 " ARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
787 " ARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
788 " ARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
789 " ARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
790 " ARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000791 " STRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
792 " match STRING REGEXP same as STRING : REGEXP\n" \
793 " substr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
794 " index STRING CHARS index in STRING where any CHARS is found, or 0\n" \
795 " length STRING length of STRING\n" \
796 " quote TOKEN interpret TOKEN as a string, even if\n" \
797 " it is a keyword like 'match' or an\n" \
798 " operator like '/'\n" \
799 " (EXPRESSION) value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000800 "Beware that many operators need to be escaped or quoted for shells.\n" \
801 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
802 "lexicographical. Pattern matches return the string matched between\n" \
803 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
804 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000805
Mike Frysingerfa69f112005-04-17 07:24:19 +0000806#define fakeidentd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000807 "[-b ip] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000808#define fakeidentd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000809 "Returns a set string to auth requests\n\n" \
810 " -b Bind to ip address\n" \
811 " STRING The ident answer string (default is nobody)"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000812
Eric Andersen7e9276b2001-02-22 01:15:47 +0000813#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000814 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000815#define false_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000816 "Return an exit code of FALSE (1)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000817#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000818 "$ false\n" \
819 "$ echo $?\n" \
820 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000821
822#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000823 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000824#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000825 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000826#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000827 "$ fbset\n" \
828 "mode \"1024x768-76\"\n" \
829 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
830 " geometry 1024 768 1024 768 16\n" \
831 " timings 12714 128 32 16 4 128 4\n" \
832 " accel false\n" \
833 " rgba 5/11,6/5,5/0,0/0\n" \
834 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000835
Eric Andersen7e9276b2001-02-22 01:15:47 +0000836#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000837 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000838#define fdflush_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000839 "Forces floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000840
Eric Andersen01c3d402003-07-05 07:51:31 +0000841#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000842 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +0000843#define fdformat_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000844 "Low-level formats a floppy disk\n\n" \
845 "Options:\n" \
846 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +0000847
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000848#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000849 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000850#define fdisk_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000851 "Change partition table\n" \
852 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000853 " -l List partition table(s)\n" \
854 " -u Give Start and End in sector (instead of cylinder) units\n" \
855 " -s PARTITION Give partition size(s) in blocks\n" \
856 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
857 " -C CYLINDERS Set the number of cylinders\n" \
858 " -H HEADS Set the number of heads\n" \
859 " -S SECTORS Set the number of sectors\n" \
860 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000861
Eric Andersen7e9276b2001-02-22 01:15:47 +0000862#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000863 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000864#define find_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000865 "Search for files in a directory hierarchy. The default PATH is\n" \
866 "the current directory; default EXPRESSION is '-print'\n" \
867 "\nEXPRESSION may consist of:\n" \
868 " -follow Dereference symbolic links\n" \
869 " -name PATTERN File name (leading directories removed) matches PATTERN\n" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000870 " -print Print (default and assumed)" \
Paul Foxd7384292006-05-12 14:47:20 +0000871 USE_FEATURE_FIND_PRINT0( \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000872 "\n -print0 Delimit output with null characters rather than" \
873 "\n newlines" \
874 ) USE_FEATURE_FIND_TYPE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000875 "\n -type X Filetype matches X (where X is one of: f,d,l,b,c,...)" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000876 ) USE_FEATURE_FIND_PERM( \
877 "\n -perm PERMS Permissions match any of (+NNN); all of (-NNN);" \
878 "\n or exactly (NNN)" \
879 ) USE_FEATURE_FIND_MTIME( \
880 "\n -mtime DAYS Modified time is greater than (+N); less than (-N);" \
881 "\n or exactly (N) days" \
882 ) USE_FEATURE_FIND_MMIN( \
883 "\n -mmin MINS Modified time is greater than (+N); less than (-N);" \
884 "\n or exactly (N) minutes" \
885 ) USE_FEATURE_FIND_NEWER( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000886 "\n -newer FILE Modified time is more recent than FILE's" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000887 ) USE_FEATURE_FIND_INUM( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000888 "\n -inum N File has inode number N" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000889 ) USE_FEATURE_FIND_EXEC( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000890 "\n -exec CMD Execute CMD with all instances of {} replaced by the" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000891 "\n files matching EXPRESSION" \
892 ) USE_DESKTOP( \
893 "\n -size N File size is N" \
894 "\n -prune Stop traversing current subtree" \
895 "\n (expr) Group" \
896 )
Rob Landley5d3a0e82005-10-04 03:34:39 +0000897
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000898#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000899 "$ find / -name passwd\n" \
900 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000901
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000902#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000903 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000904#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000905 "Wrap input lines in each FILE (standard input by default), writing to\n" \
906 "standard output.\n\n" \
907 "Options:\n" \
908 " -b count bytes rather than columns\n" \
909 " -s break at spaces\n" \
910 " -w use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000911
Eric Andersen7e9276b2001-02-22 01:15:47 +0000912#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000913 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000914#define free_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000915 "Displays the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000916#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000917 "$ free\n" \
918 " total used free shared buffers\n" \
919 " Mem: 257628 248724 8904 59644 93124\n" \
920 " Swap: 128516 8404 120112\n" \
921 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000922
Eric Andersen7e9276b2001-02-22 01:15:47 +0000923#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000924 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000925#define freeramdisk_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000926 "Frees all memory used by the specified ramdisk."
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000927#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000928 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000929
Mike Frysinger51a43b42005-09-24 07:11:16 +0000930#define fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000931 "[-ANPRTV] [ -C [ fd ] ] [-t fstype] [fs-options] [filesys ...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000932#define fsck_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000933 "Check and repair filesystems.\n\n" \
934 "Options:\n" \
935 " -A Walk /etc/fstab and check all filesystems\n" \
936 " -N Don't execute, just show what would be done\n" \
937 " -P When using -A, check filesystems in parallel\n" \
938 " -R When using -A, skip the root filesystem\n" \
939 " -T Don't show title on startup\n" \
940 " -V Verbose mode\n" \
941 " -C Write status information to specified filedescriptor\n" \
942 " -t List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000943
Eric Andersen7e9276b2001-02-22 01:15:47 +0000944#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000945 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000946#define fsck_minix_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000947 "Performs a consistency check for MINIX filesystems.\n\n" \
948 "Options:\n" \
949 " -l Lists all filenames\n" \
950 " -r Perform interactive repairs\n" \
951 " -a Perform automatic repairs\n" \
952 " -v verbose\n" \
953 " -s Outputs super-block information\n" \
954 " -m Activates MINIX-like \"mode not cleared\" warnings\n" \
955 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000956
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000957#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000958 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000959#define ftpget_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000960 "Retrieve a remote file via FTP.\n\n" \
961 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000962 " -c, --continue Continue a previous transfer\n" \
963 " -v, --verbose Verbose\n" \
964 " -u, --username Username to be used\n" \
965 " -p, --password Password to be used\n" \
966 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000967
968#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000969 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000970#define ftpput_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000971 "Store a local file on a remote machine via FTP.\n\n" \
972 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000973 " -v, --verbose Verbose\n" \
974 " -u, --username Username to be used\n" \
975 " -p, --password Password to be used\n" \
976 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000977
Rob Landleyaa872762005-10-28 13:05:12 +0000978#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000979 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +0000980#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000981 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000982 " -m Show all processes on the same mounted fs\n" \
983 " -k Kill all processes that match.\n" \
984 " -s Don't print or kill anything.\n" \
985 " -4 When using port/proto only search IPv4 space\n" \
986 " -6 When using port/proto only search IPv6 space\n" \
987 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +0000988
Eric Andersen7e9276b2001-02-22 01:15:47 +0000989#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000990 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000991#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000992 "Parse command options\n" \
993 " -a, --alternative Allow long options starting with single -\n" \
994 " -l, --longoptions=longopts Long options to be recognized\n" \
995 " -n, --name=progname The name under which errors are reported\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000996 " -o, --options=optstring Short options to be recognized\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000997 " -q, --quiet Disable error reporting by getopt(3)\n" \
998 " -Q, --quiet-output No normal output\n" \
999 " -s, --shell=shell Set shell quoting conventions\n" \
1000 " -T, --test Test for getopt(1) version\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001001 " -u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001002#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001003 "$ cat getopt.test\n" \
1004 "#!/bin/sh\n" \
1005 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1006 " -n 'example.busybox' -- \"$@\"`\n" \
1007 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
1008 "eval set -- \"$GETOPT\"\n" \
1009 "while true ; do\n" \
1010 " case $1 in\n" \
1011 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
1012 " -b|--b-long) echo \"Option b, argument '$2'\" ; shift 2 ;;\n" \
1013 " -c|--c-long)\n" \
1014 " case \"$2\" in\n" \
1015 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
1016 " *) echo \"Option c, argument '$2'\" ; shift 2 ;;\n" \
1017 " esac ;;\n" \
1018 " --) shift ; break ;;\n" \
1019 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
1020 " esac\n" \
1021 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001022
Eric Andersenf349e972001-08-21 16:18:59 +00001023#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001024 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001025#define getty_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001026 "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \
1027 "Options:\n" \
1028 " -h Enable hardware (RTS/CTS) flow control\n" \
1029 " -i Do not display /etc/issue before running login\n" \
1030 " -L Local line, so do not do carrier detect\n" \
1031 " -m Get baud rate from modem's CONNECT status message\n" \
1032 " -w Wait for a CR or LF before sending /etc/issue\n" \
1033 " -n Do not prompt the user for a login name\n" \
1034 " -f issue_file Display issue_file instead of /etc/issue\n" \
1035 " -l login_app Invoke login_app instead of /bin/login\n" \
1036 " -t timeout Terminate after timeout if no username is read\n" \
1037 " -I initstring Sets the init string to send before anything else\n" \
1038 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001039
Eric Andersen7e9276b2001-02-22 01:15:47 +00001040#define grep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001041 "[-rihHnqvso" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001042 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1043 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001044 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001045#define grep_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001046 "Search for PATTERN in each FILE or standard input.\n\n" \
1047 "Options:\n" \
1048 " -H prefix output lines with filename where match was found\n" \
1049 " -h suppress the prefixing filename on output\n" \
1050 " -r recurse subdirectories\n" \
1051 " -i ignore case distinctions\n" \
1052 " -l list names of files that match\n" \
1053 " -L list names of files that do not match\n" \
1054 " -n print line number with output lines\n" \
1055 " -q be quiet. Returns 0 if PATTERN was found, 1 otherwise\n" \
1056 " -v select non-matching lines\n" \
1057 " -s suppress file open/read error messages\n" \
1058 " -c only print count of matching lines\n" \
1059 " -f read PATTERN from file\n" \
1060 " -o show only the part of a line that matches PATTERN\n" \
1061 " -e PATTERN is a regular expression\n" \
1062 " -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001063 USE_FEATURE_GREP_EGREP_ALIAS( \
1064 "\n -E PATTERN is an extended regular expression") \
1065 USE_FEATURE_GREP_CONTEXT( \
1066 "\n -A print NUM lines of trailing context") \
1067 USE_FEATURE_GREP_CONTEXT( \
1068 "\n -B print NUM lines of leading context") \
1069 USE_FEATURE_GREP_CONTEXT( \
1070 "\n -C print NUM lines of output context")
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001071
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001072#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001073 "$ grep root /etc/passwd\n" \
1074 "root:x:0:0:root:/root:/bin/bash\n" \
1075 "$ grep ^[rR]oo. /etc/passwd\n" \
1076 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001077
Eric Andersen7e9276b2001-02-22 01:15:47 +00001078#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001079 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001080#define gunzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001081 "Uncompress FILE (or standard input if FILE is '-').\n\n" \
1082 "Options:\n" \
1083 " -c Write output to standard output\n" \
1084 " -f Force read when source is a terminal\n" \
1085 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001086#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001087 "$ ls -la /tmp/BusyBox*\n" \
1088 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1089 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1090 "$ ls -la /tmp/BusyBox*\n" \
1091 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001092
1093#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001094 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001095#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001096 "Compress FILE(s) with maximum compression.\n" \
1097 "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \
1098 "Options:\n" \
1099 " -c Write output to standard output instead of FILE.gz\n" \
1100 " -d Decompress\n" \
1101 " -f Force write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001102#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001103 "$ ls -la /tmp/busybox*\n" \
1104 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1105 "$ gzip /tmp/busybox.tar\n" \
1106 "$ ls -la /tmp/busybox*\n" \
1107 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001108
1109#define halt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001110 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001111#define halt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001112 "Halt the system.\n" \
1113 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001114 " -d delay interval for halting\n" \
1115 " -n no call to sync()\n" \
1116 " -f force halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001117
Eric Andersen3443bd72003-07-22 07:30:36 +00001118#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001119 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001120#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001121 USE_FEATURE_HDPARM_GET_IDENTITY( \
1122 " If no device name is specified try to read from stdin.\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001123 "\nOptions:\n" \
1124 " -a get/set fs readahead\n" \
1125 " -A set drive read-lookahead flag (0/1)\n" \
1126 " -b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1127 " -B set Advanced Power Management setting (1-255)\n" \
1128 " -c get/set IDE 32-bit IO setting\n" \
1129 " -C check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001130 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
1131 " -d get/set using_dma flag\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001132 " -D enable/disable drive defect-mgmt\n" \
1133 " -f flush buffer cache for device on exit\n" \
1134 " -g display drive geometry\n" \
1135 " -h display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001136 USE_FEATURE_HDPARM_GET_IDENTITY( \
1137 " -i display drive identification\n") \
1138 USE_FEATURE_HDPARM_GET_IDENTITY( \
1139 " -I detailed/current information directly from drive\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001140 " -k get/set keep_settings_over_reset flag (0/1)\n" \
1141 " -K set drive keep_features_over_reset flag (0/1)\n" \
1142 " -L set drive doorlock (0/1) (removable harddisks only)\n" \
1143 " -m get/set multiple sector count\n" \
1144 " -n get/set ignore-write-errors flag (0/1)\n" \
1145 " -p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1146 " -P set drive prefetch count\n" \
1147 " -q change next setting quietly\n" \
1148 " -Q get/set DMA tagged-queuing depth (if supported)\n" \
1149 " -r get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001150 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
1151 " -R register an IDE interface (DANGEROUS)\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001152 " -S set standby (spindown) timeout\n" \
1153 " -t perform device read timings\n" \
1154 " -T perform cache read timings\n" \
1155 " -u get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001156 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
1157 " -U un-register an IDE interface (DANGEROUS)\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001158 " -v defaults; same as -mcudkrag for IDE drives\n" \
1159 " -V display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001160 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
1161 " -w perform device reset (DANGEROUS)\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001162 " -W set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001163 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
1164 " -x tristate device for hotswap (0/1) (DANGEROUS)\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001165 " -X set IDE xfer mode (DANGEROUS)\n" \
1166 " -y put IDE drive in standby mode\n" \
1167 " -Y put IDE drive to sleep\n" \
1168 " -Z disable Seagate auto-powersaving mode\n" \
1169 " -z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001170
Eric Andersen7e9276b2001-02-22 01:15:47 +00001171#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001172 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001173#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001174 "Print first 10 lines of each FILE to standard output.\n" \
1175 "With more than one FILE, precede each with a header giving the\n" \
1176 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001177 "Options:" \
1178 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001179 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001180 "\n -c NUM output the first NUM bytes" \
1181 "\n -q never output headers giving file names" \
1182 "\n -v always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001183#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001184 "$ head -n 2 /etc/passwd\n" \
1185 "root:x:0:0:root:/root:/bin/bash\n" \
1186 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001187
Glenn L McGrath60281112001-11-02 11:39:46 +00001188#define hexdump_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001189 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001190#define hexdump_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001191 "The hexdump utility is a filter which displays the specified files,\n" \
1192 "or the standard input, if no files are specified, in a user specified\n" \
1193 "format\n" \
1194 " -b One-byte octal display\n" \
1195 " -c One-byte character display\n" \
1196 " -C Canonical hex+ASCII, 16 bytes per line\n" \
1197 " -d Two-byte decimal display\n" \
1198 " -e FORMAT STRING\n" \
1199 " -f FORMAT FILE\n" \
1200 " -n LENGTH Interpret only length bytes of input\n" \
1201 " -o Two-byte octal display\n" \
1202 " -s OFFSET Skip offset byte\n" \
1203 " -v display all input data\n" \
1204 " -x Two-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001205
Eric Andersen7e9276b2001-02-22 01:15:47 +00001206#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001207 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001208#define hostid_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001209 "Print out a unique 32-bit identifier for the machine."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001210
1211#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001212 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001213#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001214 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
1215 "(or FILE with the -F parameter), the host name will be set.\n\n" \
1216 "Options:\n" \
1217 " -s Short\n" \
1218 " -i Addresses for the hostname\n" \
1219 " -d DNS domain name\n" \
1220 " -f Fully qualified domain name\n" \
1221 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001222#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001223 "$ hostname\n" \
1224 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001225
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001226#define httpd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001227 "[-c <conf file>]" \
1228 " [-p <port>]" \
1229 " [-i] [-f]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001230 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001231 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1232 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001233 " [-h home]" \
1234 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001235#define httpd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001236 "Listens for incoming http server requests.\n\n" \
1237 "Options:\n" \
1238 " -c FILE Specifies configuration file. (default httpd.conf)\n" \
1239 " -p PORT Server port (default 80)\n" \
1240 " -i Assume that we are started from inetd\n" \
1241 " -f Do not daemonize\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001242 USE_FEATURE_HTTPD_SETUID( \
1243 " -u USER[:GRP] Set uid/gid after binding to port\n") \
1244 USE_FEATURE_HTTPD_BASIC_AUTH( \
1245 " -r REALM Authentication Realm for Basic Authentication\n") \
1246 USE_FEATURE_HTTPD_AUTH_MD5( \
1247 " -m PASS Crypt PASS with md5 algorithm\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001248 " -h HOME Specifies http HOME directory (default ./)\n" \
1249 " -e STRING HTML encode STRING\n" \
1250 " -d STRING URL decode STRING"
Eric Andersen40520512003-07-28 09:59:05 +00001251
Robert Griebl1cd04452002-07-21 16:50:49 +00001252#define hwclock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001253 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
Robert Griebl1cd04452002-07-21 16:50:49 +00001254#define hwclock_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001255 "Query and set the hardware clock (RTC)\n\n" \
1256 "Options:\n" \
1257 " -r read hardware clock and print result\n" \
1258 " -s set the system time from the hardware clock\n" \
1259 " -w set the hardware clock to the current system time\n" \
1260 " -u the hardware clock is kept in coordinated universal time\n" \
1261 " -l the hardware clock is kept in local time"
Robert Griebl1cd04452002-07-21 16:50:49 +00001262
Eric Andersen7e9276b2001-02-22 01:15:47 +00001263#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001264 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001265#define id_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001266 "Print information for USERNAME or the current user\n\n" \
1267 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001268 USE_SELINUX( \
1269 " -c prints only the security context\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001270 " -g prints only the group ID\n" \
1271 " -u prints only the user ID\n" \
1272 " -n print a name instead of a number\n" \
1273 " -r prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001274#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001275 "$ id\n" \
1276 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001277
Eric Andersen7e9276b2001-02-22 01:15:47 +00001278#define ifconfig_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001279 USE_FEATURE_IFCONFIG_STATUS("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001280#define ifconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001281 "configure a network interface\n\n" \
1282 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001283 USE_FEATURE_IPV6( \
1284 " [add <address>[/<prefixlen>]]\n") \
1285 USE_FEATURE_IPV6( \
1286 " [del <address>[/<prefixlen>]]\n") \
1287 " [[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
1288 " [netmask <address>] [dstaddr <address>]\n" \
1289 USE_FEATURE_IFCONFIG_SLIP( \
1290 " [outfill <NN>] [keepalive <NN>]\n") \
1291 " " USE_FEATURE_IFCONFIG_HW("[hw ether <address>] ") "[metric <NN>] [mtu <NN>]\n" \
1292 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
1293 " [multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1294 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
1295 " [mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001296 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001297
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001298#define ifup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001299 "<-ahinv> <ifaces...>"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001300#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001301 "ifup <options> <ifaces...>\n\n" \
1302 "Options:\n" \
1303 " -h this help\n" \
1304 " -a de/configure all interfaces automatically\n" \
1305 " -i FILE use FILE for interface definitions\n" \
1306 " -n print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001307 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001308 " -v print out what would happen before doing it\n" \
1309 " -m don't run any mappings\n" \
1310 " -f force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001311
1312#define ifdown_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001313 "<-ahinv> <ifaces...>"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001314#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001315 "ifdown <options> <ifaces...>\n\n" \
1316 "Options:\n" \
1317 " -h this help\n" \
1318 " -a de/configure all interfaces automatically\n" \
1319 " -i FILE use FILE for interface definitions\n" \
1320 " -n print out what would happen, but don't do it\n" \
1321 " (note that this option doesn't disable mappings)\n" \
1322 " -v print out what would happen before doing it\n" \
1323 " -m don't run any mappings\n" \
1324 " -f force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001325
Glenn L McGrath06e95652003-02-09 06:51:14 +00001326#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001327 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001328#define inetd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001329 "Listens for network connections and launches programs\n\n" \
1330 "Option:\n" \
1331 " -f Run as a foreground progress\n" \
1332 " -q Sets the size of the socket listen queue to\n" \
1333 " the specified value. Default is 128"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001334
Eric Andersen7e9276b2001-02-22 01:15:47 +00001335#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001336 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001337#define init_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001338 "Init is the parent of all processes."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001339#define init_notes_usage \
1340"This version of init is designed to be run only by the kernel.\n" \
1341"\n" \
1342"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001343"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001344"runlevels, use sysvinit.\n" \
1345"\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001346"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001347"it has the following default behavior:\n" \
1348"\n" \
1349" ::sysinit:/etc/init.d/rcS\n" \
1350" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001351" ::ctrlaltdel:/sbin/reboot\n" \
1352" ::shutdown:/sbin/swapoff -a\n" \
1353" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001354" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001355"\n" \
1356"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1357"\n" \
1358" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001359" tty3::askfirst:/bin/sh\n" \
1360" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001361"\n" \
1362"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1363"\n" \
1364" <id>:<runlevels>:<action>:<process>\n" \
1365"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001366" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001367"\n" \
1368" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1369" The id field is used by BusyBox init to specify the controlling tty for\n" \
1370" the specified process to run on. The contents of this field are\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001371" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001372" be unique, although if it isn't you may have strange results. If this\n" \
1373" field is left blank, the controlling tty is set to the console. Also\n" \
1374" note that if BusyBox detects that a serial console is in use, then only\n" \
1375" entries whose controlling tty is either the serial console or /dev/null\n" \
1376" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1377" stinkin' utmp.\n" \
1378"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001379" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001380"\n" \
1381" The runlevels field is completely ignored.\n" \
1382"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001383" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001384"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001385" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001386" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001387"\n" \
1388" The available actions can be classified into two groups: actions\n" \
1389" that are run only once, and actions that are re-run when the specified\n" \
1390" process exits.\n" \
1391"\n" \
1392" Run only-once actions:\n" \
1393"\n" \
1394" 'sysinit' is the first item run on boot. init waits until all\n" \
1395" sysinit actions are completed before continuing. Following the\n" \
1396" completion of all sysinit actions, all 'wait' actions are run.\n" \
1397" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001398" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001399" therefore, init does not wait for them to complete. 'restart' is\n" \
1400" the action taken to restart the init process. By default this should\n" \
1401" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1402" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001403" actions are run when the system detects that someone on the system\n" \
1404" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1405" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1406" Finally the 'shutdown' action specifies the actions to taken when\n" \
1407" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1408" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001409"\n" \
1410" Run repeatedly actions:\n" \
1411"\n" \
1412" 'respawn' actions are run after the 'once' actions. When a process\n" \
1413" started with a 'respawn' action exits, init automatically restarts\n" \
1414" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1415" respawning out of control. The 'askfirst' actions acts just like\n" \
1416" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001417" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001418" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001419" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001420"\n" \
1421" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1422" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001423" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001424"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001425" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001426"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001427" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001428"\n" \
1429"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001430"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001431" # This is run first except when booting in single-user mode.\n" \
1432" #\n" \
1433" ::sysinit:/etc/init.d/rcS\n" \
1434" \n" \
1435" # /bin/sh invocations on selected ttys\n" \
1436" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001437" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001438" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001439" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001440" tty2::askfirst:-/bin/sh\n" \
1441" tty3::askfirst:-/bin/sh\n" \
1442" tty4::askfirst:-/bin/sh\n" \
1443" \n" \
1444" # /sbin/getty invocations for selected ttys\n" \
1445" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001446" tty4::respawn:/sbin/getty 38400 tty4\n" \
1447" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001448" \n" \
1449" \n" \
1450" # Example of how to put a getty on a serial line (for a terminal)\n" \
1451" #\n" \
1452" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1453" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1454" #\n" \
1455" # Example how to put a getty on a modem line.\n" \
1456" #::respawn:/sbin/getty 57600 ttyS2\n" \
1457" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001458" # Stuff to do when restarting the init process\n" \
1459" ::restart:/sbin/init\n" \
1460" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001461" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001462" ::ctrlaltdel:/sbin/reboot\n" \
1463" ::shutdown:/bin/umount -a -r\n" \
1464" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001465
1466#define insmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001467 "[OPTION]... MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001468#define insmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001469 "Loads the specified kernel modules into the kernel.\n\n" \
1470 "Options:\n" \
1471 " -f Force module to load into the wrong kernel version\n" \
1472 " -k Make module autoclean-able\n" \
1473 " -v verbose output\n" \
1474 " -q quiet output\n" \
1475 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001476 USE_FEATURE_INSMOD_LOAD_MAP( \
1477 " -m Output load map to stdout\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001478 " -o NAME Set internal module name to NAME\n" \
1479 " -x do not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001480
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001481#define install_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001482 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001483#define install_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001484 "Copies files and set attributes\n\n" \
1485 "Options:\n" \
1486 " -c copy the file, default\n" \
1487 " -d create directories\n" \
1488 " -g set group ownership\n" \
1489 " -m set permission modes\n" \
1490 " -o set ownership\n" \
1491 " -p preserve date\n" \
1492 " -s strip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001493
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001494#define ip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001495 "[OPTIONS] {address | link | route | tunnel | rule} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001496#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001497 "ip [OPTIONS] OBJECT {COMMAND}\n" \
1498 "where OBJECT := {link | addr | route | tunnel |rule}\n" \
1499 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001500
1501#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001502 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1503 " [ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001504#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001505 "ipaddr {add|delete} IFADDR dev STRING\n" \
1506 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001507 " [ to PREFIX ] [ label PATTERN ]\n" \
1508 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
1509 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1510 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1511 " SCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001512
Eric Andersende4f07e2003-12-11 01:18:07 +00001513#define ipcalc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001514 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001515#define ipcalc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001516 "Calculate IP network settings from a IP address\n\n" \
1517 "Options:\n" \
1518 " -b --broadcast Display calculated broadcast address\n" \
1519 " -n --network Display calculated network address\n" \
1520 " -m --netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001521 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001522 "\n -p --prefix Display the prefix for IP/NETMASK\n" \
1523 " -h --hostname Display first resolved host name\n" \
1524 " -s --silent Don't ever display error messages")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001525
Rob Landley6eb1e412005-06-20 04:30:36 +00001526#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001527 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001528#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001529 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1530 "segment by a shmkey value. The lower-case options mqs are used\n" \
1531 "to remove a segment by shmid value.\n" \
1532 " -[mM] Remove the memory segment after the last detach\n" \
1533 " -[qQ] Remove the message queue\n" \
1534 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001535
1536#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001537 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001538#define ipcs_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001539 " -i specify a specific resource id\n" \
1540 "Resource specification:\n" \
1541 " -m shared memory segments\n" \
1542 " -q message queues\n" \
1543 " -s semaphore arrays\n" \
1544 " -a all (default)\n" \
1545 "Output format:\n" \
1546 " -t time\n" \
1547 " -c creator\n" \
1548 " -p pid\n" \
1549 " -l limits\n" \
1550 " -u summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001551
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001552#define iplink_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001553 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001554#define iplink_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001555 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1556 " dynamic { on | off } |\n" \
1557 " mtu MTU }\n" \
1558 " iplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001559
1560#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001561 "{ list | flush | { add | del | change | append |\n" \
1562 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001563#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001564 "iproute { list | flush } SELECTOR\n" \
1565 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1566 " [ oif STRING ] [ tos TOS ]\n" \
1567 " iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1568 " SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1569 " ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001570
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001571#define iprule_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001572 "{[ list | add | del ] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001573#define iprule_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001574 "iprule [ list | add | del ] SELECTOR ACTION\n" \
1575 " SELECTOR := [ from PREFIX ] [ to PREFIX ] [ tos TOS ] [ fwmark FWMARK ]\n" \
1576 " [ dev STRING ] [ pref NUMBER ]\n" \
1577 " ACTION := [ table TABLE_ID ] [ nat ADDRESS ]\n" \
1578 " [ prohibit | reject | unreachable ]\n" \
1579 " [ realms [SRCREALM/]DSTREALM ]\n" \
1580 " TABLE_ID := [ local | main | default | NUMBER ]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001581
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001582#define iptunnel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001583 "{ add | change | del | show } [ NAME ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001584 " [ mode { ipip | gre | sit } ]\n" \
1585 " [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001586#define iptunnel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001587 "iptunnel { add | change | del | show } [ NAME ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001588 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1589 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1590 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001591
Eric Andersen7e9276b2001-02-22 01:15:47 +00001592#define kill_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001593 "[-l] [-signal] process-id [process-id ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001594#define kill_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001595 "Send a signal (default is TERM) to the specified process(es).\n\n" \
1596 "Options:\n" \
1597 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001598#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001599 "$ ps | grep apache\n" \
1600 "252 root root S [apache]\n" \
1601 "263 www-data www-data S [apache]\n" \
1602 "264 www-data www-data S [apache]\n" \
1603 "265 www-data www-data S [apache]\n" \
1604 "266 www-data www-data S [apache]\n" \
1605 "267 www-data www-data S [apache]\n" \
1606 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001607
1608#define killall_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001609 "[-l] [-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001610#define killall_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001611 "Send a signal (default is TERM) to the specified process(es).\n\n" \
1612 "Options:\n" \
1613 " -l List all signal names and numbers\n" \
1614 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001615#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001616 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001617
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001618#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001619 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001620#define killall5_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001621 "Send a signal (default is TERM) to all processes outside current session.\n\n" \
1622 "Options:\n" \
1623 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001624
Mark Whitley6317c4b2001-03-12 22:51:50 +00001625#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001626 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001627#define klogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001628 "Kernel logger.\n" \
1629 "Options:\n" \
1630 " -c n Sets the default log level of console messages to n\n" \
1631 " -n Run as a foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001632
Eric Andersen7e9276b2001-02-22 01:15:47 +00001633#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001634 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001635#define length_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001636 "Prints out the length of the specified STRING."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001637#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001638 "$ length Hello\n" \
1639 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001640
Rob Landley9200e792005-09-15 19:26:59 +00001641#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001642 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001643#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001644 "View a file or list of files. The position within files can be\n" \
1645 "changed, and files can be manipulated in various ways with the\n" \
1646 "following options:\n\n" \
1647 " -E Quit once the end of a file is reached\n" \
1648 " -M Display a status line containing the current line numbers\n" \
1649 " and the percentage through the file\n" \
1650 " -N Prefix line numbers to each line\n" \
1651 " -m Display a status line containing the percentage through the\n" \
1652 " file\n" \
1653 " -~ Suppress ~s displayed when input past the end of the file is\n" \
1654 " reached.\n" \
1655 " -h, -? Display this help message"
Rob Landley9200e792005-09-15 19:26:59 +00001656
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001657#define setarch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001658 "<personality> <program> [args ...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001659#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001660 "Personality may be:\n" \
1661 " linux32 Set 32bit uname emulation\n" \
1662 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001663
Eric Andersen7e9276b2001-02-22 01:15:47 +00001664#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001665 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001666#define ln_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001667 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n" \
1668 "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \
1669 "Options:\n" \
1670 " -s make symbolic links instead of hard links\n" \
1671 " -f remove existing destination files\n" \
1672 " -n no dereference symlinks - treat like normal file\n" \
1673 " -b make a backup of the target (if exists) before link operation\n" \
1674 " -S suffix use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001675#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001676 "$ ln -s BusyBox /tmp/ls\n" \
1677 "$ ls -l /tmp/ls\n" \
1678 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001679
Eric Andersen7e9276b2001-02-22 01:15:47 +00001680#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001681 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001682#define loadfont_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001683 "Loads a console font from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001684#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001685 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001686
1687#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001688 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001689#define loadkmap_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001690 "Loads a binary keyboard translation table from standard input."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001691#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001692 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001693
1694#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001695 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001696#define logger_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001697 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1698 "Options:\n" \
1699 " -s Log to stderr as well as the system log\n" \
1700 " -t TAG Log using the specified tag (defaults to user name)\n" \
1701 " -p PRIORITY Enter the message with the specified priority\n" \
1702 " This may be numerical or a 'facility.level' pair"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001703#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001704 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001705
Robert Griebl1fca5582002-06-04 20:45:46 +00001706#define login_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001707 "[OPTION]... [username] [ENV=VAR ...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00001708#define login_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001709 "Begin a new session on the system\n\n" \
1710 "Options:\n" \
1711 " -f Do not authenticate (user already authenticated)\n" \
1712 " -h Name of the remote host for this login\n" \
1713 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001714
Eric Andersen7e9276b2001-02-22 01:15:47 +00001715#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001716 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001717#define logname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001718 "Print the name of the current user."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001719#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001720 "$ logname\n" \
1721 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001722
Mark Whitley6317c4b2001-03-12 22:51:50 +00001723#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001724 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001725#define logread_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001726 "Shows the messages from syslogd (using circular buffer).\n\n" \
1727 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001728 " -f output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001729
Matt Kraai83788da2002-03-20 17:38:37 +00001730#define losetup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001731 "[-o OFFSET] [-d] LOOPDEVICE [FILE]]"
Matt Kraai83788da2002-03-20 17:38:37 +00001732#define losetup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001733 "(Dis)associate LOOPDEVICE with FILE, or display current associations.\n\n" \
1734 "Options:\n" \
1735 " -d Disassociate LOOPDEVICE\n" \
1736 " -o OFFSET Start OFFSET bytes into FILE"
Rob Landley1d589b22005-11-29 23:47:10 +00001737#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001738 "No arguments will display all current associations.\n" \
1739 "One argument (losetup /dev/loop1) will display the current association\n" \
1740 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1741 "and filename of the file the loop device is currently bound to.\n\n" \
1742 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1743 "with an optional offset (-o 12345). Encryption is not yet supported.\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001744
Eric Andersen7e9276b2001-02-22 01:15:47 +00001745#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001746 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001747 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
1748 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
1749 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
1750 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
1751 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
1752 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
1753 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001754#define ls_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001755 "List directory contents\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001756 "Options:" \
1757 "\n -1 list files in a single column" \
1758 "\n -A do not list implied . and .." \
1759 "\n -a do not hide entries starting with ." \
1760 "\n -C list entries by columns" \
1761 USE_FEATURE_LS_TIMESTAMPS( \
1762 "\n -c with -l: show ctime") \
1763 USE_FEATURE_LS_COLOR( \
1764 "\n --color[={always,never,auto}] control coloring") \
1765 "\n -d list directory entries instead of contents" \
1766 USE_FEATURE_LS_TIMESTAMPS( \
1767 "\n -e list both full date and full time") \
1768 USE_FEATURE_LS_FILETYPES( \
1769 "\n -F append indicator (one of */=@|) to entries") \
1770 "\n -i list the i-node for each file" \
1771 "\n -l use a long listing format" \
1772 "\n -n list numeric UIDs and GIDs instead of names" \
1773 USE_FEATURE_LS_FILETYPES( \
1774 "\n -p append indicator (one of /=@|) to entries") \
1775 USE_FEATURE_LS_FOLLOWLINKS( \
1776 "\n -L list entries pointed to by symbolic links") \
1777 USE_FEATURE_LS_RECURSIVE( \
1778 "\n -R list subdirectories recursively") \
1779 USE_FEATURE_LS_SORTFILES( \
1780 "\n -r sort the listing in reverse order") \
1781 USE_FEATURE_LS_SORTFILES( \
1782 "\n -S sort the listing by file size") \
1783 "\n -s list the size of each file, in blocks" \
1784 USE_FEATURE_AUTOWIDTH( \
1785 "\n -T NUM assume Tabstop every NUM columns") \
1786 USE_FEATURE_LS_TIMESTAMPS( \
1787 "\n -t with -l: show modification time") \
1788 USE_FEATURE_LS_TIMESTAMPS( \
1789 "\n -u with -l: show access time") \
1790 USE_FEATURE_LS_SORTFILES( \
1791 "\n -v sort the listing by version") \
1792 USE_FEATURE_AUTOWIDTH( \
1793 "\n -w NUM assume the terminal is NUM columns wide") \
1794 "\n -x list entries by lines instead of by columns" \
1795 USE_FEATURE_LS_SORTFILES( \
1796 "\n -X sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001797 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001798 "\n -h print sizes in human readable format (e.g., 1K 243M 2G)") \
1799 USE_SELINUX( \
1800 "\n -k print security context") \
1801 USE_SELINUX( \
1802 "\n -K print security context in long format")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001803
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001804#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001805 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001806#define lsattr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001807 "list file attributes on an ext2 fs\n\n" \
1808 "Options:\n" \
1809 " -R recursively list subdirectories\n" \
1810 " -a do not hide entries starting with .\n" \
1811 " -d list directory entries instead of contents\n" \
1812 " -l print long flag names\n" \
1813 " -v list the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001814
Eric Andersen7e9276b2001-02-22 01:15:47 +00001815#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001816 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001817#define lsmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001818 "List the currently loaded kernel modules."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001819
Eric Andersen3d925622005-06-09 10:16:02 +00001820#ifdef CONFIG_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001821#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001822 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001823#define makedevs_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001824 "Creates a range of block or character special files\n\n" \
1825 "TYPEs include:\n" \
1826 " b: Make a block (buffered) device.\n" \
1827 " c or u: Make a character (un-buffered) device.\n" \
1828 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1829 "FIRST specifies the number appended to NAME to create the first device.\n" \
1830 "LAST specifies the number of the last item that should be created\n" \
1831 "If 's' is the last argument, the base device is created as well.\n\n" \
1832 "For example:\n" \
1833 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
1834 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001835#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001836 "# makedevs /dev/ttyS c 4 66 2 63\n" \
1837 "[creates ttyS2-ttyS63]\n" \
1838 "# makedevs /dev/hda b 3 0 0 8 s\n" \
1839 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001840#endif
1841
1842#ifdef CONFIG_FEATURE_MAKEDEVS_TABLE
1843#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001844 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001845#define makedevs_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001846 "Creates a range of special files as specified in a device table.\n" \
1847 "Device table entries take the form of:\n" \
1848 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
1849 "Where name is the file name, type can be one of:\n" \
1850 " f A regular file\n" \
1851 " d Directory\n" \
1852 " c Character special device file\n" \
1853 " b Block special device file\n" \
1854 " p Fifo (named pipe)\n" \
1855 "uid is the user id for the target file, gid is the group id for the\n" \
1856 "target file. The rest of the entries (major, minor, etc) apply to\n" \
1857 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00001858#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001859 "For example:\n" \
1860 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1861 "/dev d 755 0 0 - - - - -\n" \
1862 "/dev/console c 666 0 0 5 1 - - -\n" \
1863 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1864 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1865 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1866 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1867 "Will Produce:\n" \
1868 "/dev\n" \
1869 "/dev/console\n" \
1870 "/dev/null\n" \
1871 "/dev/zero\n" \
1872 "/dev/hda\n" \
1873 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001874#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001875
Eric Andersen7e9276b2001-02-22 01:15:47 +00001876#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001877 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001878 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001879#define md5sum_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001880 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \
1881 "Options:\n" \
1882 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001883 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001884 " -c check MD5 sums against given list\n" \
1885 "\nThe following two options are useful only when verifying checksums:\n" \
1886 " -s don't output anything, status code shows success\n" \
1887 " -w warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001888#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001889 "$ md5sum < busybox\n" \
1890 "6fd11e98b98a58f64ff3398d7b324003\n" \
1891 "$ md5sum busybox\n" \
1892 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1893 "$ md5sum -c -\n" \
1894 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1895 "busybox: OK\n" \
1896 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001897
Rob Landley70f7ef72005-12-13 08:21:33 +00001898#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001899 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00001900#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001901 " -s Scan /sys and populate /dev during system boot\n\n" \
1902 "Called with no options (via hotplug) it uses environment variables\n" \
1903 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00001904#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001905 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001906 "The mdev config file contains lines that look like:\n" \
1907 " hd[a-z][0-9]* 0:3 660\n\n" \
1908 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00001909 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001910 "Optionally, that can be followed (on the same line) by a special character\n" \
1911 "and a command line to run after creating/before deleting the corresponding\n" \
1912 "device(s). The environment variable $MDEV indicates the active device node\n" \
1913 "(which is useful if it's a regex match). For example:\n\n" \
1914 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
1915 "The special characters are @ (run after creating), $ (run before deleting),\n" \
1916 "and * (run both after creating and before deleting). The commands run in\n" \
1917 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00001918 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001919 "Config file parsing stops on the first matching line. If no config\n"\
1920 "entry is matched, devices are created with default 0:0 660. (Make\n"\
1921 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001922 )
Rob Landley70f7ef72005-12-13 08:21:33 +00001923
Glenn L McGrath061c9002002-09-16 04:21:46 +00001924#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001925 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001926#define mesg_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001927 "mesg controls write access to your terminal\n" \
1928 " y Allow write access to your terminal\n" \
1929 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001930
Eric Andersen7e9276b2001-02-22 01:15:47 +00001931#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001932 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001933#define mkdir_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001934 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
1935 "Options:\n" \
1936 " -m set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
1937 " -p no error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001938#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001939 "$ mkdir /tmp/foo\n" \
1940 "$ mkdir /tmp/foo\n" \
1941 "/tmp/foo: File exists\n" \
1942 "$ mkdir /tmp/foo/bar/baz\n" \
1943 "/tmp/foo/bar/baz: No such file or directory\n" \
1944 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001945
Mike Frysinger6447ac02005-06-11 05:29:40 +00001946#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001947 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
1948 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
1949 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
1950 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
1951 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
1952 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00001953#define mke2fs_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001954 " -b size block size in bytes\n" \
1955 " -c check for bad blocks before creating\n" \
1956 " -E opts set extended options\n" \
1957 " -f size fragment size in bytes\n" \
1958 " -F force (ignore sanity checks)\n" \
1959 " -g num number of blocks in a block group\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001960 " -i ratio the bytes/inode ratio\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001961 " -j create a journal (ext3)\n" \
1962 " -J opts set journal options (size/device)\n" \
1963 " -l file read bad blocks list from file\n" \
1964 " -L lbl set the volume label\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001965 " -m percent percent of fs blocks to reserve for admin\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001966 " -M dir set last mounted directory\n" \
1967 " -n do not actually create anything\n" \
1968 " -N num number of inodes to create\n" \
1969 " -o os set the 'creator os' field\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001970 " -O features dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001971 " -q quiet execution\n" \
1972 " -r rev set filesystem revision\n" \
1973 " -S write superblock and group descriptors only\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001974 " -T fs-type set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001975 " -v verbose execution"
Mike Frysinger6447ac02005-06-11 05:29:40 +00001976
Eric Andersen7e9276b2001-02-22 01:15:47 +00001977#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001978 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001979#define mkfifo_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001980 "Creates a named pipe (identical to 'mknod name p')\n\n" \
1981 "Options:\n" \
1982 " -m create the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001983
Eric Andersen7e9276b2001-02-22 01:15:47 +00001984#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001985 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001986#define mkfs_minix_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001987 "Make a MINIX filesystem.\n\n" \
1988 "Options:\n" \
1989 " -c Check the device for bad blocks\n" \
1990 " -n [14|30] Specify the maximum length of filenames\n" \
1991 " -i INODES Specify the number of inodes for the filesystem\n" \
1992 " -l FILENAME Read the bad blocks list from FILENAME\n" \
1993 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001994
Eric Andersen7e9276b2001-02-22 01:15:47 +00001995#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001996 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001997#define mknod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001998 "Create a special file (block, character, or pipe).\n\n" \
1999 "Options:\n" \
2000 " -m create the special file using the specified mode (default a=rw)\n\n" \
2001 "TYPEs include:\n" \
2002 " b: Make a block (buffered) device\n" \
2003 " c or u: Make a character (un-buffered) device\n" \
2004 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002005#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002006 "$ mknod /dev/fd0 b 2 0\n" \
2007 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002008
Eric Andersen7e9276b2001-02-22 01:15:47 +00002009#define mkswap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002010 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002011#define mkswap_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002012 "Prepare a disk partition to be used as a swap partition.\n\n" \
2013 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002014 " -c Check for read-ability\n" \
2015 " -v0 Make version 0 swap [max 128 Megs]\n" \
2016 " -v1 Make version 1 swap [big!] (default for kernels > 2.1.117)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002017 " block-count Number of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002018
Eric Andersen7e9276b2001-02-22 01:15:47 +00002019#define mktemp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002020 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002021#define mktemp_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002022 "Creates a temporary file with its name based on TEMPLATE.\n" \
2023 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX).\n\n" \
2024 "Options:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002025 " -d Make a directory instead of a file\n" \
2026 " -q Fail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002027#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002028 "$ mktemp /tmp/temp.XXXXXX\n" \
2029 "/tmp/temp.mWiLjM\n" \
2030 "$ ls -la /tmp/temp.mWiLjM\n" \
2031 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002032
Eric Andersen8d79ce82001-07-22 23:00:15 +00002033#define modprobe_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002034 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002035#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002036 "Options:\n" \
2037 " -k Make module autoclean-able\n" \
2038 " -n Just show what would be done\n" \
2039 " -q Quiet output\n" \
2040 " -r Remove module (stacks) or do autoclean\n" \
2041 " -s Report via syslog instead of stderr\n" \
2042 " -v Verbose output"
Rob Landley9c32a152005-12-11 20:12:24 +00002043#define modprobe_notes_usage \
2044"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2045"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2046"pass each module it loads.\n" \
2047"\n" \
2048"The configuration file is searched (in order) amongst:\n" \
2049"\n" \
2050" /etc/modprobe.conf (2.6 only)\n" \
2051" /etc/modules.conf\n" \
2052" /etc/conf.modules (deprecated)\n" \
2053"\n" \
2054"They all have the same syntax (see below). If none is present, it is\n" \
2055"_not_ an error; each loaded module is then expected to load without\n" \
2056"options. Once a file is found, the others are tested for.\n" \
2057"\n" \
2058"/etc/modules.conf entry format:\n" \
2059"\n" \
2060" alias <alias_name> <mod_name>\n" \
2061" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002062" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002063" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2064" This makes it also possible to use a different set of options (below) for\n" \
2065" the module and the alias.\n" \
2066" A module can be aliased more than once.\n" \
2067"\n" \
2068" options <mod_name|alias_name> <symbol=value ...>\n" \
2069" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2070" the \"symbol=value\" pairs as option to that module.\n" \
2071"\n" \
2072"Sample /etc/modules.conf file:\n" \
2073"\n" \
2074" options tulip irq=3\n" \
2075" alias tulip tulip2\n" \
2076" options tulip2 irq=4 io=0x308\n" \
2077"\n" \
2078"Other functionality offered by 'classic' modprobe is not available in\n" \
2079"this implementation.\n" \
2080"\n" \
2081"If module options are present both in the config file, and on the command line,\n" \
2082"then the options from the command line will be passed to the module _after_\n" \
2083"the options from the config file. That way, you can have defaults in the config\n" \
2084"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002085#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002086 "(with the above /etc/modules.conf):\n\n" \
2087 "$ modprobe tulip\n" \
2088 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2089 "$ modprobe tulip irq=5\n" \
2090 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2091 "$ modprobe tulip2\n" \
2092 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2093 " which are the default for alias 'tulip2'\n\n" \
2094 "$ modprobe tulip2 irq=8\n" \
2095 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2096 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2097 " from the command line\n\n" \
2098 "$ modprobe tulip2 irq=2 io=0x210\n" \
2099 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2100 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2101 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002102
Eric Andersen7e9276b2001-02-22 01:15:47 +00002103#define more_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002104 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002105#define more_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002106 "More is a filter for viewing FILE one screenful at a time."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002107#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002108 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002109
Eric Andersen7e9276b2001-02-22 01:15:47 +00002110#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002111 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002112#define mount_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002113 "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n\n" \
2114 "Flags:\n" \
2115 " -a: Mount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002116 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002117 " -f: \"Fake\" Add entry to mount table but don't mount it\n" \
2118 " -n: Don't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002119 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002120 " -o option: One of many filesystem options, listed below\n" \
2121 " -r: Mount the filesystem read-only\n" \
2122 " -t fs-type: Specify the filesystem type\n" \
2123 " -w: Mount for reading and writing (default)\n" \
2124 "\n" \
2125 "Options for use with the \"-o\" flag:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002126 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002127 " loop: Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002128 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002129 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002130 " [a]sync: Writes are asynchronous / synchronous\n" \
2131 " [no]atime: Disable / enable updates to inode access times\n" \
2132 " [no]diratime: Disable / enable atime updates to directories\n" \
2133 " [no]dev: Allow use of special device files / disallow them\n" \
2134 " [no]exec: Allow use of executable files / disallow them\n" \
2135 " [no]suid: Allow set-user-id-root programs / disallow them\n" \
2136 " [r]shared: Convert [recursively] to a shared subtree.\n" \
2137 " [r]slave: Convert [recursively] to a slave subtree.\n" \
2138 " [r]private: Convert [recursively] to a private subtree\n" \
2139 " [un]bindable: Make mount point [un]able to be bind mounted.\n" \
2140 " bind: Bind a directory to an additional location\n" \
2141 " move: Relocate an existing mount point.\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002142 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002143 " remount: Re-mount a mounted filesystem, changing its flags\n" \
2144 " ro/rw: Mount for read-only / read-write\n" \
2145 "\nThere are EVEN MORE flags that are specific to each filesystem\n" \
2146 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002147#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002148 "$ mount\n" \
2149 "/dev/hda3 on / type minix (rw)\n" \
2150 "proc on /proc type proc (rw)\n" \
2151 "devpts on /dev/pts type devpts (rw)\n" \
2152 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2153 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2154 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002155#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002156 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002157
Rob Landleyd00b3a52005-08-20 05:07:08 +00002158#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002159 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002160#define mountpoint_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002161 "mountpoint checks if the directory is a mountpoint\n\n" \
2162 "Options:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002163 " -q Be more quiet\n" \
2164 " -d Print major/minor device number of the filesystem\n" \
2165 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002166#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002167 "$ mountpoint /proc\n" \
2168 "/proc is not a mountpoint\n" \
2169 "$ mountpoint /sys\n" \
2170 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002171
Eric Andersen7e9276b2001-02-22 01:15:47 +00002172#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002173 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002174#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002175 "Control magnetic tape drive operation\n" \
2176 "\nAvailable Opcodes:\n\n" \
2177 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2178 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2179 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2180 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002181
Eric Andersen7e9276b2001-02-22 01:15:47 +00002182#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002183 "[OPTION]... SOURCE DEST\n" \
2184 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002185#define mv_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002186 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\n" \
2187 "Options:\n" \
2188 " -f don't prompt before overwriting\n" \
2189 " -i interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002190#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002191 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002192
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002193#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002194 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002195#define nameif_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002196 "Nameif renames network interface while it in the down state.\n\n" \
2197 "Options:\n" \
2198 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2199 " -s Use syslog (LOCAL0 facility)\n" \
2200 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002201#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002202 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2203 " or\n" \
2204 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002205
Rob Landley1cca9482006-07-10 19:45:20 +00002206#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002207#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002208#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002209#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002210#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002211
Eric Andersen7e9276b2001-02-22 01:15:47 +00002212#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002213 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002214 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002215#define nc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002216 "Netcat opens a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002217 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002218 USE_NC_EXTRA( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002219 "\n -e exec rest of command line after connect" \
2220 "\n -i SECS delay interval for lines sent" \
2221 "\n -w SECS timeout for connect" \
2222 "\n -f file use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002223 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002224 USE_NC_SERVER( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002225 "\n -l listen mode, for inbound connects" \
2226 USE_NC_EXTRA( \
2227 "\n (use -l twice with -e for persistent server)") \
2228 "\n -p PORT local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002229 )
2230
Rob Landley1cca9482006-07-10 19:45:20 +00002231#define nc_notes_usage "" \
2232 USE_NC_EXTRA( \
2233 "To use netcat as a terminal emulator on a serial port:\n\n" \
2234 "$ stty 115200 -F /dev/ttyS0\n" \
2235 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2236 ) ""
2237
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002238#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002239 "$ nc foobar.somedomain.com 25\n" \
2240 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2241 "help\n" \
2242 "214-Commands supported:\n" \
2243 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2244 "214 NOOP QUIT RSET HELP\n" \
2245 "quit\n" \
2246 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002247
Eric Andersen1552ff72001-10-31 11:07:12 +00002248#define netstat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002249 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002250#define netstat_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002251 "Netstat displays Linux networking information.\n\n" \
2252 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002253 " -l display listening server sockets\n" \
2254 " -a display all sockets (default: connected)\n" \
2255 " -e display other/more information\n" \
2256 " -n don't resolve names\n" \
2257 " -r display routing table\n" \
2258 " -t tcp sockets\n" \
2259 " -u udp sockets\n" \
2260 " -w raw sockets\n" \
2261 " -x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00002262
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002263#define nice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002264 "[-n ADJUST] [COMMAND [ARG] ...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002265#define nice_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002266 "Nice runs a program with modified scheduling priority.\n\n" \
2267 "Options:\n" \
2268 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002269
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002270#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002271 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002272#define nmeter_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002273 "Nmeter monitors your system in real time.\n\n" \
2274 "Format specifiers:\n" \
2275 "%Nc or %[cN] monitor CPU. N - bar size, default 10\n" \
2276 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
2277 "%[niface] monitor network interface 'iface'\n" \
2278 "%m monitor allocated memory\n" \
2279 "%[mf] monitor free memory\n" \
2280 "%[mt] monitor total memory\n" \
2281 "%s monitor allocated swap\n" \
2282 "%f monitor number of used file descriptors\n" \
2283 "%Ni monitor total/specific IRQ rate\n" \
2284 "%x monitor context switch rate\n" \
2285 "%p monitor forks\n" \
2286 "%[pn] monitor # of processes\n" \
2287 "%b monitor block io\n" \
2288 "%Nt show time (with N decimal points)\n" \
2289 "%Nd milliseconds between updates (default=1000)\n" \
2290 "%r print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002291#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002292 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002293
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002294#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002295 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002296#define nohup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002297 "run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002298#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002299 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002300
Eric Andersen7e9276b2001-02-22 01:15:47 +00002301#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002302 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002303#define nslookup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002304 "Queries the nameserver for the IP address of the given HOST\n" \
2305 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002306#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002307 "$ nslookup localhost\n" \
2308 "Server: default\n" \
2309 "Address: default\n" \
2310 "\n" \
2311 "Name: debian\n" \
2312 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002313
Glenn L McGrath60281112001-11-02 11:39:46 +00002314#define od_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002315 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002316#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002317 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
2318 "to standard output. With no FILE, or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002319
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002320#define openvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002321 "<vtnum> <COMMAND> [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002322#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002323 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002324#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002325 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002326
Eric Andersen27f64e12002-06-23 04:24:25 +00002327#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002328 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002329#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002330 "Change a user password. If no name is specified,\n" \
2331 "changes the password for the current user.\n" \
2332 "Options:\n" \
2333 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002334 " (Choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002335 " -d Delete the password for the specified user account\n" \
2336 " -l Locks (disables) the specified user account\n" \
2337 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002338
Glenn L McGrath655d8142003-06-22 15:32:41 +00002339#define patch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002340 "[-p<num>] [-i <diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002341#define patch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002342 " -p <num> Strip <num> leading components from file names\n" \
2343 " -i <diff> Read <diff> instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002344#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002345 "$ patch -p1 < example.diff\n" \
2346 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002347
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002348#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2349#define USAGE_PIDOF "Options:"
2350#else
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002351#define USAGE_PIDOF "\n This version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002352#endif
2353
Eric Andersen221b2ea2001-07-31 19:06:07 +00002354#define pidof_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002355 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002356
Eric Andersen221b2ea2001-07-31 19:06:07 +00002357#define pidof_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002358 "Lists the PIDs of all processes with names that match the\n" \
2359 "names on the command line.\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002360 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002361 USE_FEATURE_PIDOF_SINGLE( \
2362 "\n -s display only a single PID") \
2363 USE_FEATURE_PIDOF_OMIT( \
2364 "\n -o omit given pid.") \
2365 USE_FEATURE_PIDOF_OMIT( \
2366 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002367#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002368 "$ pidof init\n" \
2369 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002370 USE_FEATURE_PIDOF_OMIT( \
2371 "$ pidof /bin/sh\n20351 5973 5950\n") \
2372 USE_FEATURE_PIDOF_OMIT( \
2373 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002374
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002375#ifndef CONFIG_FEATURE_FANCY_PING
Eric Andersen7e9276b2001-02-22 01:15:47 +00002376#define ping_trivial_usage "host"
2377#define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2378#else
2379#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002380 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002381#define ping_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002382 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2383 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002384 " -c CNT Send only CNT pings\n" \
2385 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2386 " -I IP Use IP as source address\n" \
2387 " -q Quiet mode, only displays output at start\n" \
2388 " and when finished"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002389#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002390#define ping_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002391 "$ ping localhost\n" \
2392 "PING slag (127.0.0.1): 56 data bytes\n" \
2393 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2394 "\n" \
2395 "--- debian ping statistics ---\n" \
2396 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2397 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002398
Eric Andersen51b8bd62002-07-03 11:46:38 +00002399#ifndef CONFIG_FEATURE_FANCY_PING6
2400#define ping6_trivial_usage "host"
2401#define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts"
2402#else
2403#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002404 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002405#define ping6_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002406 "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \
2407 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002408 " -c CNT Send only CNT pings\n" \
2409 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2410 " -q Quiet mode, only displays output at start\n" \
2411 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002412#endif
2413#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002414 "$ ping6 ip6-localhost\n" \
2415 "PING ip6-localhost (::1): 56 data bytes\n" \
2416 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2417 "\n" \
2418 "--- ip6-localhost ping statistics ---\n" \
2419 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2420 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002421
Eric Andersen7e9276b2001-02-22 01:15:47 +00002422#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002423 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002424#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002425 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
2426 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002427
Eric Andersen7e9276b2001-02-22 01:15:47 +00002428#define poweroff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002429 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002430#define poweroff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002431 "Halt and shut off power.\n" \
2432 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002433 " -d delay interval for halting\n" \
2434 " -n no call to sync()\n" \
2435 " -f force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002436
Mike Frysinger95d3c452005-04-21 23:29:24 +00002437#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002438 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002439#define printenv_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002440 "print all or part of environment\n\n" \
2441 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002442
Eric Andersen7e9276b2001-02-22 01:15:47 +00002443#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002444 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002445#define printf_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002446 "Formats and prints ARGUMENT(s) according to FORMAT,\n" \
2447 "Where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002448#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002449 "$ printf \"Val=%d\\n\" 5\n" \
2450 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002451
Denis Vlasenko94949192006-11-05 00:45:47 +00002452
2453#if ENABLE_DESKTOP
2454
2455#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002456 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002457#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002458 "Report process status\n" \
2459 "\nOptions:" \
2460 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002461
2462#else /* !ENABLE_DESKTOP */
2463
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002464#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002465#define USAGE_PS "\n This version of ps accepts no options."
Rob Landley6eb1e412005-06-20 04:30:36 +00002466#else
2467#define USAGE_PS "\nOptions:"
2468#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002469
Eric Andersen7e9276b2001-02-22 01:15:47 +00002470#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002471 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002472#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002473 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002474 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002475 USE_SELINUX( \
2476 "\n -c show SE Linux context") \
2477 USE_FEATURE_PS_WIDE( \
2478 "\n w wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002479
Denis Vlasenko94949192006-11-05 00:45:47 +00002480#endif /* ENABLE_DESKTOP */
2481
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002482#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002483 "$ ps\n" \
2484 " PID Uid Gid State Command\n" \
2485 " 1 root root S init\n" \
2486 " 2 root root S [kflushd]\n" \
2487 " 3 root root S [kupdate]\n" \
2488 " 4 root root S [kpiod]\n" \
2489 " 5 root root S [kswapd]\n" \
2490 " 742 andersen andersen S [bash]\n" \
2491 " 743 andersen andersen S -bash\n" \
2492 " 745 root root S [getty]\n" \
2493 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002494
Denis Vlasenko94949192006-11-05 00:45:47 +00002495
Eric Andersen7e9276b2001-02-22 01:15:47 +00002496#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002497 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002498#define pwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002499 "Print the full filename of the current working directory."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002500#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002501 "$ pwd\n" \
2502 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002503
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002504#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002505 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002506#define raidautorun_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002507 "Tells the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002508#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002509 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002510
Eric Andersen7e9276b2001-02-22 01:15:47 +00002511#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002512 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002513#define rdate_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002514 "Get and possibly set the system date and time from a remote HOST.\n\n" \
2515 "Options:\n" \
2516 " -s Set the system date and time (default)\n" \
2517 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002518
Rob Landley0e4690d2006-08-20 22:12:18 +00002519#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002520 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002521#define readahead_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002522 "Preloads FILE(s) in RAM cache so that subsequent reads for those" \
2523 "files do not block on disk I/O."
Rob Landley0e4690d2006-08-20 22:12:18 +00002524
Eric Andersen7e9276b2001-02-22 01:15:47 +00002525#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002526 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002527#define readlink_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002528 "Displays the value of a symbolic link." \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002529 USE_FEATURE_READLINK_FOLLOW( \
2530 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002531 " -f canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002532
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002533#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002534 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002535#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002536 "Options:\n" \
2537 " -m <mapfile> (default: /boot/System.map)\n" \
2538 " -p <profile> (default: /proc/profile)\n" \
2539 " -M <mult> set the profiling multiplier to <mult>\n" \
2540 " -i print only info about the sampling step\n" \
2541 " -v print verbose data\n" \
2542 " -a print all symbols, even if count is 0\n" \
2543 " -b print individual histogram-bin counts\n" \
2544 " -s print individual counters within functions\n" \
2545 " -r reset all the counters (root only)\n" \
2546 " -n disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002547
Glenn L McGrath62fae302002-12-10 00:14:33 +00002548#define realpath_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002549 "pathname ..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00002550#define realpath_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002551 "Returns the absolute pathnames of given argument."
Tim Riker7b253f82003-12-28 05:02:40 +00002552
Eric Andersen7e9276b2001-02-22 01:15:47 +00002553#define reboot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002554 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002555#define reboot_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002556 "Reboot the system.\n" \
2557 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002558 " -d delay interval for rebooting\n" \
2559 " -n no call to sync()\n" \
2560 " -f force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002561
2562#define renice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002563 "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002564#define renice_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002565 "Changes priority of running processes.\n\n" \
2566 "Options:\n" \
2567 " -n adjusts current nice value (smaller is faster)\n" \
2568 " -p process id(s) (default)\n" \
2569 " -g process group id(s)\n" \
2570 " -u process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002571
Eric Andersen7e9276b2001-02-22 01:15:47 +00002572#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002573 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002574#define reset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002575 "Resets the screen."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002576
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002577#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002578 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002579#define resize_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002580 "Resizes the screen."
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002581
Eric Andersen7e9276b2001-02-22 01:15:47 +00002582#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002583 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002584#define rm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002585 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2586 "indicate that all following arguments are non-options.\n\n" \
2587 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002588 " -i always prompt before removing each destination\n" \
2589 " -f remove existing destinations, never prompt\n" \
2590 " -r,-R remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002591#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002592 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002593
Eric Andersen7e9276b2001-02-22 01:15:47 +00002594#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002595 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002596#define rmdir_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002597 "Remove the DIRECTORY(ies), if they are empty."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002598#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002599 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002600
Eric Andersen7e9276b2001-02-22 01:15:47 +00002601#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002602 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002603#define rmmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002604 "Unloads the specified kernel modules from the kernel.\n\n" \
2605 "Options:\n" \
2606 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002607#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002608 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002609
Eric Andersen7e9276b2001-02-22 01:15:47 +00002610#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002611 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002612#define route_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002613 "Edit the kernel's routing tables.\n\n" \
2614 "Options:\n" \
2615 " -n Dont resolve names\n" \
2616 " -e Display other/more information\n" \
2617 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002618
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002619#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002620 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002621#define rpm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002622 "Manipulates RPM packages" \
2623 "\n\nOptions:" \
2624 "\n -i Install package" \
2625 "\n -q Query package" \
2626 "\n -p Query uninstalled package" \
2627 "\n -i Show information" \
2628 "\n -l List contents" \
2629 "\n -d List documents" \
2630 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002631
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002632#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002633 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002634#define rpm2cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002635 "Outputs a cpio archive of the rpm file."
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002636
Eric Andersen6cf47a72001-10-31 10:24:36 +00002637#define run_parts_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002638 "[-t] [-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002639#define run_parts_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002640 "Run a bunch of scripts in a directory.\n\n" \
2641 "Options:\n" \
2642 " -t Prints what would be run, but does not actually run anything\n" \
2643 " -a ARG Pass ARG as an argument for every program invoked\n" \
2644 " -u MASK Set the umask to MASK before executing every program"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002645
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002646#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002647 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002648#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002649 "Find the current and previous system runlevel.\n\n" \
2650 "If no utmp file exists or if no runlevel record can be found,\n" \
2651 "runlevel prints \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002652#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002653 "$ runlevel /var/run/utmp\n" \
2654 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002655
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002656#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002657 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002658#define runsv_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002659 "Start and monitor a service and optionally an appendant log service."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002660
2661#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002662 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002663#define runsvdir_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002664 "Start a runsv process for each subdirectory."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002665
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002666#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002667 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002668#define rx_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002669 "Receive a file using the xmodem protocol."
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002670#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002671 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002672
Eric Andersen7e9276b2001-02-22 01:15:47 +00002673#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002674 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002675#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002676 "Options:\n" \
2677 " -e script add the script to the commands to be executed\n" \
2678 " -f scriptfile add script-file contents to the\n" \
2679 " commands to be executed\n" \
2680 " -i edit files in-place\n" \
2681 " -n suppress automatic printing of pattern space\n" \
2682 " -r use extended regular expression syntax\n" \
2683 "\n" \
2684 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2685 "script to interpret. All remaining arguments are names of input files; if no\n" \
2686 "input files are specified, then the standard input is read. Source files\n" \
2687 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00002688
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002689#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002690 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2691 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002692
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002693#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002694 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002695#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002696 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
2697 "FIRST, INCREMENT default to 1\n" \
2698 "Arguments:\n" \
2699 " LAST\n" \
2700 " FIRST LAST\n" \
2701 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002702
Paul Foxfc2256a2005-08-01 18:12:30 +00002703#define setconsole_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002704 "[-r|--reset] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00002705#define setconsole_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002706 "Redirects system console output to DEVICE (default: /dev/tty).\n\n" \
2707 "Options:\n" \
2708 " -r Reset output to /dev/console."
Paul Foxfc2256a2005-08-01 18:12:30 +00002709
Eric Andersen7e9276b2001-02-22 01:15:47 +00002710#define setkeycodes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002711 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002712#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002713 "Set entries into the kernel's scancode-to-keycode map,\n" \
2714 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2715 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
2716 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002717#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002718 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002719
Rob Landley87848d92006-03-27 23:23:43 +00002720#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002721 "N"
Rob Landley87848d92006-03-27 23:23:43 +00002722#define setlogcons_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002723 "Redirects the kernel output to console N (0 for current)."
Rob Landley87848d92006-03-27 23:23:43 +00002724
Paul Fox42403642005-08-01 22:52:09 +00002725#define setsid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002726 "program [arg ...]"
Paul Fox42403642005-08-01 22:52:09 +00002727#define setsid_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002728 "Runs any program in a new session by calling setsid() before\n" \
2729 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00002730
Matt Kraai2d91deb2001-08-01 17:21:35 +00002731#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002732 "[FILE]...\n" \
2733 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002734#define lash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002735 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002736#define lash_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002737 "This command does not yet have proper documentation.\n\n" \
2738 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2739 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2740 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2741 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
2742 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2743 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002744
Eric Andersen2e9c2572003-08-08 22:26:06 +00002745#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002746 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00002747#define last_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002748 "Shows listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00002749
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002750#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002751 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002752 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002753#define sha1sum_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002754 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \
2755 "Options:\n" \
2756 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002757 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002758 " -c check SHA1 sums against given list\n" \
2759 "\nThe following two options are useful only when verifying checksums:\n" \
2760 " -s don't output anything, status code shows success\n" \
2761 " -w warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002762
Eric Andersen7e9276b2001-02-22 01:15:47 +00002763#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002764 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002765#define sleep_full_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002766 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds.") \
2767 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002768 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002769 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002770#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002771 "$ sleep 2\n" \
2772 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002773 USE_FEATURE_FANCY_SLEEP( \
2774 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002775 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002776
Eric Andersen7e9276b2001-02-22 01:15:47 +00002777#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002778 "[-nru" \
2779 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") \
2780 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002781#define sort_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002782 "Sorts lines of text in the specified files\n\n" \
2783 "Options:\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002784 USE_FEATURE_SORT_BIG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002785 " -b ignore leading blanks\n" \
2786 " -c check whether input is sorted\n" \
2787 " -d dictionary order (blank or alphanumeric only)\n" \
2788 " -f ignore case\n" \
2789 " -g general numerical sort\n" \
2790 " -i ignore unprintable characters\n" \
2791 " -k specify sort key\n" \
2792 " -M sort month\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002793 " -n sort numbers\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002794 USE_FEATURE_SORT_BIG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002795 " -o output to file\n" \
2796 " -k sort by key\n" \
2797 " -t use key separator other than whitespace\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002798 " -r reverse sort order\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002799 USE_FEATURE_SORT_BIG( \
2800 " -s stable (don't sort ties alphabetically)\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002801 " -u suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002802 USE_FEATURE_SORT_BIG( \
2803 "\n -z input terminated by nulls, not newlines\n") \
2804 USE_FEATURE_SORT_BIG( \
2805 " -mST ignored for GNU compatibility") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002806 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002807#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002808 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
2809 "a\n" \
2810 "b\n" \
2811 "c\n" \
2812 "d\n" \
2813 "e\n" \
2814 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002815 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002816 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2817 "d 2\n" \
2818 "b 2\n" \
2819 "c 3\n" \
2820 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002821 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002822
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002823#define start_stop_daemon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002824 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002825#define start_stop_daemon_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002826 "Program to start and stop services." \
2827 "\n\nOptions:" \
2828 "\n -S|--start start" \
2829 "\n -K|--stop stop" \
2830 "\n -a|--startas <pathname> starts process specified by pathname" \
2831 "\n -b|--background force process into background" \
2832 "\n -u|--user <username>|<uid> stop this user's processes" \
2833 "\n -x|--exec <executable> program to either start or check" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002834 "\n -m|--make-pidfile create the -p file and enter pid in it" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002835 "\n -n|--name <process-name> stop processes with this name" \
2836 "\n -p|--pidfile <pid-file> save or load pid using a pid-file" \
2837 "\n -q|--quiet be quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002838 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002839 "\n -o|--oknodo exit status 0 if nothing done" \
2840 "\n -v|--verbose be verbose" \
2841 "\n -N|--nicelevel <N> add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002842 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002843 "\n -s|--signal <signal> signal to send (default TERM)" \
2844 "\n -U|--chuid <username>|<uid> start process with this name"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002845
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002846#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002847 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002848#define stat_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002849 "display file (default) or filesystem status.\n\n" \
2850 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002851 USE_FEATURE_STAT_FORMAT( \
2852 " -c fmt use the specified format\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002853 " -f display filesystem status\n" \
2854 " -L,-l dereference links\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002855 " -t display info in terse form" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002856 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002857 "\n\nValid format sequences for files:\n" \
2858 " %a Access rights in octal\n" \
2859 " %A Access rights in human readable form\n" \
2860 " %b Number of blocks allocated (see %B)\n" \
2861 " %B The size in bytes of each block reported by %b\n" \
2862 " %d Device number in decimal\n" \
2863 " %D Device number in hex\n" \
2864 " %f Raw mode in hex\n" \
2865 " %F File type\n" \
2866 " %g Group ID of owner\n" \
2867 " %G Group name of owner\n" \
2868 " %h Number of hard links\n" \
2869 " %i Inode number\n" \
2870 " %n File name\n" \
2871 " %N Quoted file name with dereference if symbolic link\n" \
2872 " %o I/O block size\n" \
2873 " %s Total size, in bytes\n" \
2874 " %t Major device type in hex\n" \
2875 " %T Minor device type in hex\n" \
2876 " %u User ID of owner\n" \
2877 " %U User name of owner\n" \
2878 " %x Time of last access\n" \
2879 " %X Time of last access as seconds since Epoch\n" \
2880 " %y Time of last modification\n" \
2881 " %Y Time of last modification as seconds since Epoch\n" \
2882 " %z Time of last change\n" \
2883 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002884 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002885 " %a Free blocks available to non-superuser\n" \
2886 " %b Total data blocks in file system\n" \
2887 " %c Total file nodes in file system\n" \
2888 " %d Free file nodes in file system\n" \
2889 " %f Free blocks in file system\n" \
2890 " %i File System ID in hex\n" \
2891 " %l Maximum length of filenames\n" \
2892 " %n File name\n" \
2893 " %s Block size (for faster transfers)\n" \
2894 " %S Fundamental block size (for block counts)\n" \
2895 " %t Type in hex\n" \
2896 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002897 )
2898
Eric Andersenef5e8f82002-11-07 02:09:37 +00002899#define strings_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002900 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002901#define strings_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002902 "Display printable strings in a binary file." \
2903 "\n\nOptions:" \
2904 "\n -a Scan the whole files (this is the default)." \
2905 "\n -f Precede each string with the name of the file where it was found." \
2906 "\n -n N Specifies that at least N characters forms a sequence (default 4)" \
2907 "\n -o Each string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002908
Eric Andersen7e9276b2001-02-22 01:15:47 +00002909#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002910 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002911#define stty_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002912 "Without arguments, prints baud rate, line discipline," \
2913 "\nand deviations from stty sane." \
2914 "\n\nOptions:" \
2915 "\n -F DEVICE open device instead of stdin" \
2916 "\n -a print all current settings in human-readable form" \
2917 "\n -g print in stty-readable form" \
2918 "\n [SETTING] see manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002919
Robert Griebl1fca5582002-06-04 20:45:46 +00002920#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002921 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00002922#define su_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002923 "Change user id or become root.\n" \
2924 "Options:\n" \
2925 " -p, -m Preserve environment" \
2926 "\n -c Command to pass to 'sh -c'" \
2927 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00002928
Eric Andersen27f64e12002-06-23 04:24:25 +00002929#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002930 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002931#define sulogin_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002932 "Single user login\n" \
2933 "Options:\n" \
2934 " -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00002935
Mike Frysinger95d3c452005-04-21 23:29:24 +00002936#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002937 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002938#define sum_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002939 "checksum and count the blocks in a file\n\n" \
2940 "Options:\n" \
2941 " -r use BSD sum algorithm (1K blocks)\n" \
2942 " -s use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002943
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002944#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002945 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002946#define sv_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002947 "Report the current status and control the state of services " \
2948 "monitored by the runsv supervisor."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002949
Denis Vlasenko83ea6432006-11-16 02:27:24 +00002950#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002951 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00002952#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002953 "Continuously read log data from standard input, optionally " \
2954 "filter log messages, and write the data to one or more automatically " \
2955 "rotated logs."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00002956
Eric Andersen7e9276b2001-02-22 01:15:47 +00002957#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002958 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002959#define swapoff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002960 "Stop swapping virtual memory pages on DEVICE.\n\n" \
2961 "Options:\n" \
2962 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002963
Eric Andersen7e9276b2001-02-22 01:15:47 +00002964#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002965 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002966#define swapon_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002967 "Start swapping virtual memory pages on DEVICE.\n\n" \
2968 "Options:\n" \
2969 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002970
Rob Landley0f34a822005-10-27 22:55:50 +00002971#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002972 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00002973#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002974 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
2975 "and exec NEW_INIT.\n\n" \
2976 "Options:\n" \
2977 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00002978
Eric Andersen7e9276b2001-02-22 01:15:47 +00002979#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002980 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002981#define sync_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002982 "Write all buffered filesystem blocks to disk."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002983
Eric Andersenb9050282003-12-24 06:02:11 +00002984#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002985 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002986#define sysctl_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002987 "configure kernel parameters at runtime\n\n" \
2988 "Options:\n" \
2989 " -n Use this option to disable printing of the key name when printing values\n" \
2990 " -w Use this option when you want to change a sysctl setting\n" \
2991 " -p Load in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
2992 " -a Display all values currently available\n" \
2993 " -A Display all values currently available in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002994#define sysctl_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002995 "sysctl [-n] variable ...\n" \
2996 "sysctl [-n] -w variable=value ...\n" \
2997 "sysctl [-n] -a\n" \
2998 "sysctl [-n] -p <file> (default /etc/sysctl.conf)\n" \
2999 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003000
Eric Andersen7e9276b2001-02-22 01:15:47 +00003001#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003002 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003003#define syslogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003004 "Linux system and kernel logging utility.\n" \
3005 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
3006 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003007 " -m MIN Minutes between MARK lines (default=20, 0=off)\n" \
3008 " -n Run as a foreground process\n" \
3009 " -O FILE Use an alternate log file (default=/var/log/messages)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003010 " -l n Sets the local log level of messages to n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003011 " -S Make logging output smaller" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003012 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003013 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3014 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003015 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003016 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3017 "\n -L Log locally and via network logging (default is network only)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003018 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003019 "\n -C [size(KiB)] Log to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003020#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003021 "$ syslogd -R masterlog:514\n" \
3022 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003023
Eric Andersen7e9276b2001-02-22 01:15:47 +00003024#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003025 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003026#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003027 "Print last 10 lines of each FILE to standard output.\n" \
3028 "With more than one FILE, precede each with a header giving the\n" \
3029 "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
3030 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003031 USE_FEATURE_FANCY_TAIL( \
3032 " -c N[kbm] output the last N bytes\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003033 " -n N[kbm] print last N lines instead of last 10\n" \
3034 " -f output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003035 USE_FEATURE_FANCY_TAIL( \
3036 "\n -q never output headers giving file names\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003037 " -s SEC wait SEC seconds between reads with -f\n" \
3038 " -v always output headers giving file names\n\n" \
3039 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3040 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3041 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003042#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003043 "$ tail -n 1 /etc/resolv.conf\n" \
3044 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003045
Eric Andersen7e9276b2001-02-22 01:15:47 +00003046#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003047 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003048 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3049 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003050 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003051 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003052#define tar_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003053 "Create, extract, or list files from a tar file.\n\n" \
3054 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003055 USE_FEATURE_TAR_CREATE( \
3056 " c create\n") \
3057 " x extract\n" \
3058 " t list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003059 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003060 USE_FEATURE_TAR_GZIP( \
3061 " z Filter the archive through gzip\n") \
3062 USE_FEATURE_TAR_BZIP2( \
3063 " j Filter the archive through bzip2\n") \
3064 USE_FEATURE_TAR_LZMA( \
3065 " a Filter the archive through lzma\n") \
3066 USE_FEATURE_TAR_COMPRESS( \
3067 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003068 "\nFile selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003069 " f name of TARFILE or \"-\" for stdin\n" \
3070 " O extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003071 USE_FEATURE_TAR_FROM( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003072 " exclude file to exclude\n" \
3073 " X file with names to exclude\n") \
3074 " C change to directory DIR before operation\n" \
3075 " v verbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003076#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003077 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3078 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003079
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003080#define taskset_trivial_usage \
3081 "[OPTIONS] [mask] [pid | command [arg]...]"
3082#define taskset_full_usage \
3083 "Set or get CPU affinity.\n\n" \
3084 "Options:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003085 " -p operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003086#define taskset_example_usage \
3087 "$ taskset 0x7 ./dgemm_test&\n" \
3088 "$ taskset -p 0x1 $!\n" \
3089 "pid 4790's current affinity mask: 7\n" \
3090 "pid 4790's new affinity mask: 1\n" \
3091 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3092 "pid 6671's current affinity mask: 1\n" \
3093 "pid 6671's new affinity mask: 1\n" \
3094 "$ taskset -p 1\n"
3095 "pid 1's current affinity mask: 3\n"
3096
Eric Andersen7e9276b2001-02-22 01:15:47 +00003097#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003098 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003099#define tee_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003100 "Copy standard input to each FILE, and also to standard output.\n\n" \
3101 "Options:\n" \
3102 " -a append to the given FILEs, do not overwrite\n" \
3103 " -i ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003104#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003105 "$ echo \"Hello\" | tee /tmp/foo\n" \
3106 "$ cat /tmp/foo\n" \
3107 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003108
Eric Andersen539ffc92004-02-22 12:25:47 +00003109#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
3110#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003111 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003112#define telnet_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003113 "Telnet is used to establish interactive communication with another\n" \
3114 "computer over a network using the TELNET protocol.\n\n" \
3115 "Options:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003116 " -a Attempt an automatic login with the USER variable\n" \
3117 " -l USER Attempt an automatic login with the USER argument\n" \
3118 " HOST The official name, alias or the IP address of the\n" \
3119 " remote host.\n" \
3120 " PORT The remote port number to connect to. If it is not\n" \
3121 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003122#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003123#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003124 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003125#define telnet_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003126 "Telnet is used to establish interactive communication with another\n" \
3127 "computer over a network using the TELNET protocol."
Eric Andersen539ffc92004-02-22 12:25:47 +00003128#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003129
Denis Vlasenko75f8d082006-11-22 15:54:52 +00003130#ifdef CONFIG_FEATURE_TELNETD_STANDALONE
Eric Andersen08a72202002-09-30 20:52:10 +00003131#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003132 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003133#define telnetd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003134 "Telnetd listens for incoming TELNET connections on PORT.\n" \
3135 "Options:\n" \
3136 " -p PORT listen for connections on PORT (default 23)\n" \
3137 " -l LOGIN exec LOGIN on connect\n" \
3138 " -f issue_file Display issue_file instead of /etc/issue\n" \
3139 " -F Foreground mode\n" \
3140 " -i Inetd mode"
Denis Vlasenko75f8d082006-11-22 15:54:52 +00003141#else
3142#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003143 "[OPTION]"
Denis Vlasenko75f8d082006-11-22 15:54:52 +00003144#define telnetd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003145 "Telnetd uses incoming TELNET connections via inetd.\n" \
3146 "Options:\n" \
3147 " -l LOGIN exec LOGIN on connect\n" \
3148 " -f issue_file Display issue_file instead of /etc/issue"
Glenn L McGrath4a4c6772003-02-15 11:50:33 +00003149#endif
Eric Andersen08a72202002-09-30 20:52:10 +00003150
Eric Andersen7e9276b2001-02-22 01:15:47 +00003151#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003152 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003153#define test_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003154 "Checks file types and compares values returning an exit\n" \
3155 "code determined by the value of EXPRESSION."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003156#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003157 "$ test 1 -eq 2\n" \
3158 "$ echo $?\n" \
3159 "1\n" \
3160 "$ test 1 -eq 1\n" \
3161 "$ echo $?\n" \
3162 "0\n" \
3163 "$ [ -d /etc ]\n" \
3164 "$ echo $?\n" \
3165 "0\n" \
3166 "$ [ -d /junk ]\n" \
3167 "$ echo $?\n" \
3168 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003169
Mark Whitley450736c2001-03-02 19:08:50 +00003170#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003171 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003172#define tftp_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003173 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
3174 "Options:\n" \
3175 " -l FILE Local FILE\n" \
3176 " -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003177 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003178 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003179 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003180 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003181 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003182 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003183 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003184 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003185 )
Eric Andersenc3657422001-11-30 07:54:32 +00003186#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003187 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003188#define time_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003189 "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
3190 "COMMAND's resource usage information is displayed\n\n" \
3191 "Options:\n" \
3192 " -v Displays verbose resource usage information"
Mark Whitley450736c2001-03-02 19:08:50 +00003193
Eric Andersen420b2082002-09-17 22:14:58 +00003194#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003195 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003196#define top_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003197 "top provides a view of process activity in real time.\n" \
3198 "It reads the status of all processes from /proc each <seconds>\n" \
3199 "and shows the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003200
Eric Andersen7e9276b2001-02-22 01:15:47 +00003201#define touch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003202 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003203#define touch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003204 "Update the last-modified date on the given FILE[s].\n\n" \
3205 "Options:\n" \
3206 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003207#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003208 "$ ls -l /tmp/foo\n" \
3209 "/bin/ls: /tmp/foo: No such file or directory\n" \
3210 "$ touch /tmp/foo\n" \
3211 "$ ls -l /tmp/foo\n" \
3212 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003213
3214#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003215 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003216#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003217 "Translate, squeeze, and/or delete characters from\n" \
3218 "standard input, writing to standard output.\n\n" \
3219 "Options:\n" \
3220 " -c take complement of STRING1\n" \
3221 " -d delete input characters coded STRING1\n" \
3222 " -s squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003223#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003224 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3225 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003226
Eric Andersen5c58d282001-07-10 16:29:00 +00003227#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003228 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3229 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3230 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003231#define traceroute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003232 "trace the route ip packets follow going to \"host\"\n" \
3233 "Options:\n" \
3234 " -F Set the don't fragment bit\n" \
3235 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3236 " -l Display the ttl value of the returned packet\n" \
3237 " -d Set SO_DEBUG options to socket\n" \
3238 " -n Print hop addresses numerically rather than symbolically\n" \
3239 " -r Bypass the normal routing tables and send directly to a host\n" \
3240 " -v Verbose output\n" \
3241 " -m max_ttl Set the max time-to-live (max number of hops)\n" \
3242 " -p port# Set the base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003243 " (default is 33434)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003244 " -q nqueries Set the number of probes per 'ttl' to nqueries\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003245 " (default is 3)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003246 " -s src_addr Use the following IP address as the source address\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003247 " -t tos Set the type-of-service in probe packets to the following value\n" \
3248 " (default 0)\n" \
3249 " -w wait Set the time (in seconds) to wait for a response to a probe\n" \
3250 " (default 3 sec)\n" \
3251 " -g Specify a loose source route gateway (8 maximum)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003252
3253
Eric Andersen7e9276b2001-02-22 01:15:47 +00003254#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003255 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003256#define true_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003257 "Return an exit code of TRUE (0)."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003258#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003259 "$ true\n" \
3260 "$ echo $?\n" \
3261 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003262
Eric Andersen7e9276b2001-02-22 01:15:47 +00003263#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003264 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003265#define tty_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003266 "Print the file name of the terminal connected to standard input.\n\n" \
3267 "Options:\n" \
3268 " -s print nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003269#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003270 "$ tty\n" \
3271 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003272
Mike Frysinger174808c2005-06-11 01:14:09 +00003273#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003274 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3275 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3276 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3277 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3278 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3279 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003280#define tune2fs_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003281 "Adjust filesystem options on ext[23] filesystems."
Mike Frysinger174808c2005-06-11 01:14:09 +00003282
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003283#define udhcpc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003284 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003285#define udhcpc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003286 " -V,--vendorclass=CLASSID Set vendor class identifier\n" \
3287 " -i,--interface=INTERFACE Interface to use (default: eth0)\n" \
3288 " -H,-h,--hostname=HOSTNAME Client hostname\n" \
3289 " -c,--clientid=CLIENTID Set client identifier\n" \
3290 " -C,--clientid-none Suppress default client identifier\n" \
3291 " -p,--pidfile=file Store process ID of daemon in file\n" \
3292 " -r,--request=IP IP address to request (default: none)\n" \
3293 " -s,--script=file Run file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
3294 " -t,--retries=NUM Send up to NUM request packets\n"\
3295 " -f,--foreground Do not fork after getting lease\n" \
3296 " -b,--background Fork to background if lease cannot be immediately negotiated\n" \
3297 " -n,--now Exit with failure if lease cannot be immediately negotiated\n" \
3298 " -q,--quit Quit after obtaining lease\n" \
3299 " -R,--release Release IP on quit\n" \
3300 " -v,--version Display version" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003301
Russ Dill61fb4892002-10-14 21:41:28 +00003302#define udhcpd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003303 "[configfile]\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00003304
3305#define udhcpd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003306 ""
Russ Dill61fb4892002-10-14 21:41:28 +00003307
Eric Andersen7e9276b2001-02-22 01:15:47 +00003308#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003309 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003310#define umount_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003311 "Unmount file systems\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003312 "\nFlags:" \
3313 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
3314 USE_FEATURE_MTAB_SUPPORT( \
3315 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003316 "\n -r Try to remount devices as read-only if mount is busy" \
3317 "\n -l Lazy umount (detach filesystem)" \
3318 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003319 USE_FEATURE_MOUNT_LOOP( \
3320 "\n -D Do not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003321#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003322 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003323
3324#define uname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003325 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003326#define uname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003327 "Print certain system information. With no OPTION, same as -s.\n\n" \
3328 "Options:\n" \
3329 " -a print all information\n" \
3330 " -m the machine (hardware) type\n" \
3331 " -n print the machine's network node hostname\n" \
3332 " -r print the operating system release\n" \
3333 " -s print the operating system name\n" \
3334 " -p print the host processor type\n" \
3335 " -v print the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003336#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003337 "$ uname -a\n" \
3338 "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 +00003339
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003340#define uncompress_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003341 "[-c] [-f] [ name ... ]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003342#define uncompress_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003343 "Uncompress .Z file[s]\n" \
3344 "Options:\n" \
3345 " -c extract to stdout\n" \
3346 " -f force overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003347
Eric Andersen7e9276b2001-02-22 01:15:47 +00003348#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003349 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003350#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003351 "Discard all but one of successive identical lines from INPUT\n" \
3352 "(or standard input), writing to OUTPUT (or standard output).\n\n" \
3353 "Options:\n" \
3354 " -c prefix lines by the number of occurrences\n" \
3355 " -d only print duplicate lines\n" \
3356 " -u only print unique lines\n" \
3357 " -f N skip the first N fields\n" \
3358 " -s N skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003359#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003360 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3361 "a\n" \
3362 "b\n" \
3363 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003364
3365#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003366 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003367#define unix2dos_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003368 "Converts FILE from unix format to dos format. When no option\n" \
3369 "is given, the input is converted to the opposite output format.\n" \
3370 "When no file is given, uses stdin for input and stdout for output.\n" \
3371 "Options:\n" \
3372 " -u output will be in UNIX format\n" \
3373 " -d output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003374
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003375#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003376 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003377#define unzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003378 "Extracts files from ZIP archives.\n\n" \
3379 "Options:\n" \
3380 " -l list archive contents (short form)\n" \
3381 " -n never overwrite existing files (default)\n" \
3382 " -o overwrite files without prompting\n" \
3383 " -p send output to stdout\n" \
3384 " -q be quiet\n" \
3385 " -x exclude these files\n" \
3386 " -d extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003387
Eric Andersen7e9276b2001-02-22 01:15:47 +00003388#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003389 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003390#define uptime_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003391 "Display the time since the last boot."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003392#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003393 "$ uptime\n" \
3394 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003395
3396#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003397 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003398#define usleep_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003399 "Pause for N microseconds."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003400#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003401 "$ usleep 1000000\n" \
3402 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003403
3404#define uudecode_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003405 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003406#define uudecode_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003407 "Uudecode a file that is uuencoded.\n\n" \
3408 "Options:\n" \
3409 " -o FILE direct output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003410#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003411 "$ uudecode -o busybox busybox.uu\n" \
3412 "$ ls -l busybox\n" \
3413 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003414
3415#define uuencode_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003416 "[OPTION] [INFILE] REMOTEFILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003417#define uuencode_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003418 "Uuencode a file.\n\n" \
3419 "Options:\n" \
3420 " -m use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003421#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003422 "$ uuencode busybox busybox\n" \
3423 "begin 755 busybox\n" \
3424 "<encoded file snipped>\n" \
3425 "$ uudecode busybox busybox > busybox.uu\n" \
3426 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003427
Eric Andersen853c4942003-01-23 05:59:32 +00003428#define vconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003429 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003430#define vconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003431 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
3432 "Options:\n" \
3433 " add [interface-name] [vlan_id]\n" \
3434 " rem [vlan-name]\n" \
3435 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
3436 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3437 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3438 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003439
Eric Andersen3f980402001-04-04 17:31:15 +00003440#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003441 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00003442#define vi_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003443 "edit FILE.\n\n" \
3444 "Options:\n" \
3445 " -R Read-only- do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003446
Eric Andersen27f64e12002-06-23 04:24:25 +00003447#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003448 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003449#define vlock_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003450 "Lock a virtual terminal. A password is required to unlock\n" \
3451 "Options:\n" \
3452 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00003453
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003454#define watch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003455 "[-n <seconds>] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003456#define watch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003457 "Executes a program periodically\n\n" \
3458 "Options:\n" \
3459 " -n Loop period in seconds - default is 2\n"
3460 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003461#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003462 "$ watch date\n" \
3463 "Mon Dec 17 10:31:40 GMT 2000\n" \
3464 "Mon Dec 17 10:31:42 GMT 2000\n" \
3465 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003466
Eric Andersen7e9276b2001-02-22 01:15:47 +00003467#define watchdog_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003468 "[-t <seconds>] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003469#define watchdog_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003470 "Periodically write to watchdog device DEV.\n" \
3471 "Options:\n" \
3472 " -t Timer period in seconds - default is 30\n" \
3473 " -F Stay in the foreground and don't fork"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003474
3475#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003476 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003477#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003478 "Print line, word, and byte counts for each FILE, and a total line if\n" \
3479 "more than one FILE is specified. With no FILE, read standard input.\n\n" \
3480 "Options:\n" \
3481 " -c print the byte counts\n" \
3482 " -l print the newline counts\n" \
3483 " -L print the length of the longest line\n" \
3484 " -w print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003485#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003486 "$ wc /etc/passwd\n" \
3487 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003488
3489#define wget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003490 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
3491 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
3492 " [-U|--user-agent agent] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003493#define wget_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003494 "wget retrieves files via HTTP or FTP\n\n" \
3495 "Options:\n" \
3496 " -c continue retrieval of aborted transfers\n" \
3497 " -q quiet mode - do not print\n" \
3498 " -P Set directory prefix to DIR\n" \
3499 " -O save to filename ('-' for stdout)\n" \
3500 " -U adjust 'User-Agent' field\n" \
3501 " -Y use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003502
3503#define which_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003504 "[COMMAND ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003505#define which_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003506 "Locates a COMMAND."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003507#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003508 "$ which login\n" \
3509 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003510
Eric Andersen00a6a752002-04-26 23:53:10 +00003511#define who_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003512 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003513#define who_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003514 "Prints the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003515
3516#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003517 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003518#define whoami_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003519 "Prints the user name associated with the current effective user id."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003520
3521#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003522 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003523#define xargs_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003524 "Executes COMMAND on every item given by standard input.\n\n" \
3525 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003526 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
3527 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003528 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003529 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
3530 " -x Exit if the size is exceeded\n") \
3531 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
3532 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003533 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003534#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003535 "$ ls | xargs gzip\n" \
3536 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003537
3538#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003539 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003540#define yes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003541 "Repeatedly outputs a line with all specified STRING(s), or 'y'."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003542
Eric Andersen7e9276b2001-02-22 01:15:47 +00003543#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003544 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003545#define zcat_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003546 "Uncompress to stdout."
Eric Andersen178de172004-04-06 16:36:20 +00003547
Rob Landleyad8071f2005-04-30 03:49:37 +00003548#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003549 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00003550#define zcip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003551 "zcip manages a ZeroConf IPv4 link-local address.\n" \
3552 "Options:\n" \
3553 " -f foreground mode\n" \
3554 " -q quit after address (no daemon)\n" \
3555 " -r 169.254.x.x request this address first\n" \
3556 " -v verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00003557
Eric Andersen178de172004-04-06 16:36:20 +00003558#endif /* __BB_USAGE_H__ */