blob: 5ec15fd10e71dd158972dc65ac9b33d50f22934c [file] [log] [blame]
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001/* vi: set sw=8 ts=8: */
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +00002/*
3 * This file suffers from chronically incorrect tabification
4 * of messages. Before editing this file:
5 * 1. Switch you editor to 8-space tab mode.
6 * 2. Do not use \t in messages, use real tab character.
7 * 3. Start each source line with message as follows:
Denis Vlasenko1fffe382006-11-28 00:06:39 +00008 * |<7 spaces>"text with tabs"....
Denis Vlasenkoe2d3ded2006-11-27 23:43:28 +00009 */
10
Eric Andersen178de172004-04-06 16:36:20 +000011#ifndef __BB_USAGE_H__
12#define __BB_USAGE_H__
13
Eric Andersenf349e972001-08-21 16:18:59 +000014#define addgroup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000015 "[-g GID] group_name [user_name]"
Eric Andersenf349e972001-08-21 16:18:59 +000016#define addgroup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +000017 "Add a group to the system" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000018 "\n\nOptions:\n" \
Denis 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 Vlasenko7a50a642006-12-24 17:40:16 +000024 "Add a user to the system" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000025 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000026 " -h DIR Assign home directory DIR\n" \
27 " -g GECOS Assign gecos field GECOS\n" \
28 " -s SHELL Assign login shell SHELL\n" \
29 " -G Add the user to existing group GROUP\n" \
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 Vlasenko7a50a642006-12-24 17:40:16 +000037 "Read and optionally set system timebase parameters.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +000038 "See adjtimex(2)." \
39 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000040 " -q quiet mode - do not print\n" \
41 " -o offset time offset, microseconds\n" \
42 " -f frequency frequency adjust, integer kernel units (65536 is 1ppm)\n" \
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 Vlasenko765996a2006-12-24 16:59:27 +000050 "Extract or list FILES from an ar archive" \
51 "\n\nOptions:\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 Vlasenko765996a2006-12-24 16:59:27 +000061 "Ping hosts by ARP requests/replies" \
62 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +000063 " -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 Vlasenko7a50a642006-12-24 17:40:16 +000092 "Strip directory path and suffixes from FILE.\n" \
93 "If specified, also remove 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 Vlasenko765996a2006-12-24 16:59:27 +0000105 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
106 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000107 " -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 Vlasenko7a50a642006-12-24 17:40:16 +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 Vlasenko765996a2006-12-24 16:59:27 +0000121 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
122 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000123 " -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 Vlasenko7a50a642006-12-24 17:40:16 +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 Vlasenko765996a2006-12-24 16:59:27 +0000134 "Display a calendar" \
135 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000136 " -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 Vlasenko7a50a642006-12-24 17:40:16 +0000142 "Concatenate FILE(s) and print them to stdout" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000143 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000144 " -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 Vlasenko765996a2006-12-24 16:59:27 +0000152 "Display nonprinting characters as ^x or M-x" \
153 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000154 " -e End each line with $\n" \
155 " -t Show tabs as ^I\n" \
156 " -v Don't use ^x or M-x escapes."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000157#define chattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000158 "[-R] [-+=AacDdijsStTu] [-v version] files..."
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000159#define chattr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000160 "Change file attributes on an ext2 fs\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000161 "Modifiers:\n" \
162 " - remove attributes\n" \
163 " + add attributes\n" \
164 " = set attributes\n" \
165 "Attributes:\n" \
166 " A don't track atime\n" \
167 " a append mode only\n" \
168 " c enable compress\n" \
169 " D write dir contents synchronously\n" \
170 " d do not backup with dump\n" \
171 " i cannot be modified (immutable)\n" \
172 " j write all data to journal first\n" \
173 " s zero disk storage when deleted\n" \
174 " S write file contents synchronously\n" \
175 " t disable tail-merging of partial blocks with other files\n" \
176 " u allow file to be undeleted\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000177 " Options:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000178 " -R recursively list subdirectories\n" \
179 " -v set the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +0000180
Eric Andersen7e9276b2001-02-22 01:15:47 +0000181#define chgrp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000182 "[-Rh"USE_DESKTOP("cvf")"]... GROUP FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000183#define chgrp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000184 "Change the group membership of each FILE to GROUP" \
185 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000186 " -R Changes files and directories recursively\n" \
187 " -h Do not dereference symbolic links" \
Denis Vlasenkoe80e2a32006-10-27 23:28:38 +0000188 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000189 "\n -c List changed files" \
190 "\n -v List all files" \
191 "\n -f Hide errors" \
Denis Vlasenkoe80e2a32006-10-27 23:28:38 +0000192 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000193#define chgrp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000194 "$ ls -l /tmp/foo\n" \
195 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
196 "$ chgrp root /tmp/foo\n" \
197 "$ ls -l /tmp/foo\n" \
198 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000199
Eric Andersen7e9276b2001-02-22 01:15:47 +0000200#define chmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000201 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000202#define chmod_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000203 "Each MODE is one or more of the letters ugoa, one of the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000204 "symbols +-= and one or more of the letters rwxst" \
205 "\n\nOptions:" \
206 "\n -R Changes files and directories recursively" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000207 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000208 "\n -c List changed files" \
209 "\n -v List all files" \
210 "\n -f Hide errors" \
Denis Vlasenkofefb2792006-10-27 15:13:54 +0000211 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000212#define chmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000213 "$ ls -l /tmp/foo\n" \
214 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
215 "$ chmod u+x /tmp/foo\n" \
216 "$ ls -l /tmp/foo\n" \
217 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
218 "$ chmod 444 /tmp/foo\n" \
219 "$ ls -l /tmp/foo\n" \
220 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000221
Eric Andersen7e9276b2001-02-22 01:15:47 +0000222#define chown_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000223 "[-Rh"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000224#define chown_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000225 "Change the owner and/or group of each FILE to OWNER and/or GROUP" \
226 "\n\nOptions:" \
227 "\n -R Changes files and directories recursively" \
228 "\n -h Do not dereference symbolic links" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000229 USE_DESKTOP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000230 "\n -c List changed files" \
231 "\n -v List all files" \
232 "\n -f Hide errors" \
Denis Vlasenko51b4c922006-10-27 16:07:20 +0000233 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000234#define chown_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000235 "$ ls -l /tmp/foo\n" \
236 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
237 "$ chown root /tmp/foo\n" \
238 "$ ls -l /tmp/foo\n" \
239 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
240 "$ chown root.root /tmp/foo\n" \
241 "ls -l /tmp/foo\n" \
242 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000243
Denis Vlasenkofe544582006-10-03 15:57:40 +0000244#define chpst_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000245 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
246 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
247 "[-p processes] [-f bytes] [-c bytes] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000248#define chpst_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000249 "Change the process state and run specified program" \
250 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000251 " -u user[:grp] set uid and gid\n" \
252 " -U user[:grp] set environment variables UID and GID\n" \
253 " -e dir set environment variables as specified by files\n" \
254 " in the directory: file=1st_line_of_file\n" \
255 " -/ dir chroot to dir\n" \
256 " -n inc add inc to nice value\n" \
257 " -m bytes limit data segment, stack segment, locked physical pages,\n" \
258 " and total of all segment per process to bytes bytes each\n" \
259 " -d bytes limit data segment\n" \
260 " -o n limit the number of open file descriptors per process to n\n" \
261 " -p n limit number of processes per uid to n\n" \
262 " -f bytes limit output file size to bytes bytes\n" \
263 " -c bytes limit core file size to bytes bytes\n" \
264 " -v verbose\n" \
265 " -P run prog in a new process group\n" \
266 " -0 close standard input\n" \
267 " -1 close standard output\n" \
268 " -2 close standard error"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000269#define setuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000270 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000271#define setuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000272 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
273 "groups, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000274#define envuidgid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000275 "account prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000276#define envuidgid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000277 "Set $UID to account's uid and $GID to account's gid, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000278#define envdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000279 "dir prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000280#define envdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000281 "Set various environment variables as specified by files\n" \
282 "in the directory dir, then run prog"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000283#define softlimit_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000284 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
285 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
286 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000287#define softlimit_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000288 "Set soft resource limits, then run prog" \
289 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000290 " -m n Same as -d n -s n -l n -a n\n" \
291 " -d n Limit the data segment per process to n bytes\n" \
292 " -s n Limit the stack segment per process to n bytes\n" \
293 " -l n Limit the locked physical pages per process to n bytes\n" \
294 " -a n Limit the total of all segments per process to n bytes\n" \
295 " -o n Limit the number of open file descriptors per process to n\n" \
296 " -p n Limit the number of processes per uid to n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000297 "Options controlling file sizes:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000298 " -f n Limit output file sizes to n bytes\n" \
299 " -c n Limit core file sizes to n bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000300 "Efficiency opts:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000301 " -r n Limit the resident set size to n bytes. This limit is not\n" \
302 " enforced unless physical memory is full\n" \
303 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
304 " except that the process receives a SIGXCPU signal after n seconds\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000305 "\n" \
306 "Some options may have no effect on some operating systems\n" \
307 "n may be =, indicating that soft limit should be set equal to hard limit"
Denis Vlasenkofe544582006-10-03 15:57:40 +0000308
Eric Andersen7e9276b2001-02-22 01:15:47 +0000309#define chroot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000310 "NEWROOT [COMMAND...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000311#define chroot_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000312 "Run COMMAND with root directory set to NEWROOT"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000313#define chroot_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000314 "$ ls -l /bin/ls\n" \
315 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
316 "# mount /dev/hdc1 /mnt -t minix\n" \
317 "# chroot /mnt\n" \
318 "# ls -l /bin/ls\n" \
319 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000320
Eric Andersen7e9276b2001-02-22 01:15:47 +0000321#define chvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000322 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000323#define chvt_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000324 "Change the foreground virtual terminal to /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000325
Rob Landley856489b2006-04-18 20:57:28 +0000326#define cksum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000327 "FILES..."
Rob Landley856489b2006-04-18 20:57:28 +0000328#define cksum_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000329 "Calculate the CRC32 checksums of FILES"
Rob Landley856489b2006-04-18 20:57:28 +0000330
Eric Andersen7e9276b2001-02-22 01:15:47 +0000331#define clear_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000332 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000333#define clear_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000334 "Clear screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000335
Eric Andersen7e9276b2001-02-22 01:15:47 +0000336#define cmp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000337 "[-l] [-s] FILE1 [FILE2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000338#define cmp_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000339 "Compares FILE1 vs stdin if FILE2 is not specified" \
340 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000341 " -l Write the byte numbers (decimal) and values (octal)\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000342 " for all differing bytes\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000343 " -s quiet mode - do not print"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000344
Rob Landley2acfd7b2005-05-11 23:12:49 +0000345#define comm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000346 "[-123] FILE1 FILE2"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000347#define comm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000348 "Compare FILE1 to FILE2, or to stdin if - is specified" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000349 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000350 " -1 Suppress lines unique to FILE1\n" \
351 " -2 Suppress lines unique to FILE2\n" \
352 " -3 Suppress lines common to both files"
Rob Landley2acfd7b2005-05-11 23:12:49 +0000353
Paul Fox79c142d2005-08-01 16:04:40 +0000354#define bbconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000355 ""
Paul Fox79c142d2005-08-01 16:04:40 +0000356#define bbconfig_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000357 "Print the config file which built busybox"
Mike Frysinger036f2992005-09-24 23:50:14 +0000358
Rob Landley69674942006-09-11 00:34:01 +0000359#define bbsh_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000360 "[FILE]...\n" \
361 "or: bbsh -c command [args]..."
Rob Landley69674942006-09-11 00:34:01 +0000362#define bbsh_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000363 "The bbsh shell (command interpreter)"
Rob Landley69674942006-09-11 00:34:01 +0000364
Eric Andersen7e9276b2001-02-22 01:15:47 +0000365#define cp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000366 "[OPTION]... SOURCE DEST"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000367#define cp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000368 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY" \
369 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000370 " -a Same as -dpR\n" \
371 " -d,-P Preserve links\n" \
372 " -H,-L Dereference all symlinks (implied by default)\n" \
373 " -p Preserve file attributes if possible\n" \
374 " -f force, overwrite\n" \
375 " -i interactive, prompt before overwrite\n" \
376 " -R,-r Copy directories recursively\n" \
377 " -l,-s Create (sym)links"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000378
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000379#define cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000380 "-[dimtuv][F cpiofile]"
Glenn L McGrath8f5b63e2001-06-22 09:22:06 +0000381#define cpio_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000382 "Extract or list files from a cpio archive\n" \
383 "Main operation mode:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000384 " d make leading directories\n" \
385 " i extract\n" \
386 " m preserve mtime\n" \
387 " t list\n" \
388 " v verbose\n" \
389 " u unconditional overwrite\n" \
390 " F input from file"
Tim Riker7b253f82003-12-28 05:02:40 +0000391
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000392#define crond_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000393 "-d[#] -c <crondir> -f -b"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000394#define crond_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000395 " -d [#] -l [#] -S -L logfile -f -b -c dir\n" \
396 " -d num debug level\n" \
397 " -l num log level (8 - default)\n" \
398 " -S log to syslogd (default)\n" \
399 " -L file log to file\n" \
400 " -f run in foreground\n" \
401 " -b run in background (default)\n" \
402 " -c dir working dir"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000403
404#define crontab_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000405 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000406#define crontab_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000407 " file <opts> replace crontab from file\n" \
408 " - <opts> replace crontab from stdin\n" \
409 " -u user specify user\n" \
410 " -l [user] list crontab for user\n" \
411 " -e [user] edit crontab for user\n" \
412 " -d [user] delete crontab for user\n" \
413 " -c dir specify crontab directory"
Eric Andersenf6f7bfb2002-10-22 12:24:59 +0000414
415
Eric Andersen7e9276b2001-02-22 01:15:47 +0000416#define cut_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000417 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000418#define cut_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000419 "Print selected fields from each input FILE to standard output" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000420 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000421 " -b LIST Output only bytes from LIST\n" \
422 " -c LIST Output only characters from LIST\n" \
423 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
424 " -s Output only the lines containing delimiter\n" \
425 " -f N Print only these fields\n" \
426 " -n Ignored"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000427#define cut_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000428 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
429 "Hello\n" \
430 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
431 "world\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000432
Eric Andersen7e9276b2001-02-22 01:15:47 +0000433#define date_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000434 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000435#define date_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000436 "Display current time in the given FORMAT, or set system date" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000437 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000438 " -R Outputs RFC-822 compliant date string\n" \
439 " -d STRING Displays time described by STRING, not 'now'\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000440 USE_FEATURE_DATE_ISOFMT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000441 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
442 " TIMESPEC='date' (or missing) for date only,\n" \
443 " 'hours', 'minutes', or 'seconds' for date and,\n" \
444 " time to the indicated precision\n" \
445 " -D hint Use 'hint' as date format, via strptime()\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000446 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000447 " -s Sets time described by STRING\n" \
448 " -r FILE Displays the last modification time of FILE\n" \
449 " -u Prints or sets Coordinated Universal Time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000450#define date_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000451 "$ date\n" \
452 "Wed Apr 12 18:52:41 MDT 2000\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000453
Eric Andersen7e9276b2001-02-22 01:15:47 +0000454#define dc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000455 "expression ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000456#define dc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000457 "This is a Tiny RPN calculator that understands the\n" \
458 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
459 "**, exp, and, or, not, eor.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000460 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
461 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000462 "p - Prints the value on the top of the stack, without altering the stack\n" \
463 "f - Prints the entire contents of the stack without altering anything\n" \
464 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
465 " Only 10 and 16 are supported"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000466#define dc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000467 "$ dc 2 2 + p\n" \
468 "4\n" \
469 "$ dc 8 8 \\* 2 2 + / p\n" \
470 "16\n" \
471 "$ dc 0 1 and p\n" \
472 "0\n" \
473 "$ dc 0 1 or p\n" \
474 "1\n" \
475 "$ echo 72 9 div 8 mul p | dc\n" \
476 "64\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000477
Eric Andersen7e9276b2001-02-22 01:15:47 +0000478#define dd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000479 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
480 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
Eric Andersen7e9276b2001-02-22 01:15:47 +0000481#define dd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000482 "Copy a file with converting and formatting" \
483 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000484 " if=FILE read from FILE instead of stdin\n" \
485 " of=FILE write to FILE instead of stdout\n" \
486 " bs=N read and write N bytes at a time\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000487 USE_FEATURE_DD_IBS_OBS( \
488 " ibs=N read N bytes at a time\n") \
489 USE_FEATURE_DD_IBS_OBS( \
490 " obs=N write N bytes at a time\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000491 " count=N copy only N input blocks\n" \
492 " skip=N skip N input blocks\n" \
493 " seek=N skip N output blocks\n" \
Rob Landley2686d3b2006-05-16 16:52:12 +0000494 USE_FEATURE_DD_IBS_OBS( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000495 " conv=notrunc don't truncate output file\n" \
496 " conv=noerror continue after read errors\n" \
497 " conv=sync pad blocks with zeros\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000498 "\n" \
499 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
500 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000501#define dd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000502 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
503 "4+0 records in\n" \
504 "4+0 records out\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000505
Eric Andersen7e9276b2001-02-22 01:15:47 +0000506#define deallocvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000507 "[N]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000508#define deallocvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000509 "Deallocate unused virtual terminal /dev/ttyN"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000510
Eric Andersenf349e972001-08-21 16:18:59 +0000511#define delgroup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000512 "GROUP"
Eric Andersenf349e972001-08-21 16:18:59 +0000513#define delgroup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000514 "Delete group GROUP from the system"
Eric Andersenf349e972001-08-21 16:18:59 +0000515
516#define deluser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000517 "USER"
Eric Andersenf349e972001-08-21 16:18:59 +0000518#define deluser_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000519 "Delete user USER from the system"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000520
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000521#define devfsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000522 "mntpnt [-v]" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000523 USE_DEVFSD_FG_NP("[-fg][-np]" )
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000524#define devfsd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000525 "Manage devfs permissions and old device name symlinks" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000526 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000527 "\n mntpnt The mount point where devfs is mounted." \
528 "\n -v Print the protocol version numbers for devfsd." \
529 "\n and the kernel-side protocol version and exits." \
530 USE_DEVFSD_FG_NP( \
531 "\n -fg Run the daemon in the foreground." \
532 "\n -np Exit after parsing the configuration file" \
533 "\n and processing synthetic REGISTER events." \
534 "\n Do not poll for events.")
Glenn L McGrath17d21fa2003-10-09 11:46:23 +0000535
Eric Andersen7e9276b2001-02-22 01:15:47 +0000536#define df_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000537 "[-" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILESYSTEM ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000538#define df_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000539 "Print the filesystem space used and space available" \
540 "\n\nOptions:\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000541 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000542 "\n -h print sizes in human readable format (e.g., 1K 243M 2G )\n" \
543 " -m print sizes in megabytes\n" \
544 " -k print sizes in kilobytes(default)") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000545 SKIP_FEATURE_HUMAN_READABLE( \
546 "\n -k ignored")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000547#define df_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000548 "$ df\n" \
549 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
550 "/dev/sda3 8690864 8553540 137324 98% /\n" \
551 "/dev/sda1 64216 36364 27852 57% /boot\n" \
552 "$ df /dev/sda3\n" \
553 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
554 "/dev/sda3 8690864 8553540 137324 98% /\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000555
Denis Vlasenko736230e2006-11-20 19:40:36 +0000556#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000557 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000558#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000559 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000560
561#define dhcprelay_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000562 "[client_device_list] [server_device]"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000563#define dhcprelay_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000564 "Relay dhcp requests from client devices to server device"
Denis Vlasenko736230e2006-11-20 19:40:36 +0000565
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000566#define diff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000567 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000568#define diff_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000569 "Compare files line by line and output the differences between them.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000570 "This diff implementation only supports unified diffs." \
571 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000572 " -a Treat all files as text\n" \
573 " -b Ignore changes in the amount of whitespace\n" \
574 " -d Try hard to find a smaller set of changes\n" \
575 " -i Ignore case differences\n" \
576 " -L Use LABEL instead of the filename in the unified header\n" \
577 " -N Treat absent files as empty\n" \
578 " -q Output only whether files differ\n" \
579 " -r Recursively compare any subdirectories\n" \
580 " -S Start with FILE when comparing directories\n" \
581 " -T Make tabs line up by prefixing a tab when necessary\n" \
582 " -s Report when two files are the same\n" \
583 " -t Expand tabs to spaces in output\n" \
584 " -U Output LINES lines of context\n" \
585 " -w Ignore all whitespace\n"
Bernhard Reutner-Fischer8f7d3892006-04-06 08:11:08 +0000586
Eric Andersen7e9276b2001-02-22 01:15:47 +0000587#define dirname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000588 "FILENAME"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000589#define dirname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000590 "Strip non-directory suffix from FILENAME"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000591#define dirname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000592 "$ dirname /tmp/foo\n" \
593 "/tmp\n" \
594 "$ dirname /tmp/foo/\n" \
595 "/tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000596
Eric Andersen7e9276b2001-02-22 01:15:47 +0000597#define dmesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000598 "[-c] [-n LEVEL] [-s SIZE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000599#define dmesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000600 "Print or control the kernel ring buffer" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000601 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000602 " -c Clears the ring buffer's contents after printing\n" \
603 " -n LEVEL Sets console logging level\n" \
604 " -s SIZE Use a buffer of size SIZE"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000605
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000606#define dnsd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000607 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000608#define dnsd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000609 "Small and static DNS server daemon" \
610 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000611 " -c config filename\n" \
612 " -t TTL in seconds\n" \
613 " -p listening port\n" \
614 " -i listening iface ip (default all)\n" \
615 " -d daemonize"
"Vladimir N. Oleynik"7b4aa6f2006-01-25 14:19:11 +0000616
Eric Andersen7e9276b2001-02-22 01:15:47 +0000617#define dos2unix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000618 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000619#define dos2unix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000620 "Convert FILE from dos format to unix format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000621 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000622 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000623 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000624 " -u output will be in UNIX format\n" \
625 " -d output will be in DOS format"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000626
Eric Andersen7e9276b2001-02-22 01:15:47 +0000627#define dpkg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000628 "[-ilCPru] [-F option] package_name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000629#define dpkg_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000630 "Install, remove and manage Debian packages" \
631 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000632 " -i Install the package\n" \
633 " -l List of installed packages\n" \
634 " -C Configure an unpackaged package\n" \
635 " -F depends Ignore dependency problems\n" \
636 " -P Purge all files of a package\n" \
637 " -r Remove all but the configuration files for a package\n" \
638 " -u Unpack a package, but don't configure it"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000639
Eric Andersen7e9276b2001-02-22 01:15:47 +0000640#define dpkg_deb_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000641 "[-cefxX] FILE [argument]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000642#define dpkg_deb_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000643 "Perform actions on Debian packages (.debs)" \
644 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000645 " -c List contents of filesystem tree\n" \
646 " -e Extract control files to [argument] directory\n" \
647 " -f Display control field name starting with [argument]\n" \
648 " -x Extract packages filesystem tree to directory\n" \
649 " -X Verbose extract"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000650#define dpkg_deb_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000651 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000652
Eric Andersen7e9276b2001-02-22 01:15:47 +0000653#define du_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000654 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000655#define du_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000656 "Summarize disk space used for each FILE and/or directory.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000657 "Disk space is printed in units of " \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000658 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
659 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000660 " bytes." \
661 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000662 " -a show sizes of files in addition to directories\n" \
663 " -H follow symbolic links that are FILE command line args\n" \
664 " -L follow all symbolic links encountered\n" \
665 " -d N limit output to directories (and files with -a) of depth < N\n" \
666 " -c output a grand total\n" \
667 " -l count sizes many times if hard linked\n" \
668 " -s display only a total for each argument\n" \
669 " -x skip directories on different filesystems\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000670 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +0000671 " -h print sizes in human readable format (e.g., 1K 243M 2G )\n" \
672 " -m print sizes in megabytes\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000673 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000674 " -k print sizes in kilobytes" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000675 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000676#define du_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000677 "$ du\n" \
678 "16 ./CVS\n" \
679 "12 ./kernel-patches/CVS\n" \
680 "80 ./kernel-patches\n" \
681 "12 ./tests/CVS\n" \
682 "36 ./tests\n" \
683 "12 ./scripts/CVS\n" \
684 "16 ./scripts\n" \
685 "12 ./docs/CVS\n" \
686 "104 ./docs\n" \
687 "2417 .\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000688
Eric Andersen7e9276b2001-02-22 01:15:47 +0000689#define dumpkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000690 "> keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000691#define dumpkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000692 "Print out a binary keyboard translation table to standard output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000693#define dumpkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000694 "$ dumpkmap > keymap\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000695
Russ Dill61fb4892002-10-14 21:41:28 +0000696#define dumpleases_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000697 "[-r|-a] [-f LEASEFILE]"
Russ Dill61fb4892002-10-14 21:41:28 +0000698#define dumpleases_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000699 "Display DHCP leases granted by udhcpd" \
700 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000701 " -f, --file=FILENAME Leases file to load\n" \
702 " -r, --remaining Interpret lease times as time remaining\n" \
703 " -a, --absolute Interpret lease times as expire time"
Russ Dill61fb4892002-10-14 21:41:28 +0000704
Mike Frysinger51a43b42005-09-24 07:11:16 +0000705#define e2fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000706 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
707 "[-I inode_buffer_blocks] [-P process_inode_size] " \
708 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
709 "[-E extended-options] device"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000710#define e2fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000711 "Check ext2/ext3 file system" \
712 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000713 " -p Automatic repair (no questions)\n" \
714 " -n Make no changes to the filesystem\n" \
715 " -y Assume 'yes' to all questions\n" \
716 " -c Check for bad blocks and add them to the badblock list\n" \
717 " -f Force checking even if filesystem is marked clean\n" \
718 " -v Be verbose\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000719 " -b superblock Use alternative superblock\n" \
720 " -B blocksize Force blocksize when looking for superblock\n" \
721 " -j journal Set location of the external journal\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000722 " -l file Add to badblocks list\n" \
723 " -L file Set badblocks list"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000724
Eric Andersen7e9276b2001-02-22 01:15:47 +0000725#define echo_trivial_usage \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000726 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000727#define echo_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000728 "Print the specified ARGs to stdout" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000729 USE_FEATURE_FANCY_ECHO( \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000730 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000731 " -n suppress trailing newline\n" \
732 " -e interpret backslash-escaped characters (i.e., \\t=tab)\n" \
733 " -E disable interpretation of backslash-escaped characters" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000734 )
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000735#define echo_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000736 "$ echo \"Erik is cool\"\n" \
737 "Erik is cool\n" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +0000738 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000739 "Erik\n" \
740 "is\n" \
741 "cool\n" \
742 "$ echo \"Erik\\nis\\ncool\"\n" \
743 "Erik\\nis\\ncool\n")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000744
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000745#define eject_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000746 "[-t] [-T] [DEVICE]"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000747#define eject_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000748 "Eject specified DEVICE (or default /dev/cdrom)" \
749 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000750 " -t close tray\n" \
751 " -T open/close tray (toggle)"
Mike Frysinger55e2cf62005-05-11 00:25:47 +0000752
Rob Landley3b890392006-05-04 20:56:43 +0000753#define ed_trivial_usage ""
754#define ed_full_usage ""
755
Eric Andersen84e229c2001-03-29 22:48:33 +0000756#define env_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000757 "[-iu] [-] [name=value]... [command]"
Eric Andersen84e229c2001-03-29 22:48:33 +0000758#define env_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000759 "Print the current environment or run a program after setting\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000760 "up the specified environment" \
761 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000762 " -, -i start with an empty environment\n" \
763 " -u remove variable from the environment"
Eric Andersen84e229c2001-03-29 22:48:33 +0000764
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000765#define ether_wake_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000766 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000767#define ether_wake_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000768 "Send a magic packet to wake up sleeping machines.\n" \
769 "MAC must be a station address (00:11:22:33:44:55) or\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000770 "a hostname with a known 'ethers' entry." \
771 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000772 " -b Send wake-up packet to the broadcast address\n" \
773 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000774 " -p pass Append the four or six byte password PW to the packet"
Mike Frysingerb662f0d2005-05-11 03:59:53 +0000775
Eric Andersen7e9276b2001-02-22 01:15:47 +0000776#define expr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000777 "EXPRESSION"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000778#define expr_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000779 "Print the value of EXPRESSION to standard output.\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000780 "EXPRESSION may be:\n" \
781 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
782 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
783 " ARG1 < ARG2 ARG1 is less than ARG2\n" \
784 " ARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \
785 " ARG1 = ARG2 ARG1 is equal to ARG2\n" \
786 " ARG1 != ARG2 ARG1 is unequal to ARG2\n" \
787 " ARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \
788 " ARG1 > ARG2 ARG1 is greater than ARG2\n" \
789 " ARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \
790 " ARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \
791 " ARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \
792 " ARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \
793 " ARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000794 " STRING : REGEXP anchored pattern match of REGEXP in STRING\n" \
795 " match STRING REGEXP same as STRING : REGEXP\n" \
796 " substr STRING POS LENGTH substring of STRING, POS counted from 1\n" \
797 " index STRING CHARS index in STRING where any CHARS is found, or 0\n" \
798 " length STRING length of STRING\n" \
799 " quote TOKEN interpret TOKEN as a string, even if\n" \
800 " it is a keyword like 'match' or an\n" \
801 " operator like '/'\n" \
802 " (EXPRESSION) value of EXPRESSION\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000803 "Beware that many operators need to be escaped or quoted for shells.\n" \
804 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
805 "lexicographical. Pattern matches return the string matched between\n" \
806 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
807 "of characters matched or 0."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000808
Mike Frysingerfa69f112005-04-17 07:24:19 +0000809#define fakeidentd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000810 "[-b ip] [STRING]"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000811#define fakeidentd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000812 "Return a set string to auth requests" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000813 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000814 " -b Bind to ip address\n" \
815 " STRING The ident answer string (default is nobody)"
Mike Frysingerfa69f112005-04-17 07:24:19 +0000816
Eric Andersen7e9276b2001-02-22 01:15:47 +0000817#define false_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000818 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000819#define false_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000820 "Return an exit code of FALSE (1)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000821#define false_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000822 "$ false\n" \
823 "$ echo $?\n" \
824 "1\n"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000825
826#define fbset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000827 "[options] [mode]"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000828#define fbset_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000829 "Show and modify frame buffer settings"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000830#define fbset_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000831 "$ fbset\n" \
832 "mode \"1024x768-76\"\n" \
833 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
834 " geometry 1024 768 1024 768 16\n" \
835 " timings 12714 128 32 16 4 128 4\n" \
836 " accel false\n" \
837 " rgba 5/11,6/5,5/0,0/0\n" \
838 "endmode\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000839
Eric Andersen7e9276b2001-02-22 01:15:47 +0000840#define fdflush_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000841 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000842#define fdflush_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000843 "Force floppy disk drive to detect disk change"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000844
Eric Andersen01c3d402003-07-05 07:51:31 +0000845#define fdformat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000846 "[-n] DEVICE"
Eric Andersen01c3d402003-07-05 07:51:31 +0000847#define fdformat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000848 "Format floppy disk" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000849 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000850 " -n Don't verify after format"
Eric Andersen01c3d402003-07-05 07:51:31 +0000851
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000852#define fdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000853 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000854#define fdisk_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000855 "Change partition table" \
856 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000857 " -l List partition table(s)\n" \
858 " -u Give Start and End in sector (instead of cylinder) units\n" \
859 " -s PARTITION Give partition size(s) in blocks\n" \
860 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
861 " -C CYLINDERS Set the number of cylinders\n" \
862 " -H HEADS Set the number of heads\n" \
863 " -S SECTORS Set the number of sectors\n" \
864 " -v Give fdisk version"
Glenn L McGrath441e7ef2002-11-26 22:00:21 +0000865
Eric Andersen7e9276b2001-02-22 01:15:47 +0000866#define find_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000867 "[PATH...] [EXPRESSION]"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000868#define find_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000869 "Search for files in a directory hierarchy. The default PATH is\n" \
870 "the current directory; default EXPRESSION is '-print'\n" \
871 "\nEXPRESSION may consist of:\n" \
872 " -follow Dereference symbolic links\n" \
873 " -name PATTERN File name (leading directories removed) matches PATTERN\n" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000874 " -print Print (default and assumed)" \
Paul Foxd7384292006-05-12 14:47:20 +0000875 USE_FEATURE_FIND_PRINT0( \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000876 "\n -print0 Delimit output with null characters rather than" \
877 "\n newlines" \
878 ) USE_FEATURE_FIND_TYPE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000879 "\n -type X Filetype matches X (where X is one of: f,d,l,b,c,...)" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000880 ) USE_FEATURE_FIND_PERM( \
881 "\n -perm PERMS Permissions match any of (+NNN); all of (-NNN);" \
882 "\n or exactly (NNN)" \
883 ) USE_FEATURE_FIND_MTIME( \
884 "\n -mtime DAYS Modified time is greater than (+N); less than (-N);" \
885 "\n or exactly (N) days" \
886 ) USE_FEATURE_FIND_MMIN( \
887 "\n -mmin MINS Modified time is greater than (+N); less than (-N);" \
888 "\n or exactly (N) minutes" \
889 ) USE_FEATURE_FIND_NEWER( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000890 "\n -newer FILE Modified time is more recent than FILE's" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000891 ) USE_FEATURE_FIND_INUM( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000892 "\n -inum N File has inode number N" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000893 ) USE_FEATURE_FIND_EXEC( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000894 "\n -exec CMD Execute CMD with all instances of {} replaced by the" \
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000895 "\n files matching EXPRESSION" \
896 ) USE_DESKTOP( \
897 "\n -size N File size is N" \
898 "\n -prune Stop traversing current subtree" \
899 "\n (expr) Group" \
900 )
Rob Landley5d3a0e82005-10-04 03:34:39 +0000901
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000902#define find_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000903 "$ find / -name passwd\n" \
904 "/etc/passwd\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000905
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000906#define fold_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000907 "[-bs] [-w WIDTH] [FILE]"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000908#define fold_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000909 "Wrap input lines in each FILE (standard input by default), writing to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000910 "standard output" \
911 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000912 " -b count bytes rather than columns\n" \
913 " -s break at spaces\n" \
914 " -w use WIDTH columns instead of 80"
Glenn L McGrathf01b8052003-04-27 06:02:14 +0000915
Eric Andersen7e9276b2001-02-22 01:15:47 +0000916#define free_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000917 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +0000918#define free_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000919 "Display the amount of free and used system memory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000920#define free_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000921 "$ free\n" \
922 " total used free shared buffers\n" \
923 " Mem: 257628 248724 8904 59644 93124\n" \
924 " Swap: 128516 8404 120112\n" \
925 "Total: 386144 257128 129016\n" \
Eric Andersen3ec8ffb2001-02-14 21:46:30 +0000926
Eric Andersen7e9276b2001-02-22 01:15:47 +0000927#define freeramdisk_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000928 "DEVICE"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000929#define freeramdisk_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000930 "Free all memory used by the specified ramdisk"
Eric Andersen0d3a02e2001-03-15 18:14:25 +0000931#define freeramdisk_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000932 "$ freeramdisk /dev/ram2\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000933
Mike Frysinger51a43b42005-09-24 07:11:16 +0000934#define fsck_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000935 "[-ANPRTV] [ -C [ fd ] ] [-t fstype] [fs-options] [filesys ...]"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000936#define fsck_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000937 "Check and repair filesystems" \
938 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000939 " -A Walk /etc/fstab and check all filesystems\n" \
940 " -N Don't execute, just show what would be done\n" \
941 " -P When using -A, check filesystems in parallel\n" \
942 " -R When using -A, skip the root filesystem\n" \
943 " -T Don't show title on startup\n" \
944 " -V Verbose mode\n" \
945 " -C Write status information to specified filedescriptor\n" \
946 " -t List of filesystem types to check"
Mike Frysinger51a43b42005-09-24 07:11:16 +0000947
Eric Andersen7e9276b2001-02-22 01:15:47 +0000948#define fsck_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000949 "[-larvsmf] /dev/name"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000950#define fsck_minix_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +0000951 "Perform a consistency check for MINIX filesystems" \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000952 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000953 " -l Lists all filenames\n" \
954 " -r Perform interactive repairs\n" \
955 " -a Perform automatic repairs\n" \
956 " -v verbose\n" \
957 " -s Outputs super-block information\n" \
958 " -m Activates MINIX-like \"mode not cleared\" warnings\n" \
959 " -f Force file system check"
Eric Andersen7e9276b2001-02-22 01:15:47 +0000960
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000961#define ftpget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000962 "[options] remote-host local-file remote-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000963#define ftpget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000964 "Retrieve a remote file via FTP" \
965 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000966 " -c, --continue Continue a previous transfer\n" \
967 " -v, --verbose Verbose\n" \
968 " -u, --username Username to be used\n" \
969 " -p, --password Password to be used\n" \
970 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000971
972#define ftpput_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000973 "[options] remote-host remote-file local-file"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000974#define ftpput_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +0000975 "Store a local file on a remote machine via FTP" \
976 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000977 " -v, --verbose Verbose\n" \
978 " -u, --username Username to be used\n" \
979 " -p, --password Password to be used\n" \
980 " -P, --port Port number to be used"
Glenn L McGrath02d7cbf2002-12-13 02:43:50 +0000981
Rob Landleyaa872762005-10-28 13:05:12 +0000982#define fuser_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000983 "[options] file OR port/proto"
Rob Landleyaa872762005-10-28 13:05:12 +0000984#define fuser_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000985 "Options:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +0000986 " -m Show all processes on the same mounted fs\n" \
987 " -k Kill all processes that match.\n" \
988 " -s Don't print or kill anything.\n" \
989 " -4 When using port/proto only search IPv4 space\n" \
990 " -6 When using port/proto only search IPv6 space\n" \
991 " -SIGNAL When used with -k, this signal will be used to kill"
Mike Frysingerbf28ed82006-02-21 04:32:03 +0000992
Eric Andersen7e9276b2001-02-22 01:15:47 +0000993#define getopt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000994 "[OPTIONS]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +0000995#define getopt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +0000996 "Parse command options\n" \
997 " -a, --alternative Allow long options starting with single -\n" \
998 " -l, --longoptions=longopts Long options to be recognized\n" \
999 " -n, --name=progname The name under which errors are reported\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001000 " -o, --options=optstring Short options to be recognized\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001001 " -q, --quiet Disable error reporting by getopt(3)\n" \
1002 " -Q, --quiet-output No normal output\n" \
1003 " -s, --shell=shell Set shell quoting conventions\n" \
1004 " -T, --test Test for getopt(1) version\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001005 " -u, --unquoted Do not quote the output"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001006#define getopt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001007 "$ cat getopt.test\n" \
1008 "#!/bin/sh\n" \
1009 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1010 " -n 'example.busybox' -- \"$@\"`\n" \
1011 "if [ $? != 0 ] ; then exit 1 ; fi\n" \
1012 "eval set -- \"$GETOPT\"\n" \
1013 "while true ; do\n" \
1014 " case $1 in\n" \
1015 " -a|--a-long) echo \"Option a\" ; shift ;;\n" \
1016 " -b|--b-long) echo \"Option b, argument '$2'\" ; shift 2 ;;\n" \
1017 " -c|--c-long)\n" \
1018 " case \"$2\" in\n" \
1019 " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \
1020 " *) echo \"Option c, argument '$2'\" ; shift 2 ;;\n" \
1021 " esac ;;\n" \
1022 " --) shift ; break ;;\n" \
1023 " *) echo \"Internal error!\" ; exit 1 ;;\n" \
1024 " esac\n" \
1025 "done\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001026
Eric Andersenf349e972001-08-21 16:18:59 +00001027#define getty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001028 "[OPTIONS]... baud_rate,... line [termtype]"
Eric Andersenf349e972001-08-21 16:18:59 +00001029#define getty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001030 "Open a tty, prompt for a login name, then invoke /bin/login" \
1031 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001032 " -h Enable hardware (RTS/CTS) flow control\n" \
1033 " -i Do not display /etc/issue before running login\n" \
1034 " -L Local line, so do not do carrier detect\n" \
1035 " -m Get baud rate from modem's CONNECT status message\n" \
1036 " -w Wait for a CR or LF before sending /etc/issue\n" \
1037 " -n Do not prompt the user for a login name\n" \
1038 " -f issue_file Display issue_file instead of /etc/issue\n" \
1039 " -l login_app Invoke login_app instead of /bin/login\n" \
1040 " -t timeout Terminate after timeout if no username is read\n" \
1041 " -I initstring Sets the init string to send before anything else\n" \
1042 " -H login_host Log login_host into the utmp file as the hostname"
Eric Andersenf349e972001-08-21 16:18:59 +00001043
Eric Andersen7e9276b2001-02-22 01:15:47 +00001044#define grep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001045 "[-rihHnqvso" \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001046 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1047 USE_FEATURE_GREP_CONTEXT("ABC") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001048 "] PATTERN [FILEs...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001049#define grep_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001050 "Search for PATTERN in each FILE or standard input" \
1051 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001052 " -H prefix output lines with filename where match was found\n" \
1053 " -h suppress the prefixing filename on output\n" \
1054 " -r recurse subdirectories\n" \
1055 " -i ignore case distinctions\n" \
1056 " -l list names of files that match\n" \
1057 " -L list names of files that do not match\n" \
1058 " -n print line number with output lines\n" \
1059 " -q be quiet. Returns 0 if PATTERN was found, 1 otherwise\n" \
1060 " -v select non-matching lines\n" \
1061 " -s suppress file open/read error messages\n" \
1062 " -c only print count of matching lines\n" \
1063 " -f read PATTERN from file\n" \
1064 " -o show only the part of a line that matches PATTERN\n" \
1065 " -e PATTERN is a regular expression\n" \
1066 " -F PATTERN is a set of newline-separated strings" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001067 USE_FEATURE_GREP_EGREP_ALIAS( \
1068 "\n -E PATTERN is an extended regular expression") \
1069 USE_FEATURE_GREP_CONTEXT( \
1070 "\n -A print NUM lines of trailing context") \
1071 USE_FEATURE_GREP_CONTEXT( \
1072 "\n -B print NUM lines of leading context") \
1073 USE_FEATURE_GREP_CONTEXT( \
1074 "\n -C print NUM lines of output context")
Bernhard Reutner-Fischer0a44c172005-09-23 15:40:15 +00001075
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001076#define grep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001077 "$ grep root /etc/passwd\n" \
1078 "root:x:0:0:root:/root:/bin/bash\n" \
1079 "$ grep ^[rR]oo. /etc/passwd\n" \
1080 "root:x:0:0:root:/root:/bin/bash\n"
Mark Whitley40e5e7c2001-03-14 17:45:45 +00001081
Eric Andersen7e9276b2001-02-22 01:15:47 +00001082#define gunzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001083 "[OPTION]... FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001084#define gunzip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001085 "Uncompress FILE (or standard input if FILE is '-')" \
1086 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001087 " -c Write output to standard output\n" \
1088 " -f Force read when source is a terminal\n" \
1089 " -t Test compressed file integrity"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001090#define gunzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001091 "$ ls -la /tmp/BusyBox*\n" \
1092 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1093 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1094 "$ ls -la /tmp/BusyBox*\n" \
1095 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001096
1097#define gzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001098 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001099#define gzip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001100 "Compress FILE(s) with maximum compression.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001101 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
1102 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001103 " -c Write output to standard output instead of FILE.gz\n" \
1104 " -d Decompress\n" \
1105 " -f Force write when destination is a terminal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001106#define gzip_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001107 "$ ls -la /tmp/busybox*\n" \
1108 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1109 "$ gzip /tmp/busybox.tar\n" \
1110 "$ ls -la /tmp/busybox*\n" \
1111 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001112
1113#define halt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001114 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001115#define halt_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001116 "Halt the system" \
1117 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001118 " -d delay interval for halting\n" \
1119 " -n no call to sync()\n" \
1120 " -f force halt (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001121
Eric Andersen3443bd72003-07-22 07:30:36 +00001122#define hdparm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001123 "[options] [device] .."
Eric Andersen3443bd72003-07-22 07:30:36 +00001124#define hdparm_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001125 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001126 "If no device name is specified try to read from stdin.\n\n") \
1127 "Options:\n" \
1128 " -a get/set fs readahead\n" \
1129 " -A set drive read-lookahead flag (0/1)\n" \
1130 " -b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1131 " -B set Advanced Power Management setting (1-255)\n" \
1132 " -c get/set IDE 32-bit IO setting\n" \
1133 " -C check IDE power mode status\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001134 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001135 " -d get/set using_dma flag\n") \
1136 " -D enable/disable drive defect-mgmt\n" \
1137 " -f flush buffer cache for device on exit\n" \
1138 " -g display drive geometry\n" \
1139 " -h display terse usage information\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001140 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001141 " -i display drive identification\n") \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001142 USE_FEATURE_HDPARM_GET_IDENTITY( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001143 " -I detailed/current information directly from drive\n") \
1144 " -k get/set keep_settings_over_reset flag (0/1)\n" \
1145 " -K set drive keep_features_over_reset flag (0/1)\n" \
1146 " -L set drive doorlock (0/1) (removable harddisks only)\n" \
1147 " -m get/set multiple sector count\n" \
1148 " -n get/set ignore-write-errors flag (0/1)\n" \
1149 " -p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1150 " -P set drive prefetch count\n" \
1151 " -q change next setting quietly\n" \
1152 " -Q get/set DMA tagged-queuing depth (if supported)\n" \
1153 " -r get/set readonly flag (DANGEROUS to set)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001154 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001155 " -R register an IDE interface (DANGEROUS)\n") \
1156 " -S set standby (spindown) timeout\n" \
1157 " -t perform device read timings\n" \
1158 " -T perform cache read timings\n" \
1159 " -u get/set unmaskirq flag (0/1)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001160 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001161 " -U un-register an IDE interface (DANGEROUS)\n") \
1162 " -v defaults; same as -mcudkrag for IDE drives\n" \
1163 " -V display program version and exit immediately\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001164 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001165 " -w perform device reset (DANGEROUS)\n") \
1166 " -W set drive write-caching flag (0/1) (DANGEROUS)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001167 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001168 " -x tristate device for hotswap (0/1) (DANGEROUS)\n") \
1169 " -X set IDE xfer mode (DANGEROUS)\n" \
1170 " -y put IDE drive in standby mode\n" \
1171 " -Y put IDE drive to sleep\n" \
1172 " -Z disable Seagate auto-powersaving mode\n" \
1173 " -z re-read partition table"
Eric Andersen3443bd72003-07-22 07:30:36 +00001174
Eric Andersen7e9276b2001-02-22 01:15:47 +00001175#define head_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001176 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001177#define head_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001178 "Print first 10 lines of each FILE to standard output.\n" \
1179 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001180 "file name. With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001181 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001182 "\n -n NUM Print first NUM lines instead of first 10" \
Rob Landleya2d9a172006-04-28 19:38:04 +00001183 USE_FEATURE_FANCY_HEAD( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001184 "\n -c NUM output the first NUM bytes" \
1185 "\n -q never output headers giving file names" \
1186 "\n -v always output headers giving file names")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001187#define head_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001188 "$ head -n 2 /etc/passwd\n" \
1189 "root:x:0:0:root:/root:/bin/bash\n" \
1190 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001191
Glenn L McGrath60281112001-11-02 11:39:46 +00001192#define hexdump_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001193 "[-[bcCdefnosvx]] [OPTION] FILE"
Glenn L McGrath60281112001-11-02 11:39:46 +00001194#define hexdump_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001195 "Display file(s) or standard input in a user specified format" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001196 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001197 " -b One-byte octal display\n" \
1198 " -c One-byte character display\n" \
1199 " -C Canonical hex+ASCII, 16 bytes per line\n" \
1200 " -d Two-byte decimal display\n" \
1201 " -e FORMAT STRING\n" \
1202 " -f FORMAT FILE\n" \
1203 " -n LENGTH Interpret only length bytes of input\n" \
1204 " -o Two-byte octal display\n" \
1205 " -s OFFSET Skip offset byte\n" \
1206 " -v display all input data\n" \
1207 " -x Two-byte hexadecimal display"
Glenn L McGrath60281112001-11-02 11:39:46 +00001208
Eric Andersen7e9276b2001-02-22 01:15:47 +00001209#define hostid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001210 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001211#define hostid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001212 "Print out a unique 32-bit identifier for the machine"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001213
1214#define hostname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001215 "[OPTION] {hostname | -F FILE}"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001216#define hostname_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001217 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001218 "(or FILE with the -F parameter), the host name will be set." \
1219 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001220 " -s Short\n" \
1221 " -i Addresses for the hostname\n" \
1222 " -d DNS domain name\n" \
1223 " -f Fully qualified domain name\n" \
1224 " -F FILE Use the contents of FILE to specify the hostname"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001225#define hostname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001226 "$ hostname\n" \
1227 "sage\n"
Eric Andersen40520512003-07-28 09:59:05 +00001228
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001229#define httpd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001230 "[-c <conf file>]" \
1231 " [-p <port>]" \
1232 " [-i] [-f]" \
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001233 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
Rob Landleya2d9a172006-04-28 19:38:04 +00001234 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
1235 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001236 " [-h home]" \
1237 " [-d/-e <string>]"
Glenn L McGrath58c708a2003-01-05 04:01:56 +00001238#define httpd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001239 "Listen for incoming http server requests" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001240 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001241 " -c FILE Specifies configuration file. (default httpd.conf)\n" \
1242 " -p PORT Server port (default 80)\n" \
1243 " -i Assume that we are started from inetd\n" \
1244 " -f Do not daemonize\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001245 USE_FEATURE_HTTPD_SETUID( \
1246 " -u USER[:GRP] Set uid/gid after binding to port\n") \
1247 USE_FEATURE_HTTPD_BASIC_AUTH( \
1248 " -r REALM Authentication Realm for Basic Authentication\n") \
1249 USE_FEATURE_HTTPD_AUTH_MD5( \
1250 " -m PASS Crypt PASS with md5 algorithm\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001251 " -h HOME Specifies http HOME directory (default ./)\n" \
1252 " -e STRING HTML encode STRING\n" \
1253 " -d STRING URL decode STRING"
Eric Andersen40520512003-07-28 09:59:05 +00001254
Robert Griebl1cd04452002-07-21 16:50:49 +00001255#define hwclock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001256 "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
Robert Griebl1cd04452002-07-21 16:50:49 +00001257#define hwclock_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001258 "Query and set the hardware clock (RTC)" \
1259 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001260 " -r read hardware clock and print result\n" \
1261 " -s set the system time from the hardware clock\n" \
1262 " -w set the hardware clock to the current system time\n" \
1263 " -u the hardware clock is kept in coordinated universal time\n" \
1264 " -l the hardware clock is kept in local time"
Robert Griebl1cd04452002-07-21 16:50:49 +00001265
Eric Andersen7e9276b2001-02-22 01:15:47 +00001266#define id_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001267 "[OPTIONS]... [USERNAME]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001268#define id_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001269 "Print information for USERNAME or the current user" \
1270 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001271 USE_SELINUX( \
1272 " -c prints only the security context\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001273 " -g prints only the group ID\n" \
1274 " -u prints only the user ID\n" \
1275 " -n print a name instead of a number\n" \
1276 " -r prints the real user ID instead of the effective ID"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001277#define id_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001278 "$ id\n" \
1279 "uid=1000(andersen) gid=1000(andersen)\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001280
Eric Andersen7e9276b2001-02-22 01:15:47 +00001281#define ifconfig_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001282 USE_FEATURE_IFCONFIG_STATUS("[-a]") " <interface> [<address>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001283#define ifconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001284 "Configure a network interface" \
1285 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001286 USE_FEATURE_IPV6( \
1287 " [add <address>[/<prefixlen>]]\n") \
1288 USE_FEATURE_IPV6( \
1289 " [del <address>[/<prefixlen>]]\n") \
1290 " [[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \
1291 " [netmask <address>] [dstaddr <address>]\n" \
1292 USE_FEATURE_IFCONFIG_SLIP( \
1293 " [outfill <NN>] [keepalive <NN>]\n") \
1294 " " USE_FEATURE_IFCONFIG_HW("[hw ether <address>] ") "[metric <NN>] [mtu <NN>]\n" \
1295 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
1296 " [multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \
1297 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
1298 " [mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001299 " [up|down] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001300
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001301#define ifup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001302 "<-ahinv> <ifaces...>"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001303#define ifup_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001304 "Options:\n" \
1305 " -h this help\n" \
1306 " -a de/configure all interfaces automatically\n" \
1307 " -i FILE use FILE for interface definitions\n" \
1308 " -n print out what would happen, but don't do it\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001309 " (note that this option doesn't disable mappings)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001310 " -v print out what would happen before doing it\n" \
1311 " -m don't run any mappings\n" \
1312 " -f force de/configuration"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001313
1314#define ifdown_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001315 "<-ahinv> <ifaces...>"
Glenn L McGrath021fa7d2002-11-09 09:34:15 +00001316#define ifdown_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001317 "Options:\n" \
1318 " -h this help\n" \
1319 " -a de/configure all interfaces automatically\n" \
1320 " -i FILE use FILE for interface definitions\n" \
1321 " -n print out what would happen, but don't do it\n" \
1322 " (note that this option doesn't disable mappings)\n" \
1323 " -v print out what would happen before doing it\n" \
1324 " -m don't run any mappings\n" \
1325 " -f force de/configuration"
Tim Riker7b253f82003-12-28 05:02:40 +00001326
Glenn L McGrath06e95652003-02-09 06:51:14 +00001327#define inetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001328 "[-f] [-q len] [conf]"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001329#define inetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001330 "Listen for network connections and launch programs" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001331 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001332 " -f Run as a foreground progress\n" \
1333 " -q Sets the size of the socket listen queue to\n" \
1334 " the specified value. Default is 128"
Glenn L McGrath06e95652003-02-09 06:51:14 +00001335
Eric Andersen7e9276b2001-02-22 01:15:47 +00001336#define init_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001337 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001338#define init_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001339 "Init is the parent of all processes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001340#define init_notes_usage \
1341"This version of init is designed to be run only by the kernel.\n" \
1342"\n" \
1343"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001344"the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001345"runlevels, use sysvinit.\n" \
1346"\n" \
Denis Vlasenkoe1a0d482006-10-20 13:28:22 +00001347"BusyBox init works just fine without an inittab. If no inittab is found,\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001348"it has the following default behavior:\n" \
1349"\n" \
1350" ::sysinit:/etc/init.d/rcS\n" \
1351" ::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001352" ::ctrlaltdel:/sbin/reboot\n" \
1353" ::shutdown:/sbin/swapoff -a\n" \
1354" ::shutdown:/bin/umount -a -r\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001355" ::restart:/sbin/init\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001356"\n" \
1357"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1358"\n" \
1359" tty2::askfirst:/bin/sh\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001360" tty3::askfirst:/bin/sh\n" \
1361" tty4::askfirst:/bin/sh\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001362"\n" \
1363"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1364"\n" \
1365" <id>:<runlevels>:<action>:<process>\n" \
1366"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001367" <id>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001368"\n" \
1369" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1370" The id field is used by BusyBox init to specify the controlling tty for\n" \
1371" the specified process to run on. The contents of this field are\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001372" appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001373" be unique, although if it isn't you may have strange results. If this\n" \
1374" field is left blank, the controlling tty is set to the console. Also\n" \
1375" note that if BusyBox detects that a serial console is in use, then only\n" \
1376" entries whose controlling tty is either the serial console or /dev/null\n" \
1377" will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1378" stinkin' utmp.\n" \
1379"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001380" <runlevels>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001381"\n" \
1382" The runlevels field is completely ignored.\n" \
1383"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001384" <action>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001385"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001386" Valid actions include: sysinit, respawn, askfirst, wait,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001387" once, restart, ctrlaltdel, and shutdown.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001388"\n" \
1389" The available actions can be classified into two groups: actions\n" \
1390" that are run only once, and actions that are re-run when the specified\n" \
1391" process exits.\n" \
1392"\n" \
1393" Run only-once actions:\n" \
1394"\n" \
1395" 'sysinit' is the first item run on boot. init waits until all\n" \
1396" sysinit actions are completed before continuing. Following the\n" \
1397" completion of all sysinit actions, all 'wait' actions are run.\n" \
1398" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
Eric Andersen77d92682001-05-23 20:32:09 +00001399" the specified task completes. 'once' actions are asynchronous,\n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001400" therefore, init does not wait for them to complete. 'restart' is\n" \
1401" the action taken to restart the init process. By default this should\n" \
1402" simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1403" can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001404" actions are run when the system detects that someone on the system\n" \
1405" console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1406" wants to run 'reboot' at this point to cause the system to reboot.\n" \
1407" Finally the 'shutdown' action specifies the actions to taken when\n" \
1408" init is told to reboot. Unmounting filesystems and disabling swap\n" \
1409" is a very good here\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001410"\n" \
1411" Run repeatedly actions:\n" \
1412"\n" \
1413" 'respawn' actions are run after the 'once' actions. When a process\n" \
1414" started with a 'respawn' action exits, init automatically restarts\n" \
1415" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1416" respawning out of control. The 'askfirst' actions acts just like\n" \
1417" respawn, except that before running the specified process it\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001418" displays the line \"Please press Enter to activate this console.\"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001419" and then waits for the user to press enter before starting the\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001420" specified process.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001421"\n" \
1422" Unrecognized actions (like initdefault) will cause init to emit an\n" \
1423" error message, and then go along with its business. All actions are\n" \
Eric Andersene0f55002002-09-30 20:59:33 +00001424" run in the order they appear in /etc/inittab.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001425"\n" \
Eric Andersen63a1a7a2004-03-13 08:33:10 +00001426" <process>:\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001427"\n" \
Glenn L McGrath43596232004-07-23 01:27:56 +00001428" Specifies the process to be executed and its command line.\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001429"\n" \
1430"Example /etc/inittab file:\n" \
Mark Whitley0a6f1d32001-03-15 21:19:09 +00001431"\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001432" # This is run first except when booting in single-user mode.\n" \
1433" #\n" \
1434" ::sysinit:/etc/init.d/rcS\n" \
1435" \n" \
1436" # /bin/sh invocations on selected ttys\n" \
1437" #\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001438" # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001439" ::askfirst:-/bin/sh\n" \
Mike Frysinger058e7402005-04-23 07:00:33 +00001440" # Start an \"askfirst\" shell on /dev/tty2-4\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001441" tty2::askfirst:-/bin/sh\n" \
1442" tty3::askfirst:-/bin/sh\n" \
1443" tty4::askfirst:-/bin/sh\n" \
1444" \n" \
1445" # /sbin/getty invocations for selected ttys\n" \
1446" #\n" \
Eric Andersen1713a112002-11-07 02:26:59 +00001447" tty4::respawn:/sbin/getty 38400 tty4\n" \
1448" tty5::respawn:/sbin/getty 38400 tty5\n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001449" \n" \
1450" \n" \
1451" # Example of how to put a getty on a serial line (for a terminal)\n" \
1452" #\n" \
1453" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1454" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1455" #\n" \
1456" # Example how to put a getty on a modem line.\n" \
1457" #::respawn:/sbin/getty 57600 ttyS2\n" \
1458" \n" \
Eric Andersen730f8262001-12-17 23:13:08 +00001459" # Stuff to do when restarting the init process\n" \
1460" ::restart:/sbin/init\n" \
1461" \n" \
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001462" # Stuff to do before rebooting\n" \
Eric Andersenc97ec342001-04-03 18:01:51 +00001463" ::ctrlaltdel:/sbin/reboot\n" \
1464" ::shutdown:/bin/umount -a -r\n" \
1465" ::shutdown:/sbin/swapoff -a\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001466
1467#define insmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001468 "[OPTION]... MODULE [symbol=value]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001469#define insmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001470 "Load the specified kernel modules into the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001471 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001472 " -f Force module to load into the wrong kernel version\n" \
1473 " -k Make module autoclean-able\n" \
1474 " -v verbose output\n" \
1475 " -q quiet output\n" \
1476 " -L Lock to prevent simultaneous loads of a module\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001477 USE_FEATURE_INSMOD_LOAD_MAP( \
1478 " -m Output load map to stdout\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001479 " -o NAME Set internal module name to NAME\n" \
1480 " -x do not export externs"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001481
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001482#define install_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001483 "[-cgmops] [sources] <dest|directory>"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001484#define install_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001485 "Copy files and set attributes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001486 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001487 " -c copy the file, default\n" \
1488 " -d create directories\n" \
1489 " -g set group ownership\n" \
1490 " -m set permission modes\n" \
1491 " -o set ownership\n" \
1492 " -p preserve date\n" \
1493 " -s strip symbol tables"
Glenn L McGratheebcc1d2003-09-24 03:22:57 +00001494
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001495#define ip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001496 "[OPTIONS] {address | link | route | tunnel | rule} {COMMAND}"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001497#define ip_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001498 "ip [OPTIONS] OBJECT {COMMAND}\n" \
1499 "where OBJECT := {link | addr | route | tunnel |rule}\n" \
1500 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001501
1502#define ipaddr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001503 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1504 " [ dev STRING ] [ to PREFIX ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001505#define ipaddr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001506 "ipaddr {add|delete} IFADDR dev STRING\n" \
1507 "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001508 " [ to PREFIX ] [ label PATTERN ]\n" \
1509 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
1510 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1511 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1512 " SCOPE-ID := [ host | link | global | NUMBER ]"
Glenn L McGrath9a2d2722002-11-10 01:33:55 +00001513
Eric Andersende4f07e2003-12-11 01:18:07 +00001514#define ipcalc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001515 "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]"
Eric Andersende4f07e2003-12-11 01:18:07 +00001516#define ipcalc_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001517 "Calculate IP network settings from a IP address" \
1518 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001519 " -b --broadcast Display calculated broadcast address\n" \
1520 " -n --network Display calculated network address\n" \
1521 " -m --netmask Display default netmask for IP" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001522 USE_FEATURE_IPCALC_FANCY( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001523 "\n -p --prefix Display the prefix for IP/NETMASK\n" \
1524 " -h --hostname Display first resolved host name\n" \
1525 " -s --silent Don't ever display error messages")
Glenn L McGrathc11986d2002-11-10 23:42:27 +00001526
Rob Landley6eb1e412005-06-20 04:30:36 +00001527#define ipcrm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001528 "[-[MQS] key] [-[mqs] id]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001529#define ipcrm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001530 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1531 "segment by a shmkey value. The lower-case options mqs are used\n" \
1532 "to remove a segment by shmid value.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001533 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001534 " -[mM] Remove the memory segment after the last detach\n" \
1535 " -[qQ] Remove the message queue\n" \
1536 " -[sS] Remove the semaphore"
Rob Landley6eb1e412005-06-20 04:30:36 +00001537
1538#define ipcs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001539 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
Rob Landley6eb1e412005-06-20 04:30:36 +00001540#define ipcs_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001541 " -i specify a specific resource id\n" \
1542 "Resource specification:\n" \
1543 " -m shared memory segments\n" \
1544 " -q message queues\n" \
1545 " -s semaphore arrays\n" \
1546 " -a all (default)\n" \
1547 "Output format:\n" \
1548 " -t time\n" \
1549 " -c creator\n" \
1550 " -p pid\n" \
1551 " -l limits\n" \
1552 " -u summary"
Rob Landley6eb1e412005-06-20 04:30:36 +00001553
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001554#define iplink_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001555 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001556#define iplink_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001557 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1558 " dynamic { on | off } |\n" \
1559 " mtu MTU }\n" \
1560 " iplink show [ DEVICE ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001561
1562#define iproute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001563 "{ list | flush | { add | del | change | append |\n" \
1564 " replace | monitor } ROUTE }"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001565#define iproute_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001566 "iproute { list | flush } SELECTOR\n" \
1567 "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \
1568 " [ oif STRING ] [ tos TOS ]\n" \
1569 " iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1570 " SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1571 " ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001572
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001573#define iprule_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001574 "{[ list | add | del ] RULE}"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001575#define iprule_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001576 "iprule [ list | add | del ] SELECTOR ACTION\n" \
1577 " SELECTOR := [ from PREFIX ] [ to PREFIX ] [ tos TOS ] [ fwmark FWMARK ]\n" \
1578 " [ dev STRING ] [ pref NUMBER ]\n" \
1579 " ACTION := [ table TABLE_ID ] [ nat ADDRESS ]\n" \
1580 " [ prohibit | reject | unreachable ]\n" \
1581 " [ realms [SRCREALM/]DSTREALM ]\n" \
1582 " TABLE_ID := [ local | main | default | NUMBER ]"
Bernhard Reutner-Fischer921f5df2006-11-21 15:36:08 +00001583
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001584#define iptunnel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001585 "{ add | change | del | show } [ NAME ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001586 " [ mode { ipip | gre | sit } ]\n" \
1587 " [ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001588#define iptunnel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001589 "iptunnel { add | change | del | show } [ NAME ]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001590 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1591 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1592 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
Glenn L McGrathf112daa2002-12-01 23:04:06 +00001593
Eric Andersen7e9276b2001-02-22 01:15:47 +00001594#define kill_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001595 "[-l] [-signal] process-id [process-id ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001596#define kill_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001597 "Send a signal (default is TERM) to the specified process(es)" \
1598 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001599 " -l List all signal names and numbers"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001600#define kill_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001601 "$ ps | grep apache\n" \
1602 "252 root root S [apache]\n" \
1603 "263 www-data www-data S [apache]\n" \
1604 "264 www-data www-data S [apache]\n" \
1605 "265 www-data www-data S [apache]\n" \
1606 "266 www-data www-data S [apache]\n" \
1607 "267 www-data www-data S [apache]\n" \
1608 "$ kill 252\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001609
1610#define killall_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001611 "[-l] [-q] [-signal] process-name [process-name ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001612#define killall_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001613 "Send a signal (default is TERM) to the specified process(es)" \
1614 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001615 " -l List all signal names and numbers\n" \
1616 " -q Do not complain if no processes were killed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001617#define killall_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001618 "$ killall apache\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001619
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001620#define killall5_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001621 "[-l] [-signal]"
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001622#define killall5_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001623 "Send a signal (default is TERM) to all processes outside current session" \
1624 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001625 " -l List all signal names and numbers\n" \
Denis Vlasenko0bb628f2006-09-27 14:25:33 +00001626
Mark Whitley6317c4b2001-03-12 22:51:50 +00001627#define klogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001628 "[-c n] [-n]"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001629#define klogd_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001630 "Kernel logger" \
1631 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001632 " -c n Sets the default log level of console messages to n\n" \
1633 " -n Run as a foreground process"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001634
Eric Andersen7e9276b2001-02-22 01:15:47 +00001635#define length_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001636 "STRING"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001637#define length_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001638 "Print out the length of the specified STRING"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001639#define length_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001640 "$ length Hello\n" \
1641 "5\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001642
Rob Landley9200e792005-09-15 19:26:59 +00001643#define less_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001644 "[-EMNmh~?] FILE1 FILE2..."
Rob Landley9200e792005-09-15 19:26:59 +00001645#define less_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001646 "View a file or list of files. The position within files can be\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001647 "changed, and files can be manipulated in various ways." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001648 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001649 " -E Quit once the end of a file is reached\n" \
1650 " -M Display a status line containing the current line numbers\n" \
1651 " and the percentage through the file\n" \
1652 " -N Prefix line numbers to each line\n" \
1653 " -m Display a status line containing the percentage through the\n" \
1654 " file\n" \
1655 " -~ Suppress ~s displayed when input past the end of the file is\n" \
1656 " reached.\n" \
1657 " -h, -? Display this help message"
Rob Landley9200e792005-09-15 19:26:59 +00001658
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001659#define setarch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001660 "<personality> <program> [args ...]"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001661#define setarch_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001662 "Personality may be:\n" \
1663 " linux32 Set 32bit uname emulation\n" \
1664 " linux64 Set 64bit uname emulation"
Mike Frysinger0a6b0bf2006-02-21 04:26:52 +00001665
Eric Andersen7e9276b2001-02-22 01:15:47 +00001666#define ln_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001667 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001668#define ln_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001669 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1670 "You may use '--' to indicate that all following arguments are non-options." \
1671 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001672 " -s make symbolic links instead of hard links\n" \
1673 " -f remove existing destination files\n" \
1674 " -n no dereference symlinks - treat like normal file\n" \
1675 " -b make a backup of the target (if exists) before link operation\n" \
1676 " -S suffix use suffix instead of ~ when making backup files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001677#define ln_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001678 "$ ln -s BusyBox /tmp/ls\n" \
1679 "$ ls -l /tmp/ls\n" \
1680 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001681
Eric Andersen7e9276b2001-02-22 01:15:47 +00001682#define loadfont_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001683 "< font"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001684#define loadfont_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001685 "Load a console font from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001686#define loadfont_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001687 "$ loadfont < /etc/i18n/fontname\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001688
1689#define loadkmap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001690 "< keymap"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001691#define loadkmap_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001692 "Load a binary keyboard translation table from standard input"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001693#define loadkmap_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001694 "$ loadkmap < /etc/i18n/lang-keymap\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001695
1696#define logger_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001697 "[OPTION]... [MESSAGE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001698#define logger_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001699 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
1700 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001701 " -s Log to stderr as well as the system log\n" \
1702 " -t TAG Log using the specified tag (defaults to user name)\n" \
1703 " -p PRIORITY Enter the message with the specified priority\n" \
1704 " This may be numerical or a 'facility.level' pair"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001705#define logger_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001706 "$ logger \"hello\"\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001707
Robert Griebl1fca5582002-06-04 20:45:46 +00001708#define login_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001709 "[OPTION]... [username] [ENV=VAR ...]"
Robert Griebl1fca5582002-06-04 20:45:46 +00001710#define login_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001711 "Begin a new session on the system" \
1712 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001713 " -f Do not authenticate (user already authenticated)\n" \
1714 " -h Name of the remote host for this login\n" \
1715 " -p Preserve environment"
Robert Griebl1fca5582002-06-04 20:45:46 +00001716
Eric Andersen7e9276b2001-02-22 01:15:47 +00001717#define logname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001718 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001719#define logname_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001720 "Print the name of the current user"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001721#define logname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001722 "$ logname\n" \
1723 "root\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001724
Mark Whitley6317c4b2001-03-12 22:51:50 +00001725#define logread_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001726 "[OPTION]..."
Mark Whitley6317c4b2001-03-12 22:51:50 +00001727#define logread_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001728 "Show the messages from syslogd (using circular buffer)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001729 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001730 " -f output data as the log grows"
Mark Whitley6317c4b2001-03-12 22:51:50 +00001731
Matt Kraai83788da2002-03-20 17:38:37 +00001732#define losetup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001733 "[-o OFFSET] [-d] LOOPDEVICE [FILE]]"
Matt Kraai83788da2002-03-20 17:38:37 +00001734#define losetup_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001735 "(Dis)associate LOOPDEVICE with FILE, or display current associations" \
1736 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001737 " -d Disassociate LOOPDEVICE\n" \
1738 " -o OFFSET Start OFFSET bytes into FILE"
Rob Landley1d589b22005-11-29 23:47:10 +00001739#define losetup_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001740 "No arguments will display all current associations.\n" \
1741 "One argument (losetup /dev/loop1) will display the current association\n" \
1742 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1743 "and filename of the file the loop device is currently bound to.\n\n" \
1744 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1745 "with an optional offset (-o 12345). Encryption is not yet supported.\n\n"
Matt Kraai83788da2002-03-20 17:38:37 +00001746
Eric Andersen7e9276b2001-02-22 01:15:47 +00001747#define ls_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001748 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001749 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
1750 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
1751 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
1752 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
1753 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
1754 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
1755 USE_SELINUX("K") "] [filenames...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001756#define ls_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001757 "List directory contents" \
1758 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001759 "\n -1 list files in a single column" \
1760 "\n -A do not list implied . and .." \
1761 "\n -a do not hide entries starting with ." \
1762 "\n -C list entries by columns" \
1763 USE_FEATURE_LS_TIMESTAMPS( \
1764 "\n -c with -l: show ctime") \
1765 USE_FEATURE_LS_COLOR( \
1766 "\n --color[={always,never,auto}] control coloring") \
1767 "\n -d list directory entries instead of contents" \
1768 USE_FEATURE_LS_TIMESTAMPS( \
1769 "\n -e list both full date and full time") \
1770 USE_FEATURE_LS_FILETYPES( \
1771 "\n -F append indicator (one of */=@|) to entries") \
1772 "\n -i list the i-node for each file" \
1773 "\n -l use a long listing format" \
1774 "\n -n list numeric UIDs and GIDs instead of names" \
1775 USE_FEATURE_LS_FILETYPES( \
1776 "\n -p append indicator (one of /=@|) to entries") \
1777 USE_FEATURE_LS_FOLLOWLINKS( \
1778 "\n -L list entries pointed to by symbolic links") \
1779 USE_FEATURE_LS_RECURSIVE( \
1780 "\n -R list subdirectories recursively") \
1781 USE_FEATURE_LS_SORTFILES( \
1782 "\n -r sort the listing in reverse order") \
1783 USE_FEATURE_LS_SORTFILES( \
1784 "\n -S sort the listing by file size") \
1785 "\n -s list the size of each file, in blocks" \
1786 USE_FEATURE_AUTOWIDTH( \
1787 "\n -T NUM assume Tabstop every NUM columns") \
1788 USE_FEATURE_LS_TIMESTAMPS( \
1789 "\n -t with -l: show modification time") \
1790 USE_FEATURE_LS_TIMESTAMPS( \
1791 "\n -u with -l: show access time") \
1792 USE_FEATURE_LS_SORTFILES( \
1793 "\n -v sort the listing by version") \
1794 USE_FEATURE_AUTOWIDTH( \
1795 "\n -w NUM assume the terminal is NUM columns wide") \
1796 "\n -x list entries by lines instead of by columns" \
1797 USE_FEATURE_LS_SORTFILES( \
1798 "\n -X sort the listing by extension") \
Rob Landley5fe8d5b2006-04-25 22:40:53 +00001799 USE_FEATURE_HUMAN_READABLE( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001800 "\n -h print sizes in human readable format (e.g., 1K 243M 2G)") \
1801 USE_SELINUX( \
1802 "\n -k print security context") \
1803 USE_SELINUX( \
1804 "\n -K print security context in long format")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001805
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001806#define lsattr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001807 "[-Radlv] [files...]"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001808#define lsattr_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001809 "List file attributes on an ext2 fs" \
1810 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001811 " -R recursively list subdirectories\n" \
1812 " -a do not hide entries starting with .\n" \
1813 " -d list directory entries instead of contents\n" \
1814 " -l print long flag names\n" \
1815 " -v list the file's version/generation number"
Mike Frysingerde9f1f72005-04-22 02:33:37 +00001816
Eric Andersen7e9276b2001-02-22 01:15:47 +00001817#define lsmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001818 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00001819#define lsmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001820 "List the currently loaded kernel modules"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001821
Eric Andersen3d925622005-06-09 10:16:02 +00001822#ifdef CONFIG_FEATURE_MAKEDEVS_LEAF
Eric Andersen7e9276b2001-02-22 01:15:47 +00001823#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001824 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001825#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001826 "Create a range of block or character special files\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001827 "TYPEs include:\n" \
1828 " b: Make a block (buffered) device.\n" \
1829 " c or u: Make a character (un-buffered) device.\n" \
1830 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \
1831 "FIRST specifies the number appended to NAME to create the first device.\n" \
1832 "LAST specifies the number of the last item that should be created\n" \
1833 "If 's' is the last argument, the base device is created as well.\n\n" \
1834 "For example:\n" \
1835 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
1836 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001837#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001838 "# makedevs /dev/ttyS c 4 66 2 63\n" \
1839 "[creates ttyS2-ttyS63]\n" \
1840 "# makedevs /dev/hda b 3 0 0 8 s\n" \
1841 "[creates hda,hda1-hda8]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001842#endif
1843
1844#ifdef CONFIG_FEATURE_MAKEDEVS_TABLE
1845#define makedevs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001846 "[-d device_table] rootdir"
Eric Andersen3d925622005-06-09 10:16:02 +00001847#define makedevs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001848 "Create a range of special files as specified in a device table.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001849 "Device table entries take the form of:\n" \
1850 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
1851 "Where name is the file name, type can be one of:\n" \
1852 " f A regular file\n" \
1853 " d Directory\n" \
1854 " c Character special device file\n" \
1855 " b Block special device file\n" \
1856 " p Fifo (named pipe)\n" \
1857 "uid is the user id for the target file, gid is the group id for the\n" \
1858 "target file. The rest of the entries (major, minor, etc) apply to\n" \
1859 "to device special files. A '-' may be used for blank entries."
Eric Andersene8614db2005-07-18 09:28:36 +00001860#define makedevs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001861 "For example:\n" \
1862 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1863 "/dev d 755 0 0 - - - - -\n" \
1864 "/dev/console c 666 0 0 5 1 - - -\n" \
1865 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1866 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1867 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1868 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1869 "Will Produce:\n" \
1870 "/dev\n" \
1871 "/dev/console\n" \
1872 "/dev/null\n" \
1873 "/dev/zero\n" \
1874 "/dev/hda\n" \
1875 "/dev/hda[0-15]\n"
Eric Andersen3d925622005-06-09 10:16:02 +00001876#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001877
Eric Andersen7e9276b2001-02-22 01:15:47 +00001878#define md5sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001879 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001880 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00001881#define md5sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001882 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
1883 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001884 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenkoce979602006-09-27 23:31:08 +00001885 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001886 " -c check MD5 sums against given list\n" \
1887 "\nThe following two options are useful only when verifying checksums:\n" \
1888 " -s don't output anything, status code shows success\n" \
1889 " -w warn about improperly formatted MD5 checksum lines")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001890#define md5sum_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001891 "$ md5sum < busybox\n" \
1892 "6fd11e98b98a58f64ff3398d7b324003\n" \
1893 "$ md5sum busybox\n" \
1894 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1895 "$ md5sum -c -\n" \
1896 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
1897 "busybox: OK\n" \
1898 "^D\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001899
Rob Landley70f7ef72005-12-13 08:21:33 +00001900#define mdev_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001901 "[-s]"
Rob Landley70f7ef72005-12-13 08:21:33 +00001902#define mdev_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001903 " -s Scan /sys and populate /dev during system boot\n\n" \
1904 "Called with no options (via hotplug) it uses environment variables\n" \
1905 "to determine which device to add/remove."
Rob Landleyef10d522006-06-26 14:11:33 +00001906#define mdev_notes_usage "" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001907 USE_FEATURE_MDEV_CONFIG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001908 "The mdev config file contains lines that look like:\n" \
1909 " hd[a-z][0-9]* 0:3 660\n\n" \
1910 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00001911 USE_FEATURE_MDEV_EXEC( \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00001912 "Optionally, that can be followed (on the same line) by a special character\n" \
1913 "and a command line to run after creating/before deleting the corresponding\n" \
1914 "device(s). The environment variable $MDEV indicates the active device node\n" \
1915 "(which is useful if it's a regex match). For example:\n\n" \
1916 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
1917 "The special characters are @ (run after creating), $ (run before deleting),\n" \
1918 "and * (run both after creating and before deleting). The commands run in\n" \
1919 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
Rob Landleyef10d522006-06-26 14:11:33 +00001920 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001921 "Config file parsing stops on the first matching line. If no config\n"\
1922 "entry is matched, devices are created with default 0:0 660. (Make\n"\
1923 "the last line match .* to override this.)\n\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001924 )
Rob Landley70f7ef72005-12-13 08:21:33 +00001925
Glenn L McGrath061c9002002-09-16 04:21:46 +00001926#define mesg_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001927 "[y|n]"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001928#define mesg_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001929 "Control write access to your terminal\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001930 " y Allow write access to your terminal\n" \
1931 " n Disallow write access to your terminal"
Glenn L McGrath061c9002002-09-16 04:21:46 +00001932
Eric Andersen7e9276b2001-02-22 01:15:47 +00001933#define mkdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001934 "[OPTION] DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00001935#define mkdir_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001936 "Create the DIRECTORY(ies) if they do not already exist" \
1937 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001938 " -m set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
1939 " -p no error if existing, make parent directories as needed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00001940#define mkdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001941 "$ mkdir /tmp/foo\n" \
1942 "$ mkdir /tmp/foo\n" \
1943 "/tmp/foo: File exists\n" \
1944 "$ mkdir /tmp/foo/bar/baz\n" \
1945 "/tmp/foo/bar/baz: No such file or directory\n" \
1946 "$ mkdir -p /tmp/foo/bar/baz\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001947
Mike Frysinger6447ac02005-06-11 05:29:40 +00001948#define mke2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001949 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
1950 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
1951 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
1952 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
1953 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
1954 "device [blocks-count]"
Mike Frysinger6447ac02005-06-11 05:29:40 +00001955#define mke2fs_full_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001956 " -b size block size in bytes\n" \
1957 " -c check for bad blocks before creating\n" \
1958 " -E opts set extended options\n" \
1959 " -f size fragment size in bytes\n" \
1960 " -F force (ignore sanity checks)\n" \
1961 " -g num number of blocks in a block group\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001962 " -i ratio the bytes/inode ratio\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001963 " -j create a journal (ext3)\n" \
1964 " -J opts set journal options (size/device)\n" \
1965 " -l file read bad blocks list from file\n" \
1966 " -L lbl set the volume label\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001967 " -m percent percent of fs blocks to reserve for admin\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001968 " -M dir set last mounted directory\n" \
1969 " -n do not actually create anything\n" \
1970 " -N num number of inodes to create\n" \
1971 " -o os set the 'creator os' field\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001972 " -O features dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001973 " -q quiet execution\n" \
1974 " -r rev set filesystem revision\n" \
1975 " -S write superblock and group descriptors only\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001976 " -T fs-type set usage type (news/largefile/largefile4)\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00001977 " -v verbose execution"
Mike Frysinger6447ac02005-06-11 05:29:40 +00001978
Eric Andersen7e9276b2001-02-22 01:15:47 +00001979#define mkfifo_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001980 "[OPTIONS] name"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001981#define mkfifo_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00001982 "Create a named pipe (identical to 'mknod name p')" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001983 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001984 " -m create the pipe using the specified mode (default a=rw)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001985
Eric Andersen7e9276b2001-02-22 01:15:47 +00001986#define mkfs_minix_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001987 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001988#define mkfs_minix_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00001989 "Make a MINIX filesystem" \
1990 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001991 " -c Check the device for bad blocks\n" \
1992 " -n [14|30] Specify the maximum length of filenames\n" \
1993 " -i INODES Specify the number of inodes for the filesystem\n" \
1994 " -l FILENAME Read the bad blocks list from FILENAME\n" \
1995 " -v Make a Minix version 2 filesystem"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00001996
Eric Andersen7e9276b2001-02-22 01:15:47 +00001997#define mknod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00001998 "[OPTIONS] NAME TYPE MAJOR MINOR"
Eric Andersen7e9276b2001-02-22 01:15:47 +00001999#define mknod_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002000 "Create a special file (block, character, or pipe)" \
2001 "\n\nOptions:\n" \
2002 " -m create the special file using the specified mode (default a=rw)" \
2003 "\n\nTYPEs include:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002004 " b: Make a block (buffered) device\n" \
2005 " c or u: Make a character (un-buffered) device\n" \
2006 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002007#define mknod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002008 "$ mknod /dev/fd0 b 2 0\n" \
2009 "$ mknod -m 644 /tmp/pipe p\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002010
Eric Andersen7e9276b2001-02-22 01:15:47 +00002011#define mkswap_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002012 "[-c] [-v0|-v1] device [block-count]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002013#define mkswap_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002014 "Prepare a disk partition to be used as a swap partition" \
2015 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002016 " -c Check for read-ability\n" \
2017 " -v0 Make version 0 swap [max 128 Megs]\n" \
2018 " -v1 Make version 1 swap [big!] (default for kernels > 2.1.117)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002019 " block-count Number of block to use (default is entire partition)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002020
Eric Andersen7e9276b2001-02-22 01:15:47 +00002021#define mktemp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002022 "[-dq] TEMPLATE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002023#define mktemp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002024 "Create a temporary file with its name based on TEMPLATE.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002025 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2026 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002027 " -d Make a directory instead of a file\n" \
2028 " -q Fail silently if an error occurs"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002029#define mktemp_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002030 "$ mktemp /tmp/temp.XXXXXX\n" \
2031 "/tmp/temp.mWiLjM\n" \
2032 "$ ls -la /tmp/temp.mWiLjM\n" \
2033 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002034
Eric Andersen8d79ce82001-07-22 23:00:15 +00002035#define modprobe_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002036 "[-knqrsv] MODULE [symbol=value ...]"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002037#define modprobe_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002038 "Options:\n" \
2039 " -k Make module autoclean-able\n" \
2040 " -n Just show what would be done\n" \
2041 " -q Quiet output\n" \
2042 " -r Remove module (stacks) or do autoclean\n" \
2043 " -s Report via syslog instead of stderr\n" \
2044 " -v Verbose output"
Rob Landley9c32a152005-12-11 20:12:24 +00002045#define modprobe_notes_usage \
2046"modprobe can (un)load a stack of modules, passing each module options (when\n" \
2047"loading). modprobe uses a configuration file to determine what option(s) to\n" \
2048"pass each module it loads.\n" \
2049"\n" \
2050"The configuration file is searched (in order) amongst:\n" \
2051"\n" \
2052" /etc/modprobe.conf (2.6 only)\n" \
2053" /etc/modules.conf\n" \
2054" /etc/conf.modules (deprecated)\n" \
2055"\n" \
2056"They all have the same syntax (see below). If none is present, it is\n" \
2057"_not_ an error; each loaded module is then expected to load without\n" \
2058"options. Once a file is found, the others are tested for.\n" \
2059"\n" \
2060"/etc/modules.conf entry format:\n" \
2061"\n" \
2062" alias <alias_name> <mod_name>\n" \
2063" Makes it possible to modprobe alias_name, when there is no such module.\n" \
Mike Frysingerfa6c4842006-05-26 01:48:17 +00002064" It makes sense if your mod_name is long, or you want a more representative\n" \
Rob Landley9c32a152005-12-11 20:12:24 +00002065" name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2066" This makes it also possible to use a different set of options (below) for\n" \
2067" the module and the alias.\n" \
2068" A module can be aliased more than once.\n" \
2069"\n" \
2070" options <mod_name|alias_name> <symbol=value ...>\n" \
2071" When loading module mod_name (or the module aliased by alias_name), pass\n" \
2072" the \"symbol=value\" pairs as option to that module.\n" \
2073"\n" \
2074"Sample /etc/modules.conf file:\n" \
2075"\n" \
2076" options tulip irq=3\n" \
2077" alias tulip tulip2\n" \
2078" options tulip2 irq=4 io=0x308\n" \
2079"\n" \
2080"Other functionality offered by 'classic' modprobe is not available in\n" \
2081"this implementation.\n" \
2082"\n" \
2083"If module options are present both in the config file, and on the command line,\n" \
2084"then the options from the command line will be passed to the module _after_\n" \
2085"the options from the config file. That way, you can have defaults in the config\n" \
2086"file, and override them for a specific usage from the command line.\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002087#define modprobe_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002088 "(with the above /etc/modules.conf):\n\n" \
2089 "$ modprobe tulip\n" \
2090 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2091 "$ modprobe tulip irq=5\n" \
2092 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2093 "$ modprobe tulip2\n" \
2094 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2095 " which are the default for alias 'tulip2'\n\n" \
2096 "$ modprobe tulip2 irq=8\n" \
2097 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2098 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2099 " from the command line\n\n" \
2100 "$ modprobe tulip2 irq=2 io=0x210\n" \
2101 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2102 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2103 " from the command line\n"
Eric Andersen8d79ce82001-07-22 23:00:15 +00002104
Eric Andersen7e9276b2001-02-22 01:15:47 +00002105#define more_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002106 "[FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002107#define more_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002108 "View FILE or standard input one screenful at a time"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002109#define more_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002110 "$ dmesg | more\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002111
Eric Andersen7e9276b2001-02-22 01:15:47 +00002112#define mount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002113 "[flags] DEVICE NODE [-o options,more-options]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002114#define mount_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002115 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2116 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002117 " -a: Mount all filesystems in fstab\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002118 USE_FEATURE_MTAB_SUPPORT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002119 " -f: \"Fake\" Add entry to mount table but don't mount it\n" \
2120 " -n: Don't write a mount table entry\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002121 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002122 " -o option: One of many filesystem options, listed below\n" \
2123 " -r: Mount the filesystem read-only\n" \
2124 " -t fs-type: Specify the filesystem type\n" \
2125 " -w: Mount for reading and writing (default)\n" \
2126 "\n" \
2127 "Options for use with the \"-o\" flag:\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002128 USE_FEATURE_MOUNT_LOOP( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002129 " loop: Ignored (loop devices are autodetected)\n" \
Eric Andersen7e9276b2001-02-22 01:15:47 +00002130 ) \
Rob Landleye55a73c2006-08-09 20:55:35 +00002131 USE_FEATURE_MOUNT_FLAGS( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002132 " [a]sync: Writes are asynchronous / synchronous\n" \
2133 " [no]atime: Disable / enable updates to inode access times\n" \
2134 " [no]diratime: Disable / enable atime updates to directories\n" \
2135 " [no]dev: Allow use of special device files / disallow them\n" \
2136 " [no]exec: Allow use of executable files / disallow them\n" \
2137 " [no]suid: Allow set-user-id-root programs / disallow them\n" \
2138 " [r]shared: Convert [recursively] to a shared subtree.\n" \
2139 " [r]slave: Convert [recursively] to a slave subtree.\n" \
2140 " [r]private: Convert [recursively] to a private subtree\n" \
2141 " [un]bindable: Make mount point [un]able to be bind mounted.\n" \
2142 " bind: Bind a directory to an additional location\n" \
2143 " move: Relocate an existing mount point.\n" \
Rob Landleye55a73c2006-08-09 20:55:35 +00002144 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002145 " remount: Re-mount a mounted filesystem, changing its flags\n" \
2146 " ro/rw: Mount for read-only / read-write\n" \
2147 "\nThere are EVEN MORE flags that are specific to each filesystem\n" \
2148 "You'll have to see the written documentation for those filesystems"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002149#define mount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002150 "$ mount\n" \
2151 "/dev/hda3 on / type minix (rw)\n" \
2152 "proc on /proc type proc (rw)\n" \
2153 "devpts on /dev/pts type devpts (rw)\n" \
2154 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2155 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2156 "$ mount cd_image.iso mydir\n"
Rob Landleye1ee4822006-06-24 22:39:19 +00002157#define mount_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002158 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002159
Rob Landleyd00b3a52005-08-20 05:07:08 +00002160#define mountpoint_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002161 "[-q] <[-d] DIR | -x DEVICE>"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002162#define mountpoint_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002163 "mountpoint checks if the directory is a mountpoint" \
2164 "\n\nOptions:\n" \
Bernhard Reutner-Fischer95da1772006-12-07 12:16:17 +00002165 " -q Be more quiet\n" \
2166 " -d Print major/minor device number of the filesystem\n" \
2167 " -x Print major/minor device number of the blockdevice"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002168#define mountpoint_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002169 "$ mountpoint /proc\n" \
2170 "/proc is not a mountpoint\n" \
2171 "$ mountpoint /sys\n" \
2172 "/sys is a mountpoint\n"
Rob Landleyd00b3a52005-08-20 05:07:08 +00002173
Eric Andersen7e9276b2001-02-22 01:15:47 +00002174#define mt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002175 "[-f device] opcode value"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002176#define mt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002177 "Control magnetic tape drive operation\n" \
2178 "\nAvailable Opcodes:\n\n" \
2179 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2180 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2181 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2182 "setpart tell unload unlock weof wset"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002183
Eric Andersen7e9276b2001-02-22 01:15:47 +00002184#define mv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002185 "[OPTION]... SOURCE DEST\n" \
2186 "or: mv [OPTION]... SOURCE... DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002187#define mv_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002188 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2189 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002190 " -f don't prompt before overwriting\n" \
2191 " -i interactive, prompt before overwrite"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002192#define mv_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002193 "$ mv /tmp/foo /bin/bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002194
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002195#define nameif_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002196 "[-s] [-c FILE] [{IFNAME MACADDR}]"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002197#define nameif_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002198 "Rename network interface while it in the down state" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002199 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002200 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2201 " -s Use syslog (LOCAL0 facility)\n" \
2202 " IFNAME MACADDR new_interface_name interface_mac_address"
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002203#define nameif_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002204 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2205 " or\n" \
2206 "$ nameif -c /etc/my_mactab_file\n" \
Glenn L McGrathf03c9332002-12-13 00:01:44 +00002207
Rob Landley1cca9482006-07-10 19:45:20 +00002208#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002209#define NC_OPTIONS_STR "\n\nOptions:"
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002210#else
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002211#define NC_OPTIONS_STR
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002212#endif
Rob Landley1cca9482006-07-10 19:45:20 +00002213
Eric Andersen7e9276b2001-02-22 01:15:47 +00002214#define nc_trivial_usage \
Denis Vlasenkof7eaccd2006-11-18 02:17:37 +00002215 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002216 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002217#define nc_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002218 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
Denis Vlasenkod0e70af2006-10-16 01:10:28 +00002219 NC_OPTIONS_STR \
Rob Landley1cca9482006-07-10 19:45:20 +00002220 USE_NC_EXTRA( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002221 "\n -e exec rest of command line after connect" \
2222 "\n -i SECS delay interval for lines sent" \
2223 "\n -w SECS timeout for connect" \
2224 "\n -f file use file (ala /dev/ttyS0) instead of network" \
Mike Frysinger7dc7f402005-05-06 05:00:34 +00002225 ) \
Rob Landley1cca9482006-07-10 19:45:20 +00002226 USE_NC_SERVER( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002227 "\n -l listen mode, for inbound connects" \
2228 USE_NC_EXTRA( \
2229 "\n (use -l twice with -e for persistent server)") \
2230 "\n -p PORT local port number" \
Rob Landley1cca9482006-07-10 19:45:20 +00002231 )
2232
Rob Landley1cca9482006-07-10 19:45:20 +00002233#define nc_notes_usage "" \
2234 USE_NC_EXTRA( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002235 "To use netcat as a terminal emulator on a serial port:\n\n" \
2236 "$ stty 115200 -F /dev/ttyS0\n" \
2237 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2238 )
Rob Landley1cca9482006-07-10 19:45:20 +00002239
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002240#define nc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002241 "$ nc foobar.somedomain.com 25\n" \
2242 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2243 "help\n" \
2244 "214-Commands supported:\n" \
2245 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2246 "214 NOOP QUIT RSET HELP\n" \
2247 "quit\n" \
2248 "221 foobar closing connection\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002249
Eric Andersen1552ff72001-10-31 11:07:12 +00002250#define netstat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002251 "[-laenrtuwx]"
Eric Andersen1552ff72001-10-31 11:07:12 +00002252#define netstat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002253 "Display networking information" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002254 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002255 " -l display listening server sockets\n" \
2256 " -a display all sockets (default: connected)\n" \
2257 " -e display other/more information\n" \
2258 " -n don't resolve names\n" \
2259 " -r display routing table\n" \
2260 " -t tcp sockets\n" \
2261 " -u udp sockets\n" \
2262 " -w raw sockets\n" \
2263 " -x unix sockets"
Eric Andersen1552ff72001-10-31 11:07:12 +00002264
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002265#define nice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002266 "[-n ADJUST] [COMMAND [ARG] ...]"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002267#define nice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002268 "Run a program with modified scheduling priority" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002269 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002270 " -n ADJUST Adjust the scheduling priority by ADJUST"
Manuel Novoa III 2c511602005-02-13 20:14:05 +00002271
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002272#define nmeter_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002273 "format_string"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002274#define nmeter_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002275 "Monitor system in real time\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002276 "Format specifiers:\n" \
2277 "%Nc or %[cN] monitor CPU. N - bar size, default 10\n" \
2278 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
2279 "%[niface] monitor network interface 'iface'\n" \
2280 "%m monitor allocated memory\n" \
2281 "%[mf] monitor free memory\n" \
2282 "%[mt] monitor total memory\n" \
2283 "%s monitor allocated swap\n" \
2284 "%f monitor number of used file descriptors\n" \
2285 "%Ni monitor total/specific IRQ rate\n" \
2286 "%x monitor context switch rate\n" \
2287 "%p monitor forks\n" \
2288 "%[pn] monitor # of processes\n" \
2289 "%b monitor block io\n" \
2290 "%Nt show time (with N decimal points)\n" \
2291 "%Nd milliseconds between updates (default=1000)\n" \
2292 "%r print <cr> instead of <lf> at EOL"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002293#define nmeter_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002294 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
Denis Vlasenko1db39b22006-10-11 20:59:02 +00002295
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002296#define nohup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002297 "COMMAND [ARGS]"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002298#define nohup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002299 "Run a command immune to hangups, with output to a non-tty"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002300#define nohup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002301 "$ nohup make &"
Bernhard Reutner-Fischer9d7010c2005-09-21 18:25:05 +00002302
Eric Andersen7e9276b2001-02-22 01:15:47 +00002303#define nslookup_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002304 "[HOST] [SERVER]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002305#define nslookup_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002306 "Query the nameserver for the IP address of the given HOST\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002307 "optionally using a specified DNS server"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002308#define nslookup_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002309 "$ nslookup localhost\n" \
2310 "Server: default\n" \
2311 "Address: default\n" \
2312 "\n" \
2313 "Name: debian\n" \
2314 "Address: 127.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002315
Glenn L McGrath60281112001-11-02 11:39:46 +00002316#define od_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002317 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
Glenn L McGrath60281112001-11-02 11:39:46 +00002318#define od_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002319 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
2320 "to standard output. With no FILE, or when FILE is -, read standard input."
Glenn L McGrath60281112001-11-02 11:39:46 +00002321
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002322#define openvt_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002323 "<vtnum> <COMMAND> [ARGS...]"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002324#define openvt_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002325 "Start a command on a new virtual terminal"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002326#define openvt_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002327 "openvt 2 /bin/ash\n"
Glenn L McGrathec0c48c2002-09-16 03:16:06 +00002328
Eric Andersen27f64e12002-06-23 04:24:25 +00002329#define passwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002330 "[OPTION] [name]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002331#define passwd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002332 "Change a user password. If no name is specified,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002333 "changes the password for the current user." \
2334 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002335 " -a Define which algorithm shall be used for the password\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002336 " (Choices: des, md5)\n" /* ", sha1)" */ \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002337 " -d Delete the password for the specified user account\n" \
2338 " -l Locks (disables) the specified user account\n" \
2339 " -u Unlocks (re-enables) the specified user account"
Eric Andersen27f64e12002-06-23 04:24:25 +00002340
Glenn L McGrath655d8142003-06-22 15:32:41 +00002341#define patch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002342 "[-p<num>] [-i <diff>]"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002343#define patch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002344 " -p NUM Strip NUM leading components from file names\n" \
2345 " -i DIFF Read DIFF instead of stdin"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002346#define patch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002347 "$ patch -p1 < example.diff\n" \
2348 "$ patch -p0 -i example.diff"
Glenn L McGrath655d8142003-06-22 15:32:41 +00002349
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002350#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2351#define USAGE_PIDOF "Options:"
2352#else
Denis Vlasenko765996a2006-12-24 16:59:27 +00002353#define USAGE_PIDOF "\nThis version of pidof accepts no options."
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002354#endif
2355
Eric Andersen221b2ea2001-07-31 19:06:07 +00002356#define pidof_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002357 "process-name [OPTION] [process-name ...]"
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002358
Eric Andersen221b2ea2001-07-31 19:06:07 +00002359#define pidof_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002360 "List the PIDs of all processes with names that match the\n" \
2361 "names on the command line\n" \
Bernhard Reutner-Fischer81c3a512005-10-06 15:37:02 +00002362 USAGE_PIDOF \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002363 USE_FEATURE_PIDOF_SINGLE( \
2364 "\n -s display only a single PID") \
2365 USE_FEATURE_PIDOF_OMIT( \
2366 "\n -o omit given pid.") \
2367 USE_FEATURE_PIDOF_OMIT( \
2368 "\n Use %PPID to omit the parent pid of pidof itself")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002369#define pidof_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002370 "$ pidof init\n" \
2371 "1\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002372 USE_FEATURE_PIDOF_OMIT( \
2373 "$ pidof /bin/sh\n20351 5973 5950\n") \
2374 USE_FEATURE_PIDOF_OMIT( \
2375 "$ pidof /bin/sh -o %PPID\n20351 5950")
Eric Andersen221b2ea2001-07-31 19:06:07 +00002376
Eric Andersenbdfd0d72001-10-24 05:00:29 +00002377#ifndef CONFIG_FEATURE_FANCY_PING
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002378#define ping_trivial_usage \
2379 "host"
2380#define ping_full_usage \
2381 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002382#else
2383#define ping_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002384 "[OPTION]... host"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002385#define ping_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002386 "Send ICMP ECHO_REQUEST packets to network hosts" \
2387 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002388 " -c CNT Send only CNT pings\n" \
2389 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2390 " -I IP Use IP as source address\n" \
2391 " -q Quiet mode, only displays output at start\n" \
2392 " and when finished"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002393#endif
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002394#define ping_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002395 "$ ping localhost\n" \
2396 "PING slag (127.0.0.1): 56 data bytes\n" \
2397 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2398 "\n" \
2399 "--- debian ping statistics ---\n" \
2400 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2401 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002402
Eric Andersen51b8bd62002-07-03 11:46:38 +00002403#ifndef CONFIG_FEATURE_FANCY_PING6
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002404#define ping6_trivial_usage \
2405 "host"
2406#define ping6_full_usage \
2407 "Send ICMP ECHO_REQUEST packets to network hosts"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002408#else
2409#define ping6_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002410 "[OPTION]... host"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002411#define ping6_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002412 "Send ICMP ECHO_REQUEST packets to network hosts" \
2413 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002414 " -c CNT Send only CNT pings\n" \
2415 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2416 " -q Quiet mode, only displays output at start\n" \
2417 " and when finished"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002418#endif
2419#define ping6_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002420 "$ ping6 ip6-localhost\n" \
2421 "PING ip6-localhost (::1): 56 data bytes\n" \
2422 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2423 "\n" \
2424 "--- ip6-localhost ping statistics ---\n" \
2425 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2426 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
Eric Andersen51b8bd62002-07-03 11:46:38 +00002427
Eric Andersen7e9276b2001-02-22 01:15:47 +00002428#define pivot_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002429 "NEW_ROOT PUT_OLD"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002430#define pivot_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002431 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
2432 "the new root file system."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002433
Eric Andersen7e9276b2001-02-22 01:15:47 +00002434#define poweroff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002435 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002436#define poweroff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002437 "Halt and shut off power" \
2438 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002439 " -d delay interval for halting\n" \
2440 " -n no call to sync()\n" \
2441 " -f force power off (don't go through init)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002442
Mike Frysinger95d3c452005-04-21 23:29:24 +00002443#define printenv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002444 "[VARIABLES...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002445#define printenv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002446 "Print all or part of environment.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002447 "If no environment VARIABLE specified, print them all."
Mike Frysinger95d3c452005-04-21 23:29:24 +00002448
Eric Andersen7e9276b2001-02-22 01:15:47 +00002449#define printf_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002450 "FORMAT [ARGUMENT...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002451#define printf_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002452 "Format and print ARGUMENT(s) according to FORMAT,\n" \
2453 "where FORMAT controls the output exactly as in C printf."
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002454#define printf_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002455 "$ printf \"Val=%d\\n\" 5\n" \
2456 "Val=5\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002457
Denis Vlasenko94949192006-11-05 00:45:47 +00002458
2459#if ENABLE_DESKTOP
2460
2461#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002462 ""
Denis Vlasenko94949192006-11-05 00:45:47 +00002463#define ps_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002464 "Report process status" \
2465 "\n\nOptions:" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002466 "\n -o col1,col2=header Select columns for display" \
Denis Vlasenko94949192006-11-05 00:45:47 +00002467
2468#else /* !ENABLE_DESKTOP */
2469
Bernhard Reutner-Fischer6d6a40c2005-10-04 14:31:18 +00002470#if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002471#define USAGE_PS "\n This version of ps accepts no options."
Rob Landley6eb1e412005-06-20 04:30:36 +00002472#else
2473#define USAGE_PS "\nOptions:"
2474#endif
Eric Andersen15c03c32004-04-06 17:52:02 +00002475
Eric Andersen7e9276b2001-02-22 01:15:47 +00002476#define ps_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002477 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002478#define ps_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002479 "Report process status\n" \
Rob Landley6eb1e412005-06-20 04:30:36 +00002480 USAGE_PS \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002481 USE_SELINUX( \
2482 "\n -c show SE Linux context") \
2483 USE_FEATURE_PS_WIDE( \
2484 "\n w wide output")
Rob Landley6eb1e412005-06-20 04:30:36 +00002485
Denis Vlasenko94949192006-11-05 00:45:47 +00002486#endif /* ENABLE_DESKTOP */
2487
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002488#define ps_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002489 "$ ps\n" \
2490 " PID Uid Gid State Command\n" \
2491 " 1 root root S init\n" \
2492 " 2 root root S [kflushd]\n" \
2493 " 3 root root S [kupdate]\n" \
2494 " 4 root root S [kpiod]\n" \
2495 " 5 root root S [kswapd]\n" \
2496 " 742 andersen andersen S [bash]\n" \
2497 " 743 andersen andersen S -bash\n" \
2498 " 745 root root S [getty]\n" \
2499 " 2990 andersen andersen R ps\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002500
Denis Vlasenko94949192006-11-05 00:45:47 +00002501
Eric Andersen7e9276b2001-02-22 01:15:47 +00002502#define pwd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002503 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002504#define pwd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002505 "Print the full filename of the current working directory"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002506#define pwd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002507 "$ pwd\n" \
2508 "/root\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002509
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002510#define raidautorun_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002511 "DEVICE"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002512#define raidautorun_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002513 "Tell the kernel to automatically search and start RAID arrays"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002514#define raidautorun_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002515 "$ raidautorun /dev/md0"
Denis Vlasenkoc108ed52006-10-20 19:39:48 +00002516
Eric Andersen7e9276b2001-02-22 01:15:47 +00002517#define rdate_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002518 "[-sp] HOST"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002519#define rdate_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002520 "Get and possibly set the system date and time from a remote HOST" \
2521 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002522 " -s Set the system date and time (default)\n" \
2523 " -p Print the date and time"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002524
Rob Landley0e4690d2006-08-20 22:12:18 +00002525#define readahead_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002526 "[FILE]..."
Rob Landley0e4690d2006-08-20 22:12:18 +00002527#define readahead_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002528 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2529 "files do not block on disk I/O"
Rob Landley0e4690d2006-08-20 22:12:18 +00002530
Eric Andersen7e9276b2001-02-22 01:15:47 +00002531#define readlink_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002532 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002533#define readlink_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002534 "Display the value of a symbolic link" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002535 USE_FEATURE_READLINK_FOLLOW( \
2536 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002537 " -f canonicalize by following all symlinks")
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002538
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002539#define readprofile_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002540 "[OPTIONS]..."
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002541#define readprofile_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002542 "Options:\n" \
2543 " -m <mapfile> (default: /boot/System.map)\n" \
2544 " -p <profile> (default: /proc/profile)\n" \
2545 " -M <mult> set the profiling multiplier to <mult>\n" \
2546 " -i print only info about the sampling step\n" \
2547 " -v print verbose data\n" \
2548 " -a print all symbols, even if count is 0\n" \
2549 " -b print individual histogram-bin counts\n" \
2550 " -s print individual counters within functions\n" \
2551 " -r reset all the counters (root only)\n" \
2552 " -n disable byte order auto-detection"
Paul Mundt8b2d02e2005-05-20 17:22:18 +00002553
Glenn L McGrath62fae302002-12-10 00:14:33 +00002554#define realpath_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002555 "pathname ..."
Glenn L McGrath62fae302002-12-10 00:14:33 +00002556#define realpath_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002557 "Return the absolute pathnames of given argument"
Tim Riker7b253f82003-12-28 05:02:40 +00002558
Eric Andersen7e9276b2001-02-22 01:15:47 +00002559#define reboot_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002560 "[-d<delay>] [-n<nosync>] [-f<force>]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002561#define reboot_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002562 "Reboot the system" \
2563 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002564 " -d delay interval for rebooting\n" \
2565 " -n no call to sync()\n" \
2566 " -f force reboot (don't go through init)"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002567
2568#define renice_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002569 "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002570#define renice_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002571 "Change priority of running processes" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002572 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002573 " -n adjusts current nice value (smaller is faster)\n" \
2574 " -p process id(s) (default)\n" \
2575 " -g process group id(s)\n" \
2576 " -u process user name(s) and/or id(s)"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002577
Eric Andersen7e9276b2001-02-22 01:15:47 +00002578#define reset_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002579 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002580#define reset_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002581 "Reset the screen"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002582
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002583#define resize_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002584 ""
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002585#define resize_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002586 "Resize the screen"
Bernhard Reutner-Fischere63a0de2006-10-25 15:07:56 +00002587
Eric Andersen7e9276b2001-02-22 01:15:47 +00002588#define rm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002589 "[OPTION]... FILE..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002590#define rm_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002591 "Remove (unlink) the FILE(s). You may use '--' to\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002592 "indicate that all following arguments are non-options." \
2593 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002594 " -i always prompt before removing each destination\n" \
2595 " -f remove existing destinations, never prompt\n" \
2596 " -r,-R remove the contents of directories recursively"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002597#define rm_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002598 "$ rm -rf /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002599
Eric Andersen7e9276b2001-02-22 01:15:47 +00002600#define rmdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002601 "[OPTION]... DIRECTORY..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002602#define rmdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002603 "Remove the DIRECTORY, if it is empty"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002604#define rmdir_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002605 "# rmdir /tmp/foo\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002606
Eric Andersen7e9276b2001-02-22 01:15:47 +00002607#define rmmod_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002608 "[OPTION]... [MODULE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002609#define rmmod_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002610 "Unload the specified kernel modules from the kernel" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002611 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002612 " -a Remove all unused modules (recursively)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002613#define rmmod_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002614 "$ rmmod tulip\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002615
Eric Andersen7e9276b2001-02-22 01:15:47 +00002616#define route_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002617 "[{add|del|delete}]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002618#define route_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002619 "Edit the kernel's routing tables" \
2620 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002621 " -n Dont resolve names\n" \
2622 " -e Display other/more information\n" \
2623 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002624
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002625#define rpm_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002626 "-i -q[ildc]p package.rpm"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002627#define rpm_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002628 "Manipulate RPM packages" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002629 "\n\nOptions:" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002630 "\n -i Install package" \
2631 "\n -q Query package" \
2632 "\n -p Query uninstalled package" \
2633 "\n -i Show information" \
2634 "\n -l List contents" \
2635 "\n -d List documents" \
2636 "\n -c List config files"
Glenn L McGrathb72a7352002-12-10 00:17:22 +00002637
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002638#define rpm2cpio_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002639 "package.rpm"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002640#define rpm2cpio_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002641 "Output a cpio archive of the rpm file"
Glenn L McGrathf8736d22001-06-26 01:19:34 +00002642
Eric Andersen6cf47a72001-10-31 10:24:36 +00002643#define run_parts_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002644 "[-t] [-a ARG] [-u MASK] DIRECTORY"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002645#define run_parts_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002646 "Run a bunch of scripts in a directory" \
2647 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002648 " -t Prints what would be run, but does not actually run anything\n" \
2649 " -a ARG Pass ARG as an argument for every program invoked\n" \
2650 " -u MASK Set the umask to MASK before executing every program"
Eric Andersen6cf47a72001-10-31 10:24:36 +00002651
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002652#define runlevel_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002653 "[utmp]"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002654#define runlevel_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002655 "Find the current and previous system runlevel.\n\n" \
2656 "If no utmp file exists or if no runlevel record can be found,\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002657 "print \"unknown\""
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002658#define runlevel_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002659 "$ runlevel /var/run/utmp\n" \
2660 "N 2"
Bernhard Reutner-Fischer62d7acc2005-10-28 20:37:03 +00002661
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002662#define runsv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002663 "dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002664#define runsv_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002665 "Start and monitor a service and optionally an appendant log service"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002666
2667#define runsvdir_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002668 "[-P] dir"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002669#define runsvdir_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002670 "Start a runsv process for each subdirectory"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002671
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002672#define rx_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002673 "FILE"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002674#define rx_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002675 "Receive a file using the xmodem protocol"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002676#define rx_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002677 "$ rx /tmp/foo\n"
Glenn L McGrath8f3bc4c2003-12-20 07:30:35 +00002678
Eric Andersen7e9276b2001-02-22 01:15:47 +00002679#define sed_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002680 "[-efinr] pattern [files...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002681#define sed_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002682 "Options:\n" \
2683 " -e script add the script to the commands to be executed\n" \
2684 " -f scriptfile add script-file contents to the\n" \
2685 " commands to be executed\n" \
2686 " -i edit files in-place\n" \
2687 " -n suppress automatic printing of pattern space\n" \
2688 " -r use extended regular expression syntax\n" \
2689 "\n" \
2690 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
2691 "script to interpret. All remaining arguments are names of input files; if no\n" \
2692 "input files are specified, then the standard input is read. Source files\n" \
2693 "will not be modified unless -i option is given."
Eric Andersenf802ff72004-04-12 15:12:06 +00002694
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002695#define sed_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002696 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
2697 "bar\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002698
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002699#define seq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002700 "[first [increment]] last"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002701#define seq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002702 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002703 "FIRST, INCREMENT default to 1" \
2704 "\n\nArguments:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002705 " LAST\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002706 " FIRST LAST\n" \
2707 " FIRST INCREMENT LAST"
Glenn L McGrath82364bb2004-01-27 09:22:20 +00002708
Paul Foxfc2256a2005-08-01 18:12:30 +00002709#define setconsole_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002710 "[-r|--reset] [DEVICE]"
Paul Foxfc2256a2005-08-01 18:12:30 +00002711#define setconsole_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002712 "Redirect system console output to DEVICE (default: /dev/tty)" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002713 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002714 " -r Reset output to /dev/console"
Paul Foxfc2256a2005-08-01 18:12:30 +00002715
Eric Andersen7e9276b2001-02-22 01:15:47 +00002716#define setkeycodes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002717 "SCANCODE KEYCODE ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002718#define setkeycodes_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002719 "Set entries into the kernel's scancode-to-keycode map,\n" \
2720 "allowing unusual keyboards to generate usable keycodes.\n\n" \
2721 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
2722 "and KEYCODE is given in decimal"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002723#define setkeycodes_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002724 "$ setkeycodes e030 127\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002725
Rob Landley87848d92006-03-27 23:23:43 +00002726#define setlogcons_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002727 "N"
Rob Landley87848d92006-03-27 23:23:43 +00002728#define setlogcons_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002729 "Redirect the kernel output to console N (0 for current)"
Rob Landley87848d92006-03-27 23:23:43 +00002730
Paul Fox42403642005-08-01 22:52:09 +00002731#define setsid_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002732 "program [arg ...]"
Paul Fox42403642005-08-01 22:52:09 +00002733#define setsid_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002734 "Run any program in a new session by calling setsid() before\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002735 "exec'ing the rest of its arguments. See setsid(2) for details."
Paul Fox42403642005-08-01 22:52:09 +00002736
Matt Kraai2d91deb2001-08-01 17:21:35 +00002737#define lash_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002738 "[FILE]...\n" \
2739 "or: sh -c command [args]..."
Matt Kraai2d91deb2001-08-01 17:21:35 +00002740#define lash_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002741 "The BusyBox LAme SHell (command interpreter)"
Matt Kraai2d91deb2001-08-01 17:21:35 +00002742#define lash_notes_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002743 "This command does not yet have proper documentation.\n\n" \
2744 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2745 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2746 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2747 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
2748 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2749 "this will do the job."
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002750
Eric Andersen2e9c2572003-08-08 22:26:06 +00002751#define last_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002752 ""
Eric Andersen2e9c2572003-08-08 22:26:06 +00002753#define last_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002754 "Show listing of the last users that logged into the system"
Eric Andersen2e9c2572003-08-08 22:26:06 +00002755
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002756#define sha1sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002757 "[OPTION] [FILEs...]" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002758 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002759#define sha1sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002760 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002761 "With no FILE, or when FILE is -, read standard input." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002762 "\n\nOptions:\n" \
2763 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002764 " -c check SHA1 sums against given list\n" \
2765 "\nThe following two options are useful only when verifying checksums:\n" \
2766 " -s don't output anything, status code shows success\n" \
2767 " -w warn about improperly formatted SHA1 checksum lines")
Glenn L McGrathae0f1e72003-02-17 08:23:22 +00002768
Eric Andersen7e9276b2001-02-22 01:15:47 +00002769#define sleep_trivial_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002770 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002771#define sleep_full_usage \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002772 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds.") \
2773 USE_FEATURE_FANCY_SLEEP( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002774 "Pause for a time equal to the total of the args given, where each arg can\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002775 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002776#define sleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002777 "$ sleep 2\n" \
2778 "[2 second delay results]\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002779 USE_FEATURE_FANCY_SLEEP( \
2780 "$ sleep 1d 3h 22m 8s\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002781 "[98528 second delay results]\n")
Eric Andersen7e9276b2001-02-22 01:15:47 +00002782
Eric Andersen7e9276b2001-02-22 01:15:47 +00002783#define sort_trivial_usage \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002784 "[-nru" \
2785 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") \
2786 "] [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002787#define sort_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002788 "Sort lines of text in the specified files" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002789 "\n\nOptions:\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002790 USE_FEATURE_SORT_BIG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002791 " -b ignore leading blanks\n" \
2792 " -c check whether input is sorted\n" \
2793 " -d dictionary order (blank or alphanumeric only)\n" \
2794 " -f ignore case\n" \
2795 " -g general numerical sort\n" \
2796 " -i ignore unprintable characters\n" \
2797 " -k specify sort key\n" \
2798 " -M sort month\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002799 " -n sort numbers\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002800 USE_FEATURE_SORT_BIG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002801 " -o output to file\n" \
2802 " -k sort by key\n" \
2803 " -t use key separator other than whitespace\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002804 " -r reverse sort order\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002805 USE_FEATURE_SORT_BIG( \
2806 " -s stable (don't sort ties alphabetically)\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002807 " -u suppress duplicate lines" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002808 USE_FEATURE_SORT_BIG( \
2809 "\n -z input terminated by nulls, not newlines\n") \
2810 USE_FEATURE_SORT_BIG( \
2811 " -mST ignored for GNU compatibility") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002812 ""
Eric Andersen0d3a02e2001-03-15 18:14:25 +00002813#define sort_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002814 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
2815 "a\n" \
2816 "b\n" \
2817 "c\n" \
2818 "d\n" \
2819 "e\n" \
2820 "f\n" \
Denis Vlasenko77a1a532006-11-05 00:46:35 +00002821 USE_FEATURE_SORT_BIG( \
Rob Landleyc0dedd02005-01-24 07:00:02 +00002822 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
2823 "d 2\n" \
2824 "b 2\n" \
2825 "c 3\n" \
2826 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002827 ""
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002828
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002829#define start_stop_daemon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002830 "[OPTIONS] [--start|--stop] ... [-- arguments...]"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002831#define start_stop_daemon_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002832 "Start and stop services" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002833 "\n\nOptions:" \
2834 "\n -S|--start start" \
2835 "\n -K|--stop stop" \
2836 "\n -a|--startas <pathname> starts process specified by pathname" \
2837 "\n -b|--background force process into background" \
2838 "\n -u|--user <username>|<uid> stop this user's processes" \
2839 "\n -x|--exec <executable> program to either start or check" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002840 "\n -m|--make-pidfile create the -p file and enter pid in it" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002841 "\n -n|--name <process-name> stop processes with this name" \
2842 "\n -p|--pidfile <pid-file> save or load pid using a pid-file" \
2843 "\n -q|--quiet be quiet" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002844 USE_FEATURE_START_STOP_DAEMON_FANCY( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002845 "\n -o|--oknodo exit status 0 if nothing done" \
2846 "\n -v|--verbose be verbose" \
2847 "\n -N|--nicelevel <N> add N to process's nice level" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002848 ) \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002849 "\n -s|--signal <signal> signal to send (default TERM)" \
2850 "\n -U|--chuid <username>|<uid> start process with this name"
Eric Andersenc2af1ee2001-10-18 19:33:06 +00002851
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002852#define stat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002853 "[OPTION] FILE..."
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002854#define stat_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002855 "Display file (default) or filesystem status" \
2856 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002857 USE_FEATURE_STAT_FORMAT( \
2858 " -c fmt use the specified format\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002859 " -f display filesystem status\n" \
2860 " -L,-l dereference links\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002861 " -t display info in terse form" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00002862 USE_FEATURE_STAT_FORMAT( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002863 "\n\nValid format sequences for files:\n" \
2864 " %a Access rights in octal\n" \
2865 " %A Access rights in human readable form\n" \
2866 " %b Number of blocks allocated (see %B)\n" \
2867 " %B The size in bytes of each block reported by %b\n" \
2868 " %d Device number in decimal\n" \
2869 " %D Device number in hex\n" \
2870 " %f Raw mode in hex\n" \
2871 " %F File type\n" \
2872 " %g Group ID of owner\n" \
2873 " %G Group name of owner\n" \
2874 " %h Number of hard links\n" \
2875 " %i Inode number\n" \
2876 " %n File name\n" \
2877 " %N Quoted file name with dereference if symbolic link\n" \
2878 " %o I/O block size\n" \
2879 " %s Total size, in bytes\n" \
2880 " %t Major device type in hex\n" \
2881 " %T Minor device type in hex\n" \
2882 " %u User ID of owner\n" \
2883 " %U User name of owner\n" \
2884 " %x Time of last access\n" \
2885 " %X Time of last access as seconds since Epoch\n" \
2886 " %y Time of last modification\n" \
2887 " %Y Time of last modification as seconds since Epoch\n" \
2888 " %z Time of last change\n" \
2889 " %Z Time of last change as seconds since Epoch\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002890 "\nValid format sequences for file systems:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00002891 " %a Free blocks available to non-superuser\n" \
2892 " %b Total data blocks in file system\n" \
2893 " %c Total file nodes in file system\n" \
2894 " %d Free file nodes in file system\n" \
2895 " %f Free blocks in file system\n" \
2896 " %i File System ID in hex\n" \
2897 " %l Maximum length of filenames\n" \
2898 " %n File name\n" \
2899 " %s Block size (for faster transfers)\n" \
2900 " %S Fundamental block size (for block counts)\n" \
2901 " %t Type in hex\n" \
2902 " %T Type in human readable form" \
Mike Frysinger9b5f71e2005-04-23 06:26:38 +00002903 )
2904
Eric Andersenef5e8f82002-11-07 02:09:37 +00002905#define strings_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002906 "[-afo] [-n length] [file ... ]"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002907#define strings_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002908 "Display printable strings in a binary file" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002909 "\n\nOptions:" \
2910 "\n -a Scan the whole files (this is the default)." \
2911 "\n -f Precede each string with the name of the file where it was found." \
2912 "\n -n N Specifies that at least N characters forms a sequence (default 4)" \
2913 "\n -o Each string is preceded by its decimal offset in the file"
Eric Andersenef5e8f82002-11-07 02:09:37 +00002914
Eric Andersen7e9276b2001-02-22 01:15:47 +00002915#define stty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002916 "[-a|g] [-F DEVICE] [SETTING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00002917#define stty_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002918 "Without arguments, prints baud rate, line discipline,\n" \
2919 "and deviations from stty sane." \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002920 "\n\nOptions:" \
2921 "\n -F DEVICE open device instead of stdin" \
2922 "\n -a print all current settings in human-readable form" \
2923 "\n -g print in stty-readable form" \
2924 "\n [SETTING] see manpage"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002925
Robert Griebl1fca5582002-06-04 20:45:46 +00002926#define su_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002927 "[OPTION]... [-] [username]"
Robert Griebl1fca5582002-06-04 20:45:46 +00002928#define su_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002929 "Change user id or become root" \
2930 "\n\nOptions:" \
2931 "\n -p, -m Preserve environment" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002932 "\n -c Command to pass to 'sh -c'" \
2933 "\n -s Shell to use instead of default shell"
Robert Griebl1fca5582002-06-04 20:45:46 +00002934
Eric Andersen27f64e12002-06-23 04:24:25 +00002935#define sulogin_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002936 "[OPTION]... [tty-device]"
Eric Andersen27f64e12002-06-23 04:24:25 +00002937#define sulogin_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002938 "Single user login" \
2939 "\n\nOptions:" \
2940 "\n -t Timeout"
Eric Andersen27f64e12002-06-23 04:24:25 +00002941
Mike Frysinger95d3c452005-04-21 23:29:24 +00002942#define sum_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002943 "[rs] [files...]"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002944#define sum_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002945 "Checksum and count the blocks in a file" \
2946 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002947 " -r use BSD sum algorithm (1K blocks)\n" \
2948 " -s use System V sum algorithm (512byte blocks)"
Mike Frysinger95d3c452005-04-21 23:29:24 +00002949
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002950#define sv_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002951 "[-v] [-w sec] command service..."
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002952#define sv_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002953 "Report the current status and control the state of services " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002954 "monitored by the runsv supervisor"
Denis Vlasenko8a00f442006-11-17 18:58:16 +00002955
Denis Vlasenko83ea6432006-11-16 02:27:24 +00002956#define svlogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002957 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
Denis Vlasenko83ea6432006-11-16 02:27:24 +00002958#define svlogd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002959 "Continuously read log data from standard input, optionally " \
2960 "filter log messages, and write the data to one or more automatically " \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002961 "rotated logs"
Denis Vlasenko83ea6432006-11-16 02:27:24 +00002962
Eric Andersen7e9276b2001-02-22 01:15:47 +00002963#define swapoff_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002964 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002965#define swapoff_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002966 "Stop swapping virtual memory pages on DEVICE" \
2967 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002968 " -a Stop swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002969
Eric Andersen7e9276b2001-02-22 01:15:47 +00002970#define swapon_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002971 "[-a] [DEVICE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00002972#define swapon_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002973 "Start swapping virtual memory pages on DEVICE" \
2974 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002975 " -a Start swapping on all swap devices"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002976
Rob Landley0f34a822005-10-27 22:55:50 +00002977#define switch_root_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002978 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
Rob Landley0f34a822005-10-27 22:55:50 +00002979#define switch_root_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002980 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002981 "and exec NEW_INIT" \
2982 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002983 " -c Redirect console to device on new root"
Rob Landley0f34a822005-10-27 22:55:50 +00002984
Eric Andersen7e9276b2001-02-22 01:15:47 +00002985#define sync_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002986 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00002987#define sync_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00002988 "Write all buffered filesystem blocks to disk"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00002989
Eric Andersenb9050282003-12-24 06:02:11 +00002990#define sysctl_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002991 "[OPTIONS]... [VALUE]..."
Eric Andersen5d38f5b2005-09-12 21:42:48 +00002992#define sysctl_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00002993 "Configure kernel parameters at runtime" \
2994 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00002995 " -n Use this option to disable printing of the key name when printing values\n" \
2996 " -w Use this option when you want to change a sysctl setting\n" \
2997 " -p Load in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \
2998 " -a Display all values currently available\n" \
2999 " -A Display all values currently available in table form"
Eric Andersen5d38f5b2005-09-12 21:42:48 +00003000#define sysctl_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003001 "sysctl [-n] variable ...\n" \
3002 "sysctl [-n] -w variable=value ...\n" \
3003 "sysctl [-n] -a\n" \
3004 "sysctl [-n] -p <file> (default /etc/sysctl.conf)\n" \
3005 "sysctl [-n] -A\n"
Eric Andersenb9050282003-12-24 06:02:11 +00003006
Eric Andersen7e9276b2001-02-22 01:15:47 +00003007#define syslogd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003008 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003009#define syslogd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003010 "System logging utility.\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003011 "Note that this version of syslogd ignores /etc/syslog.conf." \
3012 "\n\nOptions:" \
3013 "\n -m MIN Minutes between MARK lines (default=20, 0=off)" \
3014 "\n -n Run as a foreground process" \
3015 "\n -O FILE Use an alternate log file (default=/var/log/messages)" \
3016 "\n -l n Sets the local log level of messages to n" \
3017 "\n -S Make logging output smaller" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003018 USE_FEATURE_ROTATE_LOGFILE( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003019 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3020 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003021 USE_FEATURE_REMOTE_LOG( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003022 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3023 "\n -L Log locally and via network logging (default is network only)") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003024 USE_FEATURE_IPC_SYSLOG( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003025 "\n -C [size(KiB)] Log to a circular buffer (read the buffer using logread)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003026#define syslogd_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003027 "$ syslogd -R masterlog:514\n" \
3028 "$ syslogd -R 192.168.1.1:601\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003029
Eric Andersen7e9276b2001-02-22 01:15:47 +00003030#define tail_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003031 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003032#define tail_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003033 "Print last 10 lines of each FILE to standard output.\n" \
3034 "With more than one FILE, precede each with a header giving the\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003035 "file name. With no FILE, or when FILE is -, read standard input." \
3036 "\n\nOptions:" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003037 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003038 "\n -c N[kbm] output the last N bytes") \
3039 "\n -n N[kbm] print last N lines instead of last 10" \
3040 "\n -f output data as the file grows" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003041 USE_FEATURE_FANCY_TAIL( \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003042 "\n -q never output headers giving file names" \
3043 "\n -s SEC wait SEC seconds between reads with -f" \
3044 "\n -v always output headers giving file names" \
3045 "\n\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003046 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3047 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3048 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003049#define tail_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003050 "$ tail -n 1 /etc/resolv.conf\n" \
3051 "nameserver 10.0.0.1\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003052
Eric Andersen7e9276b2001-02-22 01:15:47 +00003053#define tar_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003054 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003055 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3056 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
Denis Vlasenkod031ffa2006-11-24 21:54:44 +00003057 USE_FEATURE_TAR_FROM("[-X FILE] ") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003058 "[-f TARFILE] [-C DIR] [FILE(s)] ..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003059#define tar_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003060 "Create, extract, or list files from a tar file" \
3061 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003062 USE_FEATURE_TAR_CREATE( \
3063 " c create\n") \
3064 " x extract\n" \
3065 " t list\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003066 "\nArchive format selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003067 USE_FEATURE_TAR_GZIP( \
3068 " z Filter the archive through gzip\n") \
3069 USE_FEATURE_TAR_BZIP2( \
3070 " j Filter the archive through bzip2\n") \
3071 USE_FEATURE_TAR_LZMA( \
3072 " a Filter the archive through lzma\n") \
3073 USE_FEATURE_TAR_COMPRESS( \
3074 " Z Filter the archive through compress\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003075 "\nFile selection:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003076 " f name of TARFILE or \"-\" for stdin\n" \
3077 " O extract to stdout\n" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003078 USE_FEATURE_TAR_FROM( \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003079 " exclude file to exclude\n" \
3080 " X file with names to exclude\n") \
3081 " C change to directory DIR before operation\n" \
3082 " v verbosely list files processed"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003083#define tar_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003084 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3085 "$ tar -cf /tmp/tarball.tar /usr/local\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003086
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003087#define taskset_trivial_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003088 "[OPTIONS] [mask] [pid | command [arg]...]"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003089#define taskset_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003090 "Set or get CPU affinity" \
3091 "\n\nOptions:\n" \
3092 " -p operate on an existing PID"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003093#define taskset_example_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003094 "$ taskset 0x7 ./dgemm_test&\n" \
3095 "$ taskset -p 0x1 $!\n" \
3096 "pid 4790's current affinity mask: 7\n" \
3097 "pid 4790's new affinity mask: 1\n" \
3098 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3099 "pid 6671's current affinity mask: 1\n" \
3100 "pid 6671's new affinity mask: 1\n" \
3101 "$ taskset -p 1\n" \
3102 "pid 1's current affinity mask: 3\n"
Bernhard Reutner-Fischer32eddff2006-11-22 16:39:48 +00003103
Eric Andersen7e9276b2001-02-22 01:15:47 +00003104#define tee_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003105 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003106#define tee_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003107 "Copy standard input to each FILE, and also to standard output" \
3108 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003109 " -a append to the given FILEs, do not overwrite\n" \
3110 " -i ignore interrupt signals (SIGINT)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003111#define tee_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003112 "$ echo \"Hello\" | tee /tmp/foo\n" \
3113 "$ cat /tmp/foo\n" \
3114 "Hello\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003115
Eric Andersen539ffc92004-02-22 12:25:47 +00003116#ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN
3117#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003118 "[-a] [-l USER] HOST [PORT]"
Eric Andersen539ffc92004-02-22 12:25:47 +00003119#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003120 "Connect to remote telnet server" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003121 "\n\nOptions:\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003122 " -a Attempt an automatic login with the USER variable\n" \
3123 " -l USER Attempt an automatic login with the USER argument\n" \
3124 " HOST The official name, alias or the IP address of the\n" \
3125 " remote host.\n" \
3126 " PORT The remote port number to connect to. If it is not\n" \
3127 " specified, the default telnet (23) port is used."
Eric Andersen539ffc92004-02-22 12:25:47 +00003128#else
Eric Andersen7e9276b2001-02-22 01:15:47 +00003129#define telnet_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003130 "HOST [PORT]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003131#define telnet_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003132 "Connect to remote telnet server"
Eric Andersen539ffc92004-02-22 12:25:47 +00003133#endif
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003134
Eric Andersen08a72202002-09-30 20:52:10 +00003135#define telnetd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003136 "[OPTION]"
Eric Andersen08a72202002-09-30 20:52:10 +00003137#define telnetd_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003138 "Handle incoming telnet connections" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003139 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3140 "\n\nOptions:" \
3141 "\n -l LOGIN exec LOGIN on connect" \
3142 "\n -f issue_file Display issue_file instead of /etc/issue" \
3143 USE_FEATURE_TELNETD_STANDALONE( \
3144 "\n -p PORT port to listen to" \
3145 "\n -b ADDR address to bind to" \
3146 "\n -F stay in foreground" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003147 "\n -i run as inetd subservice" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003148 )
Eric Andersen08a72202002-09-30 20:52:10 +00003149
Eric Andersen7e9276b2001-02-22 01:15:47 +00003150#define test_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003151 "EXPRESSION\n or [ EXPRESSION ]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003152#define test_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003153 "Check file types and compares values returning an exit code\n" \
3154 "determined by the value of EXPRESSION"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003155#define test_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003156 "$ test 1 -eq 2\n" \
3157 "$ echo $?\n" \
3158 "1\n" \
3159 "$ test 1 -eq 1\n" \
3160 "$ echo $?\n" \
3161 "0\n" \
3162 "$ [ -d /etc ]\n" \
3163 "$ echo $?\n" \
3164 "0\n" \
3165 "$ [ -d /junk ]\n" \
3166 "$ echo $?\n" \
3167 "1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003168
Mark Whitley450736c2001-03-02 19:08:50 +00003169#define tftp_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003170 "[OPTION]... HOST [PORT]"
Mark Whitley450736c2001-03-02 19:08:50 +00003171#define tftp_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003172 "Transfer a file from/to tftp server using \"octet\" mode" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003173 "\n\nOptions:" \
3174 "\n -l FILE Local FILE" \
3175 "\n -r FILE Remote FILE" \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003176 USE_FEATURE_TFTP_GET( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003177 "\n -g Get file" \
Mike Frysinger82e6c0b2005-04-23 06:35:06 +00003178 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003179 USE_FEATURE_TFTP_PUT( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003180 "\n -p Put file" \
Mark Whitley450736c2001-03-02 19:08:50 +00003181 ) \
Denis Vlasenkoce979602006-09-27 23:31:08 +00003182 USE_FEATURE_TFTP_BLOCKSIZE( \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003183 "\n -b SIZE Transfer blocks of SIZE octets" \
Tim Riker7b253f82003-12-28 05:02:40 +00003184 )
Eric Andersenc3657422001-11-30 07:54:32 +00003185#define time_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003186 "[OPTION]... COMMAND [ARGS...]"
Eric Andersenc3657422001-11-30 07:54:32 +00003187#define time_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003188 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003189 "COMMAND's resource usage information is displayed." \
3190 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003191 " -v Displays verbose resource usage information"
Mark Whitley450736c2001-03-02 19:08:50 +00003192
Eric Andersen420b2082002-09-17 22:14:58 +00003193#define top_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003194 "[-b] [-n count] [-d seconds]"
Eric Andersen420b2082002-09-17 22:14:58 +00003195#define top_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003196 "Provide a view of process activity in real time.\n" \
3197 "Read the status of all processes from /proc each <seconds>\n" \
3198 "and show the status for however many processes will fit on the screen."
Eric Andersen420b2082002-09-17 22:14:58 +00003199
Eric Andersen7e9276b2001-02-22 01:15:47 +00003200#define touch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003201 "[-c] FILE [FILE ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003202#define touch_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003203 "Update the last-modified date on the given FILE[s]" \
3204 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003205 " -c Do not create any files"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003206#define touch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003207 "$ ls -l /tmp/foo\n" \
3208 "/bin/ls: /tmp/foo: No such file or directory\n" \
3209 "$ touch /tmp/foo\n" \
3210 "$ ls -l /tmp/foo\n" \
3211 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003212
3213#define tr_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003214 "[-cds] STRING1 [STRING2]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003215#define tr_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003216 "Translate, squeeze, and/or delete characters from\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003217 "standard input, writing to standard output" \
3218 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003219 " -c take complement of STRING1\n" \
3220 " -d delete input characters coded STRING1\n" \
3221 " -s squeeze multiple output characters of STRING2 into one character"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003222#define tr_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003223 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3224 "hello world\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003225
Eric Andersen5c58d282001-07-10 16:29:00 +00003226#define traceroute_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003227 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3228 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3229 " [-z pausemsecs] host [data size]"
Eric Andersen5c58d282001-07-10 16:29:00 +00003230#define traceroute_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003231 "Trace the route ip packets follow going to \"host\"" \
3232 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003233 " -F Set the don't fragment bit\n" \
3234 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3235 " -l Display the ttl value of the returned packet\n" \
3236 " -d Set SO_DEBUG options to socket\n" \
3237 " -n Print hop addresses numerically rather than symbolically\n" \
3238 " -r Bypass the normal routing tables and send directly to a host\n" \
3239 " -v Verbose output\n" \
3240 " -m max_ttl Set the max time-to-live (max number of hops)\n" \
3241 " -p port# Set the base UDP port number used in probes\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003242 " (default is 33434)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003243 " -q nqueries Set the number of probes per 'ttl' to nqueries\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003244 " (default is 3)\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003245 " -s src_addr Use the following IP address as the source address\n" \
Denis Vlasenko7df69b82006-11-28 00:46:49 +00003246 " -t tos Set the type-of-service in probe packets to the following value\n" \
3247 " (default 0)\n" \
3248 " -w wait Set the time (in seconds) to wait for a response to a probe\n" \
3249 " (default 3 sec)\n" \
3250 " -g Specify a loose source route gateway (8 maximum)"
Eric Andersen5c58d282001-07-10 16:29:00 +00003251
3252
Eric Andersen7e9276b2001-02-22 01:15:47 +00003253#define true_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003254 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003255#define true_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003256 "Return an exit code of TRUE (0)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003257#define true_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003258 "$ true\n" \
3259 "$ echo $?\n" \
3260 "0\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003261
Eric Andersen7e9276b2001-02-22 01:15:47 +00003262#define tty_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003263 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003264#define tty_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003265 "Print the file name of the terminal connected to standard input" \
3266 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003267 " -s print nothing, only return an exit status"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003268#define tty_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003269 "$ tty\n" \
3270 "/dev/tty2\n"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003271
Mike Frysinger174808c2005-06-11 01:14:09 +00003272#define tune2fs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003273 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3274 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3275 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3276 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3277 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3278 "[-T last-check-time] [-U UUID] device"
Mike Frysinger174808c2005-06-11 01:14:09 +00003279#define tune2fs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003280 "Adjust filesystem options on ext[23] filesystems"
Mike Frysinger174808c2005-06-11 01:14:09 +00003281
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003282#define udhcpc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003283 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003284#define udhcpc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003285 " -V,--vendorclass=CLASSID Set vendor class identifier\n" \
3286 " -i,--interface=INTERFACE Interface to use (default: eth0)\n" \
3287 " -H,-h,--hostname=HOSTNAME Client hostname\n" \
3288 " -c,--clientid=CLIENTID Set client identifier\n" \
3289 " -C,--clientid-none Suppress default client identifier\n" \
3290 " -p,--pidfile=file Store process ID of daemon in file\n" \
3291 " -r,--request=IP IP address to request (default: none)\n" \
3292 " -s,--script=file Run file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \
3293 " -t,--retries=NUM Send up to NUM request packets\n"\
3294 " -f,--foreground Do not fork after getting lease\n" \
3295 " -b,--background Fork to background if lease cannot be immediately negotiated\n" \
3296 " -n,--now Exit with failure if lease cannot be immediately negotiated\n" \
3297 " -q,--quit Quit after obtaining lease\n" \
3298 " -R,--release Release IP on quit\n" \
3299 " -v,--version Display version" \
Glenn L McGrath8eb0dc12002-08-21 10:27:58 +00003300
Russ Dill61fb4892002-10-14 21:41:28 +00003301#define udhcpd_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003302 "[configfile]\n" \
Russ Dill61fb4892002-10-14 21:41:28 +00003303
3304#define udhcpd_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003305 ""
Russ Dill61fb4892002-10-14 21:41:28 +00003306
Eric Andersen7e9276b2001-02-22 01:15:47 +00003307#define umount_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003308 "[flags] FILESYSTEM|DIRECTORY"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003309#define umount_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003310 "Unmount file systems" \
3311 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003312 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
3313 USE_FEATURE_MTAB_SUPPORT( \
3314 "\n -n Don't erase /etc/mtab entries") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003315 "\n -r Try to remount devices as read-only if mount is busy" \
3316 "\n -l Lazy umount (detach filesystem)" \
3317 "\n -f Force umount (i.e., unreachable NFS server)" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003318 USE_FEATURE_MOUNT_LOOP( \
3319 "\n -D Do not free loop device (if a loop device has been used)")
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003320#define umount_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003321 "$ umount /dev/hdc1\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003322
3323#define uname_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003324 "[OPTION]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003325#define uname_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003326 "Print certain system information. With no OPTION, same as -s." \
3327 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003328 " -a print all information\n" \
3329 " -m the machine (hardware) type\n" \
3330 " -n print the machine's network node hostname\n" \
3331 " -r print the operating system release\n" \
3332 " -s print the operating system name\n" \
3333 " -p print the host processor type\n" \
3334 " -v print the operating system version"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003335#define uname_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003336 "$ uname -a\n" \
3337 "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 +00003338
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003339#define uncompress_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003340 "[-c] [-f] [ name ... ]"
Glenn L McGrathbf1cc8b2002-11-01 23:38:54 +00003341#define uncompress_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003342 "Uncompress .Z file[s]" \
3343 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003344 " -c extract to stdout\n" \
3345 " -f force overwrite an existing file"
Tim Riker7b253f82003-12-28 05:02:40 +00003346
Eric Andersen7e9276b2001-02-22 01:15:47 +00003347#define uniq_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003348 "[-fscdu]... [INPUT [OUTPUT]]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003349#define uniq_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003350 "Discard all but one of successive identical lines from INPUT\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003351 "(or standard input), writing to OUTPUT (or standard output)" \
3352 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003353 " -c prefix lines by the number of occurrences\n" \
3354 " -d only print duplicate lines\n" \
3355 " -u only print unique lines\n" \
3356 " -f N skip the first N fields\n" \
3357 " -s N skip the first N chars (after any skipped fields)"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003358#define uniq_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003359 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3360 "a\n" \
3361 "b\n" \
3362 "c\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003363
3364#define unix2dos_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003365 "[option] [FILE]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003366#define unix2dos_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003367 "Convert FILE from unix format to dos format. When no option\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003368 "is given, the input is converted to the opposite output format.\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003369 "When no file is given, use stdin for input and stdout for output." \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003370 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003371 " -u output will be in UNIX format\n" \
3372 " -d output will be in DOS format"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003373
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003374#define unzip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003375 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003376#define unzip_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003377 "Extract files from ZIP archives" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003378 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003379 " -l list archive contents (short form)\n" \
3380 " -n never overwrite existing files (default)\n" \
3381 " -o overwrite files without prompting\n" \
3382 " -p send output to stdout\n" \
3383 " -q be quiet\n" \
3384 " -x exclude these files\n" \
3385 " -d extract files into this directory"
Glenn L McGrath87ac7022002-01-02 13:52:26 +00003386
Eric Andersen7e9276b2001-02-22 01:15:47 +00003387#define uptime_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003388 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003389#define uptime_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003390 "Display the time since the last boot"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003391#define uptime_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003392 "$ uptime\n" \
3393 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003394
3395#define usleep_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003396 "N"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003397#define usleep_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003398 "Pause for N microseconds"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003399#define usleep_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003400 "$ usleep 1000000\n" \
3401 "[pauses for 1 second]\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003402
3403#define uudecode_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003404 "[FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003405#define uudecode_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003406 "Uudecode a file" \
3407 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003408 " -o FILE direct output to FILE"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003409#define uudecode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003410 "$ uudecode -o busybox busybox.uu\n" \
3411 "$ ls -l busybox\n" \
3412 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003413
3414#define uuencode_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003415 "[OPTION] [INFILE] REMOTEFILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003416#define uuencode_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003417 "Uuencode a file" \
3418 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003419 " -m use base64 encoding per RFC1521"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003420#define uuencode_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003421 "$ uuencode busybox busybox\n" \
3422 "begin 755 busybox\n" \
3423 "<encoded file snipped>\n" \
3424 "$ uudecode busybox busybox > busybox.uu\n" \
3425 "$\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003426
Eric Andersen853c4942003-01-23 05:59:32 +00003427#define vconfig_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003428 "COMMAND [OPTIONS] ..."
Eric Andersen853c4942003-01-23 05:59:32 +00003429#define vconfig_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003430 "Create and remove virtual ethernet devices" \
3431 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003432 " add [interface-name] [vlan_id]\n" \
3433 " rem [vlan-name]\n" \
3434 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
3435 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3436 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
3437 " set_name_type [name-type]"
Eric Andersen853c4942003-01-23 05:59:32 +00003438
Eric Andersen3f980402001-04-04 17:31:15 +00003439#define vi_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003440 "[OPTION] [FILE]..."
Eric Andersen3f980402001-04-04 17:31:15 +00003441#define vi_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003442 "Edit FILE" \
3443 "\n\nOptions:\n" \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003444 " -R Read-only - do not write to the file"
Eric Andersen3f980402001-04-04 17:31:15 +00003445
Eric Andersen27f64e12002-06-23 04:24:25 +00003446#define vlock_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003447 "[OPTIONS]"
Eric Andersen27f64e12002-06-23 04:24:25 +00003448#define vlock_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003449 "Lock a virtual terminal. A password is required to unlock." \
3450 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003451 " -a Lock all VTs"
Eric Andersen27f64e12002-06-23 04:24:25 +00003452
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003453#define watch_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003454 "[-n <seconds>] [-t] COMMAND..."
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003455#define watch_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003456 "Execute a program periodically" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003457 "\n\nOptions:\n" \
3458 " -n Loop period in seconds - default is 2\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003459 " -t Don't print header"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003460#define watch_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003461 "$ watch date\n" \
3462 "Mon Dec 17 10:31:40 GMT 2000\n" \
3463 "Mon Dec 17 10:31:42 GMT 2000\n" \
3464 "Mon Dec 17 10:31:44 GMT 2000"
Glenn L McGrath18b76e62002-09-16 09:10:04 +00003465
Eric Andersen7e9276b2001-02-22 01:15:47 +00003466#define watchdog_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003467 "[-t <seconds>] [-F] DEV"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003468#define watchdog_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003469 "Periodically write to watchdog device DEV" \
3470 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003471 " -t Timer period in seconds - default is 30\n" \
3472 " -F Stay in the foreground and don't fork"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003473
3474#define wc_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003475 "[OPTION]... [FILE]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003476#define wc_full_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003477 "Print line, word, and byte counts for each FILE, and a total line if\n" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003478 "more than one FILE is specified. With no FILE, read standard input." \
3479 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003480 " -c print the byte counts\n" \
3481 " -l print the newline counts\n" \
3482 " -L print the length of the longest line\n" \
3483 " -w print the word counts"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003484#define wc_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003485 "$ wc /etc/passwd\n" \
3486 " 31 46 1365 /etc/passwd\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003487
3488#define wget_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003489 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
3490 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
3491 " [-U|--user-agent agent] url"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003492#define wget_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003493 "Retrieve files via HTTP or FTP" \
3494 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003495 " -c continue retrieval of aborted transfers\n" \
3496 " -q quiet mode - do not print\n" \
3497 " -P Set directory prefix to DIR\n" \
3498 " -O save to filename ('-' for stdout)\n" \
3499 " -U adjust 'User-Agent' field\n" \
3500 " -Y use proxy ('on' or 'off')"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003501
3502#define which_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003503 "[COMMAND ...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003504#define which_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003505 "Locate a COMMAND"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003506#define which_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003507 "$ which login\n" \
3508 "/bin/login\n"
Glenn L McGrath8f0722a2002-11-11 03:00:12 +00003509
Eric Andersen00a6a752002-04-26 23:53:10 +00003510#define who_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003511 " "
Eric Andersen00a6a752002-04-26 23:53:10 +00003512#define who_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003513 "Print the current user names and related information"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003514
3515#define whoami_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003516 ""
Eric Andersen7e9276b2001-02-22 01:15:47 +00003517#define whoami_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003518 "Print the user name associated with the current effective user id"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003519
3520#define xargs_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003521 "[OPTIONS] [COMMAND] [ARGS...]"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003522#define xargs_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003523 "Execute COMMAND on every item given by standard input" \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003524 "\n\nOptions:\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003525 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
3526 " -p Prompt the user about whether to run each command\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003527 " -r Do not run command for empty read lines\n" \
Denis Vlasenko7cdc54f2006-12-17 17:27:56 +00003528 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
3529 " -x Exit if the size is exceeded\n") \
3530 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
3531 " -0 Input filenames are terminated by a null character\n") \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003532 " -t Print the command line on stderr before executing it"
Eric Andersen0d3a02e2001-03-15 18:14:25 +00003533#define xargs_example_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003534 "$ ls | xargs gzip\n" \
3535 "$ find . -name '*.c' -print | xargs rm\n"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003536
3537#define yes_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003538 "[OPTION]... [STRING]..."
Eric Andersen7e9276b2001-02-22 01:15:47 +00003539#define yes_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003540 "Repeatedly output a line with all specified STRING(s), or 'y'"
Eric Andersen3ec8ffb2001-02-14 21:46:30 +00003541
Eric Andersen7e9276b2001-02-22 01:15:47 +00003542#define zcat_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003543 "FILE"
Eric Andersen7e9276b2001-02-22 01:15:47 +00003544#define zcat_full_usage \
Denis Vlasenko7a50a642006-12-24 17:40:16 +00003545 "Uncompress to stdout"
Eric Andersen178de172004-04-06 16:36:20 +00003546
Rob Landleyad8071f2005-04-30 03:49:37 +00003547#define zcip_trivial_usage \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003548 "[OPTIONS] ifname script"
Rob Landleyad8071f2005-04-30 03:49:37 +00003549#define zcip_full_usage \
Denis Vlasenko765996a2006-12-24 16:59:27 +00003550 "Manage a ZeroConf IPv4 link-local address" \
3551 "\n\nOptions:\n" \
Denis Vlasenko1fffe382006-11-28 00:06:39 +00003552 " -f foreground mode\n" \
3553 " -q quit after address (no daemon)\n" \
3554 " -r 169.254.x.x request this address first\n" \
3555 " -v verbose"
Rob Landleyad8071f2005-04-30 03:49:37 +00003556
Eric Andersen178de172004-04-06 16:36:20 +00003557#endif /* __BB_USAGE_H__ */