microcom: split -d (delay) option away from -t
[oweals/busybox.git] / include / usage.h
index d0eecdb4a673d830de0d29fce1b3ca2d1a7468f1..37cefeab192be17af8535ee85b52cf49d4bea806 100644 (file)
@@ -76,7 +76,7 @@
        "\n     -H hwtype       Hardware address type"
 
 #define arping_trivial_usage \
-       "[-fqbDUA] [-c count] [-w timeout] [-i device] [-s sender] target"
+       "[-fqbDUA] [-c count] [-w timeout] [-I dev] [-s sender] target"
 #define arping_full_usage \
        "Ping hosts by ARP requests/replies" \
        "\n\nOptions:\n" \
        "       -q              Quiet\n" \
        "       -b              Keep broadcasting, don't go unicast\n" \
        "       -D              Duplicated address detection mode\n" \
-       "       -U              Unsolicited ARP mode, update your neighbours\n" \
-       "       -A              ARP answer mode, update your neighbours\n" \
-       "       -c count        Stop after sending count ARP request packets\n" \
+       "       -U              Unsolicited ARP mode, update your neighbors\n" \
+       "       -A              ARP answer mode, update your neighbors\n" \
+       "       -c N            Stop after sending N ARP requests\n" \
        "       -w timeout      Time to wait for ARP reply, in seconds\n" \
-       "       -I device       Outgoing interface name, default is eth0\n" \
-       "       -s sender       Set specific sender IP address\n" \
-       "       target          Target IP address of ARP request"
+       "       -I dev          Interface to use (default eth0)\n" \
+       "       -s sender       Sender IP address\n" \
+       "       target          Target IP address"
 
 #define ash_trivial_usage \
        "[FILE]...\n" \
        "$ basename /foo/bar.txt .txt\n" \
        "bar"
 
+#define brctl_trivial_usage \
+       "COMMAND [BRIDGE [INTERFACE]]"
+#define brctl_full_usage \
+       "Manage ethernet bridges." \
+       "\n\nCommands:\n" \
+       "       addbr <bridge>          Create <bridge>\n" \
+       "       delbr <bridge>          Delete <bridge>\n" \
+       "       addif <bridge> <iface>  Add <iface> to <bridge>\n" \
+       "       delif <bridge> <iface>  Delete <iface> from <bridge>" \
+USE_FEATURE_BRCTL_FANCY("\n" \
+       "       setageing <bridge <time>        set ageing time\n" \
+       "       setfd <bridge <time>            set bridge forward delay\n" \
+       "       sethello <bridge <time>         set hello time\n" \
+       "       setmaxage <bridge <time>        set max message age\n" \
+       "       setpathcost <bridge <cost>      set path cost\n" \
+       "       setportprio <bridge <prio>      set port priority\n" \
+       "       setbridgeprio <bridge <prio>    set bridge priority\n" \
+       "       stp <bridge> [1|0]              turn stp on/off\n" \
+)
 #define bunzip2_trivial_usage \
        "[OPTION]... [FILE]"
 #define bunzip2_full_usage \
 #define eject_full_usage \
        "Eject specified DEVICE (or default /dev/cdrom)" \
        "\n\nOptions:\n" \
+       USE_FEATURE_EJECT_SCSI( \
+       "       -s      scsi device\n" \
+       ) \
        "       -t      Close tray\n" \
        "       -T      Open/close tray (toggle)"
 
        "       -S SECTORS      Set the number of sectors\n" \
        "       -v              Give fdisk version"
 
+#define fetchmail_trivial_usage \
+       "[-C dir] [-w timeout] [-U user] -P password [-X] [-t] [-z] server[:port]"
+#define fetchmail_full_usage \
+       "Fetch content of remote mailbox to local Maildir." \
+       "\n\nOptions:\n" \
+       "       -C dir          Set Maildir location\n" \
+       "       -w timeout      Set timeout on network operations\n" \
+       "       -U username     Authenticate with specified username\n" \
+       "       -P password     Authenticate with specified password\n" \
+       "       -X              Use openssl connection helper for secured servers\n" \
+       "       -t              Get only headers\n" \
+       "       -z              Delete messages on server"
+
 #define find_trivial_usage \
        "[PATH...] [EXPRESSION]"
 #define find_full_usage \
      "\n       -maxdepth N     Descend at most N levels. -maxdepth 0 applies" \
      "\n                       tests/actions to command line arguments only") \
      "\n       -name PATTERN   File name (w/o directory name) matches PATTERN" \
+     "\n       -iname PATTERN  Case insensitive -name" \
        USE_FEATURE_FIND_PATH( \
      "\n       -path PATTERN   Path matches PATTERN") \
        USE_FEATURE_FIND_REGEX( \
        "[-d delay] [-n] [-f]"
 #define halt_full_usage \
        "Halt the system" \
-       "\n\nOptions:\n" \
-       "       -d      Delay interval for halting\n" \
-       "       -n      No call to sync()\n" \
-       "       -f      Force halt (don't go through init)"
+       "\n\nOptions:" \
+       "\n     -d      Delay interval for halting" \
+       "\n     -n      No call to sync()" \
+       "\n     -f      Force halt (don't go through init)" \
+       USE_FEATURE_WTMP( \
+       "\n     -w      Only write a wtmp record" \
+       )
 
 #define hdparm_trivial_usage \
        "[options] [device] .."
        "and * (run both after creating and before deleting). The commands run in\n" \
        "the /dev directory, and use system() which calls /bin/sh.\n\n" \
        ) \
-       "Config file parsing stops on the first matching line. If no config\n"\
-       "entry is matched, devices are created with default 0:0 660. (Make\n"\
+       "Config file parsing stops on the first matching line. If no config\n" \
+       "entry is matched, devices are created with default 0:0 660. (Make\n" \
        "the last line match .* to override this.)\n\n" \
        )
 
        "       n       Disallow write access to your terminal"
 
 #define microcom_trivial_usage \
-       "[-s speed] tty-name"
+       "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
 #define microcom_full_usage \
-       ""
+       "Copy bytes for stdin to TTY and from TTY to stdout" \
+       "\n\nOptions:" \
+     "\n       -d      Wait up to DELAY ms for TTY output before sending every" \
+     "\n               next byte to it" \
+     "\n       -t      Exit if both stdin and TTY are silent for TIMEOUT ms" \
+     "\n       -s      Set serial line to SPEED"
+     "\n       -X      Disable special meaning of NUL and Ctrl-X from stdin"
 
 #define mkdir_trivial_usage \
        "[OPTION] DIRECTORY..."
        "       block-count     Number of block to use (default is entire partition)"
 
 #define mktemp_trivial_usage \
-       "[-dq] TEMPLATE"
+       "[-dt] [-p DIR] TEMPLATE"
 #define mktemp_full_usage \
        "Create a temporary file with its name based on TEMPLATE.\n" \
        "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
        "\n\nOptions:\n" \
        "       -d      Make a directory instead of a file\n" \
-       "       -q      Fail silently if an error occurs"
+       /* "    -q      Fail silently if an error occurs\n" - we ignore it */ \
+       "       -t      Generate a path rooted in temporary directory\n" \
+       "       -p DIR  Use DIR as a temporary directory (implies -t)\n" \
+       "\n" \
+       "For -t or -p, directory is chosen as follows:\n" \
+       "$TMPDIR if set, else -p DIR, else /tmp"
+
 #define mktemp_example_usage \
        "$ mktemp /tmp/temp.XXXXXX\n" \
        "/tmp/temp.mWiLjM\n" \
        "Address:    127.0.0.1\n"
 
 #define od_trivial_usage \
-       "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
+       "[-aBbcDdeFfHhIiLlOovXx] " USE_DESKTOP("[-t TYPE] ") "[FILE]"
 #define od_full_usage \
        "Write an unambiguous representation, octal bytes by default, of FILE\n" \
-       "to standard output. With no FILE, or when FILE is -, read standard input."
+       "to standard output. With no FILE or when FILE is -, read standard input."
 
 #define openvt_trivial_usage \
        "VTNUM COMMAND [ARGS...]"
@@ -3111,6 +3162,23 @@ USE_FEATURE_RUN_PARTS_FANCY("\n  -l      Prints names of all matching files even when
 #define selinuxenabled_trivial_usage
 #define selinuxenabled_full_usage
 
+#define sendmail_trivial_usage \
+       "[-C dir] [-w timeout] [-U user] [-P password] [-X]\n" \
+       "-t to [-t to] -f from [-n] [-s subject] [-c charset] server[:port] [body] [attachment ...]"
+#define sendmail_full_usage \
+       "Send an email with optional attachments." \
+       "\n\nOptions:\n" \
+       "       -C dir          Change current directory to dir\n" \
+       "       -w timeout      Set timeout on network operations\n" \
+       "       -U username     Authenticate with specified username\n" \
+       "       -P password     Authenticate with specified password\n" \
+       "       -X              Use openssl connection helper for secured servers\n" \
+       "       -t to           Recipient email. May be multiple\n" \
+       "       -f from         Sender address\n" \
+       "       -n              Request delivery notification to sender\n" \
+       "       -s subject      Subject\n" \
+       "       -c charset      Assumed charset for body and subject [utf-8]"
+
 #define seq_trivial_usage \
        "[first [increment]] last"
 #define seq_full_usage \
@@ -3121,6 +3189,12 @@ USE_FEATURE_RUN_PARTS_FANCY("\n  -l      Prints names of all matching files even when
        "       FIRST LAST\n" \
        "       FIRST INCREMENT LAST"
 
+#define sestatus_trivial_usage \
+       "[-vb]"
+#define sestatus_full_usage \
+       "-v     Verbose\n" \
+       "-b     Display current state of booleans"
+
 #define setconsole_trivial_usage \
        "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
 #define setconsole_full_usage \
@@ -3188,15 +3262,7 @@ USE_FEATURE_RUN_PARTS_FANCY("\n  -l      Prints names of all matching files even when
        "[FILE]...\n" \
        "or: sh -c command [args]..."
 #define lash_full_usage \
-       "The BusyBox LAme SHell (command interpreter)"
-#define lash_notes_usage \
-       "This command does not yet have proper documentation.\n\n" \
-       "Use lash just as you would use any other shell. It properly handles pipes,\n" \
-       "redirects, job control, can be used as the shell for scripts, and has a\n" \
-       "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
-       "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
-       "use ash or bash. If you just need a very simple and extremely small shell,\n" \
-       "this will do the job."
+       "lash is deprecated, please use hush"
 
 #define last_trivial_usage \
        ""
@@ -3355,7 +3421,7 @@ USE_FEATURE_RUN_PARTS_FANCY("\n   -l      Prints names of all matching files even when
        USE_FEATURE_STAT_FORMAT( \
        "       -c fmt  Use the specified format\n") \
        "       -f      Display filesystem status\n" \
-       "       -L,-l   Dereference links\n" \
+       "       -L      Dereference links\n" \
        "       -t      Display info in terse form" \
        USE_SELINUX( \
        "\n     -Z      Print security context" \
@@ -3507,16 +3573,17 @@ USE_FEATURE_RUN_PARTS_FANCY("\n -l      Prints names of all matching files even when
        "Configure kernel parameters at runtime" \
        "\n\nOptions:\n" \
        "       -n      Disable printing of key names\n" \
+       "       -e      Don't warn about unknown keys\n" \
        "       -w      Change sysctl setting\n" \
        "       -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)\n" \
        "       -a      Display all values\n" \
        "       -A      Display all values in table form"
 #define sysctl_example_usage \
-       "sysctl [-n] variable...\n" \
-       "sysctl [-n] -w variable=value...\n" \
-       "sysctl [-n] -a\n" \
-       "sysctl [-n] -p file    (default /etc/sysctl.conf)\n" \
-       "sysctl [-n] -A\n"
+       "sysctl [-n] [-e] variable...\n" \
+       "sysctl [-n] [-e] -w variable=value...\n" \
+       "sysctl [-n] [-e] -a\n" \
+       "sysctl [-n] [-e] -p file       (default /etc/sysctl.conf)\n" \
+       "sysctl [-n] [-e] -A\n"
 
 #define syslogd_trivial_usage \
        "[OPTION]..."
@@ -3542,6 +3609,11 @@ USE_FEATURE_RUN_PARTS_FANCY("\n  -l      Prints names of all matching files even when
        "$ syslogd -R masterlog:514\n" \
        "$ syslogd -R 192.168.1.1:601\n"
 
+#define tac_trivial_usage \
+       "[FILE]..."
+#define tac_full_usage \
+       "Concatenates FILE(s) and prints them to stdout in reverse"
+
 #define tail_trivial_usage \
        "[OPTION]... [FILE]..."
 #define tail_full_usage \
@@ -3840,56 +3912,71 @@ USE_FEATURE_RUN_PARTS_FANCY("\n -l      Prints names of all matching files even when
 
 #define udhcpc_trivial_usage \
        "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
-       "       [-p pidfile] [-r IP] [-s script]"
+       "       [-p pidfile] [-r IP] [-s script] [-O dhcp-option]..." USE_FEATURE_UDHCP_PORT(" [-P N]")
 #define udhcpc_full_usage \
        USE_GETOPT_LONG( \
-       "       -V,--vendorclass=CLASSID        Set vendor class identifier" \
-       "\n     -i,--interface=INTERFACE        Interface to use (default: eth0)" \
+       "       -V,--vendorclass=CLASSID        Vendor class identifier" \
+       "\n     -i,--interface=INTERFACE        Interface to use (default eth0)" \
        "\n     -H,-h,--hostname=HOSTNAME       Client hostname" \
-       "\n     -c,--clientid=CLIENTID  Set client identifier" \
+       "\n     -c,--clientid=CLIENTID  Client identifier" \
        "\n     -C,--clientid-none      Suppress default client identifier" \
-       "\n     -p,--pidfile=file       Store process ID of daemon in file" \
+       "\n     -p,--pidfile=file       Create pidfile" \
        "\n     -r,--request=IP         IP address to request" \
-       "\n     -s,--script=file        Run file at dhcp events (default: /usr/share/udhcpc/default.script)" \
-       "\n     -t,--retries=N          Send up to N request packets"\
-       "\n     -T,--timeout=N          Try to get a lease for N seconds (default: 3)"\
-       "\n     -A,--tryagain=N         Wait N seconds (default: 60) after failure"\
+       "\n     -s,--script=file        Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
+       "\n     -t,--retries=N          Send up to N request packets" \
+       "\n     -T,--timeout=N          Try to get a lease for N seconds (default 3)" \
+       "\n     -A,--tryagain=N         Wait N seconds (default 20) after failure" \
        "\n     -f,--foreground Run in foreground" \
-       "\n     -b,--background Background if lease cannot be immediately negotiated" \
+       "\n     -b,--background Background if lease is not immediately obtained" \
        "\n     -S,--syslog     Log to syslog too" \
-       "\n     -n,--now        Exit with failure if lease cannot be immediately negotiated" \
+       "\n     -n,--now        Exit with failure if lease is not immediately obtained" \
        "\n     -q,--quit       Quit after obtaining lease" \
        "\n     -R,--release    Release IP on quit" \
-       "\n     -v,--version    Display version" \
+       "\n     -O,--request-option=OPT Request DHCP option OPT from server" \
+       USE_FEATURE_UDHCP_PORT( \
+       "\n     -P,--client-port N  Use port N instead of default 68" \
+       ) \
+       USE_FEATURE_UDHCPC_ARPING( \
+       "\n     -a,--arping     Use arping to validate offered address" \
+       ) \
        ) \
        SKIP_GETOPT_LONG( \
-       "       -V CLASSID      Set vendor class identifier" \
+       "       -V CLASSID      Vendor class identifier" \
        "\n     -i INTERFACE    Interface to use (default: eth0)" \
        "\n     -H,-h HOSTNAME  Client hostname" \
-       "\n     -c CLIENTID     Set client identifier" \
+       "\n     -c CLIENTID     Client identifier" \
        "\n     -C              Suppress default client identifier" \
-       "\n     -p file         Store process ID of daemon in file" \
+       "\n     -p file         Create pidfile" \
        "\n     -r IP           IP address to request" \
-       "\n     -s file         Run file at dhcp events (default: /usr/share/udhcpc/default.script)" \
-       "\n     -t N            Send up to N request packets"\
-       "\n     -T N            Try to get a lease for N seconds (default: 3)"\
-       "\n     -A N            Wait N seconds (default: 60) after failure"\
+       "\n     -s file         Run file at dhcp events (default /usr/share/udhcpc/default.script)" \
+       "\n     -t N            Send up to N request packets" \
+       "\n     -T N            Try to get a lease for N seconds (default 3)" \
+       "\n     -A N            Wait N seconds (default 20) after failure" \
        "\n     -f              Run in foreground" \
-       "\n     -b              Background if lease cannot be immediately negotiated" \
+       "\n     -b              Background if lease is not immediately obtained" \
        "\n     -S              Log to syslog too" \
-       "\n     -n              Exit with failure if lease cannot be immediately negotiated" \
+       "\n     -n              Exit with failure if lease is not immediately obtained" \
        "\n     -q              Quit after obtaining lease" \
        "\n     -R              Release IP on quit" \
-       "\n     -v              Display version" \
+       "\n     -O OPT          Request DHCP option OPT from server" \
+       USE_FEATURE_UDHCP_PORT( \
+       "\n     -P N            Use port N instead of default 68" \
+       ) \
+       USE_FEATURE_UDHCPC_ARPING( \
+       "\n     -a              Use arping to validate offered address" \
+       ) \
        )
 
 #define udhcpd_trivial_usage \
-       "[-fS] [configfile]" \
+       "[-fS]" USE_FEATURE_UDHCP_PORT(" [-P N]") " [configfile]" \
 
 #define udhcpd_full_usage \
        "DHCP server" \
        "\n     -f      Run in foreground" \
-       "\n     -S      Log to syslog too"
+       "\n     -S      Log to syslog too" \
+       USE_FEATURE_UDHCP_PORT( \
+       "\n     -P N    Use port N instead of default 67" \
+       )
 
 #define umount_trivial_usage \
        "[flags] FILESYSTEM|DIRECTORY"
@@ -3909,17 +3996,17 @@ USE_FEATURE_RUN_PARTS_FANCY("\n -l      Prints names of all matching files even when
        "$ umount /dev/hdc1\n"
 
 #define uname_trivial_usage \
-       "[OPTION]..."
+       "[-amnrspv]"
 #define uname_full_usage \
-       "Print certain system information. With no OPTION, same as -s." \
+       "Print system information." \
        "\n\nOptions:\n" \
-       "       -a      Print all information\n" \
+       "       -a      Print all\n" \
        "       -m      The machine (hardware) type\n" \
-       "       -n      Print machine's hostname\n" \
-       "       -r      Print OS release\n" \
-       "       -s      Print OS name\n" \
-       "       -p      Print host processor type\n" \
-       "       -v      Print OS version"
+       "       -n      Hostname\n" \
+       "       -r      OS release\n" \
+       "       -s      OS name (default)\n" \
+       "       -p      Processor type\n" \
+       "       -v      OS version"
 #define uname_example_usage \
        "$ uname -a\n" \
        "Linux debian 2.4.23 #2 Tue Dec 23 17:09:10 MST 2003 i686 GNU/Linux\n"
@@ -3930,7 +4017,7 @@ USE_FEATURE_RUN_PARTS_FANCY("\n   -l      Prints names of all matching files even when
        "Uncompress .Z file[s]" \
        "\n\nOptions:\n" \
        "       -c      Extract to stdout\n" \
-       "       -f      Force overwrite an existing file"
+       "       -f      Overwrite an existing file"
 
 #define unexpand_trivial_usage \
        "[-f][-a][-t NUM] [FILE|-]"