aboutsummaryrefslogtreecommitdiff
path: root/include/usage.src.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/usage.src.h')
-rw-r--r--include/usage.src.h216
1 files changed, 37 insertions, 179 deletions
diff --git a/include/usage.src.h b/include/usage.src.h
index f30edbc54..b3396006f 100644
--- a/include/usage.src.h
+++ b/include/usage.src.h
@@ -119,12 +119,6 @@ INSERT
119#define sh_full_usage "" 119#define sh_full_usage ""
120#define ash_trivial_usage NOUSAGE_STR 120#define ash_trivial_usage NOUSAGE_STR
121#define ash_full_usage "" 121#define ash_full_usage ""
122#define hush_trivial_usage NOUSAGE_STR
123#define hush_full_usage ""
124#define lash_trivial_usage NOUSAGE_STR
125#define lash_full_usage ""
126#define msh_trivial_usage NOUSAGE_STR
127#define msh_full_usage ""
128#define bash_trivial_usage NOUSAGE_STR 122#define bash_trivial_usage NOUSAGE_STR
129#define bash_full_usage "" 123#define bash_full_usage ""
130 124
@@ -163,16 +157,6 @@ INSERT
163#define blkid_full_usage "\n\n" \ 157#define blkid_full_usage "\n\n" \
164 "Print UUIDs of all filesystems" 158 "Print UUIDs of all filesystems"
165 159
166#define bootchartd_trivial_usage \
167 "start [PROG ARGS]|stop|init"
168#define bootchartd_full_usage "\n\n" \
169 "Create /var/log/bootchart.tgz with boot chart data\n" \
170 "\nOptions:" \
171 "\nstart: start background logging; with PROG, run PROG, then kill logging with USR1" \
172 "\nstop: send USR1 to all bootchartd processes" \
173 "\ninit: start background logging; stop when getty/xdm is seen (for init scripts)" \
174 "\nUnder PID 1: as init, then exec $bootchart_init, /init, /sbin/init" \
175
176#define brctl_trivial_usage \ 160#define brctl_trivial_usage \
177 "COMMAND [BRIDGE [INTERFACE]]" 161 "COMMAND [BRIDGE [INTERFACE]]"
178#define brctl_full_usage "\n\n" \ 162#define brctl_full_usage "\n\n" \
@@ -444,7 +428,7 @@ INSERT
444 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \ 428 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
445 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS" 429 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
446#define chpst_full_usage "\n\n" \ 430#define chpst_full_usage "\n\n" \
447 "Change the process state and run PROG\n" \ 431 "Change the process state, run PROG\n" \
448 "\nOptions:" \ 432 "\nOptions:" \
449 "\n -u USER[:GRP] Set uid and gid" \ 433 "\n -u USER[:GRP] Set uid and gid" \
450 "\n -U USER[:GRP] Set $UID and $GID in environment" \ 434 "\n -U USER[:GRP] Set $UID and $GID in environment" \
@@ -467,17 +451,17 @@ INSERT
467#define setuidgid_trivial_usage \ 451#define setuidgid_trivial_usage \
468 "USER PROG ARGS" 452 "USER PROG ARGS"
469#define setuidgid_full_usage "\n\n" \ 453#define setuidgid_full_usage "\n\n" \
470 "Set uid and gid to USER's uid and gid, removing all supplementary\n" \ 454 "Set uid and gid to USER's uid and gid, drop supplementary group ids,\n" \
471 "groups and run PROG" 455 "run PROG"
472#define envuidgid_trivial_usage \ 456#define envuidgid_trivial_usage \
473 "USER PROG ARGS" 457 "USER PROG ARGS"
474#define envuidgid_full_usage "\n\n" \ 458#define envuidgid_full_usage "\n\n" \
475 "Set $UID to USER's uid and $GID to USER's gid and run PROG" 459 "Set $UID to USER's uid and $GID to USER's gid, run PROG"
476#define envdir_trivial_usage \ 460#define envdir_trivial_usage \
477 "DIR PROG ARGS" 461 "DIR PROG ARGS"
478#define envdir_full_usage "\n\n" \ 462#define envdir_full_usage "\n\n" \
479 "Set various environment variables as specified by files\n" \ 463 "Set various environment variables as specified by files\n" \
480 "in the directory dir and run PROG" 464 "in the directory DIR, run PROG"
481#define softlimit_trivial_usage \ 465#define softlimit_trivial_usage \
482 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \ 466 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
483 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \ 467 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
@@ -548,24 +532,49 @@ INSERT
548#define bbconfig_trivial_usage \ 532#define bbconfig_trivial_usage \
549 "" 533 ""
550#define bbconfig_full_usage "\n\n" \ 534#define bbconfig_full_usage "\n\n" \
551 "Print the config file which built busybox" 535 "Print the config file used by busybox build"
552 536
553#define chrt_trivial_usage \ 537#define chrt_trivial_usage \
554 "[OPTIONS] [PRIO] [PID | PROG ARGS]" 538 "[OPTIONS] [PRIO] [PID | PROG ARGS]"
555#define chrt_full_usage "\n\n" \ 539#define chrt_full_usage "\n\n" \
556 "Manipulate real-time attributes of a process\n" \ 540 "Change scheduling priority and class for a process\n" \
557 "\nOptions:" \ 541 "\nOptions:" \
558 "\n -p Operate on PID" \ 542 "\n -p Operate on PID" \
559 "\n -r Set SCHED_RR scheduling" \ 543 "\n -r Set SCHED_RR class" \
560 "\n -f Set SCHED_FIFO scheduling" \ 544 "\n -f Set SCHED_FIFO class" \
561 "\n -o Set SCHED_OTHER scheduling" \ 545 "\n -o Set SCHED_OTHER class" \
562 "\n -m Show min and max priorities" \ 546 "\n -m Show min/max priorities" \
563 547
564#define chrt_example_usage \ 548#define chrt_example_usage \
565 "$ chrt -r 4 sleep 900; x=$!\n" \ 549 "$ chrt -r 4 sleep 900; x=$!\n" \
566 "$ chrt -f -p 3 $x\n" \ 550 "$ chrt -f -p 3 $x\n" \
567 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process" 551 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
568 552
553#define nice_trivial_usage \
554 "[-n ADJUST] [PROG ARGS]"
555#define nice_full_usage "\n\n" \
556 "Change scheduling priority, run PROG\n" \
557 "\nOptions:" \
558 "\n -n ADJUST Adjust priority by ADJUST" \
559
560#define renice_trivial_usage \
561 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
562#define renice_full_usage "\n\n" \
563 "Change scheduling priority for a running process\n" \
564 "\nOptions:" \
565 "\n -n Adjust current nice value (smaller is faster)" \
566 "\n -p Process id(s) (default)" \
567 "\n -g Process group id(s)" \
568 "\n -u Process user name(s) and/or id(s)" \
569
570#define ionice_trivial_usage \
571 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
572#define ionice_full_usage "\n\n" \
573 "Change I/O priority and class\n" \
574 "\nOptions:" \
575 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
576 "\n -n Priority" \
577
569#define cp_trivial_usage \ 578#define cp_trivial_usage \
570 "[OPTIONS] SOURCE DEST" 579 "[OPTIONS] SOURCE DEST"
571#define cp_full_usage "\n\n" \ 580#define cp_full_usage "\n\n" \
@@ -1309,7 +1318,7 @@ INSERT
1309#define flock_trivial_usage \ 1318#define flock_trivial_usage \
1310 "[-sxun] FD|{FILE [-c] PROG ARGS}" 1319 "[-sxun] FD|{FILE [-c] PROG ARGS}"
1311#define flock_full_usage "\n\n" \ 1320#define flock_full_usage "\n\n" \
1312 "[Un]lock file descriptor, or lock FILE and run PROG\n" \ 1321 "[Un]lock file descriptor, or lock FILE, run PROG\n" \
1313 "\nOptions:" \ 1322 "\nOptions:" \
1314 "\n -s Shared lock" \ 1323 "\n -s Shared lock" \
1315 "\n -x Exclusive lock (default)" \ 1324 "\n -x Exclusive lock (default)" \
@@ -2048,14 +2057,6 @@ INSERT
2048 "\n -Z Set security context" \ 2057 "\n -Z Set security context" \
2049 ) 2058 )
2050 2059
2051#define ionice_trivial_usage \
2052 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
2053#define ionice_full_usage "\n\n" \
2054 "Change I/O scheduling class and priority\n" \
2055 "\nOptions:" \
2056 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
2057 "\n -n Priority" \
2058
2059/* would need to make the " | " optional depending on more than one selected: */ 2060/* would need to make the " | " optional depending on more than one selected: */
2060#define ip_trivial_usage \ 2061#define ip_trivial_usage \
2061 "[OPTIONS] {" \ 2062 "[OPTIONS] {" \
@@ -2954,84 +2955,6 @@ INSERT
2954 " or\n" \ 2955 " or\n" \
2955 "$ nameif -c /etc/my_mactab_file\n" \ 2956 "$ nameif -c /etc/my_mactab_file\n" \
2956 2957
2957#if !ENABLE_DESKTOP
2958
2959#if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
2960#define NC_OPTIONS_STR "\n\nOptions:"
2961#else
2962#define NC_OPTIONS_STR
2963#endif
2964
2965#define nc_trivial_usage \
2966 IF_NC_EXTRA("[-iN] [-wN] ")IF_NC_SERVER("[-l] [-p PORT] ") \
2967 "["IF_NC_EXTRA("-f FILENAME|")"IPADDR PORT]"IF_NC_EXTRA(" [-e PROG]")
2968#define nc_full_usage "\n\n" \
2969 "Open a pipe to IP:port" IF_NC_EXTRA(" or file") \
2970 NC_OPTIONS_STR \
2971 IF_NC_EXTRA( \
2972 "\n -e PROG Run PROG after connect" \
2973 "\n -i SEC Delay interval for lines sent" \
2974 "\n -w SEC Timeout for connect" \
2975 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
2976 ) \
2977 IF_NC_SERVER( \
2978 "\n -l Listen mode, for inbound connects" \
2979 IF_NC_EXTRA( \
2980 "\n (use -l twice with -e for persistent server)") \
2981 "\n -p PORT Local port" \
2982 )
2983
2984#define nc_notes_usage "" \
2985 IF_NC_EXTRA( \
2986 "To use netcat as a terminal emulator on a serial port:\n\n" \
2987 "$ stty 115200 -F /dev/ttyS0\n" \
2988 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2989 )
2990
2991#define nc_example_usage \
2992 "$ nc foobar.somedomain.com 25\n" \
2993 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2994 "help\n" \
2995 "214-Commands supported:\n" \
2996 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2997 "214 NOOP QUIT RSET HELP\n" \
2998 "quit\n" \
2999 "221 foobar closing connection\n"
3000
3001#else /* DESKTOP nc - much more compatible with nc 1.10 */
3002
3003#define nc_trivial_usage \
3004 "[OPTIONS] HOST PORT - connect" \
3005 IF_NC_SERVER("\n" \
3006 "nc [OPTIONS] -l -p PORT [HOST] [PORT] - listen")
3007#define nc_full_usage "\n\n" \
3008 "Options:" \
3009 "\n -e PROG Run PROG after connect (must be last)" \
3010 IF_NC_SERVER( \
3011 "\n -l Listen mode, for inbound connects" \
3012 ) \
3013 "\n -n Don't do DNS resolution" \
3014 "\n -s ADDR Local address" \
3015 "\n -p PORT Local port" \
3016 "\n -u UDP mode" \
3017 "\n -v Verbose" \
3018 "\n -w SEC Timeout for connects and final net reads" \
3019 IF_NC_EXTRA( \
3020 "\n -i SEC Delay interval for lines sent" /* ", ports scanned" */ \
3021 "\n -o FILE Hex dump traffic" \
3022 "\n -z Zero-I/O mode (scanning)" \
3023 ) \
3024/* "\n -r Randomize local and remote ports" */
3025/* "\n -g gateway Source-routing hop point[s], up to 8" */
3026/* "\n -G num Source-routing pointer: 4, 8, 12, ..." */
3027/* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
3028
3029/* -e PROG can take ARGS too: "nc ... -e ls -l", but we don't document it
3030 * in help text: nc 1.10 does not allow that. We don't want to entice
3031 * users to use this incompatibility */
3032
3033#endif
3034
3035#define netstat_trivial_usage \ 2958#define netstat_trivial_usage \
3036 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]" 2959 "[-laentuwxr"IF_FEATURE_NETSTAT_WIDE("W")IF_FEATURE_NETSTAT_PRG("p")"]"
3037#define netstat_full_usage "\n\n" \ 2960#define netstat_full_usage "\n\n" \
@@ -3053,13 +2976,6 @@ INSERT
3053 "\n -p Display PID/Program name for sockets" \ 2976 "\n -p Display PID/Program name for sockets" \
3054 ) 2977 )
3055 2978
3056#define nice_trivial_usage \
3057 "[-n ADJUST] [PROG ARGS]"
3058#define nice_full_usage "\n\n" \
3059 "Run PROG with modified scheduling priority\n" \
3060 "\nOptions:" \
3061 "\n -n ADJUST Adjust priority by ADJUST" \
3062
3063#define nmeter_trivial_usage \ 2979#define nmeter_trivial_usage \
3064 "format_string" 2980 "format_string"
3065#define nmeter_full_usage "\n\n" \ 2981#define nmeter_full_usage "\n\n" \
@@ -3513,16 +3429,6 @@ INSERT
3513 "\n" \ 3429 "\n" \
3514 "\nOther options are silently ignored" \ 3430 "\nOther options are silently ignored" \
3515 3431
3516#define renice_trivial_usage \
3517 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
3518#define renice_full_usage "\n\n" \
3519 "Change priority of running processes\n" \
3520 "\nOptions:" \
3521 "\n -n Adjust current nice value (smaller is faster)" \
3522 "\n -p Process id(s) (default)" \
3523 "\n -g Process group id(s)" \
3524 "\n -u Process user name(s) and/or id(s)" \
3525
3526#define scriptreplay_trivial_usage \ 3432#define scriptreplay_trivial_usage \
3527 "timingfile [typescript [divisor]]" 3433 "timingfile [typescript [divisor]]"
3528#define scriptreplay_full_usage "\n\n" \ 3434#define scriptreplay_full_usage "\n\n" \
@@ -4273,54 +4179,6 @@ INSERT
4273#define tac_full_usage "\n\n" \ 4179#define tac_full_usage "\n\n" \
4274 "Concatenate FILEs and print them in reverse" 4180 "Concatenate FILEs and print them in reverse"
4275 4181
4276#define tar_trivial_usage \
4277 "-[" IF_FEATURE_TAR_CREATE("c") "xt" IF_FEATURE_SEAMLESS_GZ("z") \
4278 IF_FEATURE_SEAMLESS_BZ2("j") IF_FEATURE_SEAMLESS_LZMA("a") \
4279 IF_FEATURE_SEAMLESS_Z("Z") IF_FEATURE_TAR_NOPRESERVE_TIME("m") "vO] " \
4280 IF_FEATURE_TAR_FROM("[-X FILE] ") \
4281 "[-f TARFILE] [-C DIR] [FILE]..."
4282#define tar_full_usage "\n\n" \
4283 IF_FEATURE_TAR_CREATE("Create, extract, ") \
4284 IF_NOT_FEATURE_TAR_CREATE("Extract ") \
4285 "or list files from a tar file\n" \
4286 "\nOptions:" \
4287 IF_FEATURE_TAR_CREATE( \
4288 "\n c Create" \
4289 ) \
4290 "\n x Extract" \
4291 "\n t List" \
4292 "\nArchive format selection:" \
4293 IF_FEATURE_SEAMLESS_GZ( \
4294 "\n z Filter the archive through gzip" \
4295 ) \
4296 IF_FEATURE_SEAMLESS_BZ2( \
4297 "\n j Filter the archive through bzip2" \
4298 ) \
4299 IF_FEATURE_SEAMLESS_LZMA( \
4300 "\n a Filter the archive through lzma" \
4301 ) \
4302 IF_FEATURE_SEAMLESS_Z( \
4303 "\n Z Filter the archive through compress" \
4304 ) \
4305 IF_FEATURE_TAR_NOPRESERVE_TIME( \
4306 "\n m Do not restore mtime" \
4307 ) \
4308 "\nFile selection:" \
4309 "\n f Name of TARFILE or \"-\" for stdin" \
4310 "\n O Extract to stdout" \
4311 IF_FEATURE_TAR_FROM( \
4312 IF_FEATURE_TAR_LONG_OPTIONS( \
4313 "\n exclude File to exclude" \
4314 ) \
4315 "\n X File with names to exclude" \
4316 ) \
4317 "\n C Change to DIR before operation" \
4318 "\n v Verbose" \
4319
4320#define tar_example_usage \
4321 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
4322 "$ tar -cf /tmp/tarball.tar /usr/local\n"
4323
4324#define taskset_trivial_usage \ 4182#define taskset_trivial_usage \
4325 "[-p] [MASK] [PID | PROG ARGS]" 4183 "[-p] [MASK] [PID | PROG ARGS]"
4326#define taskset_full_usage "\n\n" \ 4184#define taskset_full_usage "\n\n" \