aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Andersen <andersen@codepoet.org>2004-04-06 16:36:20 +0000
committerEric Andersen <andersen@codepoet.org>2004-04-06 16:36:20 +0000
commit178de17969c628550700b293d2b171f559a2d2e6 (patch)
tree50df9b23af03ff1d4ed178ac9a1c071f4205f61f
parent69bd0d1e8926f06ac4a741607f02ae9cd0d16bed (diff)
downloadbusybox-w32-178de17969c628550700b293d2b171f559a2d2e6.tar.gz
busybox-w32-178de17969c628550700b293d2b171f559a2d2e6.tar.bz2
busybox-w32-178de17969c628550700b293d2b171f559a2d2e6.zip
yet-more doc updates and cleanups
-rw-r--r--include/usage.h209
1 files changed, 106 insertions, 103 deletions
diff --git a/include/usage.h b/include/usage.h
index 7a6284e87..e2adbc183 100644
--- a/include/usage.h
+++ b/include/usage.h
@@ -1,22 +1,25 @@
1#ifndef __BB_USAGE_H__
2#define __BB_USAGE_H__
3
1#define addgroup_trivial_usage \ 4#define addgroup_trivial_usage \
2 "[OPTIONS] group_name [user_name]" 5 "[-g GID] group_name [user_name]"
3#define addgroup_full_usage \ 6#define addgroup_full_usage \
4 "Adds a group to the system" \ 7 "Adds a group to the system" \
5 "Options:\n" \ 8 "Options:\n" \
6 "\t-g\t\tspecify gid\n" 9 "\t-g GID\t\tspecify gid"
7 10
8#define adduser_trivial_usage \ 11#define adduser_trivial_usage \
9 "[OPTIONS] user_name" 12 "[OPTIONS] user_name"
10#define adduser_full_usage \ 13#define adduser_full_usage \
11 "Adds a user to the system" \ 14 "Adds a user to the system" \
12 "Options:\n" \ 15 "Options:\n" \
13 "\t-h DIR\t\tAssign home directory DIR\n" \ 16 "\t-h DIR\t\tAssign home directory DIR\n" \
14 "\t-g GECOS\t\tAssign gecos field GECOS\n" \ 17 "\t-g GECOS\tAssign gecos field GECOS\n" \
15 "\t-s SHELL\t\tAssign login shell SHELL\n" \ 18 "\t-s SHELL\tAssign login shell SHELL\n" \
16 "\t-G\t\tAdd the user to existing group GROUP\n" \ 19 "\t-G\t\tAdd the user to existing group GROUP\n" \
17 "\t-S\t\tcreate a system user (ignored)\n" \ 20 "\t-S\t\tcreate a system user (ignored)\n" \
18 "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \ 21 "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \
19 "\t-H\t\tDo not create the home directory\n" 22 "\t-H\t\tDo not create the home directory"
20 23
21#define adjtimex_trivial_usage \ 24#define adjtimex_trivial_usage \
22 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]" 25 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
@@ -29,10 +32,10 @@
29 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \ 32 "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \
30 "\t\t\t(positive values make the system clock run fast)\n" \ 33 "\t\t\t(positive values make the system clock run fast)\n" \
31 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \ 34 "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \
32 "\t-p timeconstant\n" 35 "\t-p timeconstant"
33 36
34#define ar_trivial_usage \ 37#define ar_trivial_usage \
35 "-[ov][ptx] ARCHIVE FILES" 38 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
36#define ar_full_usage \ 39#define ar_full_usage \
37 "Extract or list FILES from an ar archive.\n\n" \ 40 "Extract or list FILES from an ar archive.\n\n" \
38 "Options:\n" \ 41 "Options:\n" \
@@ -40,7 +43,7 @@
40 "\t-p\t\textract to stdout\n" \ 43 "\t-p\t\textract to stdout\n" \
41 "\t-t\t\tlist\n" \ 44 "\t-t\t\tlist\n" \
42 "\t-x\t\textract\n" \ 45 "\t-x\t\textract\n" \
43 "\t-v\t\tverbosely list files processed\n" 46 "\t-v\t\tverbosely list files processed"
44 47
45#define arping_trivial_usage \ 48#define arping_trivial_usage \
46 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n" 49 "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n"
@@ -57,7 +60,7 @@
57 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \ 60 "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
58 "\t-I device\tOutgoing interface name, default is eth0\n" \ 61 "\t-I device\tOutgoing interface name, default is eth0\n" \
59 "\t-s sender\tSet specific sender IP address\n" \ 62 "\t-s sender\tSet specific sender IP address\n" \
60 "\ttarget\t\tTarget IP address of ARP request\n" 63 "\ttarget\t\tTarget IP address of ARP request"
61 64
62#define ash_trivial_usage \ 65#define ash_trivial_usage \
63 "[FILE]...\n" \ 66 "[FILE]...\n" \
@@ -71,7 +74,7 @@
71 "Options:\n" \ 74 "Options:\n" \
72 "\t-v var=val\t\tassign value 'val' to variable 'var'\n" \ 75 "\t-v var=val\t\tassign value 'val' to variable 'var'\n" \
73 "\t-F sep\t\tuse 'sep' as field separator\n" \ 76 "\t-F sep\t\tuse 'sep' as field separator\n" \
74 "\t-f progname\t\tread program source from file 'progname'\n" 77 "\t-f progname\t\tread program source from file 'progname'"
75 78
76#define basename_trivial_usage \ 79#define basename_trivial_usage \
77 "FILE [SUFFIX]" 80 "FILE [SUFFIX]"
@@ -171,9 +174,9 @@
171#define chroot_example_usage \ 174#define chroot_example_usage \
172 "$ ls -l /bin/ls\n" \ 175 "$ ls -l /bin/ls\n" \
173 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \ 176 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
174 "$ mount /dev/hdc1 /mnt -t minix\n" \ 177 "# mount /dev/hdc1 /mnt -t minix\n" \
175 "$ chroot /mnt\n" \ 178 "# chroot /mnt\n" \
176 "$ ls -l /bin/ls\n" \ 179 "# ls -l /bin/ls\n" \
177 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n" 180 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
178 181
179#define chvt_trivial_usage \ 182#define chvt_trivial_usage \
@@ -187,9 +190,9 @@
187 "Clear screen." 190 "Clear screen."
188 191
189#define cmp_trivial_usage \ 192#define cmp_trivial_usage \
190 "[OPTION]... FILE1 [FILE2]" 193 "[-l] [-s] FILE1 [FILE2]"
191#define cmp_full_usage \ 194#define cmp_full_usage \
192 "Compare files.\n\n" \ 195 "Compare files. Compares FILE1 vs stdin if FILE2 is not specified.\n\n" \
193 "Options:\n" \ 196 "Options:\n" \
194 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \ 197 "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \
195 "\t\t for all differing bytes.\n" \ 198 "\t\t for all differing bytes.\n" \
@@ -294,8 +297,7 @@
294 "p - Prints the value on the top of the stack, without altering the stack.\n" \ 297 "p - Prints the value on the top of the stack, without altering the stack.\n" \
295 "f - Prints the entire contents of the stack without altering anything.\n" \ 298 "f - Prints the entire contents of the stack without altering anything.\n" \
296 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \ 299 "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
297 " Only 10 and 16 are supported.\n" 300 " Only 10 and 16 are supported."
298
299#define dc_example_usage \ 301#define dc_example_usage \
300 "$ dc 2 2 +\n" \ 302 "$ dc 2 2 +\n" \
301 "4\n" \ 303 "4\n" \
@@ -355,7 +357,7 @@
355 "mntpnt [-v]"\ 357 "mntpnt [-v]"\
356 USAGE_DEVFSD_FG_NP("[-fg][-np]" ) 358 USAGE_DEVFSD_FG_NP("[-fg][-np]" )
357#define devfsd_full_usage \ 359#define devfsd_full_usage \
358 "Optional daemon for managing devfs (the Linux Device Filesystem).\n" \ 360 "Optional daemon for managing devfs permissions and old device name symlinks.\n" \
359 "\nOptions:\n" \ 361 "\nOptions:\n" \
360 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \ 362 "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \
361 "\t-v\tPrint the protocol version numbers for devfsd\n" \ 363 "\t-v\tPrint the protocol version numbers for devfsd\n" \
@@ -392,7 +394,7 @@
392 "/dev/sda3 8690864 8553540 137324 98% /\n" 394 "/dev/sda3 8690864 8553540 137324 98% /\n"
393 395
394#define dirname_trivial_usage \ 396#define dirname_trivial_usage \
395 "[FILENAME ...]" 397 "FILENAME"
396#define dirname_full_usage \ 398#define dirname_full_usage \
397 "Strips non-directory suffix from FILENAME" 399 "Strips non-directory suffix from FILENAME"
398#define dirname_example_usage \ 400#define dirname_example_usage \
@@ -421,19 +423,20 @@
421 "\t-d\toutput will be in DOS format" 423 "\t-d\toutput will be in DOS format"
422 424
423#define dpkg_trivial_usage \ 425#define dpkg_trivial_usage \
424 "-i package_file\n" \ 426 "[-iCPru] package_name"
425 "[-CPru] package_name"
426#define dpkg_full_usage \ 427#define dpkg_full_usage \
428 "dpkg is a utility to install, remove and manage Debian packages.\n\n" \
429 "Options:\n" \
427 "\t-i\tInstall the package\n" \ 430 "\t-i\tInstall the package\n" \
428 "\t-C\tConfigure an unpackaged package\n" \ 431 "\t-C\tConfigure an unpackaged package\n" \
429 "\t-P\tPurge all files of a package\n" \ 432 "\t-P\tPurge all files of a package\n" \
430 "\t-r\tRemove all but the configuration files for a package\n" \ 433 "\t-r\tRemove all but the configuration files for a package\n" \
431 "\t-u\tUnpack a package, but dont configure it\n" 434 "\t-u\tUnpack a package, but dont configure it"
432 435
433#define dpkg_deb_trivial_usage \ 436#define dpkg_deb_trivial_usage \
434 "[-cefItxX] FILE [argument]" 437 "[-cefItxX] FILE [argument]"
435#define dpkg_deb_full_usage \ 438#define dpkg_deb_full_usage \
436 "Perform actions on debian packages (.debs)\n\n" \ 439 "Perform actions on Debian packages (.debs)\n\n" \
437 "Options:\n" \ 440 "Options:\n" \
438 "\t-c\tList contents of filesystem tree\n" \ 441 "\t-c\tList contents of filesystem tree\n" \
439 "\t-e\tExtract control files to [argument] directory\n" \ 442 "\t-e\tExtract control files to [argument] directory\n" \
@@ -496,9 +499,11 @@
496#define dumpleases_trivial_usage \ 499#define dumpleases_trivial_usage \
497 "[-r|-a] [-f LEASEFILE]" 500 "[-r|-a] [-f LEASEFILE]"
498#define dumpleases_full_usage \ 501#define dumpleases_full_usage \
502 "Displays the DHCP leases granted by udhcpd.\n\n" \
503 "Options:\n" \
499 "\t-f,\t--file=FILENAME\tLeases file to load\n" \ 504 "\t-f,\t--file=FILENAME\tLeases file to load\n" \
500 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \ 505 "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
501 "\t-a,\t--absolute\tInterepret lease times as expire time\n" 506 "\t-a,\t--absolute\tInterepret lease times as expire time"
502 507
503#ifdef CONFIG_FEATURE_FANCY_ECHO 508#ifdef CONFIG_FEATURE_FANCY_ECHO
504 #define USAGE_FANCY_ECHO(a) a 509 #define USAGE_FANCY_ECHO(a) a
@@ -531,7 +536,7 @@
531 "up the specified environment.\n\n" \ 536 "up the specified environment.\n\n" \
532 "Options:\n" \ 537 "Options:\n" \
533 "\t-, -i\tstart with an empty environment\n" \ 538 "\t-, -i\tstart with an empty environment\n" \
534 "\t-u\tremove variable from the environment\n" 539 "\t-u\tremove variable from the environment"
535 540
536#define expr_trivial_usage \ 541#define expr_trivial_usage \
537 "EXPRESSION" 542 "EXPRESSION"
@@ -670,7 +675,7 @@
670 "Options:\n" \ 675 "Options:\n" \
671 "\t-b\tcount bytes rather than columns\n" \ 676 "\t-b\tcount bytes rather than columns\n" \
672 "\t-s\tbreak at spaces\n" \ 677 "\t-s\tbreak at spaces\n" \
673 "\t-w\tuse WIDTH columns instead of 80\n" 678 "\t-w\tuse WIDTH columns instead of 80"
674 679
675#define free_trivial_usage \ 680#define free_trivial_usage \
676 "" 681 ""
@@ -712,7 +717,7 @@
712 "\t-v, --verbose Verbose\n" \ 717 "\t-v, --verbose Verbose\n" \
713 "\t-u, --username Username to be used\n" \ 718 "\t-u, --username Username to be used\n" \
714 "\t-p, --password Password to be used\n" \ 719 "\t-p, --password Password to be used\n" \
715 "\t-P, --port Port number to be used\n" 720 "\t-P, --port Port number to be used"
716 721
717#define ftpput_trivial_usage \ 722#define ftpput_trivial_usage \
718 "[options] remote-host remote-file local-file" 723 "[options] remote-host remote-file local-file"
@@ -722,7 +727,7 @@
722 "\t-v, --verbose Verbose\n" \ 727 "\t-v, --verbose Verbose\n" \
723 "\t-u, --username Username to be used\n" \ 728 "\t-u, --username Username to be used\n" \
724 "\t-p, --password Password to be used\n" \ 729 "\t-p, --password Password to be used\n" \
725 "\t-P, --port Port number to be used\n" 730 "\t-P, --port Port number to be used"
726 731
727#define getopt_trivial_usage \ 732#define getopt_trivial_usage \
728 "[OPTIONS]..." 733 "[OPTIONS]..."
@@ -908,7 +913,7 @@
908 " -y put IDE drive in standby mode\n" \ 913 " -y put IDE drive in standby mode\n" \
909 " -Y put IDE drive to sleep\n" \ 914 " -Y put IDE drive to sleep\n" \
910 " -Z disable Seagate auto-powersaving mode\n" \ 915 " -Z disable Seagate auto-powersaving mode\n" \
911 " -z re-read partition table\n" 916 " -z re-read partition table"
912 917
913#ifdef CONFIG_FEATURE_FANCY_HEAD 918#ifdef CONFIG_FEATURE_FANCY_HEAD
914#define USAGE_FANCY_HEAD(a) a 919#define USAGE_FANCY_HEAD(a) a
@@ -948,7 +953,7 @@
948 "\t-o\t\tTwo-byte octal display\n" \ 953 "\t-o\t\tTwo-byte octal display\n" \
949 "\t-s OFFSET\tSkip offset byte\n" \ 954 "\t-s OFFSET\tSkip offset byte\n" \
950 "\t-v\t\tdisplay all input data\n" \ 955 "\t-v\t\tdisplay all input data\n" \
951 "\t-x\t\tTwo-byte hexadecimal display\n" 956 "\t-x\t\tTwo-byte hexadecimal display"
952 957
953#define hostid_trivial_usage \ 958#define hostid_trivial_usage \
954 "" 959 ""
@@ -1096,7 +1101,7 @@
1096 "\t\t\t(note that this option doesn't disable mappings)\n" \ 1101 "\t\t\t(note that this option doesn't disable mappings)\n" \
1097 "\t-v\tprint out what would happen before doing it\n" \ 1102 "\t-v\tprint out what would happen before doing it\n" \
1098 "\t-m\tdon't run any mappings\n" \ 1103 "\t-m\tdon't run any mappings\n" \
1099 "\t-f\tforce de/configuration\n" 1104 "\t-f\tforce de/configuration"
1100 1105
1101#define ifdown_trivial_usage \ 1106#define ifdown_trivial_usage \
1102 "<-ahinv> <ifaces...>" 1107 "<-ahinv> <ifaces...>"
@@ -1110,7 +1115,7 @@
1110 "\t\t(note that this option doesn't disable mappings)\n" \ 1115 "\t\t(note that this option doesn't disable mappings)\n" \
1111 "\t-v\tprint out what would happen before doing it\n" \ 1116 "\t-v\tprint out what would happen before doing it\n" \
1112 "\t-m\tdon't run any mappings\n" \ 1117 "\t-m\tdon't run any mappings\n" \
1113 "\t-f\tforce de/configuration\n" 1118 "\t-f\tforce de/configuration"
1114 1119
1115#define inetd_trivial_usage \ 1120#define inetd_trivial_usage \
1116 "[-q len] [conf]" 1121 "[-q len] [conf]"
@@ -1266,7 +1271,7 @@
1266 "\t-v\tverbose output\n" \ 1271 "\t-v\tverbose output\n" \
1267 "\t-L\tLock to prevent simultaneous loads of a module\n" \ 1272 "\t-L\tLock to prevent simultaneous loads of a module\n" \
1268 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \ 1273 USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
1269 "\t-x\tdo not export externs\n" 1274 "\t-x\tdo not export externs"
1270 1275
1271#define install_trivial_usage \ 1276#define install_trivial_usage \
1272 "[cgmops] [sources] <dest|directory>" 1277 "[cgmops] [sources] <dest|directory>"
@@ -1278,14 +1283,14 @@
1278 "\t-m\tset permission modes\n" \ 1283 "\t-m\tset permission modes\n" \
1279 "\t-o\tset ownership\n" \ 1284 "\t-o\tset ownership\n" \
1280 "\t-p\tpreserve date\n" \ 1285 "\t-p\tpreserve date\n" \
1281 "\t-s\tstrip symbol tables\n" 1286 "\t-s\tstrip symbol tables"
1282 1287
1283#define ip_trivial_usage \ 1288#define ip_trivial_usage \
1284 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }" 1289 "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
1285#define ip_full_usage \ 1290#define ip_full_usage \
1286 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \ 1291 "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \
1287 "where OBJECT := { link | addr | route | tunnel }\n" \ 1292 "where OBJECT := { link | addr | route | tunnel }\n" \
1288 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }\n" 1293 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
1289 1294
1290#define ipaddr_trivial_usage \ 1295#define ipaddr_trivial_usage \
1291 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }" 1296 "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }"
@@ -1296,7 +1301,7 @@
1296 "IFADDR := PREFIX | ADDR peer PREFIX\n" \ 1301 "IFADDR := PREFIX | ADDR peer PREFIX\n" \
1297 " [ broadcast ADDR ] [ anycast ADDR ]\n" \ 1302 " [ broadcast ADDR ] [ anycast ADDR ]\n" \
1298 " [ label STRING ] [ scope SCOPE-ID ]\n" \ 1303 " [ label STRING ] [ scope SCOPE-ID ]\n" \
1299 "SCOPE-ID := [ host | link | global | NUMBER ]\n" 1304 "SCOPE-ID := [ host | link | global | NUMBER ]"
1300 1305
1301#ifndef CONFIG_FEATURE_IPCALC_FANCY 1306#ifndef CONFIG_FEATURE_IPCALC_FANCY
1302#define ipcalc_trivial_usage \ 1307#define ipcalc_trivial_usage \
@@ -1322,19 +1327,13 @@
1322 "\t-s\t--silent\tDon't ever display error messages." 1327 "\t-s\t--silent\tDon't ever display error messages."
1323#endif 1328#endif
1324 1329
1325#define ipcalc_notes_usage \
1326 "ipcalc provides a simple way to calculate IP information for\n" \
1327 "a host. The various options specify what information ipcalc\n" \
1328 "should display on standard out. Multiple options may be\n" \
1329 "specified.\n"
1330
1331#define iplink_trivial_usage \ 1330#define iplink_trivial_usage \
1332 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }" 1331 "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
1333#define iplink_full_usage \ 1332#define iplink_full_usage \
1334 "iplink set DEVICE { up | down | arp { on | off } |\n" \ 1333 "iplink set DEVICE { up | down | arp { on | off } |\n" \
1335 " dynamic { on | off } |\n" \ 1334 " dynamic { on | off } |\n" \
1336 " mtu MTU }\n" \ 1335 " mtu MTU }\n" \
1337 "iplink show [ DEVICE ]\n" 1336 "iplink show [ DEVICE ]"
1338 1337
1339#define iproute_trivial_usage \ 1338#define iproute_trivial_usage \
1340 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }" 1339 "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }"
@@ -1344,15 +1343,16 @@
1344 " [ oif STRING ] [ tos TOS ]\n" \ 1343 " [ oif STRING ] [ tos TOS ]\n" \
1345 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \ 1344 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1346 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \ 1345 "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \
1347 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]\n" 1346 "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]"
1348 1347
1349#define iptunnel_trivial_usage \ 1348#define iptunnel_trivial_usage \
1350 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ] [ ttl TTL ]" 1349 "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ]\n" \
1350 "\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]"
1351#define iptunnel_full_usage \ 1351#define iptunnel_full_usage \
1352 "iptunnel { add | change | del | show } [ NAME ]\n" \ 1352 "iptunnel { add | change | del | show } [ NAME ]\n" \
1353 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \ 1353 " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \
1354 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \ 1354 " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \
1355 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]\n" 1355 " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]"
1356 1356
1357#define kill_trivial_usage \ 1357#define kill_trivial_usage \
1358 "[-signal] process-id [process-id ...]" 1358 "[-signal] process-id [process-id ...]"
@@ -1429,8 +1429,8 @@
1429 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \ 1429 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \
1430 "Options:\n" \ 1430 "Options:\n" \
1431 "\t-s\tLog to stderr as well as the system log.\n" \ 1431 "\t-s\tLog to stderr as well as the system log.\n" \
1432 "\t-t\tLog using the specified tag (defaults to user name).\n" \ 1432 "\t-t TAG\tLog using the specified tag (defaults to user name).\n" \
1433 "\t-p\tEnter the message with the specified priority.\n" \ 1433 "\t-p PRIORITY\tEnter the message with the specified priority.\n" \
1434 "\t\tThis may be numerical or a ``facility.level'' pair." 1434 "\t\tThis may be numerical or a ``facility.level'' pair."
1435#define logger_example_usage \ 1435#define logger_example_usage \
1436 "$ logger "hello"\n" 1436 "$ logger "hello"\n"
@@ -1454,7 +1454,6 @@
1454 1454
1455#define logread_trivial_usage \ 1455#define logread_trivial_usage \
1456 "[OPTION]..." 1456 "[OPTION]..."
1457
1458#define logread_full_usage \ 1457#define logread_full_usage \
1459 "Shows the messages from syslogd (using circular buffer).\n\n" 1458 "Shows the messages from syslogd (using circular buffer).\n\n"
1460 "Options:\n" \ 1459 "Options:\n" \
@@ -1467,7 +1466,7 @@
1467 "Associate LOOPDEVICE with FILE.\n\n" \ 1466 "Associate LOOPDEVICE with FILE.\n\n" \
1468 "Options:\n" \ 1467 "Options:\n" \
1469 "\t-d\t\tDisassociate LOOPDEVICE.\n" \ 1468 "\t-d\t\tDisassociate LOOPDEVICE.\n" \
1470 "\t-o OFFSET\tStart OFFSET bytes into FILE.\n" 1469 "\t-o OFFSET\tStart OFFSET bytes into FILE."
1471 1470
1472#ifdef CONFIG_FEATURE_LS_TIMESTAMPS 1471#ifdef CONFIG_FEATURE_LS_TIMESTAMPS
1473 #define USAGE_LS_TIMESTAMPS(a) a 1472 #define USAGE_LS_TIMESTAMPS(a) a
@@ -1744,7 +1743,7 @@
1744 "\t-i\tInterrupt. Send the service an INT signal.\n" \ 1743 "\t-i\tInterrupt. Send the service an INT signal.\n" \
1745 "\t-t\tTerminate. Send the service a TERM signal.\n" \ 1744 "\t-t\tTerminate. Send the service a TERM signal.\n" \
1746 "\t-k\tKill. Send the service a KILL signal.\n" \ 1745 "\t-k\tKill. Send the service a KILL signal.\n" \
1747 "\t-x\tExit. supervise will quit as soon as the service is down.\n" 1746 "\t-x\tExit. supervise will quit as soon as the service is down."
1748 1747
1749#define mt_trivial_usage \ 1748#define mt_trivial_usage \
1750 "[-f device] opcode value" 1749 "[-f device] opcode value"
@@ -1767,15 +1766,15 @@
1767#define nameif_trivial_usage \ 1766#define nameif_trivial_usage \
1768 "[-s] [-c FILE] [{IFNAME MACADDR}]" 1767 "[-s] [-c FILE] [{IFNAME MACADDR}]"
1769#define nameif_full_usage \ 1768#define nameif_full_usage \
1770 "Nameif renaming network interface while it in the down state.\n\n" \ 1769 "Nameif renaming network interface while it in the down state.\n\n" \
1771 "Options:\n" \ 1770 "Options:\n" \
1772 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \ 1771 "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
1773 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \ 1772 "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
1774 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n" 1773 "\tIFNAME MACADDR\tnew_interface_name interface_mac_address"
1775#define nameif_example_usage \ 1774#define nameif_example_usage \
1776 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \ 1775 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
1777 " or\n" \ 1776 " or\n" \
1778 "$ nameif -c /etc/my_mactab_file\n" \ 1777 "$ nameif -c /etc/my_mactab_file\n" \
1779 1778
1780#define nc_trivial_usage \ 1779#define nc_trivial_usage \
1781 "[OPTIONS] [IP] [port]" 1780 "[OPTIONS] [IP] [port]"
@@ -1807,7 +1806,7 @@
1807 "-t tcp sockets\n" \ 1806 "-t tcp sockets\n" \
1808 "-u udp sockets\n" \ 1807 "-u udp sockets\n" \
1809 "-w raw sockets\n" \ 1808 "-w raw sockets\n" \
1810 "-x unix sockets\n" 1809 "-x unix sockets"
1811 1810
1812#define nslookup_trivial_usage \ 1811#define nslookup_trivial_usage \
1813 "[HOST] [SERVER]" 1812 "[HOST] [SERVER]"
@@ -1868,7 +1867,8 @@
1868#define pidof_trivial_usage \ 1867#define pidof_trivial_usage \
1869 "process-name [process-name ...]" 1868 "process-name [process-name ...]"
1870#define pidof_full_usage \ 1869#define pidof_full_usage \
1871 "Lists the PIDs of all processes with names that match the names on the command line" 1870 "Lists the PIDs of all processes with names that match the\n" \
1871 "names on the command line"
1872#define pidof_example_usage \ 1872#define pidof_example_usage \
1873 "$ pidof init\n" \ 1873 "$ pidof init\n" \
1874 "1\n" 1874 "1\n"
@@ -1943,7 +1943,8 @@
1943 "" 1943 ""
1944#define ps_full_usage \ 1944#define ps_full_usage \
1945 "Report process status\n" \ 1945 "Report process status\n" \
1946 USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context", "\nThis version of ps accepts no options.") 1946 USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context", \
1947 "\nThis version of ps accepts no options.")
1947 1948
1948#define ps_example_usage \ 1949#define ps_example_usage \
1949 "$ ps\n" \ 1950 "$ ps\n" \
@@ -1988,7 +1989,7 @@
1988#define realpath_trivial_usage \ 1989#define realpath_trivial_usage \
1989 "pathname ..." 1990 "pathname ..."
1990#define realpath_full_usage \ 1991#define realpath_full_usage \
1991 "return the canonicalized absolute pathnames of given arguments\n\n" 1992 "Returns the absolute pathnames of given argument."
1992 1993
1993#define reboot_trivial_usage \ 1994#define reboot_trivial_usage \
1994 "" 1995 ""
@@ -2108,7 +2109,7 @@
2108 "Arguments:\n" \ 2109 "Arguments:\n" \
2109 "\tLAST\n" \ 2110 "\tLAST\n" \
2110 "\tFIRST\tLAST\n" \ 2111 "\tFIRST\tLAST\n" \
2111 "\tFIRST\tINCREMENT\tLAST\n" 2112 "\tFIRST\tINCREMENT\tLAST"
2112 2113
2113#define setkeycodes_trivial_usage \ 2114#define setkeycodes_trivial_usage \
2114 "SCANCODE KEYCODE ..." 2115 "SCANCODE KEYCODE ..."
@@ -2126,14 +2127,13 @@
2126#define lash_full_usage \ 2127#define lash_full_usage \
2127 "The BusyBox LAme SHell (command interpreter)" 2128 "The BusyBox LAme SHell (command interpreter)"
2128#define lash_notes_usage \ 2129#define lash_notes_usage \
2129"This command does not yet have proper documentation.\n" \ 2130 "This command does not yet have proper documentation.\n\n" \
2130"\n" \ 2131 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
2131"Use lash just as you would use any other shell. It properly handles pipes,\n" \ 2132 "redirects, job control, can be used as the shell for scripts, and has a\n" \
2132"redirects, job control, can be used as the shell for scripts, and has a\n" \ 2133 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
2133"sufficient set of builtins to do what is needed. It does not (yet) support\n" \ 2134 "Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \
2134"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \ 2135 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
2135"use ash or bash. If you just need a very simple and extremely small shell,\n" \ 2136 "this will do the job."
2136"this will do the job."
2137 2137
2138#define last_trivial_usage \ 2138#define last_trivial_usage \
2139 "" 2139 ""
@@ -2166,8 +2166,8 @@
2166#define sleep_full_usage \ 2166#define sleep_full_usage \
2167 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \ 2167 USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \
2168 USAGE_FANCY_SLEEP( \ 2168 USAGE_FANCY_SLEEP( \
2169"Pause for a time equal to the total of the args given, where each arg can\n" \ 2169 "Pause for a time equal to the total of the args given, where each arg can\n" \
2170"have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.") 2170 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.")
2171#define sleep_example_usage \ 2171#define sleep_example_usage \
2172 "$ sleep 2\n" \ 2172 "$ sleep 2\n" \
2173 "[2 second delay results]\n" \ 2173 "[2 second delay results]\n" \
@@ -2215,16 +2215,16 @@
2215 "\n\t-n|--name <process-name>\tstop processes with this name"\ 2215 "\n\t-n|--name <process-name>\tstop processes with this name"\
2216 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file"\ 2216 "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file"\
2217 "\n\t-q|--quiet\t\t\tbe quiet" \ 2217 "\n\t-q|--quiet\t\t\tbe quiet" \
2218 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)\n" 2218 "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)"
2219 2219
2220#define strings_trivial_usage \ 2220#define strings_trivial_usage \
2221 "[-afo] [-n length] [file ... ]" 2221 "[-afo] [-n length] [file ... ]"
2222#define strings_full_usage \ 2222#define strings_full_usage \
2223 "Display printable strings in a binary file." \ 2223 "Display printable strings in a binary file." \
2224 "\n\nOptions:" \ 2224 "\n\nOptions:" \
2225 "\n\t-f\tPrecede each string with the name of the file where it was found." \ 2225 "\n\t-f\tPrecede each string with the name of the file where it was found." \
2226 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \ 2226 "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \
2227 "\n\t-o\tEach string is preceded by its decimal offset in the file." 2227 "\n\t-o\tEach string is preceded by its decimal offset in the file."
2228 2228
2229#define stty_trivial_usage \ 2229#define stty_trivial_usage \
2230 "[-a|g] [-F DEVICE] [SETTING]..." 2230 "[-a|g] [-F DEVICE] [SETTING]..."
@@ -2301,7 +2301,6 @@
2301 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given.\n" \ 2301 "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given.\n" \
2302 "\t-a\tDisplay all values currently available.\n" \ 2302 "\t-a\tDisplay all values currently available.\n" \
2303 "\t-A\tDisplay all values currently available in table form." 2303 "\t-A\tDisplay all values currently available in table form."
2304
2305#define sysctl_example_usage 2304#define sysctl_example_usage
2306 "sysctl [-n] [-e] variable ...\n" \ 2305 "sysctl [-n] [-e] variable ...\n" \
2307 "sysctl [-n] [-e] -w variable=value ...\n" \ 2306 "sysctl [-n] [-e] -w variable=value ...\n" \
@@ -2316,12 +2315,12 @@
2316 "Linux system and kernel logging utility.\n" \ 2315 "Linux system and kernel logging utility.\n" \
2317 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \ 2316 "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \
2318 "Options:\n" \ 2317 "Options:\n" \
2319 "\t-m NUM\t\tInterval between MARK lines (default=20min, 0=off)\n" \ 2318 "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \
2320 "\t-n\t\tRun as a foreground process\n" \ 2319 "\t-n\t\tRun as a foreground process\n" \
2321 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \ 2320 "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \
2322 USAGE_ROTATE_LOGFILE( \ 2321 USAGE_ROTATE_LOGFILE( \
2323 "\n\t-s SIZE\t\tMax size (KB) bevor rotate (default=200KB, 0=off)\n" \ 2322 "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \
2324 "\t-b NUM\t\tNumber of rotated log files (default=1, 0=purge log)") \ 2323 "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \
2325 USAGE_REMOTE_LOG( \ 2324 USAGE_REMOTE_LOG( \
2326 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \ 2325 "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \
2327 "\t-L\t\tLog locally and via network logging (default is network only)") \ 2326 "\t-L\t\tLog locally and via network logging (default is network only)") \
@@ -2434,7 +2433,7 @@
2434 "\tHOST\t\tThe official name, alias or the IP address of the\n" \ 2433 "\tHOST\t\tThe official name, alias or the IP address of the\n" \
2435 "\t\t\tremote host.\n" \ 2434 "\t\t\tremote host.\n" \
2436 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \ 2435 "\tPORT\t\tThe remote port number to connect to. If it is not\n" \
2437 "\t\t\tspecified, the default telnet (23) port is used.\n" 2436 "\t\t\tspecified, the default telnet (23) port is used."
2438#else 2437#else
2439#define telnet_trivial_usage \ 2438#define telnet_trivial_usage \
2440 "HOST [PORT]" 2439 "HOST [PORT]"
@@ -2501,15 +2500,15 @@
2501 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \ 2500 "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \
2502 "Options:\n" \ 2501 "Options:\n" \
2503 "\t-l FILE\tLocal FILE.\n" \ 2502 "\t-l FILE\tLocal FILE.\n" \
2504 "\t-r FILE\tRemote FILE.\n" \ 2503 "\t-r FILE\tRemote FILE." \
2505 USAGE_TFTP_GET( \ 2504 USAGE_TFTP_GET( \
2506 "\t-g\tGet file.\n" \ 2505 "\n\t-g\tGet file." \
2507 ) \ 2506 ) \
2508 USAGE_TFTP_PUT( \ 2507 USAGE_TFTP_PUT( \
2509 "\t-p\tPut file.\n" \ 2508 "\n\t-p\tPut file." \
2510 ) \ 2509 ) \
2511 USAGE_TFTP_BS( \ 2510 USAGE_TFTP_BS( \
2512 "\t-b SIZE\tTransfer blocks of SIZE octets.\n" \ 2511 "\n\t-b SIZE\tTransfer blocks of SIZE octets." \
2513 ) 2512 )
2514#define time_trivial_usage \ 2513#define time_trivial_usage \
2515 "[OPTION]... COMMAND [ARGS...]" 2514 "[OPTION]... COMMAND [ARGS...]"
@@ -2656,7 +2655,7 @@
2656 "Uncompress .Z file[s]\n" \ 2655 "Uncompress .Z file[s]\n" \
2657 "Options:\n" \ 2656 "Options:\n" \
2658 "\t-c\textract to stdout\n" \ 2657 "\t-c\textract to stdout\n" \
2659 "\t-f\tforce overwrite an existing file\n" 2658 "\t-f\tforce overwrite an existing file"
2660 2659
2661#define uniq_trivial_usage \ 2660#define uniq_trivial_usage \
2662 "[OPTION]... [INPUT [OUTPUT]]" 2661 "[OPTION]... [INPUT [OUTPUT]]"
@@ -2740,14 +2739,15 @@
2740 2739
2741#define vconfig_trivial_usage \ 2740#define vconfig_trivial_usage \
2742 "COMMAND [OPTIONS] ..." 2741 "COMMAND [OPTIONS] ..."
2743
2744#define vconfig_full_usage \ 2742#define vconfig_full_usage \
2745"Usage: add [interface-name] [vlan_id]\n" \ 2743 "vconfig lets you create and remove virtual ethernet devices.\n\n" \
2746" rem [vlan-name]\n" \ 2744 "Options:\n" \
2747" set_flag [interface-name] [flag-num] [0 | 1]\n" \ 2745 "\tadd [interface-name] [vlan_id]\n" \
2748" set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \ 2746 "\trem [vlan-name]\n" \
2749" set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \ 2747 "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \
2750" set_name_type [name-type]\n" 2748 "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
2749 "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
2750 "\tset_name_type [name-type]"
2751 2751
2752#define vi_trivial_usage \ 2752#define vi_trivial_usage \
2753 "[OPTION] [FILE]..." 2753 "[OPTION] [FILE]..."
@@ -2797,7 +2797,8 @@
2797 " 31 46 1365 /etc/passwd\n" 2797 " 31 46 1365 /etc/passwd\n"
2798 2798
2799#define wget_trivial_usage \ 2799#define wget_trivial_usage \
2800 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url" 2800 "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
2801 "\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
2801#define wget_full_usage \ 2802#define wget_full_usage \
2802 "wget retrieves files via HTTP or FTP\n\n" \ 2803 "wget retrieves files via HTTP or FTP\n\n" \
2803 "Options:\n" \ 2804 "Options:\n" \
@@ -2865,3 +2866,5 @@
2865 "FILE" 2866 "FILE"
2866#define zcat_full_usage \ 2867#define zcat_full_usage \
2867 "Uncompress to stdout." 2868 "Uncompress to stdout."
2869
2870#endif /* __BB_USAGE_H__ */