remove a few extra newlines in help text
[oweals/busybox.git] / include / usage.h
index f654062541f393453c87145eab76c4f5837c5001..aae06fda14a8671fa3b5b8373835758424d4ff25 100644 (file)
 #define ash_full_usage ""
 #define hush_trivial_usage NOUSAGE_STR
 #define hush_full_usage ""
+#define lash_trivial_usage NOUSAGE_STR
+#define lash_full_usage ""
 #define msh_trivial_usage NOUSAGE_STR
 #define msh_full_usage ""
-#define bbsh_trivial_usage \
-       "[FILE]...\n" \
-       "or: bbsh -c command [args]..."
-#define bbsh_full_usage "\n\n" \
-       "The bbsh shell (command interpreter)"
 
 #define awk_trivial_usage \
        "[OPTIONS] [AWK_PROGRAM] [FILE]..."
        "$ basename /foo/bar.txt .txt\n" \
        "bar"
 
+#define beep_trivial_usage \
+       "-f freq -l length -d delay -r repetitions -n"
+#define beep_full_usage "\n\n" \
+       "Options:" \
+     "\n       -f      Frequency in Hz" \
+     "\n       -l      Length in ms" \
+     "\n       -d      Delay in ms" \
+     "\n       -r      Repetitions" \
+     "\n       -n      Start new tone" \
+
 #define fbsplash_trivial_usage \
        "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
 #define fbsplash_full_usage "\n\n" \
-       "Options:\n" \
+       "Options:" \
      "\n       -s      Image" \
      "\n       -c      Hide cursor" \
      "\n       -d      Framebuffer device (default /dev/fb0)" \
 #define date_full_usage "\n\n" \
        "Display time (using +FMT), or set time\n" \
      "\nOptions:" \
+     "\n       [-s] TIME       Set time to TIME" \
      "\n       -u              Work in UTC (don't convert to local time)" \
      "\n       -R              Output RFC-822 compliant date string" \
        IF_FEATURE_DATE_ISOFMT( \
      "\n                       'hours', 'minutes', or 'seconds' for date and" \
      "\n                       time to the indicated precision" \
        ) \
-     "\n       -d TIME         Display TIME, not 'now'" \
      "\n       -r FILE         Display last modification time of FILE" \
-     "\n       [-s] TIME       Set time to TIME" \
+     "\n       -d TIME         Display TIME, not 'now'" \
        IF_FEATURE_DATE_ISOFMT( \
-     "\n       -D FMT          Use FMT for str->date conversion" \
+     "\n       -D FMT          Use FMT for -d TIME conversion" \
        ) \
      "\n" \
      "\nRecognized formats for TIME:" \
      "\n       hh:mm[:ss]" \
      "\n       [YYYY.]MM.DD-hh:mm[:ss]" \
      "\n       YYYY-MM-DD hh:mm[:ss]" \
-     "\n       MMDDhhmm[[YY]YY][.ss]" \
+     "\n       [[[[[YY]YY]MM]DD]hh]mm[.ss]" \
 
 #define date_example_usage \
        "$ date\n" \
 #define ifplugd_trivial_usage \
        "[OPTIONS]"
 #define ifplugd_full_usage "\n\n" \
-       "Network interface plug detection daemon.\n\n" \
-       "Options:\n" \
+       "Network interface plug detection daemon\n" \
+     "\nOptions:" \
      "\n       -n              Do not daemonize" \
      "\n       -s              Do not log to syslog" \
      "\n       -i IFACE        Interface" \
 #define makemime_trivial_usage \
        "[OPTIONS] [FILE]..."
 #define makemime_full_usage "\n\n" \
-       "Create MIME-encoded message\n" \
-     "\nOptions:" \
-     "\n       -C      Charset" \
-     "\n       -e      Transfer encoding. Ignored. base64 is assumed" \
+       "Create multipart MIME-encoded message from FILEs.\n" \
+/*     "Transfer encoding is base64, disposition is inline (not attachment)\n" */ \
+     "\nOptions:" \
+     "\n       -o FILE Output. Default: stdout" \
+     "\n       -a HDR  Add header. Examples:" \
+     "\n               \"From: user@host.org\", \"Date: `date -R`\"" \
+     "\n       -c CT   Content type. Default: text/plain" \
+     "\n       -C CS   Charset. Default: " CONFIG_FEATURE_MIME_CHARSET \
+/*   "\n       -e ENC  Transfer encoding. Ignored. base64 is assumed" */ \
      "\n" \
-     "\nOther options are silently ignored." \
+     "\nOther options are silently ignored" \
 
 #define man_trivial_usage \
        "[OPTIONS] [MANPAGE]..."
        )
 
 #define patch_trivial_usage \
-       "[-p NUM] [-i DIFF] [-R]"
+       "[-p NUM] [-i DIFF] [-R] [-N]"
 #define patch_full_usage "\n\n" \
        "       -p NUM  Strip NUM leading components from file names" \
      "\n       -i DIFF Read DIFF instead of stdin" \
      "\n       -R      Reverse patch" \
+     "\n       -N      Ignore already applied patches" \
 
 #define patch_example_usage \
        "$ patch -p1 < example.diff\n" \
        "$ patch -p0 -i example.diff"
 
 #define pgrep_trivial_usage \
-       "[-flnovx] PATTERN"
+       "[-flnovx] [-s SID|-P PPID|PATTERN]"
 #define pgrep_full_usage "\n\n" \
        "Display process(es) selected by regex PATTERN\n" \
      "\nOptions:" \
      "\n       -f      Match against entire command line" \
      "\n       -n      Show the newest process only" \
      "\n       -o      Show the oldest process only" \
-     "\n       -v      Negate the matching" \
+     "\n       -v      Negate the match" \
      "\n       -x      Match whole name (not substring)" \
+     "\n       -s      Match session ID (0 for current)" \
+     "\n       -P      Match parent process ID" \
 
 #if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
 #define pidof_trivial_usage \
        "the new root file system"
 
 #define pkill_trivial_usage \
-       "[-l] | [-fnovx] [-signal] PATTERN"
+       "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
 #define pkill_full_usage "\n\n" \
        "Send a signal to process(es) selected by regex PATTERN\n" \
      "\nOptions:" \
      "\n       -f      Match against entire command line" \
      "\n       -n      Signal the newest process only" \
      "\n       -o      Signal the oldest process only" \
-     "\n       -v      Negate the matching" \
+     "\n       -v      Negate the match" \
      "\n       -x      Match whole name (not substring)" \
+     "\n       -s      Match session ID (0 for current)" \
+     "\n       -P      Match parent process ID" \
 
 #define popmaildir_trivial_usage \
        "[OPTIONS] Maildir [connection-helper ...]"
 #define selinuxenabled_full_usage ""
 
 #define sendmail_trivial_usage \
-       "[OPTIONS] [rcpt]..."
+       "[OPTIONS] [RECIPIENT_EMAIL]..."
 #define sendmail_full_usage "\n\n" \
-       "Send an email\n" \
+       "Read email from stdin and send it\n" \
      "\nStandard options:" \
-     "\n       -t              Read recipients from message body, add them to those on cmdline" \
-     "\n       -f sender       Sender. REQUIRED!" \
-     "\n       -o options      various options. -oi IMPLIED! others are IGNORED!" \
+     "\n       -t              Read additional recipients from message body" \
+     "\n       -f sender       Sender (required)" \
+     "\n       -o options      Various options. -oi implied, others are ignored" \
      "\n" \
      "\nBusybox specific options:" \
      "\n       -w seconds      Network timeout" \
-     "\n       -H 'prog args'  Run connection helper" \
+     "\n       -H 'PROG ARGS'  Run connection helper" \
      "\n                       Examples:" \
      "\n                       -H 'exec openssl s_client -quiet -tls1 -starttls smtp" \
      "\n                               -connect smtp.gmail.com:25' <email.txt" \
      "\n       -S server[:port] Server" \
      "\n       -au<username>   Username for AUTH LOGIN" \
      "\n       -ap<password>   Password for AUTH LOGIN" \
-     "\n       -am<method>     Authentication method. Ignored. login is implied." \
+     "\n       -am<method>     Authentication method. Ignored. LOGIN is implied" \
      "\n" \
      "\nOther options are silently ignored; -oi -t is implied" \
+       IF_MAKEMIME( \
+     "\nUse makemime applet to create message with attachments" \
+       )
 
 #define seq_trivial_usage \
        "[-w] [-s SEP] [FIRST [INC]] LAST"
        "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
        "See setsid(2) for details." \
 
-#define lash_trivial_usage \
-       "[FILE]...\n" \
-       "or: sh -c command [args]..."
-#define lash_full_usage "\n\n" \
-       "lash is deprecated, please use hush"
-
 #define last_trivial_usage \
        ""IF_FEATURE_LAST_FANCY("[-HW] [-f file]")
 #define last_full_usage "\n\n" \
        "and show the status for however many processes will fit on the screen." \
 
 #define touch_trivial_usage \
-       "[-c] FILE [FILE]..."
+       "[-c] [-d DATE] FILE [FILE]..."
 #define touch_full_usage "\n\n" \
        "Update the last-modified date on the given FILE[s]\n" \
      "\nOptions:" \
-     "\n       -c      Do not create any files" \
+     "\n       -c      Do not create files" \
+     "\n       -d DT   Date/time to use" \
 
 #define touch_example_usage \
        "$ ls -l /tmp/foo\n" \
@@ -4888,6 +4903,11 @@ IF_FEATURE_TUNCTL_UG( \
      "\nOptions:" \
      "\n       -a      Lock all VTs" \
 
+#define volname_trivial_usage \
+       "[DEVICE]"
+#define volname_full_usage "\n\n" \
+       "Show CD volume name of the DEVICE (default /dev/cdrom)"
+
 #define watch_trivial_usage \
        "[-n seconds] [-t] PROG [ARGS]"
 #define watch_full_usage "\n\n" \