Standardize on the vi editing directives being on the first line.
[oweals/busybox.git] / include / usage.h
index 8defbd1fca5377899d17ec742b5842fba4abc439..3c1fb18e95c487dbedf3724381e18ff30b0a2fc5 100644 (file)
@@ -1,3 +1,4 @@
+/* vi: set sw=4 ts=4: */
 #ifndef __BB_USAGE_H__
 #define __BB_USAGE_H__
 
@@ -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]"
@@ -2199,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
@@ -2961,23 +2968,6 @@ USE_FEATURE_START_STOP_DAEMON_FANCY( \
        "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
        "$ tar -cf /tmp/tarball.tar /usr/local\n"
 
-#define taskset_trivial_usage \
-       "[OPTIONS] [mask] [pid | command [arg]...]"
-#define taskset_full_usage \
-       "Set or get CPU affinity.\n\n" \
-       "Options:\n" \
-       "\t-p\toperate on an existing PID"
-#define taskset_example_usage \
-       "$ taskset 0x7 ./dgemm_test&\n" \
-       "$ taskset -p 0x1 $!\n" \
-       "pid 4790's current affinity mask: 7\n" \
-       "pid 4790's new affinity mask: 1\n" \
-       "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
-       "pid 6671's current affinity mask: 1\n" \
-       "pid 6671's new affinity mask: 1\n" \
-       "$ taskset -p 1\n"
-       "pid 1's current affinity mask: 3\n"
-
 #define tee_trivial_usage \
        "[OPTION]... [FILE]..."
 #define tee_full_usage \
@@ -3366,11 +3356,12 @@ USE_FEATURE_START_STOP_DAEMON_FANCY( \
        "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]..."