udhcpc: support for -O <option>.
[oweals/busybox.git] / include / usage.h
index 953645ba0f10789057603a9cbb2346c393645f6f..12d2cefd9c1ab4d0950dc1e18f90c851a1c6c6eb 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" \
      "\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( \
        "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
 
 #define hexdump_trivial_usage \
-       "[-[bcCdefnosvx]] [OPTION] FILE"
+       "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
 #define hexdump_full_usage \
        "Display file(s) or standard input in a user specified format" \
-       "\n\nOptions:\n" \
-       "       -b              One-byte octal display\n" \
-       "       -c              One-byte character display\n" \
-       "       -C              Canonical hex+ASCII, 16 bytes per line\n" \
-       "       -d              Two-byte decimal display\n" \
-       "       -e FORMAT STRING\n" \
-       "       -f FORMAT FILE\n" \
-       "       -n LENGTH       Interpret only LENGTH bytes of input\n" \
-       "       -o              Two-byte octal display\n" \
-       "       -s OFFSET       Skip OFFSET bytes\n" \
-       "       -v              Display all input data\n" \
-       "       -x              Two-byte hexadecimal display"
+       "\n\nOptions:" \
+     "\n       -b              One-byte octal display" \
+     "\n       -c              One-byte character display" \
+     "\n       -C              Canonical hex+ASCII, 16 bytes per line" \
+     "\n       -d              Two-byte decimal display" \
+     "\n       -e FORMAT STRING" \
+     "\n       -f FORMAT FILE" \
+     "\n       -n LENGTH       Interpret only LENGTH bytes of input" \
+     "\n       -o              Two-byte octal display" \
+     "\n       -s OFFSET       Skip OFFSET bytes" \
+     "\n       -v              Display all input data" \
+     "\n       -x              Two-byte hexadecimal display" \
+       USE_FEATURE_HEXDUMP_REVERSE( \
+     "\n       -R              Reverse of 'hexdump -Cv'") \
+
+#define hd_trivial_usage \
+       "FILE..."
+#define hd_full_usage \
+       "hd is an alias for hexdump -C"
 
 #define hostid_trivial_usage \
        ""
        "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" \
        )
 
@@ -3114,6 +3122,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 \
@@ -3181,15 +3195,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 \
        ""
@@ -3500,16 +3506,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]..."
@@ -3833,47 +3840,53 @@ 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]..."
 #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_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_UDHCPC_ARPING( \
+       "\n     -a              Use arping to validate offered address" \
+       ) \
        )
 
 #define udhcpd_trivial_usage \
@@ -3902,17 +3915,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"
@@ -3923,7 +3936,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|-]"
@@ -4112,9 +4125,11 @@ USE_FEATURE_RUN_PARTS_FANCY("\n  -l      Prints names of all matching files even when
        "/bin/login\n"
 
 #define who_trivial_usage \
-       " "
+       "[-a]"
 #define who_full_usage \
-       "Print the current user names and related information"
+       "Show who is logged on" \
+       "\n\nOptions:\n" \
+       "       -a      show all"
 
 #define whoami_trivial_usage \
        ""