Apply patch from Ghozlane Toumi to add -inum support to find.
[oweals/busybox.git] / include / usage.h
index 5b357a218a5a0e690f9b08aec09f999b481fc4ee..077306bdf7733cec885a794f5480cf7cf2f50615 100644 (file)
@@ -1,12 +1,12 @@
 #define addgroup_trivial_usage \
-       "[OPTIONS] <group_name>"
+       "[OPTIONS] group_name [user_name]"
 #define addgroup_full_usage \
        "Adds a group to the system" \
        "Options:\n" \
            "\t-g\t\tspecify gid\n"
 
 #define adduser_trivial_usage \
-       "[OPTIONS] <user_name>"
+       "[OPTIONS] user_name"
 #define adduser_full_usage \
        "Adds a user to the system" \
        "Options:\n" \
        "\t-x\t\textract\n" \
        "\t-v\t\tverbosely list files processed\n"
 
+#define arping_trivial_usage \
+       "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n"
+#define arping_full_usage \
+       "Ping hosts by ARP requests/replies.\n\n" \
+       "Options:\n" \
+       "\t-f\t\tQuit on first ARP reply\n" \
+       "\t-q\t\tBe quiet\n" \
+       "\t-b\t\tKeep broadcasting, don't go unicast\n" \
+       "\t-D\t\tDuplicated address detection mode\n" \
+       "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \
+       "\t-A\t\tARP answer mode, update your neighbours\n" \
+       "\t-c count\tStop after sending count ARP request packets\n" \
+       "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \
+       "\t-I device\tOutgoing interface name, default is eth0\n" \
+       "\t-s sender\tSet specific sender IP address\n" \
+       "\ttarget\t\tTarget IP address of ARP request\n"
+
 #define        awk_trivial_usage \
        "[-v var=val][-F sep] { -f progname | 'programtext' } [FILE ...]"
 #define        awk_full_usage \
 #define dc_full_usage \
        "This is a Tiny RPN calculator that understands the\n" \
        "following operations: +, -, /, *, and, or, not, eor.\n" \
-       "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16"
+       "i.e., 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16" \
+       "p - Prints the value on the top of the stack, without altering the stack.\n" \
+       "f - Prints the entire contents of the stack without altering anything.\n" \
+       "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \
+       "    Only 10 and 16 are supported.\n"
+
 #define dc_example_usage \
        "$ dc 2 2 +\n" \
        "4\n" \
 #define dumpleases_trivial_usage \
        "[-r|-a] [-f LEASEFILE]"
 #define dumpleases_full_usage \
-       "Usage: dumpleases -f <file> -[r|a]\n" \
        "\t-f,\t--file=FILENAME\tLeases file to load\n" \
        "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \
        "\t-a,\t--absolute\tInterepret lease times as expire time\n"
 #else
   #define USAGE_FIND_MTIME(a)
 #endif
+#ifdef CONFIG_FEATURE_FIND_NEWER
+  #define USAGE_FIND_NEWER(a) a
+#else
+  #define USAGE_FIND_NEWER(a)
+#endif
+#ifdef CONFIG_FEATURE_FIND_INUM
+  #define USAGE_FIND_INUM(a) a
+#else
+  #define USAGE_FIND_INUM(a)
+#endif
 
 #define find_trivial_usage \
        "[PATH...] [EXPRESSION]"
 ) USAGE_FIND_PERM( \
        "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
 ) USAGE_FIND_MTIME( \
-       "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days")
+       "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \
+) USAGE_FIND_NEWER( \
+       "\n\t-newer FILE\tModified time is more recent than FILE's" \
+) USAGE_FIND_INUM( \
+       "\n\t-inum N\t\tFile has inode number N")
 #define find_example_usage \
        "$ find / -name /etc/passwd\n" \
        "/etc/passwd\n"
        "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \
        "\t-f\tForce file system check."
 
+#define ftpget_trivial_usage \
+       "[options] remote-host local-directory remote-file"
+#define ftpget_full_usage \
+       "Retrieve a remote file via FTP.\n\n" \
+       "Options:\n" \
+       "\t-c, --continue         Continue a previous transfer\n" \
+       "\t-v, --verbose          Verbose\n" \
+       "\t-u, --username         Username to be used\n" \
+       "\t-p, --password         Password to be used\n" \
+       "\t-P, --port             Port number to be used\n" 
+
+#define ftpput_trivial_usage \
+       "[options] remote-host remote-directory local-file"
+#define ftpput_full_usage \
+       "Store a local file on a remote machine via FTP.\n\n" \
+       "Options:\n" \
+       "\t-v, --verbose          Verbose\n" \
+       "\t-u, --username         Username to be used\n" \
+       "\t-p, --password         Password to be used\n" \
+       "\t-P, --port             Port number to be used\n" 
+
 #define getopt_trivial_usage \
        "[OPTIONS]..."
 #define getopt_full_usage \
 #define hostname_example_usage \
        "$ hostname\n" \
        "sage \n"
-
+#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
+  #define USAGE_HTTPD_BASIC_AUTH(a) a
+#else
+  #define USAGE_HTTPD_BASIC_AUTH(a)
+#endif
+#define httpd_trivial_usage \
+       "[-p <port>] [-d/-e <string>]" USAGE_HTTPD_BASIC_AUTH(" [-c <conf file>] [-r <realm>]")
+#define httpd_full_usage \
+       "Listens for incoming http server requests.\n"\
+       "Options:\n" \
+       "\t-p PORT\tServer port (default 80).\n" \
+       USAGE_HTTPD_BASIC_AUTH("\t-c FILE\tSpecifies configuration file.  (default httpd.conf)\n\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
+       "\t-e STRING\tHtml encode STRING\n" \
+       "\t-d STRING\tURL decode STRING\n" 
 #define hwclock_trivial_usage \
        "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]"
 #define hwclock_full_usage \
 #define ifup_full_usage \
        "Usage: ifup <options> <ifaces...>\n\n" \
        "Options:\n" \
-       "\t-h, --help\t\tthis help\n" \
-       "\t-a, --all\t\tde/configure all interfaces automatically\n" \
-       "\t-i, --interfaces FILE\tuse FILE for interface definitions\n" \
-    "\t-n, --no-act\t\tprint out what would happen, but don't do it\n" \
-       "\t\t\t\t(note that this option doesn't disable mappings)\n" \
-    "\t-v, --verbose\t\tprint out what would happen before doing it\n" \
-       "\t--no-mappings\t\tdon't run any mappings\n" \
-       "\t--force\t\t\tforce de/configuration\n"
+       "\t-h\tthis help\n" \
+       "\t-a\tde/configure all interfaces automatically\n" \
+       "\t-i FILE\tuse FILE for interface definitions\n" \
+       "\t-n\tprint out what would happen, but don't do it\n" \
+       "\t\t\t(note that this option doesn't disable mappings)\n" \
+       "\t-v\tprint out what would happen before doing it\n" \
+       "\t-m\tdon't run any mappings\n" \
+       "\t-f\tforce de/configuration\n"
 
 #define ifdown_trivial_usage \
        "<-ahinv> <ifaces...>"
 #define ifdown_full_usage \
        "Usage: ifdown <options> <ifaces...>\n\n" \
        "Options:\n" \
-       "\t-h, --help\t\tthis help\n" \
-       "\t-a, --all\t\tde/configure all interfaces automatically\n" \
-       "\t-i, --interfaces FILE\tuse FILE for interface definitions\n" \
-    "\t-n, --no-act\t\tprint out what would happen, but don't do it\n" \
-       "\t\t\t\t(note that this option doesn't disable mappings)\n" \
-    "\t-v, --verbose\t\tprint out what would happen before doing it\n" \
-       "\t--no-mappings\t\tdon't run any mappings\n" \
-       "\t--force\t\t\tforce de/configuration\n"
+       "\t-h\tthis help\n" \
+       "\t-a\tde/configure all interfaces automatically\n" \
+       "\t-i FILE\tuse FILE for interface definitions\n" \
+       "\t-n\tprint out what would happen, but don't do it\n" \
+       "\t\t(note that this option doesn't disable mappings)\n" \
+       "\t-v\tprint out what would happen before doing it\n" \
+       "\t-m\tdon't run any mappings\n" \
+       "\t-f\tforce de/configuration\n"
        
 #define init_trivial_usage \
        ""
 "      ::shutdown:/bin/umount -a -r\n" \
 "      ::shutdown:/sbin/swapoff -a\n"
 
+#ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP
+  #define USAGE_INSMOD_MAP(a) a
+#else
+  #define USAGE_INSMOD_MAP(a)
+#endif
 #define insmod_trivial_usage \
        "[OPTION]... MODULE [symbol=value]..."
 #define insmod_full_usage \
        "\t-k\tMake module autoclean-able.\n" \
        "\t-v\tverbose output\n"  \
        "\t-L\tLock to prevent simultaneous loads of a module\n" \
-       "\t-x\tdo not export externs"
+       USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \
+       "\t-x\tdo not export externs\n"
 
 #define ip_trivial_usage \
        "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }"
 #define mv_example_usage \
        "$ mv /tmp/foo /bin/bar\n" 
 
+#define nameif_trivial_usage \
+       "[-s] [-c FILE] [{IFNAME MACADDR}]"
+#define nameif_full_usage \
+               "Nameif renaming network interface while it in the down state.\n\n" \
+               "Options:\n" \
+               "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
+               "\t-s\t\tUse syslog (LOCAL0 facility).\n" \
+               "\tIFNAME MACADDR\tnew_interface_name interface_mac_address\n" 
+#define nameif_example_usage \
+               "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
+               " or\n" \
+               "$ nameif -c /etc/my_mactab_file\n" \
+
 #define nc_trivial_usage \
        "[OPTIONS] [IP] [port]" 
 #define nc_full_usage \
 #define rmmod_full_usage \
        "Unloads the specified kernel modules from the kernel.\n\n" \
        "Options:\n" \
-       "\t-a\tTry to remove all unused kernel modules."
+       "\t-a\tRemove all unused modules (recursively)"
 #define rmmod_example_usage \
        "$ rmmod tulip\n"
 
 #else
   #define USAGE_TAR_EXCLUDE(a)
 #endif
+#ifdef CONFIG_FEATURE_TAR_GZIP
+  #define USAGE_TAR_GZIP(a) a
+#else
+  #define USAGE_TAR_GZIP(a)
+#endif
+#ifdef CONFIG_FEATURE_TAR_BZIP2
+  #define USAGE_TAR_BZIP2(a) a
+#else
+  #define USAGE_TAR_BZIP2(a)
+#endif
+
 #define tar_trivial_usage \
-       "-[" USAGE_TAR_CREATE("c") "xtvO] " \
+       "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") "xtvO] " \
        USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
        "[-f TARFILE] [-C DIR] [FILE(s)] ..."
 #define tar_full_usage \
        USAGE_TAR_CREATE("\tc\t\tcreate\n") \
        "\tx\t\textract\n" \
        "\tt\t\tlist\n" \
+       "\nArchive format selection:\n" \
+       USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \
+       USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \
        "\nFile selection:\n" \
        "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
        "\tO\t\textract to stdout\n" \
 #define udhcpc_trivial_usage \
        "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]"
 #define udhcpc_full_usage \
-       "\tUsage: udhcpc [OPTIONS]\n" \
        "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \
        "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \
        "\t-h,\t                   \tAlias for -H\n" \
        "[configfile]\n" \
 
 #define udhcpd_full_usage \
-       "\tUsage: udhcpd [configfile]\n"
+       ""
 
 #ifdef CONFIG_FEATURE_MOUNT_FORCE
   #define USAGE_MOUNT_FORCE(a) a