Standardize on the vi editing directives being on the first line.
[oweals/busybox.git] / include / usage.h
index 239bbb373805666db9278ad42bdb8b5ee63e3824..3c1fb18e95c487dbedf3724381e18ff30b0a2fc5 100644 (file)
@@ -1,3 +1,4 @@
+/* vi: set sw=4 ts=4: */
 #ifndef __BB_USAGE_H__
 #define __BB_USAGE_H__
 
@@ -994,7 +995,7 @@ USE_FEATURE_DATE_ISOFMT( \
 #define hdparm_trivial_usage \
        "[options] [device] .."
 #define hdparm_full_usage \
-       USE_FEATURE_HDPARM_GET_IDENTITY("\tIf no device name is specified read from stdin.\n") \
+       USE_FEATURE_HDPARM_GET_IDENTITY("\tIf no device name is specified try to read from stdin.\n") \
        "\nOptions:\n" \
        "\t-a   get/set fs readahead\n" \
        "\t-A   set drive read-lookahead flag (0/1)\n" \
@@ -1799,19 +1800,25 @@ USE_FEATURE_DATE_ISOFMT( \
        "\t-s\tScan /sys and populate /dev during system boot\n\n" \
        "Called with no options (via hotplug) it uses environment variables\n" \
        "to determine which device to add/remove."
-#ifdef CONFIG_FEATURE_MDEV_CONFIG
-#define mdev_notes_usage \
+#define mdev_notes_usage "" \
+USE_FEATURE_MDEV_CONFIG( \
        "The mdev config file contains lines that look like:\n" \
        "  hd[a-z][0-9]* 0:3 660\n\n" \
        "That's device name (with regex match), uid:gid, and permissions.\n\n" \
-       "Optionally, that can be followed (on the same line) by an asterisk\n" \
-       "and a command line to run after creating the corresponding device(s),\n"\
-       "ala:\n\n" \
-       "  hdc root:cdrom 660  *ln -s hdc cdrom\n\n" \
+       USE_FEATURE_MDEV_EXEC( \
+               "Optionally, that can be followed (on the same line) by a special character\n" \
+               "and a command line to run after creating/before deleting the corresponding\n" \
+               "device(s).  The environment variable $MDEV indicates the active device node\n" \
+               "(which is useful if it's a regex match).  For example:\n\n" \
+               "  hdc root:cdrom 660  *ln -s $MDEV cdrom\n\n" \
+               "The special characters are @ (run after creating), $ (run before deleting),\n" \
+               "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"\
-       "the last line match .* to override this.)\n\n"
-#endif
+       "the last line match .* to override this.)\n\n" \
+)
 
 #define mesg_trivial_usage \
        "[y|n]"
@@ -2047,6 +2054,8 @@ USE_FEATURE_DATE_ISOFMT( \
        "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
        "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
        "$ mount cd_image.iso mydir\n"
+#define mount_notes_usage \
+       "Returns 0 for success, number of failed mounts for -a, or errno for one mount." 
 
 #define mountpoint_trivial_usage \
        "[-q] <[-d] DIR | -x DEVICE>"
@@ -2197,12 +2206,12 @@ USE_FEATURE_DATE_ISOFMT( \
        "\t-u\tUnlocks (re-enables) the specified user account"
 
 #define patch_trivial_usage \
-       "[-p<num>] [-i<patch.diff>]"
+       "[-p<num>] [-i <diff>]"
 #define patch_full_usage \
-       "[-p<num>]\n" \
-       "[-i<diff>]"
+       "\t-p <num>\tStrip <num> leading components from file names\n" \
+       "\t-i <diff>\tRead <diff> instead of stdin"
 #define patch_example_usage \
-       "$ patch -p1 <example.diff\n" \
+       "$ patch -p1 < example.diff\n" \
        "$ patch -p0 -i example.diff"
 
 #if ENABLE_FEATURE_PIDOF_SINGLE
@@ -2681,6 +2690,10 @@ USE_FEATURE_DATE_ISOFMT( \
        "\n\t-n|--name <process-name>\tstop processes with this name" \
        "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file" \
        "\n\t-q|--quiet\t\t\tbe quiet" \
+USE_FEATURE_START_STOP_DAEMON_FANCY( \
+       "\n\t-o|--oknodo\t\t\texit status 0 if nothing done" \
+       "\n\t-v|--verbose\t\t\tbe verbose" \
+) \
        "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)"
 
 #ifdef CONFIG_FEATURE_STAT_FORMAT
@@ -3343,11 +3356,12 @@ USE_FEATURE_DATE_ISOFMT( \
        "Mon Dec 17 10:31:44 GMT 2000"
 
 #define watchdog_trivial_usage \
-       "[-t <seconds>] DEV"
+       "[-t <seconds>] [-F] DEV"
 #define watchdog_full_usage \
        "Periodically write to watchdog device DEV.\n" \
        "Options:\n" \
-       "\t-t\tTimer period in seconds - default is 30"
+       "\t-t\tTimer period in seconds - default is 30\n" \
+       "\t-F\tStay in the foreground and don't fork"
 
 #define wc_trivial_usage \
        "[OPTION]... [FILE]..."
@@ -3442,6 +3456,6 @@ USE_FEATURE_DATE_ISOFMT( \
        "\t-f              foreground mode\n" \
        "\t-q              quit after address (no daemon)\n" \
        "\t-r 169.254.x.x  request this address first\n" \
-       "\t-v              verbose; show version"
+       "\t-v              verbose"
 
 #endif /* __BB_USAGE_H__ */