Move start_stop_daemon to debianutils.
[oweals/busybox.git] / include / usage.h
index 9100111157e20e6ee48c45204fa0ebac1126b112..5b7db4150fe28fec3ed3ffec20846bda12c84052 100644 (file)
 #define adduser_full_usage \
        "Adds a user to the system" \
        "Options:\n" \
-           "\t-h\t\thome directory\n" \
-           "\t-s\t\tshell\n" \
-           "\t-g\t\tGECOS string\n"
+           "\t-h DIR\t\tAssign home directory DIR\n" \
+           "\t-g GECOS\t\tAssign gecos field GECOS\n" \
+           "\t-s SHELL\t\tAssign login shell SHELL\n" \
+           "\t-G\t\tAdd the user to existing group GROUP\n" \
+           "\t-S\t\tcreate a system user (ignored)\n" \
+           "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \
+           "\t-H\t\tDo not create the home directory\n"
 
 #define adjtimex_trivial_usage \
        "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
 #define fdflush_full_usage \
        "Forces floppy disk drive to detect disk change"
 
+#define fdformat_trivial_usage \
+       "[-n] DEVICE"
+#define fdformat_full_usage \
+       "Low-level formats a floppy disk\n\n" \
+       "Options:\n" \
+       "\t-n\tDon't verify after format"
+
 #define fdisk_trivial_usage \
        "[-l] [-v] [-b SSZ] [-u] DISK"
 #define fdisk_full_usage \
 #define halt_full_usage \
        "Halt the system."
 
+#ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY
+#define USAGE_HDPARM_IDENT(a) a
+#else
+#define USAGE_HDPARM_IDENT(a)
+#endif
+
+#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
+
+#define hdparm_trivial_usage \
+       "[options] [device] .."
+#define hdparm_full_usage \
+       "Options:" \
+       " -a   get/set fs readahead\n" \
+       " -A   set drive read-lookahead flag (0/1)\n" \
+       " -b   get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
+       " -B   set Advanced Power Management setting (1-255)\n" \
+       " -c   get/set IDE 32-bit IO setting\n" \
+       " -C   check IDE power mode status\n" \
+       " -d   get/set using_dma flag\n" \
+       " -D   enable/disable drive defect-mgmt\n" \
+       " -f   flush buffer cache for device on exit\n" \
+       " -g   display drive geometry\n" \
+       " -h   display terse usage information\n" \
+       " -i   display drive identification\n" \
+       USAGE_HDPARM_IDENT(" -I   detailed/current information directly from drive\n") \
+       USAGE_HDPARM_IDENT(" -Istdin  similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \
+       " -k   get/set keep_settings_over_reset flag (0/1)\n" \
+       " -K   set drive keep_features_over_reset flag (0/1)\n" \
+       " -L   set drive doorlock (0/1) (removable harddisks only)\n" \
+       " -m   get/set multiple sector count\n" \
+       " -n   get/set ignore-write-errors flag (0/1)\n" \
+       " -p   set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
+       " -P   set drive prefetch count\n" \
+       " -q   change next setting quietly\n" \
+       " -Q   get/set DMA tagged-queuing depth (if supported)\n" \
+       " -r   get/set readonly flag (DANGEROUS to set)\n" \
+       USAGE_SCAN_HWIF(" -R   register an IDE interface (DANGEROUS)\n") \
+       " -S   set standby (spindown) timeout\n" \
+       " -t   perform device read timings\n" \
+       " -T   perform cache read timings\n" \
+       " -u   get/set unmaskirq flag (0/1)\n" \
+       USAGE_UNREGISTER_HWIF(" -U   un-register an IDE interface (DANGEROUS)\n") \
+       " -v   defaults; same as -mcudkrag for IDE drives\n" \
+       " -V   display program version and exit immediately\n" \
+       USAGE_DRIVE_RESET(" -w   perform device reset (DANGEROUS)\n") \
+       " -W   set drive write-caching flag (0/1) (DANGEROUS)\n" \
+       USAGE_TRISTATE_HWIF(" -x   tristate device for hotswap (0/1) (DANGEROUS)\n") \
+       " -X   set IDE xfer mode (DANGEROUS)\n" \
+       " -y   put IDE drive in standby mode\n" \
+       " -Y   put IDE drive to sleep\n" \
+       " -Z   disable Seagate auto-powersaving mode\n" \
+       " -z   re-read partition table\n"
+
 #ifdef CONFIG_FEATURE_FANCY_HEAD
 #define USAGE_FANCY_HEAD(a) a
 #else
        "\t-u\tthe hardware clock is kept in coordinated universal time\n" \
        "\t-l\tthe hardware clock is kept in local time"
 
+#ifdef CONFIG_SELINUX
+#define USAGE_SELINUX(a, b) a
+#else
+#define USAGE_SELINUX(a, b) b
+#endif
+
 #define id_trivial_usage \
        "[OPTIONS]... [USERNAME]"
 #define id_full_usage \
        "Options:\n" \
        "\t-g\tprints only the group ID\n" \
        "\t-u\tprints only the user ID\n" \
+       USAGE_SELINUX("\t-c\tprints only the security context\n", "") \
        "\t-n\tprint a name instead of a number (with for -ug)\n" \
        "\t-r\tprints the real user ID instead of the effective ID (with -ug)"
 #define id_example_usage \
   #define USAGE_AUTOWIDTH(a)
 #endif
 #define ls_trivial_usage \
-       "[-1Aa" USAGE_LS_TIMESTAMPS("c") "Cd" USAGE_LS_TIMESTAMPS("e") USAGE_LS_FILETYPES("F") "iln" USAGE_LS_FILETYPES("p") USAGE_LS_FOLLOWLINKS("L") USAGE_LS_RECURSIVE("R") USAGE_LS_SORTFILES("rS") "s" USAGE_AUTOWIDTH("T") USAGE_LS_TIMESTAMPS("tu") USAGE_LS_SORTFILES("v") USAGE_AUTOWIDTH("w") "x" USAGE_LS_SORTFILES("X") USAGE_HUMAN_READABLE("h") USAGE_NOT_HUMAN_READABLE("") "k] [filenames...]"
+       "[-1Aa" USAGE_LS_TIMESTAMPS("c") "Cd" USAGE_LS_TIMESTAMPS("e") USAGE_LS_FILETYPES("F") "iln" USAGE_LS_FILETYPES("p") USAGE_LS_FOLLOWLINKS("L") USAGE_LS_RECURSIVE("R") USAGE_LS_SORTFILES("rS") "s" USAGE_AUTOWIDTH("T") USAGE_LS_TIMESTAMPS("tu") USAGE_LS_SORTFILES("v") USAGE_AUTOWIDTH("w") "x" USAGE_LS_SORTFILES("X") USAGE_HUMAN_READABLE("h") USAGE_NOT_HUMAN_READABLE("") "k" USAGE_SELINUX("K", "") "] [filenames...]"
 #define ls_full_usage \
        "List directory contents\n\n" \
        "Options:\n" \
        USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \
        USAGE_HUMAN_READABLE( \
        "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \
-       "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \
-       "\t-k\tprint sizes in kilobytes(compatibility)") 
+       USAGE_SELINUX("\t-k\tprint security context\n\t-K\tprint security context in long format\n", ""))
 
 #define lsmod_trivial_usage \
        ""
 
 #define msvc_trivial_usage \
        "-[udorspchaitkx] service"
-#define msvc_full_usafe \
+#define msvc_full_usage \
        "[option] service\n" \
        "Where option is one of\n" \
        "\t-u\tUp.  If the service is not running, start it.  If the service stops, restart it.\n" \
        "\t-l\tLocks (disables) the specified user account.\n" \
        "\t-u\tUnlocks (re-enables) the specified user account."
 
+#define patch_trivial_usage \
+       "[-p<num>]"
+#define patch_full_usage \
+       "[-p<num>]"
+#define patch_example_usage \
+       "$ patch -p1 <example.diff"
+
 #define pidfilehack_trivial_usage \
        "[daemon.pid] [daemon]"
 #define pidfilehack_full_usage \
        ""
 #define ps_full_usage \
        "Report process status\n" \
-       "\nThis version of ps accepts no options."
+       USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context", "\nThis version of ps accepts no options.")
 #define ps_example_usage \
        "$ ps\n" \
        "  PID  Uid      Gid State Command\n" \
        "/root\n"
 
 #define rdate_trivial_usage \
-       "[OPTION] HOST"
+       "[-sp] HOST"
 #define rdate_full_usage \
        "Get and possibly set the system date and time from a remote HOST.\n\n" \
        "Options:\n" \
        "-i -q[ildc]p package.rpm"
 #define rpm_full_usage \
        "Manipulates RPM packages" \
-       "Options:" \
-       "\t-i Install package" \
-       "\t-q Query package" \
-       "\t\t-p Query uninstalled package" \
-       "\t\t-i Show information" \
-       "\t\t-l List contents" \
-       "\t\t-d List documents" \
-       "\t\t-c List config files"
+       "\n\nOptions:" \
+       "\n\t-i Install package" \
+       "\n\t-q Query package" \
+       "\n\t-p Query uninstalled package" \
+       "\n\t-i Show information" \
+       "\n\t-l List contents" \
+       "\n\t-d List documents" \
+       "\n\t-c List config files"
 
 #define rpm2cpio_trivial_usage \
        "package.rpm"
        "\t-x\texclude these files\n" \
        "\t-d\textract files into this directory"
 
-#define update_trivial_usage \
-       "[options]"
-#define update_full_usage \
-       "Periodically flushes filesystem buffers.\n\n" \
-       "Options:\n" \
-       "\t-S\tforce use of sync(2) instead of flushing\n" \
-       "\t-s SECS\tcall sync this often (default 30)\n" \
-       "\t-f SECS\tflush some buffers this often (default 5)"
-
 #define uptime_trivial_usage \
        ""
 #define uptime_full_usage \
        "Mon Dec 17 10:31:44 GMT 2000" 
 
 #define watchdog_trivial_usage \
-       "DEV"
+       "[-t <seconds>] DEV"
 #define watchdog_full_usage \
-       "Periodically write to watchdog device DEV"
+       "Periodically write to watchdog device DEV.\n" \
+       "Options:\n" \
+       "\t-t\tTimer period in seconds - default is 30."
 
 #define wc_trivial_usage \
        "[OPTION]... [FILE]..."