"I'll think about it" != "apply it now". It means I need to think about it.
[oweals/busybox.git] / include / usage.h
index 622c9c4d74a8dee994229a8a813ae7de16b15779..6ef7f1ecfbba9060a775d5e2151d18b220a1aa1a 100644 (file)
 #define bbconfig_full_usage \
        "Print the config file which built busybox"
 
+#define bbsh_trivial_usage \
+       "[FILE]...\n" \
+       "or: bbsh -c command [args]..."
+#define bbsh_full_usage \
+       "The bbsh shell (command interpreter)"
+
 #define cp_trivial_usage \
        "[OPTION]... SOURCE DEST"
 #define cp_full_usage \
@@ -493,9 +499,9 @@ USE_FEATURE_DATE_ISOFMT( \
        "\t-s SIZE\t\tUse a buffer of size SIZE"
 
 #define dnsd_trivial_usage \
-        "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
+       "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
 #define dnsd_full_usage \
-        "Small and static DNS server daemon\n\n" \
+       "Small and static DNS server daemon\n\n" \
        "Options:\n" \
        "\t-c\t\tconfig filename\n" \
        "\t-t\t\tTTL in seconds\n" \
@@ -1426,15 +1432,15 @@ USE_FEATURE_DATE_ISOFMT( \
 #define ipcrm_trivial_usage \
        "[-[MQS] key] [-[mqs] id]"
 #define ipcrm_full_usage \
-       "The upper-case options MQS are used to remove a shared memory\n" \
-       "segment by an shmkey value. The lower-case options mqs are used\n" \
+       "The upper-case options MQS are used to remove a shared memory segment by a\n" \
+       "segment by a shmkey value. The lower-case options mqs are used\n" \
        "to remove a segment by shmid value.\n" \
-       "\t-m | -M\tRemove the memory segment after the last detach\n" \
-       "\t-q | -Q\tRemove the message queue\n" \
-       "\t-s | -S\tRemove the semaphore"
+       "\t-[mM]\tRemove the memory segment after the last detach\n" \
+       "\t-[qQ]\tRemove the message queue\n" \
+       "\t-[sS]\tRemove the semaphore"
 
 #define ipcs_trivial_usage \
-       "[[-smq] -i shmid] | [[-asmq] [-tclup]]"
+       "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
 #define ipcs_full_usage \
        "\t-i\tspecify a specific resource id\n" \
        "Resource specification:\n" \
@@ -1444,10 +1450,10 @@ USE_FEATURE_DATE_ISOFMT( \
        "\t-a\tall (default)\n" \
        "Output format:\n" \
        "\t-t\ttime\n" \
+       "\t-c\tcreator\n" \
        "\t-p\tpid\n" \
-       "\t-s\tcreator\n" \
-       "\t-a\tlimits\n" \
-       "\t-i\tsummary"
+       "\t-l\tlimits\n" \
+       "\t-u\tsummary"
 
 #define iplink_trivial_usage \
        "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }"
@@ -2006,25 +2012,15 @@ USE_FEATURE_MDEV_CONFIG( \
 #define more_example_usage \
        "$ dmesg | more\n"
 
-#ifdef CONFIG_FEATURE_MOUNT_LOOP
-#  define USAGE_MOUNT_LOOP(a) a
-#else
-#  define USAGE_MOUNT_LOOP(a)
-#endif
-#ifdef CONFIG_FEATURE_MTAB_SUPPORT
-#  define USAGE_MTAB(a) a
-#else
-#  define USAGE_MTAB(a)
-#endif
 #define mount_trivial_usage \
        "[flags] DEVICE NODE [-o options,more-options]"
 #define mount_full_usage \
        "Mount a filesystem.  Filesystem autodetection requires /proc be mounted.\n\n" \
        "Flags:\n"  \
        "\t-a:\t\tMount all filesystems in fstab\n" \
-       USAGE_MTAB( \
-       "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it\n" \
-       "\t-n:\t\tDon't write a mount table entry\n" \
+       USE_FEATURE_MTAB_SUPPORT( \
+               "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it\n" \
+               "\t-n:\t\tDon't write a mount table entry\n" \
        ) \
        "\t-o option:\tOne of many filesystem options, listed below\n" \
        "\t-r:\t\tMount the filesystem read-only\n" \
@@ -2032,18 +2028,25 @@ USE_FEATURE_MDEV_CONFIG( \
        "\t-w:\t\tMount for reading and writing (default)\n" \
        "\n" \
        "Options for use with the \"-o\" flag:\n" \
-       "\tasync/sync:\tWrites are asynchronous / synchronous\n" \
-       "\tatime/noatime:\tEnable / disable updates to inode access times\n" \
-       "\tdev/nodev:\tAllow use of special device files / disallow them\n" \
-       "\texec/noexec:\tAllow use of executable files / disallow them\n" \
-       USAGE_MOUNT_LOOP( \
-       "\tloop:\t\t Ignored (loop devices are autodetected)\n" \
+       USE_FEATURE_MOUNT_LOOP( \
+               "\tloop:\t\tIgnored (loop devices are autodetected)\n" \
+       ) \
+       USE_FEATURE_MOUNT_FLAGS( \
+               "\t[a]sync:\tWrites are asynchronous / synchronous\n" \
+               "\t[no]atime:\tDisable / enable updates to inode access times\n" \
+               "\t[no]diratime:\tDisable / enable atime updates to directories\n" \
+               "\t[no]dev:\tAllow use of special device files / disallow them\n" \
+               "\t[no]exec:\tAllow use of executable files / disallow them\n" \
+               "\t[no]suid:\tAllow set-user-id-root programs / disallow them\n" \
+               "\t[r]shared:\tConvert [recursively] to a shared subtree.\n" \
+               "\t[r]slave:\tConvert [recursively] to a slave subtree.\n" \
+               "\t[r]private:\tConvert [recursively] to a private subtree\n" \
+               "\t[un]bindable:\tMake mount point [un]able to be bind mounted.\n" \
+               "\tbind:\t\tBind a directory to an additional location\n" \
+               "\tmove:\t\tRelocate an existing mount point.\n" \
        ) \
-       "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them\n" \
        "\tremount:\tRe-mount a mounted filesystem, changing its flags\n" \
        "\tro/rw:\t\tMount for read-only / read-write\n" \
-       "\tbind:\t\tBind a directory to an additional location\n" \
-       "\tmove:\t\tRelocate an existing mount point.\n" \
        "\nThere are EVEN MORE flags that are specific to each filesystem\n" \
        "You'll have to see the written documentation for those filesystems"
 #define mount_example_usage \
@@ -2055,7 +2058,7 @@ USE_FEATURE_MDEV_CONFIG( \
        "$ 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." 
+       "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
 
 #define mountpoint_trivial_usage \
        "[-q] <[-d] DIR | -x DEVICE>"
@@ -2095,7 +2098,7 @@ USE_FEATURE_MDEV_CONFIG( \
 #define nameif_trivial_usage \
        "[-s] [-c FILE] [{IFNAME MACADDR}]"
 #define nameif_full_usage \
-       "Nameif renaming network interface while it in the down state.\n\n" \
+       "Nameif renames network interface while it in the down state.\n\n" \
        "Options:\n" \
        "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \
        "\t-s\t\tUse syslog (LOCAL0 facility)\n" \
@@ -2275,6 +2278,7 @@ USE_FEATURE_MDEV_CONFIG( \
        "Options:\n" \
        "\t-c COUNT\tSend only COUNT pings\n" \
        "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \
+       "\t-I IPADDR\tUse IPADDR as source address\n" \
        "\t-q\t\tQuiet mode, only displays output at start\n" \
        "\t\t\tand when finished"
 #endif
@@ -2388,6 +2392,12 @@ USE_FEATURE_MDEV_CONFIG( \
        "\t-s\tSet the system date and time (default)\n" \
        "\t-p\tPrint the date and time"
 
+#define readahead_trivial_usage \
+       "[FILE]..."
+#define readahead_full_usage \
+       "Preloads FILE(s) in RAM cache so that subsequent reads for those" \
+       "files do not block on disk I/O."
+
 #ifdef CONFIG_FEATURE_READLINK_FOLLOW
 #define USAGE_READLINK_FOLLOW(a) a
 #else
@@ -2704,7 +2714,7 @@ USE_FEATURE_MDEV_CONFIG( \
        "\n\t-b|--background\t\t\tforce process into background" \
        "\n\t-u|--user <username>|<uid>\tstop this user's processes" \
        "\n\t-x|--exec <executable>\t\tprogram to either start or check" \
-       "\n\t-m|--make-pidfile <filename>\tcreate the -p file and enter pid in it" \
+       "\n\t-m|--make-pidfile\tcreate the -p file and enter pid in it" \
        "\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" \
@@ -2807,9 +2817,7 @@ USE_FEATURE_START_STOP_DAEMON_FANCY( \
 #define sulogin_full_usage \
        "Single user login\n" \
        "Options:\n" \
-       "\t-f\tDo not authenticate (user already authenticated)\n" \
-       "\t-h\tName of the remote host for this login\n" \
-       "\t-p\tPreserve environment"
+       "\t-t\tTimeout"
 
 #define sum_trivial_usage \
        "[rs] [files...]"
@@ -3214,21 +3222,16 @@ USE_FEATURE_START_STOP_DAEMON_FANCY( \
 #define udhcpd_full_usage \
        ""
 
-#ifdef CONFIG_FEATURE_MOUNT_FORCE
-#  define USAGE_MOUNT_FORCE(a) a
-#else
-#  define USAGE_MOUNT_FORCE(a)
-#endif
 #define umount_trivial_usage \
        "[flags] FILESYSTEM|DIRECTORY"
 #define umount_full_usage \
        "Unmount file systems\n" \
        "\nFlags:\n" "\t-a\tUnmount all file systems" \
-       USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
+       USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
        "\n\t-r\tTry to remount devices as read-only if mount is busy" \
        "\n\t-l\tLazy umount (detach filesystem)" \
        "\n\t-f\tForce umount (i.e., unreachable NFS server)" \
-       USAGE_MOUNT_LOOP("\n\t-D\tDo not free loop device (if a loop device has been used)")
+       USE_FEATURE_MOUNT_LOOP("\n\t-D\tDo not free loop device (if a loop device has been used)")
 #define umount_example_usage \
        "$ umount /dev/hdc1 \n"
 
@@ -3398,7 +3401,8 @@ USE_FEATURE_START_STOP_DAEMON_FANCY( \
 
 #define wget_trivial_usage \
        "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \
-       "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url"
+       "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
+       "\t\t[-U|--user-agent agent] url"
 #define wget_full_usage \
        "wget retrieves files via HTTP or FTP\n\n" \
        "Options:\n" \
@@ -3406,6 +3410,7 @@ USE_FEATURE_START_STOP_DAEMON_FANCY( \
        "\t-q\tquiet mode - do not print\n" \
        "\t-P\tSet directory prefix to DIR\n" \
        "\t-O\tsave to filename ('-' for stdout)\n" \
+       "\t-U\tadjust 'User-Agent' field\n" \
        "\t-Y\tuse proxy ('on' or 'off')"
 
 #define which_trivial_usage \