Rob Sullivan cleaned up the longstanding patch from Hideki IWAMOTO to add
[oweals/busybox.git] / include / usage.h
index 052f6fcc2647754893c31850ac883f755c690e6e..9ec25c49fa12e0ca46bcf5dbde20436b1082ffef 100644 (file)
@@ -370,19 +370,23 @@ USE_FEATURE_DATE_ISOFMT( \
        "64\n"
 
 #define dd_trivial_usage \
-       "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \
-       "\t  [seek=N] [conv=notrunc|noerror|sync]"
+       "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
+       "\t  [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
 #define dd_full_usage \
        "Copy a file, converting and formatting according to options\n\n" \
        "\tif=FILE\t\tread from FILE instead of stdin\n" \
        "\tof=FILE\t\twrite to FILE instead of stdout\n" \
        "\tbs=N\t\tread and write N bytes at a time\n" \
+       USE_FEATURE_DD_IBS_OBS("\tibs=N\t\tread N bytes at a time\n") \
+       USE_FEATURE_DD_IBS_OBS("\tobs=N\t\twrite N bytes at a time\n") \
        "\tcount=N\t\tcopy only N input blocks\n" \
        "\tskip=N\t\tskip N input blocks\n" \
        "\tseek=N\t\tskip N output blocks\n" \
-       "\tconv=notrunc\tdon't truncate output file\n" \
-       "\tconv=noerror\tcontinue after read errors\n" \
-       "\tconv=sync\tpad blocks with zeros\n" \
+       USE_FEATURE_DD_IBS_OBS( \
+               "\tconv=notrunc\tdon't truncate output file\n" \
+               "\tconv=noerror\tcontinue after read errors\n" \
+               "\tconv=sync\tpad blocks with zeros\n" \
+       ) \
        "\n" \
        "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
        "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
@@ -626,6 +630,9 @@ USE_FEATURE_DATE_ISOFMT( \
        "Options:\n" \
        "\t-t\tclose tray"
 
+#define ed_trivial_usage ""
+#define ed_full_usage ""
+
 #define env_trivial_usage \
        "[-iu] [-] [name=value]... [command]"
 #define env_full_usage \
@@ -745,7 +752,9 @@ USE_FEATURE_DATE_ISOFMT( \
        "\t-follow\t\tDereference symbolic links\n" \
        "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN\n" \
        "\t-print\t\tPrint (default and assumed)\n" \
-       USE_FEATURE_FIND_TYPE( \
+       USE_FEATURE_FIND_PRINT0( \
+       "\t-print0\t\tDelimit output with null characters rather than\n\t\t\tnewlines" \
+) USE_FEATURE_FIND_TYPE( \
        "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \
 ) USE_FEATURE_FIND_PERM( \
        "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \
@@ -975,36 +984,6 @@ USE_FEATURE_DATE_ISOFMT( \
        "\t-n\t\tno call to sync()\n" \
        "\t-f\t\tforce halt (don't go through init)"
 
-#ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF
-#define USAGE_SCAN_HWIF(a) a
-#else
-#define USAGE_SCAN_HWIF(a)
-#endif
-
-#ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF
-#define USAGE_UNREGISTER_HWIF(a) a
-#else
-#define USAGE_UNREGISTER_HWIF(a)
-#endif
-
-#ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET
-#define USAGE_DRIVE_RESET(a) a
-#else
-#define USAGE_DRIVE_RESET(a)
-#endif
-
-#ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF
-#define USAGE_TRISTATE_HWIF(a) a
-#else
-#define USAGE_TRISTATE_HWIF(a)
-#endif
-
-#ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA
-#define USAGE_GETSET_DMA(a) a
-#else
-#define USAGE_GETSET_DMA(a)
-#endif
-
 #define hdparm_trivial_usage \
        "[options] [device] .."
 #define hdparm_full_usage \
@@ -1015,7 +994,7 @@ USE_FEATURE_DATE_ISOFMT( \
        "\t-B   set Advanced Power Management setting (1-255)\n" \
        "\t-c   get/set IDE 32-bit IO setting\n" \
        "\t-C   check IDE power mode status\n" \
-       USAGE_GETSET_DMA("\t-d   get/set using_dma flag\n") \
+       USE_FEATURE_HDPARM_HDIO_GETSET_DMA("\t-d   get/set using_dma flag\n") \
        "\t-D   enable/disable drive defect-mgmt\n" \
        "\t-f   flush buffer cache for device on exit\n" \
        "\t-g   display drive geometry\n" \
@@ -1033,29 +1012,23 @@ USE_FEATURE_DATE_ISOFMT( \
        "\t-q   change next setting quietly\n" \
        "\t-Q   get/set DMA tagged-queuing depth (if supported)\n" \
        "\t-r   get/set readonly flag (DANGEROUS to set)\n" \
-       USAGE_SCAN_HWIF("\t-R   register an IDE interface (DANGEROUS)\n") \
+       USE_FEATURE_HDPARM_HDIO_SCAN_HWIF("\t-R   register an IDE interface (DANGEROUS)\n") \
        "\t-S   set standby (spindown) timeout\n" \
        "\t-t   perform device read timings\n" \
        "\t-T   perform cache read timings\n" \
        "\t-u   get/set unmaskirq flag (0/1)\n" \
-       USAGE_UNREGISTER_HWIF("\t-U   un-register an IDE interface (DANGEROUS)\n") \
+       USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF("\t-U   un-register an IDE interface (DANGEROUS)\n") \
        "\t-v   defaults; same as -mcudkrag for IDE drives\n" \
        "\t-V   display program version and exit immediately\n" \
-       USAGE_DRIVE_RESET("\t-w   perform device reset (DANGEROUS)\n") \
+       USE_FEATURE_HDPARM_HDIO_DRIVE_RESET("\t-w   perform device reset (DANGEROUS)\n") \
        "\t-W   set drive write-caching flag (0/1) (DANGEROUS)\n" \
-       USAGE_TRISTATE_HWIF("\t-x   tristate device for hotswap (0/1) (DANGEROUS)\n") \
+       USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF("\t-x   tristate device for hotswap (0/1) (DANGEROUS)\n") \
        "\t-X   set IDE xfer mode (DANGEROUS)\n" \
        "\t-y   put IDE drive in standby mode\n" \
        "\t-Y   put IDE drive to sleep\n" \
        "\t-Z   disable Seagate auto-powersaving mode\n" \
        "\t-z   re-read partition table"
 
-#ifdef CONFIG_FEATURE_FANCY_HEAD
-#define USAGE_FANCY_HEAD(a) a
-#else
-#define USAGE_FANCY_HEAD(a)
-#endif
-
 #define head_trivial_usage \
        "[OPTION]... [FILE]..."
 #define head_full_usage \
@@ -1064,7 +1037,7 @@ USE_FEATURE_DATE_ISOFMT( \
        "file name. With no FILE, or when FILE is -, read standard input.\n\n" \
        "Options:\n" \
        "\t-n NUM\t\tPrint first NUM lines instead of first 10" \
-       USAGE_FANCY_HEAD( \
+       USE_FEATURE_FANCY_HEAD( \
        "\n\t-c NUM\t\toutput the first NUM bytes\n" \
        "\t-q\t\tnever output headers giving file names\n" \
        "\t-v\t\talways output headers giving file names" )
@@ -1111,44 +1084,22 @@ USE_FEATURE_DATE_ISOFMT( \
        "$ hostname\n" \
        "sage\n"
 
-#ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH
-#  define USAGE_HTTPD_BASIC_AUTH(a) a
-#  ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5
-#    define USAGE_HTTPD_AUTH_MD5(a) a
-#  else
-#    define USAGE_HTTPD_AUTH_MD5(a)
-#  endif
-#else
-#  define USAGE_HTTPD_BASIC_AUTH(a)
-#  define USAGE_HTTPD_AUTH_MD5(a)
-#endif
-#ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY
-#  define USAGE_HTTPD_STANDALONE(a)
-#  define USAGE_HTTPD_SETUID(a)
-#else
-#  define USAGE_HTTPD_STANDALONE(a) a
-#  ifdef CONFIG_FEATURE_HTTPD_SETUID
-#    define USAGE_HTTPD_SETUID(a) a
-#  else
-#    define USAGE_HTTPD_SETUID(a)
-#  endif
-#endif
 #define httpd_trivial_usage \
        "[-c <conf file>]" \
-       USAGE_HTTPD_STANDALONE(" [-p <port>]") \
-       USAGE_HTTPD_SETUID(" [-u user]") \
-       USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
-       USAGE_HTTPD_AUTH_MD5(" [-m pass]") \
+       USE_FEATURE_HTTPD_WITHOUT_INETD(" [-p <port>]") \
+       USE_FEATURE_HTTPD_SETUID(" [-u user]") \
+       USE_FEATURE_HTTPD_BASIC_AUTH(" [-r <realm>]") \
+       USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
        " [-h home]" \
        " [-d/-e <string>]"
 #define httpd_full_usage \
        "Listens for incoming http server requests.\n\n" \
        "Options:\n" \
        "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \
-       USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \
-       USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \
-       USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
-       USAGE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
+       USE_FEATURE_HTTPD_WITHOUT_INETD("\t-p PORT\tServer port (default 80)\n") \
+       USE_FEATURE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \
+       USE_FEATURE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \
+       USE_FEATURE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \
        "\t-h HOME  \tSpecifies http HOME directory (default ./)\n" \
        "\t-e STRING\tHtml encode STRING\n" \
        "\t-d STRING\tURL decode STRING"