Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 1 | #ifndef __BB_USAGE_H__ |
| 2 | #define __BB_USAGE_H__ |
| 3 | |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 4 | #define addgroup_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 5 | "[-g GID] group_name [user_name]" |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 6 | #define addgroup_full_usage \ |
Eric Andersen | 192c35f | 2004-09-02 22:22:17 +0000 | [diff] [blame] | 7 | "Adds a group to the system\n\n" \ |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 8 | "Options:\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 9 | "\t-g GID\t\tspecify gid" |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 10 | |
| 11 | #define adduser_trivial_usage \ |
Eric Andersen | e0716ba | 2003-01-14 06:42:56 +0000 | [diff] [blame] | 12 | "[OPTIONS] user_name" |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 13 | #define adduser_full_usage \ |
Eric Andersen | 192c35f | 2004-09-02 22:22:17 +0000 | [diff] [blame] | 14 | "Adds a user to the system\n\n" \ |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 15 | "Options:\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 16 | "\t-h DIR\t\tAssign home directory DIR\n" \ |
| 17 | "\t-g GECOS\tAssign gecos field GECOS\n" \ |
| 18 | "\t-s SHELL\tAssign login shell SHELL\n" \ |
| 19 | "\t-G\t\tAdd the user to existing group GROUP\n" \ |
| 20 | "\t-S\t\tcreate a system user (ignored)\n" \ |
| 21 | "\t-D\t\tDo not assign a password (logins still possible via ssh)\n" \ |
| 22 | "\t-H\t\tDo not create the home directory" |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 23 | |
Mark Whitley | 6f93277 | 2001-03-20 19:18:10 +0000 | [diff] [blame] | 24 | #define adjtimex_trivial_usage \ |
| 25 | "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]" |
| 26 | #define adjtimex_full_usage \ |
| 27 | "Reads and optionally sets system timebase parameters.\n" \ |
| 28 | "See adjtimex(2).\n\n" \ |
| 29 | "Options:\n" \ |
| 30 | "\t-q\t\tquiet mode - do not print\n" \ |
| 31 | "\t-o offset\ttime offset, microseconds\n" \ |
| 32 | "\t-f frequency\tfrequency adjust, integer kernel units (65536 is 1ppm)\n" \ |
| 33 | "\t\t\t(positive values make the system clock run fast)\n" \ |
| 34 | "\t-t tick\t\tmicroseconds per tick, usually 10000\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 35 | "\t-p timeconstant" |
Mark Whitley | 6f93277 | 2001-03-20 19:18:10 +0000 | [diff] [blame] | 36 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 37 | #define ar_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 38 | "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 39 | #define ar_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 40 | "Extract or list FILES from an ar archive.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 41 | "Options:\n" \ |
| 42 | "\t-o\t\tpreserve original dates\n" \ |
| 43 | "\t-p\t\textract to stdout\n" \ |
| 44 | "\t-t\t\tlist\n" \ |
| 45 | "\t-x\t\textract\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 46 | "\t-v\t\tverbosely list files processed" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 47 | |
Glenn L McGrath | 9e59841 | 2003-01-09 10:06:01 +0000 | [diff] [blame] | 48 | #define arping_trivial_usage \ |
Bernhard Reutner-Fischer | e47c4cb | 2006-03-31 18:10:31 +0000 | [diff] [blame] | 49 | "[-fqbDUA] [-c count] [-w timeout] [-i device] [-s sender] target" |
Glenn L McGrath | 9e59841 | 2003-01-09 10:06:01 +0000 | [diff] [blame] | 50 | #define arping_full_usage \ |
| 51 | "Ping hosts by ARP requests/replies.\n\n" \ |
| 52 | "Options:\n" \ |
| 53 | "\t-f\t\tQuit on first ARP reply\n" \ |
| 54 | "\t-q\t\tBe quiet\n" \ |
| 55 | "\t-b\t\tKeep broadcasting, don't go unicast\n" \ |
| 56 | "\t-D\t\tDuplicated address detection mode\n" \ |
| 57 | "\t-U\t\tUnsolicited ARP mode, update your neighbours\n" \ |
| 58 | "\t-A\t\tARP answer mode, update your neighbours\n" \ |
| 59 | "\t-c count\tStop after sending count ARP request packets\n" \ |
| 60 | "\t-w timeout\tTime to wait for ARP reply, in seconds\n" \ |
Bernhard Reutner-Fischer | e47c4cb | 2006-03-31 18:10:31 +0000 | [diff] [blame] | 61 | "\t-i device\tOutgoing interface name, default is eth0\n" \ |
Glenn L McGrath | 9e59841 | 2003-01-09 10:06:01 +0000 | [diff] [blame] | 62 | "\t-s sender\tSet specific sender IP address\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 63 | "\ttarget\t\tTarget IP address of ARP request" |
Glenn L McGrath | 9e59841 | 2003-01-09 10:06:01 +0000 | [diff] [blame] | 64 | |
Eric Andersen | 08f59e3 | 2004-03-12 22:07:10 +0000 | [diff] [blame] | 65 | #define ash_trivial_usage \ |
| 66 | "[FILE]...\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 67 | "or: ash -c command [args]..." |
Eric Andersen | 08f59e3 | 2004-03-12 22:07:10 +0000 | [diff] [blame] | 68 | #define ash_full_usage \ |
| 69 | "The ash shell (command interpreter)" |
| 70 | |
| 71 | #define awk_trivial_usage \ |
| 72 | "[OPTION]... [program-text] [FILE ...]" |
| 73 | #define awk_full_usage \ |
Glenn L McGrath | 7a32aaa | 2002-09-15 17:03:48 +0000 | [diff] [blame] | 74 | "Options:\n" \ |
Mike Frysinger | 4fcefb9 | 2006-02-06 23:38:59 +0000 | [diff] [blame] | 75 | "\t-v var=val\tassign value 'val' to variable 'var'\n" \ |
Glenn L McGrath | 7a32aaa | 2002-09-15 17:03:48 +0000 | [diff] [blame] | 76 | "\t-F sep\t\tuse 'sep' as field separator\n" \ |
Mike Frysinger | 4fcefb9 | 2006-02-06 23:38:59 +0000 | [diff] [blame] | 77 | "\t-f progname\tread program source from file 'progname'" |
Glenn L McGrath | 7a32aaa | 2002-09-15 17:03:48 +0000 | [diff] [blame] | 78 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 79 | #define basename_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 80 | "FILE [SUFFIX]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 81 | #define basename_full_usage \ |
| 82 | "Strips directory path and suffixes from FILE.\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 83 | "If specified, also removes any trailing SUFFIX." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 84 | #define basename_example_usage \ |
| 85 | "$ basename /usr/local/bin/foo\n" \ |
| 86 | "foo\n" \ |
| 87 | "$ basename /usr/local/bin/\n" \ |
| 88 | "bin\n" \ |
| 89 | "$ basename /foo/bar.txt .txt\n" \ |
| 90 | "bar" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 91 | |
Glenn L McGrath | 24e2833 | 2001-10-05 03:48:57 +0000 | [diff] [blame] | 92 | #define bunzip2_trivial_usage \ |
Matt Kraai | 9cdb060 | 2002-03-27 17:31:01 +0000 | [diff] [blame] | 93 | "[OPTION]... [FILE]" |
Glenn L McGrath | 24e2833 | 2001-10-05 03:48:57 +0000 | [diff] [blame] | 94 | #define bunzip2_full_usage \ |
Matt Kraai | 9cdb060 | 2002-03-27 17:31:01 +0000 | [diff] [blame] | 95 | "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \ |
| 96 | "Options:\n" \ |
| 97 | "\t-c\tWrite output to standard output\n" \ |
| 98 | "\t-f\tForce" |
Glenn L McGrath | 24e2833 | 2001-10-05 03:48:57 +0000 | [diff] [blame] | 99 | |
Rob Landley | 6130b9b | 2006-01-23 21:10:38 +0000 | [diff] [blame] | 100 | #define busybox_notes_usage \ |
| 101 | "Hello world!\n" |
| 102 | |
Glenn L McGrath | fff11f1 | 2001-11-18 14:20:25 +0000 | [diff] [blame] | 103 | #define bzcat_trivial_usage \ |
| 104 | "FILE" |
| 105 | #define bzcat_full_usage \ |
| 106 | "Uncompress to stdout." |
| 107 | |
Rob Landley | c1d6990 | 2006-01-20 18:28:50 +0000 | [diff] [blame] | 108 | #define unlzma_trivial_usage \ |
| 109 | "[OPTION]... [FILE]" |
| 110 | #define unlzma_full_usage \ |
| 111 | "Uncompress FILE (or standard input if FILE is '-' or omitted).\n\n" \ |
| 112 | "Options:\n" \ |
| 113 | "\t-c\tWrite output to standard output\n" \ |
| 114 | "\t-f\tForce" |
| 115 | |
| 116 | #define lzmacat_trivial_usage \ |
| 117 | "FILE" |
| 118 | #define lzmacat_full_usage \ |
| 119 | "Uncompress to stdout." |
| 120 | |
Eric Andersen | c98c062 | 2001-12-06 15:16:43 +0000 | [diff] [blame] | 121 | #define cal_trivial_usage \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 122 | "[-jy] [[month] year]" |
Eric Andersen | c98c062 | 2001-12-06 15:16:43 +0000 | [diff] [blame] | 123 | #define cal_full_usage \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 124 | "Display a calendar.\n" \ |
| 125 | "\nOptions:\n" \ |
| 126 | "\t-j\tUse julian dates\n" \ |
| 127 | "\t-y\tDisplay the entire year" |
Eric Andersen | c98c062 | 2001-12-06 15:16:43 +0000 | [diff] [blame] | 128 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 129 | #define cat_trivial_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 130 | "[-u] [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 131 | #define cat_full_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 132 | "Concatenates FILE(s) and prints them to stdout.\n\n" \ |
| 133 | "Options:\n" \ |
| 134 | "\t-u\tignored since unbuffered i/o is always used" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 135 | #define cat_example_usage \ |
| 136 | "$ cat /proc/uptime\n" \ |
| 137 | "110716.72 17.67" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 138 | |
Mike Frysinger | de9f1f7 | 2005-04-22 02:33:37 +0000 | [diff] [blame] | 139 | #define chattr_trivial_usage \ |
| 140 | "[-R] [-+=AacDdijsStTu] [-v version] files..." |
| 141 | #define chattr_full_usage \ |
| 142 | "change file attributes on an ext2 fs\n\n" \ |
| 143 | "Modifiers:\n" \ |
| 144 | "\t-\tremove attributes\n" \ |
| 145 | "\t+\tadd attributes\n" \ |
| 146 | "\t=\tset attributes\n" \ |
| 147 | "Attributes:\n" \ |
| 148 | "\tA\tdon't track atime\n" \ |
| 149 | "\ta\tappend mode only\n" \ |
| 150 | "\tc\tenable compress\n" \ |
| 151 | "\tD\twrite dir contents synchronously\n" \ |
| 152 | "\td\tdo not backup with dump\n" \ |
| 153 | "\ti\tcannot be modified (immutable)\n" \ |
| 154 | "\tj\twrite all data to journal first\n" \ |
| 155 | "\ts\tzero disk storage when deleted\n" \ |
| 156 | "\tS\twrite file contents synchronously\n" \ |
| 157 | "\tt\tdisable tail-merging of partial blocks with other files\n" \ |
| 158 | "\tu\tallow file to be undeleted\n" \ |
| 159 | "Options:\n" \ |
| 160 | "\t-R\trecursively list subdirectories\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 161 | "\t-v\tset the file's version/generation number" |
Mike Frysinger | de9f1f7 | 2005-04-22 02:33:37 +0000 | [diff] [blame] | 162 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 163 | #define chgrp_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 164 | "[OPTION]... GROUP FILE..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 165 | #define chgrp_full_usage \ |
| 166 | "Change the group membership of each FILE to GROUP.\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 167 | "\nOptions:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 168 | "\t-R\tChanges files and directories recursively" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 169 | #define chgrp_example_usage \ |
| 170 | "$ ls -l /tmp/foo\n" \ |
| 171 | "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ |
| 172 | "$ chgrp root /tmp/foo\n" \ |
| 173 | "$ ls -l /tmp/foo\n" \ |
| 174 | "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 175 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 176 | #define chmod_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 177 | "[-R] MODE[,MODE]... FILE..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 178 | #define chmod_full_usage \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 179 | "Each MODE is one or more of the letters ugoa, one of the\n" \ |
| 180 | "symbols +-= and one or more of the letters rwxst.\n\n" \ |
| 181 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 182 | "\t-R\tChanges files and directories recursively" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 183 | #define chmod_example_usage \ |
| 184 | "$ ls -l /tmp/foo\n" \ |
| 185 | "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \ |
| 186 | "$ chmod u+x /tmp/foo\n" \ |
| 187 | "$ ls -l /tmp/foo\n" \ |
| 188 | "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \ |
| 189 | "$ chmod 444 /tmp/foo\n" \ |
| 190 | "$ ls -l /tmp/foo\n" \ |
| 191 | "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 192 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 193 | #define chown_trivial_usage \ |
Eric Andersen | 238da24 | 2001-05-11 16:31:46 +0000 | [diff] [blame] | 194 | "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 195 | #define chown_full_usage \ |
| 196 | "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 197 | "\nOptions:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 198 | "\t-R\tChanges files and directories recursively\n" \ |
| 199 | "\t-h\tDo not dereference symbolic links" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 200 | #define chown_example_usage \ |
| 201 | "$ ls -l /tmp/foo\n" \ |
| 202 | "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ |
| 203 | "$ chown root /tmp/foo\n" \ |
| 204 | "$ ls -l /tmp/foo\n" \ |
| 205 | "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ |
| 206 | "$ chown root.root /tmp/foo\n" \ |
| 207 | "ls -l /tmp/foo\n" \ |
| 208 | "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 209 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 210 | #define chroot_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 211 | "NEWROOT [COMMAND...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 212 | #define chroot_full_usage \ |
| 213 | "Run COMMAND with root directory set to NEWROOT." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 214 | #define chroot_example_usage \ |
| 215 | "$ ls -l /bin/ls\n" \ |
| 216 | "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 217 | "# mount /dev/hdc1 /mnt -t minix\n" \ |
| 218 | "# chroot /mnt\n" \ |
| 219 | "# ls -l /bin/ls\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 220 | "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 221 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 222 | #define chvt_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 223 | "N" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 224 | #define chvt_full_usage \ |
| 225 | "Changes the foreground virtual terminal to /dev/ttyN" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 226 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 227 | #define clear_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 228 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 229 | #define clear_full_usage \ |
| 230 | "Clear screen." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 231 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 232 | #define cmp_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 233 | "[-l] [-s] FILE1 [FILE2]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 234 | #define cmp_full_usage \ |
Mike Frysinger | 4d14920 | 2005-05-12 22:36:07 +0000 | [diff] [blame] | 235 | "Compares FILE1 vs stdin if FILE2 is not specified.\n\n" \ |
Manuel Novoa III | 4baef0c | 2003-03-19 18:40:42 +0000 | [diff] [blame] | 236 | "Options:\n" \ |
| 237 | "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 238 | "\t\t for all differing bytes\n" \ |
Manuel Novoa III | 4baef0c | 2003-03-19 18:40:42 +0000 | [diff] [blame] | 239 | "\t-s\tquiet mode - do not print" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 240 | |
Rob Landley | 2acfd7b | 2005-05-11 23:12:49 +0000 | [diff] [blame] | 241 | #define comm_trivial_usage \ |
| 242 | "[-123] FILE1 FILE2" |
| 243 | #define comm_full_usage \ |
Mike Frysinger | 4d14920 | 2005-05-12 22:36:07 +0000 | [diff] [blame] | 244 | "Compares FILE1 to FILE2, or to stdin if = is specified.\n\n" \ |
Rob Landley | 2acfd7b | 2005-05-11 23:12:49 +0000 | [diff] [blame] | 245 | "Options:\n" \ |
| 246 | "\t-1\tSuppress lines unique to FILE1\n" \ |
| 247 | "\t-2\tSuppress lines unique to FILE2\n" \ |
| 248 | "\t-3\tSuppress lines common to both files" |
| 249 | |
Paul Fox | 79c142d | 2005-08-01 16:04:40 +0000 | [diff] [blame] | 250 | #define bbconfig_trivial_usage \ |
| 251 | "" |
| 252 | #define bbconfig_full_usage \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 253 | "Print the config file which built busybox" |
Mike Frysinger | 036f299 | 2005-09-24 23:50:14 +0000 | [diff] [blame] | 254 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 255 | #define cp_trivial_usage \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 256 | "[OPTION]... SOURCE DEST" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 257 | #define cp_full_usage \ |
| 258 | "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \ |
| 259 | "\n" \ |
| 260 | "\t-a\tSame as -dpR\n" \ |
Mike Frysinger | 6077d90 | 2005-01-07 00:56:47 +0000 | [diff] [blame] | 261 | "\t-d,-P\tPreserves links\n" \ |
Mike Frysinger | 2ed05ab | 2005-04-14 02:52:50 +0000 | [diff] [blame] | 262 | "\t-H,-L\tDereference all symlinks (implied by default)\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 263 | "\t-p\tPreserves file attributes if possible\n" \ |
| 264 | "\t-f\tforce (implied; ignored) - always set\n" \ |
Eric Andersen | ced9705 | 2004-02-20 09:55:37 +0000 | [diff] [blame] | 265 | "\t-i\tinteractive, prompt before overwrite\n" \ |
| 266 | "\t-R,-r\tCopies directories recursively" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 267 | |
Glenn L McGrath | 8f5b63e | 2001-06-22 09:22:06 +0000 | [diff] [blame] | 268 | #define cpio_trivial_usage \ |
| 269 | "-[dimtuv][F cpiofile]" |
| 270 | #define cpio_full_usage \ |
| 271 | "Extract or list files from a cpio archive\n" \ |
| 272 | "Main operation mode:\n" \ |
Glenn L McGrath | 2e6d3cf | 2001-06-24 12:36:54 +0000 | [diff] [blame] | 273 | "\td\t\tmake leading directories\n" \ |
Glenn L McGrath | 8f5b63e | 2001-06-22 09:22:06 +0000 | [diff] [blame] | 274 | "\ti\t\textract\n" \ |
Glenn L McGrath | 2e6d3cf | 2001-06-24 12:36:54 +0000 | [diff] [blame] | 275 | "\tm\t\tpreserve mtime\n" \ |
Glenn L McGrath | 8f5b63e | 2001-06-22 09:22:06 +0000 | [diff] [blame] | 276 | "\tt\t\tlist\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 277 | "\tv\t\tverbose\n" \ |
Eric Andersen | 6925d50 | 2001-12-16 09:23:09 +0000 | [diff] [blame] | 278 | "\tu\t\tunconditional overwrite\n" \ |
| 279 | "\tF\t\tinput from file" |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 280 | |
Eric Andersen | f6f7bfb | 2002-10-22 12:24:59 +0000 | [diff] [blame] | 281 | #define crond_trivial_usage \ |
| 282 | "-d[#] -c <crondir> -f -b" |
| 283 | #define crond_full_usage \ |
| 284 | "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \ |
| 285 | "\t-d num\tdebug level\n" \ |
| 286 | "\t-l num\tlog level (8 - default)\n" \ |
Glenn L McGrath | 4359623 | 2004-07-23 01:27:56 +0000 | [diff] [blame] | 287 | "\t-S\tlog to syslogd (default)\n" \ |
Eric Andersen | f6f7bfb | 2002-10-22 12:24:59 +0000 | [diff] [blame] | 288 | "\t-L file\tlog to file\n" \ |
| 289 | "\t-f\trun in fordeground\n" \ |
| 290 | "\t-b\trun in background (default)\n" \ |
| 291 | "\t-c dir\tworking dir" |
| 292 | |
| 293 | #define crontab_trivial_usage \ |
Glenn L McGrath | d1daf8b | 2004-02-25 10:35:55 +0000 | [diff] [blame] | 294 | "[-c dir] {file|-}|[-u|-l|-e|-d user]" |
Eric Andersen | f6f7bfb | 2002-10-22 12:24:59 +0000 | [diff] [blame] | 295 | #define crontab_full_usage \ |
| 296 | "\tfile <opts> replace crontab from file\n" \ |
| 297 | "\t- <opts> replace crontab from stdin\n" \ |
| 298 | "\t-u user specify user\n" \ |
| 299 | "\t-l [user] list crontab for user\n" \ |
| 300 | "\t-e [user] edit crontab for user\n" \ |
| 301 | "\t-d [user] delete crontab for user\n" \ |
| 302 | "\t-c dir specify crontab directory" |
| 303 | |
| 304 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 305 | #define cut_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 306 | "[OPTION]... [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 307 | #define cut_full_usage \ |
| 308 | "Prints selected fields from each input FILE to standard output.\n\n" \ |
| 309 | "Options:\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 310 | "\t-b LIST\t\tOutput only bytes from LIST\n" \ |
| 311 | "\t-c LIST\t\tOutput only characters from LIST\n" \ |
| 312 | "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \ |
| 313 | "\t-s\t\tOutput only the lines containing delimiter\n" \ |
| 314 | "\t-f N\t\tPrint only these fields\n" \ |
| 315 | "\t-n\t\tIgnored" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 316 | #define cut_example_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 317 | "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 318 | "Hello\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 319 | "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 320 | "world\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 321 | |
Glenn L McGrath | 2ce002a | 2003-08-29 14:18:26 +0000 | [diff] [blame] | 322 | #ifdef CONFIG_FEATURE_DATE_ISOFMT |
| 323 | #define USAGE_DATE_ISOFMT(a) a |
| 324 | #else |
| 325 | #define USAGE_DATE_ISOFMT(a) |
| 326 | #endif |
| 327 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 328 | #define date_trivial_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 329 | "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 330 | #define date_full_usage \ |
| 331 | "Displays the current time in the given FORMAT, or sets the system date.\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 332 | "\nOptions:\n" \ |
Eric Andersen | 41492d6 | 2001-02-23 00:05:56 +0000 | [diff] [blame] | 333 | "\t-R\t\tOutputs RFC-822 compliant date string\n" \ |
Glenn L McGrath | 2ce002a | 2003-08-29 14:18:26 +0000 | [diff] [blame] | 334 | "\t-d STRING\tDisplays time described by STRING, not `now'\n" \ |
Rob Landley | c5789a6 | 2006-02-21 05:06:42 +0000 | [diff] [blame] | 335 | USAGE_DATE_ISOFMT( \ |
| 336 | "\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string\n" \ |
| 337 | "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \ |
| 338 | "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \ |
| 339 | "\t\t\ttime to the indicated precision\n" \ |
| 340 | "\t-D hint\t\tUse 'hint' as date format, via strptime()\n" \ |
| 341 | ) \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 342 | "\t-s\t\tSets time described by STRING\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 343 | "\t-r FILE\t\tDisplays the last modification time of FILE\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 344 | "\t-u\t\tPrints or sets Coordinated Universal Time" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 345 | #define date_example_usage \ |
| 346 | "$ date\n" \ |
| 347 | "Wed Apr 12 18:52:41 MDT 2000\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 348 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 349 | #define dc_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 350 | "expression ..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 351 | #define dc_full_usage \ |
| 352 | "This is a Tiny RPN calculator that understands the\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 353 | "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \ |
Eric Andersen | a928774 | 2003-10-22 11:24:39 +0000 | [diff] [blame] | 354 | "**, exp, and, or, not, eor.\n" \ |
| 355 | "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \ |
| 356 | "\nOptions:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 357 | "p - Prints the value on the top of the stack, without altering the stack\n" \ |
| 358 | "f - Prints the entire contents of the stack without altering anything\n" \ |
| 359 | "o - Pops the value off the top of the stack and uses it to set the output radix\n" \ |
| 360 | " Only 10 and 16 are supported" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 361 | #define dc_example_usage \ |
Eric Andersen | 9ab4657 | 2004-08-18 17:57:16 +0000 | [diff] [blame] | 362 | "$ dc 2 2 + p\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 363 | "4\n" \ |
Eric Andersen | 9ab4657 | 2004-08-18 17:57:16 +0000 | [diff] [blame] | 364 | "$ dc 8 8 \\* 2 2 + / p\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 365 | "16\n" \ |
Eric Andersen | 9ab4657 | 2004-08-18 17:57:16 +0000 | [diff] [blame] | 366 | "$ dc 0 1 and p\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 367 | "0\n" \ |
Eric Andersen | 9ab4657 | 2004-08-18 17:57:16 +0000 | [diff] [blame] | 368 | "$ dc 0 1 or p\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 369 | "1\n" \ |
Eric Andersen | 9ab4657 | 2004-08-18 17:57:16 +0000 | [diff] [blame] | 370 | "$ echo 72 9 div 8 mul p | dc\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 371 | "64\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 372 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 373 | #define dd_trivial_usage \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 374 | "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \ |
Eric Andersen | ef38b39 | 2002-04-27 01:31:43 +0000 | [diff] [blame] | 375 | "\t [seek=N] [conv=notrunc|noerror|sync]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 376 | #define dd_full_usage \ |
| 377 | "Copy a file, converting and formatting according to options\n\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 378 | "\tif=FILE\t\tread from FILE instead of stdin\n" \ |
| 379 | "\tof=FILE\t\twrite to FILE instead of stdout\n" \ |
| 380 | "\tbs=N\t\tread and write N bytes at a time\n" \ |
| 381 | "\tcount=N\t\tcopy only N input blocks\n" \ |
| 382 | "\tskip=N\t\tskip N input blocks\n" \ |
| 383 | "\tseek=N\t\tskip N output blocks\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 384 | "\tconv=notrunc\tdon't truncate output file\n" \ |
Eric Andersen | ef38b39 | 2002-04-27 01:31:43 +0000 | [diff] [blame] | 385 | "\tconv=noerror\tcontinue after read errors\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 386 | "\tconv=sync\tpad blocks with zeros\n" \ |
| 387 | "\n" \ |
| 388 | "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 389 | "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 390 | #define dd_example_usage \ |
| 391 | "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \ |
| 392 | "4+0 records in\n" \ |
| 393 | "4+0 records out\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 394 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 395 | #define deallocvt_trivial_usage \ |
Glenn L McGrath | 17b4a20 | 2004-01-15 11:50:19 +0000 | [diff] [blame] | 396 | "[N]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 397 | #define deallocvt_full_usage \ |
| 398 | "Deallocate unused virtual terminal /dev/ttyN" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 399 | |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 400 | #define delgroup_trivial_usage \ |
| 401 | "GROUP" |
| 402 | #define delgroup_full_usage \ |
| 403 | "Deletes group GROUP from the system" |
| 404 | |
| 405 | #define deluser_trivial_usage \ |
| 406 | "USER" |
| 407 | #define deluser_full_usage \ |
| 408 | "Deletes user USER from the system" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 409 | |
Eric Andersen | f18bd89 | 2003-12-19 11:07:59 +0000 | [diff] [blame] | 410 | #ifdef CONFIG_DEVFSD_FG_NP |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 411 | # define USAGE_DEVFSD_FG_NP(a) a |
Eric Andersen | f18bd89 | 2003-12-19 11:07:59 +0000 | [diff] [blame] | 412 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 413 | # define USAGE_DEVFSD_FG_NP(a) |
Eric Andersen | f18bd89 | 2003-12-19 11:07:59 +0000 | [diff] [blame] | 414 | #endif |
| 415 | |
Glenn L McGrath | 17d21fa | 2003-10-09 11:46:23 +0000 | [diff] [blame] | 416 | #define devfsd_trivial_usage \ |
Mike Frysinger | b8d0046 | 2005-08-17 01:20:10 +0000 | [diff] [blame] | 417 | "mntpnt [-v]" \ |
Eric Andersen | f18bd89 | 2003-12-19 11:07:59 +0000 | [diff] [blame] | 418 | USAGE_DEVFSD_FG_NP("[-fg][-np]" ) |
Glenn L McGrath | 17d21fa | 2003-10-09 11:46:23 +0000 | [diff] [blame] | 419 | #define devfsd_full_usage \ |
Mike Frysinger | b8d0046 | 2005-08-17 01:20:10 +0000 | [diff] [blame] | 420 | "Optional daemon for managing devfs permissions and old device name symlinks.\n" \ |
Glenn L McGrath | 17d21fa | 2003-10-09 11:46:23 +0000 | [diff] [blame] | 421 | "\nOptions:\n" \ |
| 422 | "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \ |
| 423 | "\t-v\tPrint the protocol version numbers for devfsd\n" \ |
Eric Andersen | f18bd89 | 2003-12-19 11:07:59 +0000 | [diff] [blame] | 424 | "\t\tand the kernel-side protocol version and exits." \ |
| 425 | USAGE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \ |
| 426 | "\t-np\tExit after parsing the configuration file\n" \ |
| 427 | "\t\tand processing synthetic REGISTER events.\n" \ |
| 428 | "\t\tDo not poll for events.") |
Glenn L McGrath | 17d21fa | 2003-10-09 11:46:23 +0000 | [diff] [blame] | 429 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 430 | #ifdef CONFIG_FEATURE_HUMAN_READABLE |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 431 | # define USAGE_HUMAN_READABLE(a) a |
| 432 | # define USAGE_NOT_HUMAN_READABLE(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 433 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 434 | # define USAGE_HUMAN_READABLE(a) |
| 435 | # define USAGE_NOT_HUMAN_READABLE(a) a |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 436 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 437 | #define df_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 438 | "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 439 | #define df_full_usage \ |
| 440 | "Print the filesystem space used and space available.\n\n" \ |
| 441 | "Options:\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 442 | USAGE_HUMAN_READABLE( \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 443 | "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \ |
| 444 | "\t-m\tprint sizes in megabytes\n" \ |
Eric Andersen | ed0d958 | 2001-02-23 13:23:03 +0000 | [diff] [blame] | 445 | "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 446 | "\n\t-k\tprint sizes in kilobytes(compatibility)") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 447 | #define df_example_usage \ |
| 448 | "$ df\n" \ |
| 449 | "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ |
| 450 | "/dev/sda3 8690864 8553540 137324 98% /\n" \ |
| 451 | "/dev/sda1 64216 36364 27852 57% /boot\n" \ |
| 452 | "$ df /dev/sda3\n" \ |
| 453 | "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ |
| 454 | "/dev/sda3 8690864 8553540 137324 98% /\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 455 | |
Bernhard Reutner-Fischer | 8f7d389 | 2006-04-06 08:11:08 +0000 | [diff] [blame] | 456 | #define diff_trivial_usage \ |
Bernhard Reutner-Fischer | bc14214 | 2006-04-06 16:07:08 +0000 | [diff] [blame] | 457 | "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2" |
Bernhard Reutner-Fischer | 8f7d389 | 2006-04-06 08:11:08 +0000 | [diff] [blame] | 458 | #define diff_full_usage \ |
| 459 | "Compare files line by line and output the differences between them.\n" \ |
| 460 | "This diff implementation only supports unified diffs.\n\n" \ |
| 461 | "Options:\n" \ |
| 462 | "\t-a\tTreat all files as text\n" \ |
| 463 | "\t-b\tIgnore changes in the amount of whitespace\n" \ |
| 464 | "\t-d\tTry hard to find a smaller set of changes\n" \ |
| 465 | "\t-i\tIgnore case differences\n" \ |
Bernhard Reutner-Fischer | bc14214 | 2006-04-06 16:07:08 +0000 | [diff] [blame] | 466 | "\t-L\tUse LABEL instead of the filename in the unified header\n" \ |
Bernhard Reutner-Fischer | 8f7d389 | 2006-04-06 08:11:08 +0000 | [diff] [blame] | 467 | "\t-N\tTreat absent files as empty\n" \ |
| 468 | "\t-q\tOutput only whether files differ\n" \ |
| 469 | "\t-r\tRecursively compare any subdirectories\n" \ |
| 470 | "\t-S\tStart with FILE when comparing directories\n" \ |
| 471 | "\t-T\tMake tabs line up by prefixing a tab when necessary\n" \ |
| 472 | "\t-s\tReport when two files are the same\n" \ |
| 473 | "\t-t\tExpand tabs to spaces in output\n" \ |
| 474 | "\t-U\tOutput LINES lines of context\n" \ |
| 475 | "\t-w\tIgnore all whitespace\n" |
| 476 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 477 | #define dirname_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 478 | "FILENAME" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 479 | #define dirname_full_usage \ |
| 480 | "Strips non-directory suffix from FILENAME" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 481 | #define dirname_example_usage \ |
| 482 | "$ dirname /tmp/foo\n" \ |
| 483 | "/tmp\n" \ |
| 484 | "$ dirname /tmp/foo/\n" \ |
| 485 | "/tmp\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 486 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 487 | #define dmesg_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 488 | "[-c] [-n LEVEL] [-s SIZE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 489 | #define dmesg_full_usage \ |
| 490 | "Prints or controls the kernel ring buffer\n\n" \ |
| 491 | "Options:\n" \ |
| 492 | "\t-c\t\tClears the ring buffer's contents after printing\n" \ |
| 493 | "\t-n LEVEL\tSets console logging level\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 494 | "\t-s SIZE\t\tUse a buffer of size SIZE" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 495 | |
"Vladimir N. Oleynik" | 7b4aa6f | 2006-01-25 14:19:11 +0000 | [diff] [blame] | 496 | #define dnsd_trivial_usage \ |
| 497 | "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]" |
| 498 | #define dnsd_full_usage \ |
| 499 | "Small and static DNS server daemon\n\n" \ |
| 500 | "Options:\n" \ |
| 501 | "\t-c\t\tconfig filename\n" \ |
| 502 | "\t-t\t\tTTL in seconds\n" \ |
| 503 | "\t-p\t\tlistening port\n" \ |
| 504 | "\t-i\t\tlistening iface ip (default all)\n" \ |
| 505 | "\t-d\t\tdaemonize" |
| 506 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 507 | #define dos2unix_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 508 | "[option] [FILE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 509 | #define dos2unix_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 510 | "Converts FILE from dos format to unix format. When no option\n" \ |
| 511 | "is given, the input is converted to the opposite output format.\n" \ |
Eric Andersen | 3200f5a | 2001-05-22 22:39:10 +0000 | [diff] [blame] | 512 | "When no file is given, uses stdin for input and stdout for output.\n\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 513 | "Options:\n" \ |
| 514 | "\t-u\toutput will be in UNIX format\n" \ |
Eric Andersen | 3200f5a | 2001-05-22 22:39:10 +0000 | [diff] [blame] | 515 | "\t-d\toutput will be in DOS format" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 516 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 517 | #define dpkg_trivial_usage \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 518 | "[-ilCPru] [-F option] package_name" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 519 | #define dpkg_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 520 | "dpkg is a utility to install, remove and manage Debian packages.\n\n" \ |
| 521 | "Options:\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 522 | "\t-i\t\tInstall the package\n" \ |
| 523 | "\t-l\t\tList of installed packages\n" \ |
| 524 | "\t-C\t\tConfigure an unpackaged package\n" \ |
| 525 | "\t-F depends\tIgnore depency problems\n" \ |
| 526 | "\t-P\t\tPurge all files of a package\n" \ |
| 527 | "\t-r\t\tRemove all but the configuration files for a package\n" \ |
| 528 | "\t-u\t\tUnpack a package, but don't configure it" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 529 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 530 | #define dpkg_deb_trivial_usage \ |
Glenn L McGrath | cbc453c | 2004-05-02 03:01:08 +0000 | [diff] [blame] | 531 | "[-cefxX] FILE [argument]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 532 | #define dpkg_deb_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 533 | "Perform actions on Debian packages (.debs)\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 534 | "Options:\n" \ |
Glenn L McGrath | 3e2ab88 | 2001-04-12 13:49:09 +0000 | [diff] [blame] | 535 | "\t-c\tList contents of filesystem tree\n" \ |
Glenn L McGrath | 3136904 | 2001-04-15 12:53:24 +0000 | [diff] [blame] | 536 | "\t-e\tExtract control files to [argument] directory\n" \ |
| 537 | "\t-f\tDisplay control field name starting with [argument]\n" \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 538 | "\t-x\tExtract packages filesystem tree to directory\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 539 | "\t-X\tVerbose extract" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 540 | #define dpkg_deb_example_usage \ |
| 541 | "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 542 | |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 543 | #ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K |
| 544 | #define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a |
| 545 | #define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) |
| 546 | #else |
| 547 | #define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) |
| 548 | #define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a |
| 549 | #endif |
| 550 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 551 | #define du_trivial_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 552 | "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 553 | #define du_full_usage \ |
| 554 | "Summarizes disk space used for each FILE and/or directory.\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 555 | "Disk space is printed in units of " \ |
| 556 | USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \ |
| 557 | " bytes.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 558 | "Options:\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 559 | "\t-a\tshow sizes of files in addition to directories\n" \ |
| 560 | "\t-H\tfollow symbolic links that are FILE command line args\n" \ |
| 561 | "\t-L\tfollow all symbolic links encountered\n" \ |
| 562 | "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \ |
| 563 | "\t-c\toutput a grand total\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 564 | "\t-l\tcount sizes many times if hard linked\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 565 | "\t-s\tdisplay only a total for each argument\n" \ |
Eric Andersen | 265d229 | 2002-04-06 23:16:44 +0000 | [diff] [blame] | 566 | "\t-x\tskip directories on different filesystems\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 567 | USAGE_HUMAN_READABLE( \ |
| 568 | "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \ |
| 569 | "\t-m\tprint sizes in megabytes\n" ) \ |
| 570 | "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 571 | #define du_example_usage \ |
| 572 | "$ du\n" \ |
| 573 | "16 ./CVS\n" \ |
| 574 | "12 ./kernel-patches/CVS\n" \ |
| 575 | "80 ./kernel-patches\n" \ |
| 576 | "12 ./tests/CVS\n" \ |
| 577 | "36 ./tests\n" \ |
| 578 | "12 ./scripts/CVS\n" \ |
| 579 | "16 ./scripts\n" \ |
| 580 | "12 ./docs/CVS\n" \ |
| 581 | "104 ./docs\n" \ |
| 582 | "2417 .\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 583 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 584 | #define dumpkmap_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 585 | "> keymap" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 586 | #define dumpkmap_full_usage \ |
| 587 | "Prints out a binary keyboard translation table to standard output." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 588 | #define dumpkmap_example_usage \ |
| 589 | "$ dumpkmap > keymap\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 590 | |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 591 | #define dumpleases_trivial_usage \ |
| 592 | "[-r|-a] [-f LEASEFILE]" |
| 593 | #define dumpleases_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 594 | "Displays the DHCP leases granted by udhcpd.\n\n" \ |
| 595 | "Options:\n" \ |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 596 | "\t-f,\t--file=FILENAME\tLeases file to load\n" \ |
Glenn L McGrath | 4359623 | 2004-07-23 01:27:56 +0000 | [diff] [blame] | 597 | "\t-r,\t--remaining\tInterpret lease times as time remaing\n" \ |
| 598 | "\t-a,\t--absolute\tInterpret lease times as expire time" |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 599 | |
Mike Frysinger | 51a43b4 | 2005-09-24 07:11:16 +0000 | [diff] [blame] | 600 | #define e2fsck_trivial_usage \ |
| 601 | "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \ |
| 602 | "[-I inode_buffer_blocks] [-P process_inode_size] " \ |
Mike Frysinger | 874af85 | 2006-03-08 07:03:27 +0000 | [diff] [blame] | 603 | "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \ |
Mike Frysinger | 51a43b4 | 2005-09-24 07:11:16 +0000 | [diff] [blame] | 604 | "[-E extended-options] device" |
| 605 | #define e2fsck_full_usage \ |
| 606 | "Check a Linux ext2/ext3 file system.\n\n" \ |
| 607 | "Options:\n" \ |
| 608 | "\t-p\tAutomatic repair (no questions)\n" \ |
| 609 | "\t-n\tMake no changes to the filesystem\n" \ |
| 610 | "\t-y\tAssume 'yes' to all questions\n" \ |
| 611 | "\t-c\tCheck for bad blocks and add them to the badblock list\n" \ |
| 612 | "\t-f\tForce checking even if filesystem is marked clean\n" \ |
| 613 | "\t-v\tBe verbose\n" \ |
| 614 | "\t-b superblock\tUse alternative superblock\n" \ |
| 615 | "\t-B blocksize\tForce blocksize when looking for superblock\n" \ |
| 616 | "\t-j journal\tSet location of the external journal\n" \ |
| 617 | "\t-l file\tAdd to badblocks list\n" \ |
| 618 | "\t-L file\tSet badblocks list" |
| 619 | |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 620 | #ifdef CONFIG_FEATURE_FANCY_ECHO |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 621 | # define USAGE_FANCY_ECHO(a) a |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 622 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 623 | # define USAGE_FANCY_ECHO(a) |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 624 | #endif |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 625 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 626 | #define echo_trivial_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 627 | USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 628 | #define echo_full_usage \ |
| 629 | "Prints the specified ARGs to stdout\n\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 630 | USAGE_FANCY_ECHO("Options:\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 631 | "\t-n\tsuppress trailing newline\n" \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 632 | "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 633 | "\t-E\tdisable interpretation of backslash-escaped characters") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 634 | #define echo_example_usage \ |
Mike Frysinger | 5c63a72 | 2005-04-16 04:23:58 +0000 | [diff] [blame] | 635 | "$ echo \"Erik is cool\"\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 636 | "Erik is cool\n" \ |
Mike Frysinger | 5c63a72 | 2005-04-16 04:23:58 +0000 | [diff] [blame] | 637 | USAGE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 638 | "Erik\n" \ |
| 639 | "is\n" \ |
| 640 | "cool\n" \ |
Mike Frysinger | 5c63a72 | 2005-04-16 04:23:58 +0000 | [diff] [blame] | 641 | "$ echo \"Erik\\nis\\ncool\"\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 642 | "Erik\\nis\\ncool\n") |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 643 | |
Mike Frysinger | 55e2cf6 | 2005-05-11 00:25:47 +0000 | [diff] [blame] | 644 | #define eject_trivial_usage \ |
| 645 | "[-t] [DEVICE]" |
| 646 | #define eject_full_usage \ |
| 647 | "Eject specified DEVICE (or default /dev/cdrom).\n\n" \ |
| 648 | "Options:\n" \ |
Rob Landley | 9ea8836 | 2005-05-14 00:46:18 +0000 | [diff] [blame] | 649 | "\t-t\tclose tray" |
Mike Frysinger | 55e2cf6 | 2005-05-11 00:25:47 +0000 | [diff] [blame] | 650 | |
Eric Andersen | 84e229c | 2001-03-29 22:48:33 +0000 | [diff] [blame] | 651 | #define env_trivial_usage \ |
Matt Kraai | c96381b | 2001-05-11 14:28:17 +0000 | [diff] [blame] | 652 | "[-iu] [-] [name=value]... [command]" |
Eric Andersen | 84e229c | 2001-03-29 22:48:33 +0000 | [diff] [blame] | 653 | #define env_full_usage \ |
| 654 | "Prints the current environment or runs a program after setting\n" \ |
| 655 | "up the specified environment.\n\n" \ |
| 656 | "Options:\n" \ |
| 657 | "\t-, -i\tstart with an empty environment\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 658 | "\t-u\tremove variable from the environment" |
Eric Andersen | 84e229c | 2001-03-29 22:48:33 +0000 | [diff] [blame] | 659 | |
Mike Frysinger | b662f0d | 2005-05-11 03:59:53 +0000 | [diff] [blame] | 660 | #define ether_wake_trivial_usage \ |
| 661 | "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC" |
| 662 | #define ether_wake_full_usage \ |
| 663 | "Send a magic packet to wake up sleeping machines.\n" \ |
| 664 | "MAC must be a station address (00:11:22:33:44:55) or\n" \ |
| 665 | " a hostname with a known 'ethers' entry.\n\n" \ |
| 666 | "Options:\n" \ |
| 667 | "\t-b\t\tSend wake-up packet to the broadcast address\n" \ |
| 668 | "\t-i iface\tUse interface ifname instead of the default \"eth0\"\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 669 | "\t-p pass\tAppend the four or six byte password PW to the packet" |
Mike Frysinger | b662f0d | 2005-05-11 03:59:53 +0000 | [diff] [blame] | 670 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 671 | #define expr_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 672 | "EXPRESSION" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 673 | #define expr_full_usage \ |
| 674 | "Prints the value of EXPRESSION to standard output.\n\n" \ |
| 675 | "EXPRESSION may be:\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 676 | "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \ |
| 677 | "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \ |
| 678 | "\tARG1 < ARG2 ARG1 is less than ARG2\n" \ |
| 679 | "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \ |
| 680 | "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \ |
| 681 | "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \ |
| 682 | "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \ |
| 683 | "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \ |
| 684 | "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \ |
| 685 | "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \ |
| 686 | "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \ |
| 687 | "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \ |
| 688 | "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \ |
Eric Andersen | 3757f98 | 2001-02-23 17:47:51 +0000 | [diff] [blame] | 689 | "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \ |
| 690 | "\tmatch STRING REGEXP same as STRING : REGEXP\n" \ |
| 691 | "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \ |
| 692 | "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \ |
| 693 | "\t or 0\n" \ |
| 694 | "\tlength STRING length of STRING\n" \ |
| 695 | "\tquote TOKEN interpret TOKEN as a string, even if\n" \ |
| 696 | "\t it is a keyword like `match' or an\n" \ |
| 697 | "\t operator like `/'\n" \ |
| 698 | "\t( EXPRESSION ) value of EXPRESSION\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 699 | "Beware that many operators need to be escaped or quoted for shells.\n" \ |
| 700 | "Comparisons are arithmetic if both ARGs are numbers, else\n" \ |
| 701 | "lexicographical. Pattern matches return the string matched between \n" \ |
| 702 | "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \ |
| 703 | "of characters matched or 0." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 704 | |
Mike Frysinger | fa69f11 | 2005-04-17 07:24:19 +0000 | [diff] [blame] | 705 | #define fakeidentd_trivial_usage \ |
| 706 | "[-b ip] [STRING]" |
| 707 | #define fakeidentd_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 708 | "Returns a set string to auth requests\n\n" \ |
| 709 | "\t-b\tBind to ip address\n" \ |
Mike Frysinger | fa69f11 | 2005-04-17 07:24:19 +0000 | [diff] [blame] | 710 | "\tSTRING\tThe ident answer string (default is nobody)" |
| 711 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 712 | #define false_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 713 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 714 | #define false_full_usage \ |
| 715 | "Return an exit code of FALSE (1)." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 716 | #define false_example_usage \ |
| 717 | "$ false\n" \ |
| 718 | "$ echo $?\n" \ |
| 719 | "1\n" |
| 720 | |
| 721 | #define fbset_trivial_usage \ |
| 722 | "[options] [mode]" |
| 723 | #define fbset_full_usage \ |
| 724 | "Show and modify frame buffer settings" |
| 725 | #define fbset_example_usage \ |
| 726 | "$ fbset\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 727 | "mode \"1024x768-76\"\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 728 | "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \ |
| 729 | "\tgeometry 1024 768 1024 768 16\n" \ |
| 730 | "\ttimings 12714 128 32 16 4 128 4\n" \ |
| 731 | "\taccel false\n" \ |
| 732 | "\trgba 5/11,6/5,5/0,0/0\n" \ |
| 733 | "endmode\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 734 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 735 | #define fdflush_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 736 | "DEVICE" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 737 | #define fdflush_full_usage \ |
| 738 | "Forces floppy disk drive to detect disk change" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 739 | |
Eric Andersen | 01c3d40 | 2003-07-05 07:51:31 +0000 | [diff] [blame] | 740 | #define fdformat_trivial_usage \ |
| 741 | "[-n] DEVICE" |
| 742 | #define fdformat_full_usage \ |
| 743 | "Low-level formats a floppy disk\n\n" \ |
| 744 | "Options:\n" \ |
| 745 | "\t-n\tDon't verify after format" |
| 746 | |
Glenn L McGrath | 441e7ef | 2002-11-26 22:00:21 +0000 | [diff] [blame] | 747 | #define fdisk_trivial_usage \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 748 | "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK" |
Glenn L McGrath | 441e7ef | 2002-11-26 22:00:21 +0000 | [diff] [blame] | 749 | #define fdisk_full_usage \ |
| 750 | "Change partition table\n" \ |
| 751 | "Options:\n" \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 752 | "\t-l List partition table(s)\n" \ |
| 753 | "\t-u Give Start and End in sector (instead of cylinder) units\n" \ |
| 754 | "\t-s PARTITION Give partition size(s) in blocks\n" \ |
| 755 | "\t-b 2048: (for certain MO disks) use 2048-byte sectors\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 756 | "\t-C CYLINDERS Set the number of cylinders\n" \ |
| 757 | "\t-H HEADS Set the number of heads\n" \ |
| 758 | "\t-S SECTORS Set the number of sectors\n" \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 759 | "\t-v Give fdisk version" |
Glenn L McGrath | 441e7ef | 2002-11-26 22:00:21 +0000 | [diff] [blame] | 760 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 761 | #ifdef CONFIG_FEATURE_FIND_TYPE |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 762 | # define USAGE_FIND_TYPE(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 763 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 764 | # define USAGE_FIND_TYPE(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 765 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 766 | #ifdef CONFIG_FEATURE_FIND_PERM |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 767 | # define USAGE_FIND_PERM(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 768 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 769 | # define USAGE_FIND_PERM(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 770 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 771 | #ifdef CONFIG_FEATURE_FIND_MTIME |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 772 | # define USAGE_FIND_MTIME(a) a |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 773 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 774 | # define USAGE_FIND_MTIME(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 775 | #endif |
Paul Fox | 72d1a23 | 2006-01-13 21:05:41 +0000 | [diff] [blame] | 776 | #ifdef CONFIG_FEATURE_FIND_MMIN |
| 777 | #define USAGE_FIND_MMIN(a) a |
| 778 | #else |
| 779 | #define USAGE_FIND_MMIN(a) |
| 780 | #endif |
Eric Andersen | 97d86f2 | 2003-01-23 05:27:42 +0000 | [diff] [blame] | 781 | #ifdef CONFIG_FEATURE_FIND_NEWER |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 782 | # define USAGE_FIND_NEWER(a) a |
Eric Andersen | 97d86f2 | 2003-01-23 05:27:42 +0000 | [diff] [blame] | 783 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 784 | # define USAGE_FIND_NEWER(a) |
Eric Andersen | 97d86f2 | 2003-01-23 05:27:42 +0000 | [diff] [blame] | 785 | #endif |
| 786 | #ifdef CONFIG_FEATURE_FIND_INUM |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 787 | # define USAGE_FIND_INUM(a) a |
Eric Andersen | 97d86f2 | 2003-01-23 05:27:42 +0000 | [diff] [blame] | 788 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 789 | # define USAGE_FIND_INUM(a) |
Eric Andersen | 97d86f2 | 2003-01-23 05:27:42 +0000 | [diff] [blame] | 790 | #endif |
Rob Landley | 5d3a0e8 | 2005-10-04 03:34:39 +0000 | [diff] [blame] | 791 | #ifdef CONFIG_FEATURE_FIND_EXEC |
| 792 | # define USAGE_FIND_EXEC(a) a |
| 793 | #else |
| 794 | # define USAGE_FIND_EXEC(a) |
| 795 | #endif |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 796 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 797 | #define find_trivial_usage \ |
| 798 | "[PATH...] [EXPRESSION]" |
| 799 | #define find_full_usage \ |
| 800 | "Search for files in a directory hierarchy. The default PATH is\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 801 | "the current directory; default EXPRESSION is '-print'\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 802 | "\nEXPRESSION may consist of:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 803 | "\t-follow\t\tDereference symbolic links\n" \ |
| 804 | "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN\n" \ |
| 805 | "\t-print\t\tPrint (default and assumed)\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 806 | USAGE_FIND_TYPE( \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 807 | "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \ |
| 808 | ) USAGE_FIND_PERM( \ |
| 809 | "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \ |
| 810 | ) USAGE_FIND_MTIME( \ |
Paul Fox | 72d1a23 | 2006-01-13 21:05:41 +0000 | [diff] [blame] | 811 | "\n\t-mtime DAYS\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \ |
| 812 | ) USAGE_FIND_MMIN( \ |
| 813 | "\n\t-mmin MINS\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) minutes" \ |
Eric Andersen | 97d86f2 | 2003-01-23 05:27:42 +0000 | [diff] [blame] | 814 | ) USAGE_FIND_NEWER( \ |
| 815 | "\n\t-newer FILE\tModified time is more recent than FILE's" \ |
| 816 | ) USAGE_FIND_INUM( \ |
Rob Landley | 5d3a0e8 | 2005-10-04 03:34:39 +0000 | [diff] [blame] | 817 | "\n\t-inum N\t\tFile has inode number N" \ |
| 818 | ) USAGE_FIND_EXEC( \ |
| 819 | "\n\t-exec CMD\tExecute CMD with all instances of {} replaced by the" \ |
| 820 | "\n\t\t\tfiles matching EXPRESSION") |
| 821 | |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 822 | #define find_example_usage \ |
Eric Andersen | 75eb90f | 2004-03-29 08:20:08 +0000 | [diff] [blame] | 823 | "$ find / -name passwd\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 824 | "/etc/passwd\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 825 | |
Glenn L McGrath | f01b805 | 2003-04-27 06:02:14 +0000 | [diff] [blame] | 826 | #define fold_trivial_usage \ |
Glenn L McGrath | 0bd0257 | 2005-12-11 03:09:05 +0000 | [diff] [blame] | 827 | "[-bs] [-w WIDTH] [FILE]" |
Glenn L McGrath | f01b805 | 2003-04-27 06:02:14 +0000 | [diff] [blame] | 828 | #define fold_full_usage \ |
| 829 | "Wrap input lines in each FILE (standard input by default), writing to\n" \ |
| 830 | "standard output.\n\n" \ |
| 831 | "Options:\n" \ |
| 832 | "\t-b\tcount bytes rather than columns\n" \ |
| 833 | "\t-s\tbreak at spaces\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 834 | "\t-w\tuse WIDTH columns instead of 80" |
Glenn L McGrath | f01b805 | 2003-04-27 06:02:14 +0000 | [diff] [blame] | 835 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 836 | #define free_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 837 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 838 | #define free_full_usage \ |
| 839 | "Displays the amount of free and used system memory" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 840 | #define free_example_usage \ |
| 841 | "$ free\n" \ |
| 842 | " total used free shared buffers\n" \ |
| 843 | " Mem: 257628 248724 8904 59644 93124\n" \ |
| 844 | " Swap: 128516 8404 120112\n" \ |
| 845 | "Total: 386144 257128 129016\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 846 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 847 | #define freeramdisk_trivial_usage \ |
| 848 | "DEVICE" |
| 849 | #define freeramdisk_full_usage \ |
| 850 | "Frees all memory used by the specified ramdisk." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 851 | #define freeramdisk_example_usage \ |
| 852 | "$ freeramdisk /dev/ram2\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 853 | |
Mike Frysinger | 51a43b4 | 2005-09-24 07:11:16 +0000 | [diff] [blame] | 854 | #define fsck_trivial_usage \ |
| 855 | "[-ANPRTV] [ -C [ fd ] ] [-t fstype] [fs-options] [filesys ...]" |
| 856 | #define fsck_full_usage \ |
| 857 | "Check and repair filesystems.\n\n" \ |
| 858 | "Options:\n" \ |
| 859 | "\t-A\tWalk /etc/fstab and check all filesystems\n" \ |
| 860 | "\t-N\tDon't execute, just show what would be done\n" \ |
| 861 | "\t-P\tWhen using -A, check filesystems in parallel\n" \ |
| 862 | "\t-R\tWhen using -A, skip the root filesystem\n" \ |
| 863 | "\t-T\tDon't show title on startup\n" \ |
| 864 | "\t-V\tVerbose mode\n" \ |
| 865 | "\t-C\tWrite status information to specified filedescriptor\n" \ |
| 866 | "\t-t\tList of filesystem types to check" |
| 867 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 868 | #define fsck_minix_trivial_usage \ |
| 869 | "[-larvsmf] /dev/name" |
| 870 | #define fsck_minix_full_usage \ |
| 871 | "Performs a consistency check for MINIX filesystems.\n\n" \ |
| 872 | "Options:\n" \ |
| 873 | "\t-l\tLists all filenames\n" \ |
| 874 | "\t-r\tPerform interactive repairs\n" \ |
| 875 | "\t-a\tPerform automatic repairs\n" \ |
| 876 | "\t-v\tverbose\n" \ |
| 877 | "\t-s\tOutputs super-block information\n" \ |
| 878 | "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 879 | "\t-f\tForce file system check" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 880 | |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 881 | #define ftpget_trivial_usage \ |
Glenn L McGrath | 58fd67f | 2004-02-22 04:12:58 +0000 | [diff] [blame] | 882 | "[options] remote-host local-file remote-file" |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 883 | #define ftpget_full_usage \ |
| 884 | "Retrieve a remote file via FTP.\n\n" \ |
| 885 | "Options:\n" \ |
| 886 | "\t-c, --continue Continue a previous transfer\n" \ |
| 887 | "\t-v, --verbose Verbose\n" \ |
| 888 | "\t-u, --username Username to be used\n" \ |
| 889 | "\t-p, --password Password to be used\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 890 | "\t-P, --port Port number to be used" |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 891 | |
| 892 | #define ftpput_trivial_usage \ |
Glenn L McGrath | 58fd67f | 2004-02-22 04:12:58 +0000 | [diff] [blame] | 893 | "[options] remote-host remote-file local-file" |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 894 | #define ftpput_full_usage \ |
| 895 | "Store a local file on a remote machine via FTP.\n\n" \ |
| 896 | "Options:\n" \ |
| 897 | "\t-v, --verbose Verbose\n" \ |
| 898 | "\t-u, --username Username to be used\n" \ |
| 899 | "\t-p, --password Password to be used\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 900 | "\t-P, --port Port number to be used" |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 901 | |
Rob Landley | aa87276 | 2005-10-28 13:05:12 +0000 | [diff] [blame] | 902 | #define fuser_trivial_usage \ |
| 903 | "[options] file OR port/proto" |
| 904 | #define fuser_full_usage \ |
| 905 | "Options:\n" \ |
| 906 | "\t-m Show all processes on the same mounted fs\n" \ |
| 907 | "\t-k Kill all processes that match.\n" \ |
| 908 | "\t-s Don't print or kill anything.\n" \ |
| 909 | "\t-4 When using port/proto only search IPv4 space\n" \ |
| 910 | "\t-6 When using port/proto only search IPv6 space\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 911 | "\t-SIGNAL When used with -k, this signal will be used to kill" |
| 912 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 913 | #define getopt_trivial_usage \ |
| 914 | "[OPTIONS]..." |
| 915 | #define getopt_full_usage \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 916 | "Parse command options\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 917 | "\t-a, --alternative Allow long options starting with single -\n" \ |
| 918 | "\t-l, --longoptions=longopts Long options to be recognized\n" \ |
| 919 | "\t-n, --name=progname The name under which errors are reported\n" \ |
| 920 | "\t-o, --options=optstring Short options to be recognized\n" \ |
| 921 | "\t-q, --quiet Disable error reporting by getopt(3)\n" \ |
| 922 | "\t-Q, --quiet-output No normal output\n" \ |
| 923 | "\t-s, --shell=shell Set shell quoting conventions\n" \ |
| 924 | "\t-T, --test Test for getopt(1) version\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 925 | "\t-u, --unquoted Do not quote the output" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 926 | #define getopt_example_usage \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 927 | "$ cat getopt.test\n" \ |
| 928 | "#!/bin/sh\n" \ |
| 929 | "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \ |
| 930 | " -n 'example.busybox' -- \"$@\"`\n" \ |
| 931 | "if [ $? != 0 ] ; then exit 1 ; fi\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 932 | "eval set -- \"$GETOPT\"\n" \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 933 | "while true ; do\n" \ |
| 934 | " case $1 in\n" \ |
| 935 | " -a|--a-long) echo \"Option a\" ; shift ;;\n" \ |
| 936 | " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \ |
| 937 | " -c|--c-long)\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 938 | " case \"$2\" in\n" \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 939 | " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \ |
| 940 | " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \ |
| 941 | " esac ;;\n" \ |
| 942 | " --) shift ; break ;;\n" \ |
| 943 | " *) echo \"Internal error!\" ; exit 1 ;;\n" \ |
| 944 | " esac\n" \ |
| 945 | "done\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 946 | |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 947 | #define getty_trivial_usage \ |
Glenn L McGrath | d1daf8b | 2004-02-25 10:35:55 +0000 | [diff] [blame] | 948 | "[OPTIONS]... baud_rate,... line [termtype]" |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 949 | #define getty_full_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 950 | "Opens a tty, prompts for a login name, then invokes /bin/login\n\n" \ |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 951 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 952 | "\t-h\t\tEnable hardware (RTS/CTS) flow control\n" \ |
| 953 | "\t-i\t\tDo not display /etc/issue before running login\n" \ |
| 954 | "\t-L\t\tLocal line, so do not do carrier detect\n" \ |
| 955 | "\t-m\t\tGet baud rate from modem's CONNECT status message\n" \ |
| 956 | "\t-w\t\tWait for a CR or LF before sending /etc/issue\n" \ |
| 957 | "\t-n\t\tDo not prompt the user for a login name\n" \ |
| 958 | "\t-f issue_file\tDisplay issue_file instead of /etc/issue\n" \ |
| 959 | "\t-l login_app\tInvoke login_app instead of /bin/login\n" \ |
| 960 | "\t-t timeout\tTerminate after timeout if no username is read\n" \ |
| 961 | "\t-I initstring\tSets the init string to send before anything else\n" \ |
| 962 | "\t-H login_host\tLog login_host into the utmp file as the hostname" |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 963 | |
Bernhard Reutner-Fischer | 0a44c17 | 2005-09-23 15:40:15 +0000 | [diff] [blame] | 964 | #if ENABLE_FEATURE_GREP_EGREP_ALIAS |
| 965 | #define USAGE_GREP_E(a) a |
| 966 | #else |
| 967 | #define USAGE_GREP_E(a) |
| 968 | #endif |
| 969 | #if ENABLE_FEATURE_GREP_CONTEXT |
| 970 | #define USAGE_GREP_CTX(a) a |
| 971 | #else |
| 972 | #define USAGE_GREP_CTX(a) |
| 973 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 974 | #define grep_trivial_usage \ |
Bernhard Reutner-Fischer | 0a44c17 | 2005-09-23 15:40:15 +0000 | [diff] [blame] | 975 | "[-ihHnqvs" \ |
| 976 | USAGE_GREP_E("E") \ |
| 977 | USAGE_GREP_CTX("ABC") \ |
| 978 | "] PATTERN [FILEs...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 979 | #define grep_full_usage \ |
| 980 | "Search for PATTERN in each FILE or standard input.\n\n" \ |
| 981 | "Options:\n" \ |
| 982 | "\t-H\tprefix output lines with filename where match was found\n" \ |
| 983 | "\t-h\tsuppress the prefixing filename on output\n" \ |
| 984 | "\t-i\tignore case distinctions\n" \ |
Eric Andersen | 303dd28 | 2001-04-09 23:26:31 +0000 | [diff] [blame] | 985 | "\t-l\tlist names of files that match\n" \ |
Bernhard Reutner-Fischer | 0a44c17 | 2005-09-23 15:40:15 +0000 | [diff] [blame] | 986 | "\t-L\tlist names of files that do not match\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 987 | "\t-n\tprint line number with output lines\n" \ |
Bernhard Reutner-Fischer | 0a44c17 | 2005-09-23 15:40:15 +0000 | [diff] [blame] | 988 | "\t-q\tbe quiet. Returns 0 if PATTERN was found, 1 otherwise\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 989 | "\t-v\tselect non-matching lines\n" \ |
Bernhard Reutner-Fischer | 0a44c17 | 2005-09-23 15:40:15 +0000 | [diff] [blame] | 990 | "\t-s\tsuppress file open/read error messages\n" \ |
| 991 | "\t-c\tonly print count of matching lines\n" \ |
| 992 | "\t-f\tread PATTERN from file\n" \ |
| 993 | "\t-e\tPATTERN is a regular expression\n" \ |
| 994 | "\t-F\tPATTERN is a set of newline-separated strings" \ |
| 995 | USAGE_GREP_E("\n\t-E\tPATTERN is an extended regular expression") \ |
| 996 | USAGE_GREP_CTX("\n\t-A\tprint NUM lines of trailing context") \ |
| 997 | USAGE_GREP_CTX("\n\t-B\tprint NUM lines of leading context") \ |
| 998 | USAGE_GREP_CTX("\n\t-C\tprint NUM lines of output context") |
| 999 | |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1000 | #define grep_example_usage \ |
| 1001 | "$ grep root /etc/passwd\n" \ |
| 1002 | "root:x:0:0:root:/root:/bin/bash\n" \ |
| 1003 | "$ grep ^[rR]oo. /etc/passwd\n" \ |
| 1004 | "root:x:0:0:root:/root:/bin/bash\n" |
Mark Whitley | 40e5e7c | 2001-03-14 17:45:45 +0000 | [diff] [blame] | 1005 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1006 | #define gunzip_trivial_usage \ |
| 1007 | "[OPTION]... FILE" |
| 1008 | #define gunzip_full_usage \ |
| 1009 | "Uncompress FILE (or standard input if FILE is '-').\n\n" \ |
| 1010 | "Options:\n" \ |
| 1011 | "\t-c\tWrite output to standard output\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 1012 | "\t-f\tForce read when source is a terminal\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1013 | "\t-t\tTest compressed file integrity" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1014 | #define gunzip_example_usage \ |
| 1015 | "$ ls -la /tmp/BusyBox*\n" \ |
| 1016 | "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \ |
| 1017 | "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \ |
| 1018 | "$ ls -la /tmp/BusyBox*\n" \ |
| 1019 | "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1020 | |
| 1021 | #define gzip_trivial_usage \ |
Matt Kraai | 9bd49d6 | 2002-02-05 22:31:48 +0000 | [diff] [blame] | 1022 | "[OPTION]... [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1023 | #define gzip_full_usage \ |
Matt Kraai | 9bd49d6 | 2002-02-05 22:31:48 +0000 | [diff] [blame] | 1024 | "Compress FILE(s) with maximum compression.\n" \ |
Matt Kraai | 273af73 | 2002-02-05 19:25:29 +0000 | [diff] [blame] | 1025 | "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1026 | "Options:\n" \ |
| 1027 | "\t-c\tWrite output to standard output instead of FILE.gz\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 1028 | "\t-d\tDecompress\n" \ |
| 1029 | "\t-f\tForce write when destination is a terminal" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1030 | #define gzip_example_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 1031 | "$ ls -la /tmp/busybox*\n" \ |
| 1032 | "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \ |
| 1033 | "$ gzip /tmp/busybox.tar\n" \ |
| 1034 | "$ ls -la /tmp/busybox*\n" \ |
| 1035 | "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1036 | |
| 1037 | #define halt_trivial_usage \ |
Rob Landley | 6461291 | 2006-01-30 08:31:37 +0000 | [diff] [blame] | 1038 | "[-d<delay>] [-n<nosync>] [-f<force>]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1039 | #define halt_full_usage \ |
Glenn L McGrath | d250167 | 2004-07-23 05:16:17 +0000 | [diff] [blame] | 1040 | "Halt the system.\n" \ |
| 1041 | "Options:\n" \ |
Rob Landley | 6461291 | 2006-01-30 08:31:37 +0000 | [diff] [blame] | 1042 | "\t-d\t\tdelay interval for halting\n" \ |
| 1043 | "\t-n\t\tno call to sync()\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 1044 | "\t-f\t\tforce halt (don't go through init)" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1045 | |
Eric Andersen | 3443bd7 | 2003-07-22 07:30:36 +0000 | [diff] [blame] | 1046 | #ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY |
| 1047 | #define USAGE_HDPARM_IDENT(a) a |
| 1048 | #else |
| 1049 | #define USAGE_HDPARM_IDENT(a) |
| 1050 | #endif |
| 1051 | |
| 1052 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF |
| 1053 | #define USAGE_SCAN_HWIF(a) a |
| 1054 | #else |
| 1055 | #define USAGE_SCAN_HWIF(a) |
| 1056 | #endif |
| 1057 | |
| 1058 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF |
| 1059 | #define USAGE_UNREGISTER_HWIF(a) a |
| 1060 | #else |
| 1061 | #define USAGE_UNREGISTER_HWIF(a) |
| 1062 | #endif |
| 1063 | |
| 1064 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET |
| 1065 | #define USAGE_DRIVE_RESET(a) a |
| 1066 | #else |
| 1067 | #define USAGE_DRIVE_RESET(a) |
| 1068 | #endif |
| 1069 | |
| 1070 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF |
| 1071 | #define USAGE_TRISTATE_HWIF(a) a |
| 1072 | #else |
| 1073 | #define USAGE_TRISTATE_HWIF(a) |
| 1074 | #endif |
| 1075 | |
Eric Andersen | 0a57a79 | 2003-08-06 08:57:35 +0000 | [diff] [blame] | 1076 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA |
| 1077 | #define USAGE_GETSET_DMA(a) a |
| 1078 | #else |
| 1079 | #define USAGE_GETSET_DMA(a) |
| 1080 | #endif |
| 1081 | |
Eric Andersen | 3443bd7 | 2003-07-22 07:30:36 +0000 | [diff] [blame] | 1082 | #define hdparm_trivial_usage \ |
| 1083 | "[options] [device] .." |
| 1084 | #define hdparm_full_usage \ |
| 1085 | "Options:" \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1086 | "\t-a get/set fs readahead\n" \ |
| 1087 | "\t-A set drive read-lookahead flag (0/1)\n" \ |
| 1088 | "\t-b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \ |
| 1089 | "\t-B set Advanced Power Management setting (1-255)\n" \ |
| 1090 | "\t-c get/set IDE 32-bit IO setting\n" \ |
| 1091 | "\t-C check IDE power mode status\n" \ |
| 1092 | USAGE_GETSET_DMA("\t-d get/set using_dma flag\n") \ |
| 1093 | "\t-D enable/disable drive defect-mgmt\n" \ |
| 1094 | "\t-f flush buffer cache for device on exit\n" \ |
| 1095 | "\t-g display drive geometry\n" \ |
| 1096 | "\t-h display terse usage information\n" \ |
| 1097 | "\t-i display drive identification\n" \ |
| 1098 | USAGE_HDPARM_IDENT("\t-I detailed/current information directly from drive\n") \ |
| 1099 | USAGE_HDPARM_IDENT("\t-Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \ |
| 1100 | "\t-k get/set keep_settings_over_reset flag (0/1)\n" \ |
| 1101 | "\t-K set drive keep_features_over_reset flag (0/1)\n" \ |
| 1102 | "\t-L set drive doorlock (0/1) (removable harddisks only)\n" \ |
| 1103 | "\t-m get/set multiple sector count\n" \ |
| 1104 | "\t-n get/set ignore-write-errors flag (0/1)\n" \ |
| 1105 | "\t-p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \ |
| 1106 | "\t-P set drive prefetch count\n" \ |
| 1107 | "\t-q change next setting quietly\n" \ |
| 1108 | "\t-Q get/set DMA tagged-queuing depth (if supported)\n" \ |
| 1109 | "\t-r get/set readonly flag (DANGEROUS to set)\n" \ |
| 1110 | USAGE_SCAN_HWIF("\t-R register an IDE interface (DANGEROUS)\n") \ |
| 1111 | "\t-S set standby (spindown) timeout\n" \ |
| 1112 | "\t-t perform device read timings\n" \ |
| 1113 | "\t-T perform cache read timings\n" \ |
| 1114 | "\t-u get/set unmaskirq flag (0/1)\n" \ |
| 1115 | USAGE_UNREGISTER_HWIF("\t-U un-register an IDE interface (DANGEROUS)\n") \ |
| 1116 | "\t-v defaults; same as -mcudkrag for IDE drives\n" \ |
| 1117 | "\t-V display program version and exit immediately\n" \ |
| 1118 | USAGE_DRIVE_RESET("\t-w perform device reset (DANGEROUS)\n") \ |
| 1119 | "\t-W set drive write-caching flag (0/1) (DANGEROUS)\n" \ |
| 1120 | USAGE_TRISTATE_HWIF("\t-x tristate device for hotswap (0/1) (DANGEROUS)\n") \ |
| 1121 | "\t-X set IDE xfer mode (DANGEROUS)\n" \ |
| 1122 | "\t-y put IDE drive in standby mode\n" \ |
| 1123 | "\t-Y put IDE drive to sleep\n" \ |
| 1124 | "\t-Z disable Seagate auto-powersaving mode\n" \ |
| 1125 | "\t-z re-read partition table" |
Eric Andersen | 3443bd7 | 2003-07-22 07:30:36 +0000 | [diff] [blame] | 1126 | |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 1127 | #ifdef CONFIG_FEATURE_FANCY_HEAD |
| 1128 | #define USAGE_FANCY_HEAD(a) a |
| 1129 | #else |
| 1130 | #define USAGE_FANCY_HEAD(a) |
| 1131 | #endif |
| 1132 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1133 | #define head_trivial_usage \ |
Manuel Novoa III | 4baef0c | 2003-03-19 18:40:42 +0000 | [diff] [blame] | 1134 | "[OPTION]... [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1135 | #define head_full_usage \ |
| 1136 | "Print first 10 lines of each FILE to standard output.\n" \ |
| 1137 | "With more than one FILE, precede each with a header giving the\n" \ |
| 1138 | "file name. With no FILE, or when FILE is -, read standard input.\n\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1139 | "Options:\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 1140 | "\t-n NUM\t\tPrint first NUM lines instead of first 10" \ |
| 1141 | USAGE_FANCY_HEAD( \ |
| 1142 | "\n\t-c NUM\t\toutput the first NUM bytes\n" \ |
| 1143 | "\t-q\t\tnever output headers giving file names\n" \ |
| 1144 | "\t-v\t\talways output headers giving file names" ) |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1145 | #define head_example_usage \ |
| 1146 | "$ head -n 2 /etc/passwd\n" \ |
| 1147 | "root:x:0:0:root:/root:/bin/bash\n" \ |
| 1148 | "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1149 | |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 1150 | #define hexdump_trivial_usage \ |
Paul Fox | 969af89 | 2005-11-28 21:06:00 +0000 | [diff] [blame] | 1151 | "[-[bcCdefnosvx]] [OPTION] FILE" |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 1152 | #define hexdump_full_usage \ |
| 1153 | "The hexdump utility is a filter which displays the specified files,\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1154 | "or the standard input, if no files are specified, in a user specified\n" \ |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 1155 | "format\n" \ |
| 1156 | "\t-b\t\tOne-byte octal display\n" \ |
| 1157 | "\t-c\t\tOne-byte character display\n" \ |
Paul Fox | 969af89 | 2005-11-28 21:06:00 +0000 | [diff] [blame] | 1158 | "\t-C\t\tCanonical hex+ASCII, 16 bytes per line\n" \ |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 1159 | "\t-d\t\tTwo-byte decimal display\n" \ |
| 1160 | "\t-e FORMAT STRING\n" \ |
| 1161 | "\t-f FORMAT FILE\n" \ |
| 1162 | "\t-n LENGTH\tInterpret only length bytes of input\n" \ |
| 1163 | "\t-o\t\tTwo-byte octal display\n" \ |
| 1164 | "\t-s OFFSET\tSkip offset byte\n" \ |
| 1165 | "\t-v\t\tdisplay all input data\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 1166 | "\t-x\t\tTwo-byte hexadecimal display" |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 1167 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1168 | #define hostid_trivial_usage \ |
| 1169 | "" |
| 1170 | #define hostid_full_usage \ |
| 1171 | "Print out a unique 32-bit identifier for the machine." |
| 1172 | |
| 1173 | #define hostname_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 1174 | "[OPTION] {hostname | -F FILE}" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1175 | #define hostname_full_usage \ |
| 1176 | "Get or set the hostname or DNS domain name. If a hostname is given\n" \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 1177 | "(or FILE with the -F parameter), the host name will be set.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1178 | "Options:\n" \ |
Matt Kraai | 54805af | 2001-12-06 17:37:51 +0000 | [diff] [blame] | 1179 | "\t-s\tShort\n" \ |
| 1180 | "\t-i\tAddresses for the hostname\n" \ |
| 1181 | "\t-d\tDNS domain name\n" \ |
| 1182 | "\t-f\tFully qualified domain name\n" \ |
| 1183 | "\t-F FILE\tUse the contents of FILE to specify the hostname" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1184 | #define hostname_example_usage \ |
| 1185 | "$ hostname\n" \ |
Eric Andersen | 08f59e3 | 2004-03-12 22:07:10 +0000 | [diff] [blame] | 1186 | "sage\n" |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 1187 | |
Glenn L McGrath | 58c708a | 2003-01-05 04:01:56 +0000 | [diff] [blame] | 1188 | #ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1189 | # define USAGE_HTTPD_BASIC_AUTH(a) a |
| 1190 | # ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5 |
| 1191 | # define USAGE_HTTPD_AUTH_MD5(a) a |
| 1192 | # else |
| 1193 | # define USAGE_HTTPD_AUTH_MD5(a) |
| 1194 | # endif |
Glenn L McGrath | 58c708a | 2003-01-05 04:01:56 +0000 | [diff] [blame] | 1195 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1196 | # define USAGE_HTTPD_BASIC_AUTH(a) |
| 1197 | # define USAGE_HTTPD_AUTH_MD5(a) |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 1198 | #endif |
| 1199 | #ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1200 | # define USAGE_HTTPD_STANDALONE(a) |
| 1201 | # define USAGE_HTTPD_SETUID(a) |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 1202 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1203 | # define USAGE_HTTPD_STANDALONE(a) a |
| 1204 | # ifdef CONFIG_FEATURE_HTTPD_SETUID |
| 1205 | # define USAGE_HTTPD_SETUID(a) a |
| 1206 | # else |
| 1207 | # define USAGE_HTTPD_SETUID(a) |
| 1208 | # endif |
Glenn L McGrath | 58c708a | 2003-01-05 04:01:56 +0000 | [diff] [blame] | 1209 | #endif |
| 1210 | #define httpd_trivial_usage \ |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 1211 | "[-c <conf file>]" \ |
| 1212 | USAGE_HTTPD_STANDALONE(" [-p <port>]") \ |
| 1213 | USAGE_HTTPD_SETUID(" [-u user]") \ |
| 1214 | USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \ |
| 1215 | USAGE_HTTPD_AUTH_MD5(" [-m pass]") \ |
Eric Andersen | 73afd89 | 2004-04-14 17:59:21 +0000 | [diff] [blame] | 1216 | " [-h home]" \ |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 1217 | " [-d/-e <string>]" |
Glenn L McGrath | 58c708a | 2003-01-05 04:01:56 +0000 | [diff] [blame] | 1218 | #define httpd_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1219 | "Listens for incoming http server requests.\n\n" \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1220 | "Options:\n" \ |
| 1221 | "\t-c FILE\t\tSpecifies configuration file. (default httpd.conf)\n" \ |
| 1222 | USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \ |
| 1223 | USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privileges port\n") \ |
| 1224 | USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \ |
| 1225 | USAGE_HTTPD_AUTH_MD5("\t-m PASS\t\tCrypt PASS with md5 algorithm\n") \ |
| 1226 | "\t-h HOME \tSpecifies http HOME directory (default ./)\n" \ |
| 1227 | "\t-e STRING\tHtml encode STRING\n" \ |
| 1228 | "\t-d STRING\tURL decode STRING" |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 1229 | |
Robert Griebl | 1cd0445 | 2002-07-21 16:50:49 +0000 | [diff] [blame] | 1230 | #define hwclock_trivial_usage \ |
| 1231 | "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]" |
| 1232 | #define hwclock_full_usage \ |
| 1233 | "Query and set the hardware clock (RTC)\n\n" \ |
| 1234 | "Options:\n" \ |
| 1235 | "\t-r\tread hardware clock and print result\n" \ |
| 1236 | "\t-s\tset the system time from the hardware clock\n" \ |
| 1237 | "\t-w\tset the hardware clock to the current system time\n" \ |
| 1238 | "\t-u\tthe hardware clock is kept in coordinated universal time\n" \ |
| 1239 | "\t-l\tthe hardware clock is kept in local time" |
| 1240 | |
Eric Andersen | 9e48045 | 2003-07-03 10:07:04 +0000 | [diff] [blame] | 1241 | #ifdef CONFIG_SELINUX |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1242 | # define USAGE_SELINUX(a) a |
Eric Andersen | 9e48045 | 2003-07-03 10:07:04 +0000 | [diff] [blame] | 1243 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1244 | # define USAGE_SELINUX(a) |
Eric Andersen | 9e48045 | 2003-07-03 10:07:04 +0000 | [diff] [blame] | 1245 | #endif |
| 1246 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1247 | #define id_trivial_usage \ |
| 1248 | "[OPTIONS]... [USERNAME]" |
| 1249 | #define id_full_usage \ |
| 1250 | "Print information for USERNAME or the current user\n\n" \ |
| 1251 | "Options:\n" \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1252 | USAGE_SELINUX("\t-c\tprints only the security context\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1253 | "\t-g\tprints only the group ID\n" \ |
| 1254 | "\t-u\tprints only the user ID\n" \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1255 | "\t-n\tprint a name instead of a number\n" \ |
| 1256 | "\t-r\tprints the real user ID instead of the effective ID" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1257 | #define id_example_usage \ |
| 1258 | "$ id\n" \ |
| 1259 | "uid=1000(andersen) gid=1000(andersen)\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1260 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1261 | #ifdef CONFIG_FEATURE_IFCONFIG_SLIP |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1262 | # define USAGE_SIOCSKEEPALIVE(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1263 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1264 | # define USAGE_SIOCSKEEPALIVE(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1265 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1266 | #ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1267 | # define USAGE_IFCONFIG_MII(a) a |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1268 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1269 | # define USAGE_IFCONFIG_MII(a) |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1270 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1271 | #ifdef CONFIG_FEATURE_IFCONFIG_HW |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1272 | # define USAGE_IFCONFIG_HW(a) a |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1273 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1274 | # define USAGE_IFCONFIG_HW(a) |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1275 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1276 | #ifdef CONFIG_FEATURE_IFCONFIG_STATUS |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1277 | # define USAGE_IFCONFIG_OPT_A(a) a |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1278 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1279 | # define USAGE_IFCONFIG_OPT_A(a) |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1280 | #endif |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 1281 | #ifdef CONFIG_FEATURE_IPV6 |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1282 | # define USAGE_IPV6(a) a |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 1283 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1284 | # define USAGE_IPV6(a) |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 1285 | #endif |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1286 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1287 | #define ifconfig_trivial_usage \ |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1288 | USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1289 | #define ifconfig_full_usage \ |
| 1290 | "configure a network interface\n\n" \ |
| 1291 | "Options:\n" \ |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 1292 | USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \ |
| 1293 | USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1294 | "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \ |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1295 | "\t[netmask <address>] [dstaddr <address>]\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1296 | USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \ |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1297 | "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1298 | "[metric <NN>] [mtu <NN>]\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1299 | "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \ |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1300 | "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \ |
| 1301 | USAGE_IFCONFIG_MII("\t[mem_start <NN>] [io_addr <NN>] [irq <NN>]\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1302 | "\t[up|down] ..." |
| 1303 | |
Glenn L McGrath | 021fa7d | 2002-11-09 09:34:15 +0000 | [diff] [blame] | 1304 | #define ifup_trivial_usage \ |
| 1305 | "<-ahinv> <ifaces...>" |
| 1306 | #define ifup_full_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1307 | "ifup <options> <ifaces...>\n\n" \ |
Glenn L McGrath | 021fa7d | 2002-11-09 09:34:15 +0000 | [diff] [blame] | 1308 | "Options:\n" \ |
Glenn L McGrath | d66370c | 2003-01-13 21:40:38 +0000 | [diff] [blame] | 1309 | "\t-h\tthis help\n" \ |
| 1310 | "\t-a\tde/configure all interfaces automatically\n" \ |
| 1311 | "\t-i FILE\tuse FILE for interface definitions\n" \ |
| 1312 | "\t-n\tprint out what would happen, but don't do it\n" \ |
| 1313 | "\t\t\t(note that this option doesn't disable mappings)\n" \ |
| 1314 | "\t-v\tprint out what would happen before doing it\n" \ |
| 1315 | "\t-m\tdon't run any mappings\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 1316 | "\t-f\tforce de/configuration" |
Glenn L McGrath | 021fa7d | 2002-11-09 09:34:15 +0000 | [diff] [blame] | 1317 | |
| 1318 | #define ifdown_trivial_usage \ |
| 1319 | "<-ahinv> <ifaces...>" |
| 1320 | #define ifdown_full_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1321 | "ifdown <options> <ifaces...>\n\n" \ |
Glenn L McGrath | 021fa7d | 2002-11-09 09:34:15 +0000 | [diff] [blame] | 1322 | "Options:\n" \ |
Glenn L McGrath | d66370c | 2003-01-13 21:40:38 +0000 | [diff] [blame] | 1323 | "\t-h\tthis help\n" \ |
| 1324 | "\t-a\tde/configure all interfaces automatically\n" \ |
| 1325 | "\t-i FILE\tuse FILE for interface definitions\n" \ |
| 1326 | "\t-n\tprint out what would happen, but don't do it\n" \ |
| 1327 | "\t\t(note that this option doesn't disable mappings)\n" \ |
| 1328 | "\t-v\tprint out what would happen before doing it\n" \ |
| 1329 | "\t-m\tdon't run any mappings\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 1330 | "\t-f\tforce de/configuration" |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1331 | |
Glenn L McGrath | 06e9565 | 2003-02-09 06:51:14 +0000 | [diff] [blame] | 1332 | #define inetd_trivial_usage \ |
Paul Fox | b831753 | 2005-08-01 19:39:47 +0000 | [diff] [blame] | 1333 | "[-f] [-q len] [conf]" |
Glenn L McGrath | 06e9565 | 2003-02-09 06:51:14 +0000 | [diff] [blame] | 1334 | #define inetd_full_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1335 | "Listens for network connections and launches programs\n\n" \ |
Glenn L McGrath | 06e9565 | 2003-02-09 06:51:14 +0000 | [diff] [blame] | 1336 | "Option:\n" \ |
Paul Fox | b831753 | 2005-08-01 19:39:47 +0000 | [diff] [blame] | 1337 | "\t-f\tRun as a foreground progress\n" \ |
Glenn L McGrath | 06e9565 | 2003-02-09 06:51:14 +0000 | [diff] [blame] | 1338 | "\t-q\tSets the size of the socket listen queue to\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1339 | "\t\tthe specified value. Default is 128" |
Glenn L McGrath | 06e9565 | 2003-02-09 06:51:14 +0000 | [diff] [blame] | 1340 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1341 | #define init_trivial_usage \ |
| 1342 | "" |
| 1343 | #define init_full_usage \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1344 | "Init is the parent of all processes." |
| 1345 | #define init_notes_usage \ |
| 1346 | "This version of init is designed to be run only by the kernel.\n" \ |
| 1347 | "\n" \ |
| 1348 | "BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \ |
| 1349 | "the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \ |
| 1350 | "runlevels, use sysvinit.\n" \ |
| 1351 | "\n" \ |
| 1352 | "BusyBox init works just fine without an inittab. If no inittab is found, \n" \ |
| 1353 | "it has the following default behavior:\n" \ |
| 1354 | "\n" \ |
| 1355 | " ::sysinit:/etc/init.d/rcS\n" \ |
| 1356 | " ::askfirst:/bin/sh\n" \ |
Eric Andersen | c97ec34 | 2001-04-03 18:01:51 +0000 | [diff] [blame] | 1357 | " ::ctrlaltdel:/sbin/reboot\n" \ |
| 1358 | " ::shutdown:/sbin/swapoff -a\n" \ |
| 1359 | " ::shutdown:/bin/umount -a -r\n" \ |
Eric Andersen | 730f826 | 2001-12-17 23:13:08 +0000 | [diff] [blame] | 1360 | " ::restart:/sbin/init\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1361 | "\n" \ |
| 1362 | "if it detects that /dev/console is _not_ a serial console, it will also run:\n" \ |
| 1363 | "\n" \ |
| 1364 | " tty2::askfirst:/bin/sh\n" \ |
Eric Andersen | c97ec34 | 2001-04-03 18:01:51 +0000 | [diff] [blame] | 1365 | " tty3::askfirst:/bin/sh\n" \ |
| 1366 | " tty4::askfirst:/bin/sh\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1367 | "\n" \ |
| 1368 | "If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \ |
| 1369 | "\n" \ |
| 1370 | " <id>:<runlevels>:<action>:<process>\n" \ |
| 1371 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1372 | " <id>:\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1373 | "\n" \ |
| 1374 | " WARNING: This field has a non-traditional meaning for BusyBox init!\n" \ |
| 1375 | " The id field is used by BusyBox init to specify the controlling tty for\n" \ |
| 1376 | " the specified process to run on. The contents of this field are\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1377 | " appended to \"/dev/\" and used as-is. There is no need for this field to\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1378 | " be unique, although if it isn't you may have strange results. If this\n" \ |
| 1379 | " field is left blank, the controlling tty is set to the console. Also\n" \ |
| 1380 | " note that if BusyBox detects that a serial console is in use, then only\n" \ |
| 1381 | " entries whose controlling tty is either the serial console or /dev/null\n" \ |
| 1382 | " will be run. BusyBox init does nothing with utmp. We don't need no\n" \ |
| 1383 | " stinkin' utmp.\n" \ |
| 1384 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1385 | " <runlevels>:\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1386 | "\n" \ |
| 1387 | " The runlevels field is completely ignored.\n" \ |
| 1388 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1389 | " <action>:\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1390 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1391 | " Valid actions include: sysinit, respawn, askfirst, wait,\n" \ |
Eric Andersen | 730f826 | 2001-12-17 23:13:08 +0000 | [diff] [blame] | 1392 | " once, restart, ctrlaltdel, and shutdown.\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1393 | "\n" \ |
| 1394 | " The available actions can be classified into two groups: actions\n" \ |
| 1395 | " that are run only once, and actions that are re-run when the specified\n" \ |
| 1396 | " process exits.\n" \ |
| 1397 | "\n" \ |
| 1398 | " Run only-once actions:\n" \ |
| 1399 | "\n" \ |
| 1400 | " 'sysinit' is the first item run on boot. init waits until all\n" \ |
| 1401 | " sysinit actions are completed before continuing. Following the\n" \ |
| 1402 | " completion of all sysinit actions, all 'wait' actions are run.\n" \ |
| 1403 | " 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 1404 | " the specified task completes. 'once' actions are asynchronous,\n" \ |
Eric Andersen | 730f826 | 2001-12-17 23:13:08 +0000 | [diff] [blame] | 1405 | " therefore, init does not wait for them to complete. 'restart' is\n" \ |
| 1406 | " the action taken to restart the init process. By default this should\n" \ |
| 1407 | " simply run /sbin/init, but can be a script which runs pivot_root or it\n" \ |
| 1408 | " can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \ |
Eric Andersen | c97ec34 | 2001-04-03 18:01:51 +0000 | [diff] [blame] | 1409 | " actions are run when the system detects that someone on the system\n" \ |
| 1410 | " console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \ |
| 1411 | " wants to run 'reboot' at this point to cause the system to reboot.\n" \ |
| 1412 | " Finally the 'shutdown' action specifies the actions to taken when\n" \ |
| 1413 | " init is told to reboot. Unmounting filesystems and disabling swap\n" \ |
| 1414 | " is a very good here\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1415 | "\n" \ |
| 1416 | " Run repeatedly actions:\n" \ |
| 1417 | "\n" \ |
| 1418 | " 'respawn' actions are run after the 'once' actions. When a process\n" \ |
| 1419 | " started with a 'respawn' action exits, init automatically restarts\n" \ |
| 1420 | " it. Unlike sysvinit, BusyBox init does not stop processes from\n" \ |
| 1421 | " respawning out of control. The 'askfirst' actions acts just like\n" \ |
| 1422 | " respawn, except that before running the specified process it\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1423 | " displays the line \"Please press Enter to activate this console.\"\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1424 | " and then waits for the user to press enter before starting the\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1425 | " specified process.\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1426 | "\n" \ |
| 1427 | " Unrecognized actions (like initdefault) will cause init to emit an\n" \ |
| 1428 | " error message, and then go along with its business. All actions are\n" \ |
Eric Andersen | e0f5500 | 2002-09-30 20:59:33 +0000 | [diff] [blame] | 1429 | " run in the order they appear in /etc/inittab.\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1430 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1431 | " <process>:\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1432 | "\n" \ |
Glenn L McGrath | 4359623 | 2004-07-23 01:27:56 +0000 | [diff] [blame] | 1433 | " Specifies the process to be executed and its command line.\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1434 | "\n" \ |
| 1435 | "Example /etc/inittab file:\n" \ |
Mark Whitley | 0a6f1d3 | 2001-03-15 21:19:09 +0000 | [diff] [blame] | 1436 | "\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1437 | " # This is run first except when booting in single-user mode.\n" \ |
| 1438 | " #\n" \ |
| 1439 | " ::sysinit:/etc/init.d/rcS\n" \ |
| 1440 | " \n" \ |
| 1441 | " # /bin/sh invocations on selected ttys\n" \ |
| 1442 | " #\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1443 | " # Start an \"askfirst\" shell on the console (whatever that may be)\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1444 | " ::askfirst:-/bin/sh\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1445 | " # Start an \"askfirst\" shell on /dev/tty2-4\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1446 | " tty2::askfirst:-/bin/sh\n" \ |
| 1447 | " tty3::askfirst:-/bin/sh\n" \ |
| 1448 | " tty4::askfirst:-/bin/sh\n" \ |
| 1449 | " \n" \ |
| 1450 | " # /sbin/getty invocations for selected ttys\n" \ |
| 1451 | " #\n" \ |
Eric Andersen | 1713a11 | 2002-11-07 02:26:59 +0000 | [diff] [blame] | 1452 | " tty4::respawn:/sbin/getty 38400 tty4\n" \ |
| 1453 | " tty5::respawn:/sbin/getty 38400 tty5\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1454 | " \n" \ |
| 1455 | " \n" \ |
| 1456 | " # Example of how to put a getty on a serial line (for a terminal)\n" \ |
| 1457 | " #\n" \ |
| 1458 | " #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \ |
| 1459 | " #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \ |
| 1460 | " #\n" \ |
| 1461 | " # Example how to put a getty on a modem line.\n" \ |
| 1462 | " #::respawn:/sbin/getty 57600 ttyS2\n" \ |
| 1463 | " \n" \ |
Eric Andersen | 730f826 | 2001-12-17 23:13:08 +0000 | [diff] [blame] | 1464 | " # Stuff to do when restarting the init process\n" \ |
| 1465 | " ::restart:/sbin/init\n" \ |
| 1466 | " \n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1467 | " # Stuff to do before rebooting\n" \ |
Eric Andersen | c97ec34 | 2001-04-03 18:01:51 +0000 | [diff] [blame] | 1468 | " ::ctrlaltdel:/sbin/reboot\n" \ |
| 1469 | " ::shutdown:/bin/umount -a -r\n" \ |
| 1470 | " ::shutdown:/sbin/swapoff -a\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1471 | |
Eric Andersen | be65c35 | 2003-01-23 04:57:35 +0000 | [diff] [blame] | 1472 | #ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1473 | # define USAGE_INSMOD_MAP(a) a |
Eric Andersen | be65c35 | 2003-01-23 04:57:35 +0000 | [diff] [blame] | 1474 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1475 | # define USAGE_INSMOD_MAP(a) |
Eric Andersen | be65c35 | 2003-01-23 04:57:35 +0000 | [diff] [blame] | 1476 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1477 | #define insmod_trivial_usage \ |
| 1478 | "[OPTION]... MODULE [symbol=value]..." |
| 1479 | #define insmod_full_usage \ |
| 1480 | "Loads the specified kernel modules into the kernel.\n\n" \ |
| 1481 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1482 | "\t-f\tForce module to load into the wrong kernel version\n" \ |
| 1483 | "\t-k\tMake module autoclean-able\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1484 | "\t-v\tverbose output\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 1485 | "\t-q\tquiet output\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1486 | "\t-L\tLock to prevent simultaneous loads of a module\n" \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1487 | USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout\n") \ |
Eric Andersen | 957879a | 2004-04-07 15:07:55 +0000 | [diff] [blame] | 1488 | "\t-o NAME\tSet internal module name to NAME\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 1489 | "\t-x\tdo not export externs" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1490 | |
Glenn L McGrath | eebcc1d | 2003-09-24 03:22:57 +0000 | [diff] [blame] | 1491 | #define install_trivial_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1492 | "[-cgmops] [sources] <dest|directory>" |
Glenn L McGrath | eebcc1d | 2003-09-24 03:22:57 +0000 | [diff] [blame] | 1493 | #define install_full_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1494 | "Copies files and set attributes\n\n" \ |
Glenn L McGrath | eebcc1d | 2003-09-24 03:22:57 +0000 | [diff] [blame] | 1495 | "Options:\n" \ |
| 1496 | "\t-c\tcopy the file, default\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 1497 | "\t-d\tcreate directories\n" \ |
Glenn L McGrath | eebcc1d | 2003-09-24 03:22:57 +0000 | [diff] [blame] | 1498 | "\t-g\tset group ownership\n" \ |
| 1499 | "\t-m\tset permission modes\n" \ |
| 1500 | "\t-o\tset ownership\n" \ |
| 1501 | "\t-p\tpreserve date\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 1502 | "\t-s\tstrip symbol tables" |
Glenn L McGrath | eebcc1d | 2003-09-24 03:22:57 +0000 | [diff] [blame] | 1503 | |
Glenn L McGrath | 9a2d272 | 2002-11-10 01:33:55 +0000 | [diff] [blame] | 1504 | #define ip_trivial_usage \ |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1505 | "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }" |
Glenn L McGrath | 9a2d272 | 2002-11-10 01:33:55 +0000 | [diff] [blame] | 1506 | #define ip_full_usage \ |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1507 | "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \ |
| 1508 | "where OBJECT := { link | addr | route | tunnel }\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 1509 | "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1510 | |
| 1511 | #define ipaddr_trivial_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1512 | "{ {add|del} IFADDR dev STRING | {show|flush}\n" \ |
| 1513 | "\t\t[ dev STRING ] [ to PREFIX ] }" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1514 | #define ipaddr_full_usage \ |
Rob Landley | daa4a6d | 2006-03-30 01:59:30 +0000 | [diff] [blame] | 1515 | "ipaddr {add|delete} IFADDR dev STRING\n" \ |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1516 | "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1517 | "\t\t\t[ to PREFIX ] [ label PATTERN ]\n" \ |
| 1518 | "\t\t\tIFADDR := PREFIX | ADDR peer PREFIX\n" \ |
| 1519 | "\t\t\t[ broadcast ADDR ] [ anycast ADDR ]\n" \ |
| 1520 | "\t\t\t[ label STRING ] [ scope SCOPE-ID ]\n" \ |
| 1521 | "\t\t\tSCOPE-ID := [ host | link | global | NUMBER ]" |
Glenn L McGrath | 9a2d272 | 2002-11-10 01:33:55 +0000 | [diff] [blame] | 1522 | |
Eric Andersen | 3561b01 | 2004-04-13 19:27:20 +0000 | [diff] [blame] | 1523 | #ifdef CONFIG_FEATURE_IPCALC_FANCY |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1524 | # define XUSAGE_IPCALC_FANCY(a) a |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1525 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1526 | # define XUSAGE_IPCALC_FANCY(a) |
Eric Andersen | 3561b01 | 2004-04-13 19:27:20 +0000 | [diff] [blame] | 1527 | #endif |
Eric Andersen | de4f07e | 2003-12-11 01:18:07 +0000 | [diff] [blame] | 1528 | #define ipcalc_trivial_usage \ |
Eric Andersen | 3561b01 | 2004-04-13 19:27:20 +0000 | [diff] [blame] | 1529 | "[OPTION]... <ADDRESS>[[/]<NETMASK>] [NETMASK]" |
Eric Andersen | de4f07e | 2003-12-11 01:18:07 +0000 | [diff] [blame] | 1530 | #define ipcalc_full_usage \ |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1531 | "Calculate IP network settings from a IP address\n\n" \ |
| 1532 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1533 | "\t-b\t--broadcast\tDisplay calculated broadcast address\n" \ |
| 1534 | "\t-n\t--network\tDisplay calculated network address\n" \ |
Mike Frysinger | 036f299 | 2005-09-24 23:50:14 +0000 | [diff] [blame] | 1535 | "\t-m\t--netmask\tDisplay default netmask for IP" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1536 | XUSAGE_IPCALC_FANCY( \ |
Mike Frysinger | 036f299 | 2005-09-24 23:50:14 +0000 | [diff] [blame] | 1537 | "\n\t-p\t--prefix\tDisplay the prefix for IP/NETMASK\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1538 | "\t-h\t--hostname\tDisplay first resolved host name\n" \ |
Mike Frysinger | 036f299 | 2005-09-24 23:50:14 +0000 | [diff] [blame] | 1539 | "\t-s\t--silent\tDon't ever display error messages") |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1540 | |
Rob Landley | 6eb1e41 | 2005-06-20 04:30:36 +0000 | [diff] [blame] | 1541 | #define ipcrm_trivial_usage \ |
| 1542 | "[-[MQS] key] [-[mqs] id]" |
| 1543 | #define ipcrm_full_usage \ |
| 1544 | "The upper-case options MQS are used to remove a shared memory\n" \ |
| 1545 | "segment by an shmkey value. The lower-case options mqs are used\n" \ |
| 1546 | "to remove a segment by shmid value.\n" \ |
| 1547 | "\t-m | -M\tRemove the memory segment after the last detatch\n" \ |
| 1548 | "\t-q | -Q\tRemove the message queue\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 1549 | "\t-s | -S\tRemove the semaphore" |
Rob Landley | 6eb1e41 | 2005-06-20 04:30:36 +0000 | [diff] [blame] | 1550 | |
| 1551 | #define ipcs_trivial_usage \ |
| 1552 | "[[-smq] -i shmid] | [[-asmq] [-tclup]]" |
| 1553 | #define ipcs_full_usage \ |
| 1554 | "\t-i\tspecify a specific resource id\n" \ |
| 1555 | "Resource specification:\n" \ |
| 1556 | "\t-m\tshared memory segments\n" \ |
| 1557 | "\t-q\tmessage queues\n" \ |
| 1558 | "\t-s\tsempahore arrays\n" \ |
| 1559 | "\t-a\tall (default)\n" \ |
| 1560 | "Output format:\n" \ |
| 1561 | "\t-t\ttime\n" \ |
| 1562 | "\t-p\tpid\n" \ |
| 1563 | "\t-s\tcreator\n" \ |
| 1564 | "\t-a\tlimits\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 1565 | "\t-i\tsummary" |
Rob Landley | 6eb1e41 | 2005-06-20 04:30:36 +0000 | [diff] [blame] | 1566 | |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1567 | #define iplink_trivial_usage \ |
| 1568 | "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }" |
| 1569 | #define iplink_full_usage \ |
| 1570 | "iplink set DEVICE { up | down | arp { on | off } |\n" \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1571 | "\t\t\tdynamic { on | off } |\n" \ |
| 1572 | "\t\t\tmtu MTU }\n" \ |
| 1573 | "\tiplink show [ DEVICE ]" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1574 | |
| 1575 | #define iproute_trivial_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1576 | "{ list | flush | { add | del | change | append |\n" \ |
| 1577 | "\t\treplace | monitor } ROUTE }" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1578 | #define iproute_full_usage \ |
| 1579 | "iproute { list | flush } SELECTOR\n" \ |
| 1580 | "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1581 | "\t\t\t[ oif STRING ] [ tos TOS ]\n" \ |
| 1582 | "\tiproute { add | del | change | append | replace | monitor } ROUTE\n" \ |
| 1583 | "\t\t\tSELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \ |
| 1584 | "\t\t\tROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1585 | |
| 1586 | #define iptunnel_trivial_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1587 | "{ add | change | del | show } [ NAME ]\n" \ |
| 1588 | "\t\t[ mode { ipip | gre | sit } ]\n" \ |
| 1589 | "\t\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1590 | #define iptunnel_full_usage \ |
| 1591 | "iptunnel { add | change | del | show } [ NAME ]\n" \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1592 | "\t\t\t[ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \ |
| 1593 | "\t\t\t[ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \ |
| 1594 | "\t\t\t[ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1595 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1596 | #define kill_trivial_usage \ |
| 1597 | "[-signal] process-id [process-id ...]" |
| 1598 | #define kill_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1599 | "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \ |
David Kimdon | 56082dc | 2001-02-23 06:03:22 +0000 | [diff] [blame] | 1600 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1601 | "\t-l\tList all signal names and numbers" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1602 | #define kill_example_usage \ |
| 1603 | "$ ps | grep apache\n" \ |
| 1604 | "252 root root S [apache]\n" \ |
| 1605 | "263 www-data www-data S [apache]\n" \ |
| 1606 | "264 www-data www-data S [apache]\n" \ |
| 1607 | "265 www-data www-data S [apache]\n" \ |
| 1608 | "266 www-data www-data S [apache]\n" \ |
| 1609 | "267 www-data www-data S [apache]\n" \ |
| 1610 | "$ kill 252\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1611 | |
| 1612 | #define killall_trivial_usage \ |
Eric Andersen | b131db4 | 2004-08-19 18:25:02 +0000 | [diff] [blame] | 1613 | "[-q] [-signal] process-name [process-name ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1614 | #define killall_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1615 | "Send a signal (default is SIGTERM) to the specified process(es).\n\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1616 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1617 | "\t-l\tList all signal names and numbers\n" \ |
| 1618 | "\t-q\tDo not complain if no processes were killed" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1619 | #define killall_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1620 | "$ killall apache\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1621 | |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1622 | #define klogd_trivial_usage \ |
Glenn L McGrath | f0a360e | 2002-12-05 20:56:31 +0000 | [diff] [blame] | 1623 | "[-c n] [-n]" |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1624 | #define klogd_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1625 | "Kernel logger.\n" \ |
| 1626 | "Options:\n" \ |
| 1627 | "\t-c n\tSets the default log level of console messages to n\n" \ |
| 1628 | "\t-n\tRun as a foreground process" |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1629 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1630 | #define length_trivial_usage \ |
| 1631 | "STRING" |
| 1632 | #define length_full_usage \ |
| 1633 | "Prints out the length of the specified STRING." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1634 | #define length_example_usage \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 1635 | "$ length Hello\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1636 | "5\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1637 | |
Rob Landley | 9200e79 | 2005-09-15 19:26:59 +0000 | [diff] [blame] | 1638 | #define less_trivial_usage \ |
| 1639 | "[-EMNmh~?] FILE1 FILE2..." |
| 1640 | #define less_full_usage \ |
| 1641 | "View a file or list of files. The position within files can be\n" \ |
| 1642 | "changed, and files can be manipulated in various ways with the\n" \ |
| 1643 | "following options:\n\n" \ |
| 1644 | "\t-E\tQuit once the end of a file is reached\n" \ |
| 1645 | "\t-M\tDisplay a status line containing the current line numbers\n" \ |
| 1646 | "\t\tand the percentage through the file\n" \ |
| 1647 | "\t-N\tPrefix line numbers to each line\n" \ |
| 1648 | "\t-m\tDisplay a status line containing the percentage through the\n" \ |
| 1649 | "\t\tfile\n" \ |
| 1650 | "\t-~\tSuppress ~s displayed when input past the end of the file is\n" \ |
| 1651 | "\t\treached.\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 1652 | "\t-h, -?\tDisplay this help message" |
Rob Landley | 9200e79 | 2005-09-15 19:26:59 +0000 | [diff] [blame] | 1653 | |
Mike Frysinger | 0a6b0bf | 2006-02-21 04:26:52 +0000 | [diff] [blame] | 1654 | #define setarch_trivial_usage \ |
| 1655 | "<personality> <program> [args ...]" |
| 1656 | #define setarch_full_usage \ |
| 1657 | "Personality may be:\n" \ |
| 1658 | "\tlinux32\tSet 32bit uname emulation\n" \ |
| 1659 | "\tlinux64\tSet 64bit uname emulation" |
| 1660 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1661 | #define ln_trivial_usage \ |
| 1662 | "[OPTION] TARGET... LINK_NAME|DIRECTORY" |
| 1663 | #define ln_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1664 | "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1665 | "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \ |
| 1666 | "Options:\n" \ |
| 1667 | "\t-s\tmake symbolic links instead of hard links\n" \ |
| 1668 | "\t-f\tremove existing destination files\n" \ |
Rob Landley | 55b1efc | 2005-04-29 22:14:28 +0000 | [diff] [blame] | 1669 | "\t-n\tno dereference symlinks - treat like normal file\n" \ |
| 1670 | "\t-b\tmake a backup of the target (if exists) before link operation\n" \ |
| 1671 | "\t-S suffix\tuse suffix instead of ~ when making backup files" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1672 | #define ln_example_usage \ |
| 1673 | "$ ln -s BusyBox /tmp/ls\n" \ |
| 1674 | "$ ls -l /tmp/ls\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1675 | "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1676 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1677 | #define loadfont_trivial_usage \ |
| 1678 | "< font" |
| 1679 | #define loadfont_full_usage \ |
| 1680 | "Loads a console font from standard input." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1681 | #define loadfont_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1682 | "$ loadfont < /etc/i18n/fontname\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1683 | |
| 1684 | #define loadkmap_trivial_usage \ |
| 1685 | "< keymap" |
| 1686 | #define loadkmap_full_usage \ |
| 1687 | "Loads a binary keyboard translation table from standard input." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1688 | #define loadkmap_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1689 | "$ loadkmap < /etc/i18n/lang-keymap\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1690 | |
| 1691 | #define logger_trivial_usage \ |
| 1692 | "[OPTION]... [MESSAGE]" |
| 1693 | #define logger_full_usage \ |
| 1694 | "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \ |
| 1695 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1696 | "\t-s\tLog to stderr as well as the system log\n" \ |
| 1697 | "\t-t TAG\tLog using the specified tag (defaults to user name)\n" \ |
| 1698 | "\t-p PRIORITY\tEnter the message with the specified priority\n" \ |
| 1699 | "\t\tThis may be numerical or a ``facility.level'' pair" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1700 | #define logger_example_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1701 | "$ logger \"hello\"\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1702 | |
Robert Griebl | 1fca558 | 2002-06-04 20:45:46 +0000 | [diff] [blame] | 1703 | #define login_trivial_usage \ |
| 1704 | "[OPTION]... [username] [ENV=VAR ...]" |
| 1705 | #define login_full_usage \ |
| 1706 | "Begin a new session on the system\n\n" \ |
| 1707 | "Options:\n" \ |
| 1708 | "\t-f\tDo not authenticate (user already authenticated)\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1709 | "\t-h\tName of the remote host for this login\n" \ |
| 1710 | "\t-p\tPreserve environment" |
Robert Griebl | 1fca558 | 2002-06-04 20:45:46 +0000 | [diff] [blame] | 1711 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1712 | #define logname_trivial_usage \ |
| 1713 | "" |
| 1714 | #define logname_full_usage \ |
| 1715 | "Print the name of the current user." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1716 | #define logname_example_usage \ |
| 1717 | "$ logname\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1718 | "root\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1719 | |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1720 | #define logread_trivial_usage \ |
Eric Andersen | d4a5e25 | 2003-12-19 11:32:14 +0000 | [diff] [blame] | 1721 | "[OPTION]..." |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1722 | #define logread_full_usage \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1723 | "Shows the messages from syslogd (using circular buffer).\n\n" \ |
Eric Andersen | d4a5e25 | 2003-12-19 11:32:14 +0000 | [diff] [blame] | 1724 | "Options:\n" \ |
| 1725 | "\t-f\t\toutput data as the log grows" |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1726 | |
Matt Kraai | 83788da | 2002-03-20 17:38:37 +0000 | [diff] [blame] | 1727 | #define losetup_trivial_usage \ |
Rob Landley | ce88793 | 2005-12-21 17:00:25 +0000 | [diff] [blame] | 1728 | "[-od] LOOPDEVICE [FILE]" |
Matt Kraai | 83788da | 2002-03-20 17:38:37 +0000 | [diff] [blame] | 1729 | #define losetup_full_usage \ |
Rob Landley | 1d589b2 | 2005-11-29 23:47:10 +0000 | [diff] [blame] | 1730 | "Associate LOOPDEVICE with FILE, or display current association.\n\n" \ |
Matt Kraai | 83788da | 2002-03-20 17:38:37 +0000 | [diff] [blame] | 1731 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1732 | "\t-d\t\tDisassociate LOOPDEVICE\n" \ |
| 1733 | "\t-o OFFSET\tStart OFFSET bytes into FILE" |
Rob Landley | 1d589b2 | 2005-11-29 23:47:10 +0000 | [diff] [blame] | 1734 | #define losetup_notes_usage \ |
| 1735 | "One argument (losetup /dev/loop1) will display the current association\n" \ |
| 1736 | "(if any), or disassociate it (with -d). The display shows the offset\n" \ |
| 1737 | "and filename of the file the loop device is currently bound to.\n\n" \ |
| 1738 | "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \ |
| 1739 | "with an optional offset (-o 12345). Encryption is not yet supported.\n\n" |
Matt Kraai | 83788da | 2002-03-20 17:38:37 +0000 | [diff] [blame] | 1740 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1741 | #ifdef CONFIG_FEATURE_LS_TIMESTAMPS |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1742 | # define USAGE_LS_TIMESTAMPS(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1743 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1744 | # define USAGE_LS_TIMESTAMPS(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1745 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1746 | #ifdef CONFIG_FEATURE_LS_FILETYPES |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1747 | # define USAGE_LS_FILETYPES(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1748 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1749 | # define USAGE_LS_FILETYPES(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1750 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1751 | #ifdef CONFIG_FEATURE_LS_FOLLOWLINKS |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1752 | # define USAGE_LS_FOLLOWLINKS(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1753 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1754 | # define USAGE_LS_FOLLOWLINKS(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1755 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1756 | #ifdef CONFIG_FEATURE_LS_RECURSIVE |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1757 | # define USAGE_LS_RECURSIVE(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1758 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1759 | # define USAGE_LS_RECURSIVE(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1760 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1761 | #ifdef CONFIG_FEATURE_LS_SORTFILES |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1762 | # define USAGE_LS_SORTFILES(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1763 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1764 | # define USAGE_LS_SORTFILES(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1765 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1766 | #ifdef CONFIG_FEATURE_AUTOWIDTH |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1767 | # define USAGE_AUTOWIDTH(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1768 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 1769 | # define USAGE_AUTOWIDTH(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1770 | #endif |
Paul Fox | 156dc41 | 2005-08-01 19:33:30 +0000 | [diff] [blame] | 1771 | #ifdef CONFIG_FEATURE_LS_COLOR |
| 1772 | #define USAGE_LS_COLOR(a) a |
| 1773 | #else |
| 1774 | #define USAGE_LS_COLOR(a) |
| 1775 | #endif |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1776 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1777 | #define ls_trivial_usage \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1778 | "[-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...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1779 | #define ls_full_usage \ |
| 1780 | "List directory contents\n\n" \ |
| 1781 | "Options:\n" \ |
| 1782 | "\t-1\tlist files in a single column\n" \ |
| 1783 | "\t-A\tdo not list implied . and ..\n" \ |
| 1784 | "\t-a\tdo not hide entries starting with .\n" \ |
| 1785 | "\t-C\tlist entries by columns\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1786 | USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \ |
Paul Fox | 156dc41 | 2005-08-01 19:33:30 +0000 | [diff] [blame] | 1787 | USAGE_LS_COLOR("\t--color[={always,never,auto}]\tto control coloring\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1788 | "\t-d\tlist directory entries instead of contents\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1789 | USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \ |
| 1790 | USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1791 | "\t-i\tlist the i-node for each file\n" \ |
| 1792 | "\t-l\tuse a long listing format\n" \ |
| 1793 | "\t-n\tlist numeric UIDs and GIDs instead of names\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1794 | USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \ |
| 1795 | USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \ |
| 1796 | USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \ |
| 1797 | USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \ |
| 1798 | USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1799 | "\t-s\tlist the size of each file, in blocks\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1800 | USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \ |
| 1801 | USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \ |
| 1802 | USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \ |
| 1803 | USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \ |
| 1804 | USAGE_AUTOWIDTH("\t-w NUM\tassume the terminal is NUM columns wide\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1805 | "\t-x\tlist entries by lines instead of by columns\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1806 | USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \ |
| 1807 | USAGE_HUMAN_READABLE( \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 1808 | "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n") \ |
| 1809 | USAGE_SELINUX("\t-k\tprint security context\n") \ |
| 1810 | USAGE_SELINUX("\t-K\tprint security context in long format\n") |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1811 | |
Mike Frysinger | de9f1f7 | 2005-04-22 02:33:37 +0000 | [diff] [blame] | 1812 | #define lsattr_trivial_usage \ |
| 1813 | "[-Radlv] [files...]" |
| 1814 | #define lsattr_full_usage \ |
| 1815 | "list file attributes on an ext2 fs\n\n" \ |
| 1816 | "Options:\n" \ |
| 1817 | "\t-R\trecursively list subdirectories\n" \ |
| 1818 | "\t-a\tdo not hide entries starting with .\n" \ |
| 1819 | "\t-d\tlist directory entries instead of contents\n" \ |
| 1820 | "\t-l\tprint long flag names\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1821 | "\t-v\tlist the file's version/generation number" |
Mike Frysinger | de9f1f7 | 2005-04-22 02:33:37 +0000 | [diff] [blame] | 1822 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1823 | #define lsmod_trivial_usage \ |
| 1824 | "" |
| 1825 | #define lsmod_full_usage \ |
| 1826 | "List the currently loaded kernel modules." |
| 1827 | |
Eric Andersen | 3d92562 | 2005-06-09 10:16:02 +0000 | [diff] [blame] | 1828 | #ifdef CONFIG_FEATURE_MAKEDEVS_LEAF |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1829 | #define makedevs_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1830 | "NAME TYPE MAJOR MINOR FIRST LAST [s]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1831 | #define makedevs_full_usage \ |
| 1832 | "Creates a range of block or character special files\n\n" \ |
| 1833 | "TYPEs include:\n" \ |
| 1834 | "\tb:\tMake a block (buffered) device.\n" \ |
| 1835 | "\tc or u:\tMake a character (un-buffered) device.\n" \ |
| 1836 | "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \ |
| 1837 | "FIRST specifies the number appended to NAME to create the first device.\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1838 | "LAST specifies the number of the last item that should be created\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1839 | "If 's' is the last argument, the base device is created as well.\n\n" \ |
| 1840 | "For example:\n" \ |
| 1841 | "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1842 | "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1843 | #define makedevs_example_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1844 | "# makedevs /dev/ttyS c 4 66 2 63\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1845 | "[creates ttyS2-ttyS63]\n" \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1846 | "# makedevs /dev/hda b 3 0 0 8 s\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1847 | "[creates hda,hda1-hda8]\n" |
Eric Andersen | 3d92562 | 2005-06-09 10:16:02 +0000 | [diff] [blame] | 1848 | #endif |
| 1849 | |
| 1850 | #ifdef CONFIG_FEATURE_MAKEDEVS_TABLE |
| 1851 | #define makedevs_trivial_usage \ |
Eric Andersen | e8614db | 2005-07-18 09:28:36 +0000 | [diff] [blame] | 1852 | "[-d device_table] rootdir" |
Eric Andersen | 3d92562 | 2005-06-09 10:16:02 +0000 | [diff] [blame] | 1853 | #define makedevs_full_usage \ |
Eric Andersen | e8614db | 2005-07-18 09:28:36 +0000 | [diff] [blame] | 1854 | "Creates a range of special files as specified in a device table.\n" \ |
| 1855 | "Device table entries take the form of:\n" \ |
Eric Andersen | e8614db | 2005-07-18 09:28:36 +0000 | [diff] [blame] | 1856 | "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \ |
| 1857 | "Where name is the file name, type can be one of:\n" \ |
| 1858 | " f A regular file\n" \ |
| 1859 | " d Directory\n" \ |
| 1860 | " c Character special device file\n" \ |
| 1861 | " b Block special device file\n" \ |
| 1862 | " p Fifo (named pipe)\n" \ |
| 1863 | "uid is the user id for the target file, gid is the group id for the\n" \ |
| 1864 | "target file. The rest of the entries (major, minor, etc) apply to\n" \ |
Eric Andersen | 54e57da | 2005-07-18 09:42:37 +0000 | [diff] [blame] | 1865 | "to device special files. A '-' may be used for blank entries." |
Eric Andersen | e8614db | 2005-07-18 09:28:36 +0000 | [diff] [blame] | 1866 | #define makedevs_example_usage \ |
| 1867 | "For example:\n" \ |
| 1868 | "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \ |
| 1869 | "/dev d 755 0 0 - - - - -\n" \ |
| 1870 | "/dev/console c 666 0 0 5 1 - - -\n" \ |
| 1871 | "/dev/null c 666 0 0 1 3 0 0 -\n" \ |
| 1872 | "/dev/zero c 666 0 0 1 5 0 0 -\n" \ |
| 1873 | "/dev/hda b 640 0 0 3 0 0 0 -\n" \ |
| 1874 | "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \ |
| 1875 | "Will Produce:\n" \ |
| 1876 | "/dev\n" \ |
| 1877 | "/dev/console\n" \ |
| 1878 | "/dev/null\n" \ |
| 1879 | "/dev/zero\n" \ |
| 1880 | "/dev/hda\n" \ |
Eric Andersen | 54e57da | 2005-07-18 09:42:37 +0000 | [diff] [blame] | 1881 | "/dev/hda[0-15]\n" |
Eric Andersen | 3d92562 | 2005-06-09 10:16:02 +0000 | [diff] [blame] | 1882 | #endif |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1883 | |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 1884 | #ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK |
| 1885 | #define USAGE_MD5_SHA1_SUM_CHECK(a) a |
| 1886 | #else |
| 1887 | #define USAGE_MD5_SHA1_SUM_CHECK(a) |
| 1888 | #endif |
| 1889 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1890 | #define md5sum_trivial_usage \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 1891 | "[OPTION] [FILEs...]" \ |
| 1892 | USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]") |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1893 | #define md5sum_full_usage \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 1894 | "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1895 | "Options:\n" \ |
Glenn L McGrath | c83e3a6 | 2003-12-04 13:06:44 +0000 | [diff] [blame] | 1896 | "With no FILE, or when FILE is -, read standard input." \ |
| 1897 | USAGE_MD5_SHA1_SUM_CHECK("\n\n" \ |
| 1898 | "\t-c\tcheck MD5 sums against given list\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1899 | "\nThe following two options are useful only when verifying checksums:\n" \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 1900 | "\t-s\tdon't output anything, status code shows success\n" \ |
Glenn L McGrath | c83e3a6 | 2003-12-04 13:06:44 +0000 | [diff] [blame] | 1901 | "\t-w\twarn about improperly formated MD5 checksum lines") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1902 | #define md5sum_example_usage \ |
| 1903 | "$ md5sum < busybox\n" \ |
| 1904 | "6fd11e98b98a58f64ff3398d7b324003\n" \ |
| 1905 | "$ md5sum busybox\n" \ |
| 1906 | "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ |
| 1907 | "$ md5sum -c -\n" \ |
| 1908 | "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ |
| 1909 | "busybox: OK\n" \ |
| 1910 | "^D\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1911 | |
Rob Landley | 70f7ef7 | 2005-12-13 08:21:33 +0000 | [diff] [blame] | 1912 | #define mdev_trivial_usage \ |
| 1913 | "[-s]" |
| 1914 | #define mdev_full_usage \ |
Mike Frysinger | 35cf19d | 2006-02-02 22:52:59 +0000 | [diff] [blame] | 1915 | "\t-s\tScan /sys and populate /dev during system boot\n\n" \ |
Rob Landley | 70f7ef7 | 2005-12-13 08:21:33 +0000 | [diff] [blame] | 1916 | "Called with no options (via hotplug) it uses environment variables\n" \ |
| 1917 | "to determine which device to add/remove." |
| 1918 | #ifdef CONFIG_FEATURE_MDEV_CONFIG |
| 1919 | #define mdev_notes_usage \ |
| 1920 | "The mdev config file contains lines that look like:\n" \ |
Tim Riker | c1ef7bd | 2006-01-25 00:08:53 +0000 | [diff] [blame] | 1921 | " hd[a-z][0-9]* 0:3 660\n\n" \ |
| 1922 | "That's device name (with regex match), uid:gid, and permissions.\n\n" \ |
Rob Landley | 70f7ef7 | 2005-12-13 08:21:33 +0000 | [diff] [blame] | 1923 | "Optionally, that can be followed (on the same line) by an asterisk\n" \ |
| 1924 | "and a command line to run after creating the corresponding device(s),\n"\ |
| 1925 | "ala:\n\n" \ |
| 1926 | " hdc root:cdrom 660 *ln -s hdc cdrom\n\n" \ |
| 1927 | "Config file parsing stops on the first matching line. If no config\n"\ |
| 1928 | "entry is matched, devices are created with default 0:0 660. (Make\n"\ |
| 1929 | "the last line match .* to override this.)\n\n" |
| 1930 | #endif |
| 1931 | |
Glenn L McGrath | 061c900 | 2002-09-16 04:21:46 +0000 | [diff] [blame] | 1932 | #define mesg_trivial_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1933 | "[y|n]" |
Glenn L McGrath | 061c900 | 2002-09-16 04:21:46 +0000 | [diff] [blame] | 1934 | #define mesg_full_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 1935 | "mesg controls write access to your terminal\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 1936 | "\ty\tAllow write access to your terminal\n" \ |
| 1937 | "\tn\tDisallow write access to your terminal" |
Glenn L McGrath | 061c900 | 2002-09-16 04:21:46 +0000 | [diff] [blame] | 1938 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1939 | #define mkdir_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1940 | "[OPTION] DIRECTORY..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1941 | #define mkdir_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 1942 | "Create the DIRECTORY(ies) if they do not already exist\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1943 | "Options:\n" \ |
| 1944 | "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1945 | "\t-p\tno error if existing, make parent directories as needed" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1946 | #define mkdir_example_usage \ |
| 1947 | "$ mkdir /tmp/foo\n" \ |
| 1948 | "$ mkdir /tmp/foo\n" \ |
| 1949 | "/tmp/foo: File exists\n" \ |
| 1950 | "$ mkdir /tmp/foo/bar/baz\n" \ |
| 1951 | "/tmp/foo/bar/baz: No such file or directory\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1952 | "$ mkdir -p /tmp/foo/bar/baz\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1953 | |
Mike Frysinger | 6447ac0 | 2005-06-11 05:29:40 +0000 | [diff] [blame] | 1954 | #define mke2fs_trivial_usage \ |
| 1955 | "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \ |
| 1956 | "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \ |
| 1957 | "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \ |
| 1958 | "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \ |
| 1959 | "[-M last-mounted-directory] [-S] [-T filesystem-type] " \ |
| 1960 | "device [blocks-count]" |
| 1961 | #define mke2fs_full_usage \ |
| 1962 | "\t-b size\tblock size in bytes\n" \ |
| 1963 | "\t-c\tcheck for bad blocks before creating\n" \ |
| 1964 | "\t-E opts\tset extended options\n" \ |
| 1965 | "\t-f size\tfragment size in bytes\n" \ |
| 1966 | "\t-F\tforce (ignore sanity checks)\n" \ |
| 1967 | "\t-g num\tnumber of blocks in a block group\n" \ |
| 1968 | "\t-i ratio\tthe bytes/inode ratio\n" \ |
| 1969 | "\t-j\tcreate a journal (ext3)\n" \ |
| 1970 | "\t-J opts\tset journal options (size/device)\n" \ |
| 1971 | "\t-l file\tread bad blocks list from file\n" \ |
| 1972 | "\t-L lbl\tset the volume label\n" \ |
| 1973 | "\t-m percent\tpercent of fs blocks to reserve for admin\n" \ |
| 1974 | "\t-M dir\tset last mounted directory\n" \ |
| 1975 | "\t-n\tdo not actually create anything\n" \ |
| 1976 | "\t-N num\tnumber of inodes to create\n" \ |
| 1977 | "\t-o os\tset the 'creator os' field\n" \ |
| 1978 | "\t-O features\tdir_index/filetype/has_journal/journal_dev/sparse_super\n" \ |
| 1979 | "\t-q\tquiet execution\n" \ |
| 1980 | "\t-r rev\tset filesystem revision\n" \ |
| 1981 | "\t-S\twrite superblock and group descriptors only\n" \ |
| 1982 | "\t-T fs-type\tset usage type (news/largefile/largefile4)\n" \ |
| 1983 | "\t-v\tverbose execution" |
| 1984 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1985 | #define mkfifo_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1986 | "[OPTIONS] name" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1987 | #define mkfifo_full_usage \ |
| 1988 | "Creates a named pipe (identical to 'mknod name p')\n\n" \ |
| 1989 | "Options:\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1990 | "\t-m\tcreate the pipe using the specified mode (default a=rw)" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1991 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1992 | #define mkfs_minix_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1993 | "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1994 | #define mkfs_minix_full_usage \ |
| 1995 | "Make a MINIX filesystem.\n\n" \ |
| 1996 | "Options:\n" \ |
| 1997 | "\t-c\t\tCheck the device for bad blocks\n" \ |
| 1998 | "\t-n [14|30]\tSpecify the maximum length of filenames\n" \ |
| 1999 | "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \ |
| 2000 | "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2001 | "\t-v\t\tMake a Minix version 2 filesystem" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2002 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2003 | #define mknod_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2004 | "[OPTIONS] NAME TYPE MAJOR MINOR" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2005 | #define mknod_full_usage \ |
| 2006 | "Create a special file (block, character, or pipe).\n\n" \ |
| 2007 | "Options:\n" \ |
| 2008 | "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \ |
| 2009 | "TYPEs include:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2010 | "\tb:\tMake a block (buffered) device\n" \ |
| 2011 | "\tc or u:\tMake a character (un-buffered) device\n" \ |
| 2012 | "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2013 | #define mknod_example_usage \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 2014 | "$ mknod /dev/fd0 b 2 0\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2015 | "$ mknod -m 644 /tmp/pipe p\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2016 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2017 | #define mkswap_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2018 | "[-c] [-v0|-v1] device [block-count]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2019 | #define mkswap_full_usage \ |
| 2020 | "Prepare a disk partition to be used as a swap partition.\n\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 2021 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2022 | "\t-c\t\tCheck for read-ability\n" \ |
| 2023 | "\t-v0\t\tMake version 0 swap [max 128 Megs]\n" \ |
| 2024 | "\t-v1\t\tMake version 1 swap [big!] (default for kernels >\n\t\t\t2.1.117)\n" \ |
| 2025 | "\tblock-count\tNumber of block to use (default is entire partition)" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2026 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2027 | #define mktemp_trivial_usage \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 2028 | "[-dq] TEMPLATE" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2029 | #define mktemp_full_usage \ |
| 2030 | "Creates a temporary file with its name based on TEMPLATE.\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 2031 | "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX).\n\n" \ |
| 2032 | "Options:\n" \ |
| 2033 | "\t-d\t\tMake a directory instead of a file\n" \ |
| 2034 | "\t-q\t\tFail silently if an error occurs" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2035 | #define mktemp_example_usage \ |
| 2036 | "$ mktemp /tmp/temp.XXXXXX\n" \ |
| 2037 | "/tmp/temp.mWiLjM\n" \ |
| 2038 | "$ ls -la /tmp/temp.mWiLjM\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2039 | "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2040 | |
Eric Andersen | 8d79ce8 | 2001-07-22 23:00:15 +0000 | [diff] [blame] | 2041 | #define modprobe_trivial_usage \ |
Rob Landley | 9c32a15 | 2005-12-11 20:12:24 +0000 | [diff] [blame] | 2042 | "[-knqrsv] MODULE [symbol=value ...]" |
Eric Andersen | 8d79ce8 | 2001-07-22 23:00:15 +0000 | [diff] [blame] | 2043 | #define modprobe_full_usage \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 2044 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2045 | "\t-k\tMake module autoclean-able\n" \ |
| 2046 | "\t-n\tJust show what would be done\n" \ |
| 2047 | "\t-q\tQuiet output\n" \ |
| 2048 | "\t-r\tRemove module (stacks) or do autoclean\n" \ |
| 2049 | "\t-s\tReport via syslog instead of stderr\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 2050 | "\t-v\tVerbose output" |
Rob Landley | 9c32a15 | 2005-12-11 20:12:24 +0000 | [diff] [blame] | 2051 | #define modprobe_notes_usage \ |
| 2052 | "modprobe can (un)load a stack of modules, passing each module options (when\n" \ |
| 2053 | "loading). modprobe uses a configuration file to determine what option(s) to\n" \ |
| 2054 | "pass each module it loads.\n" \ |
| 2055 | "\n" \ |
| 2056 | "The configuration file is searched (in order) amongst:\n" \ |
| 2057 | "\n" \ |
| 2058 | " /etc/modprobe.conf (2.6 only)\n" \ |
| 2059 | " /etc/modules.conf\n" \ |
| 2060 | " /etc/conf.modules (deprecated)\n" \ |
| 2061 | "\n" \ |
| 2062 | "They all have the same syntax (see below). If none is present, it is\n" \ |
| 2063 | "_not_ an error; each loaded module is then expected to load without\n" \ |
| 2064 | "options. Once a file is found, the others are tested for.\n" \ |
| 2065 | "\n" \ |
| 2066 | "/etc/modules.conf entry format:\n" \ |
| 2067 | "\n" \ |
| 2068 | " alias <alias_name> <mod_name>\n" \ |
| 2069 | " Makes it possible to modprobe alias_name, when there is no such module.\n" \ |
| 2070 | " It makes sense if your mod_name is long, or you want a more reprenstative\n" \ |
| 2071 | " name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \ |
| 2072 | " This makes it also possible to use a different set of options (below) for\n" \ |
| 2073 | " the module and the alias.\n" \ |
| 2074 | " A module can be aliased more than once.\n" \ |
| 2075 | "\n" \ |
| 2076 | " options <mod_name|alias_name> <symbol=value ...>\n" \ |
| 2077 | " When loading module mod_name (or the module aliased by alias_name), pass\n" \ |
| 2078 | " the \"symbol=value\" pairs as option to that module.\n" \ |
| 2079 | "\n" \ |
| 2080 | "Sample /etc/modules.conf file:\n" \ |
| 2081 | "\n" \ |
| 2082 | " options tulip irq=3\n" \ |
| 2083 | " alias tulip tulip2\n" \ |
| 2084 | " options tulip2 irq=4 io=0x308\n" \ |
| 2085 | "\n" \ |
| 2086 | "Other functionality offered by 'classic' modprobe is not available in\n" \ |
| 2087 | "this implementation.\n" \ |
| 2088 | "\n" \ |
| 2089 | "If module options are present both in the config file, and on the command line,\n" \ |
| 2090 | "then the options from the command line will be passed to the module _after_\n" \ |
| 2091 | "the options from the config file. That way, you can have defaults in the config\n" \ |
| 2092 | "file, and override them for a specific usage from the command line.\n" |
Eric Andersen | 8d79ce8 | 2001-07-22 23:00:15 +0000 | [diff] [blame] | 2093 | #define modprobe_example_usage \ |
Rob Landley | 9c32a15 | 2005-12-11 20:12:24 +0000 | [diff] [blame] | 2094 | "(with the above /etc/modules.conf):\n\n" \ |
| 2095 | "$ modprobe tulip\n" \ |
| 2096 | " will load the module 'tulip' with default option 'irq=3'\n\n" \ |
| 2097 | "$ modprobe tulip irq=5\n" \ |
| 2098 | " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \ |
| 2099 | "$ modprobe tulip2\n" \ |
| 2100 | " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \ |
| 2101 | " which are the default for alias 'tulip2'\n\n" \ |
| 2102 | "$ modprobe tulip2 irq=8\n" \ |
| 2103 | " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \ |
| 2104 | " which are the default for alias 'tulip2' overriden by the option 'irq=8'\n\n" \ |
| 2105 | " from the command line\n\n" \ |
| 2106 | "$ modprobe tulip2 irq=2 io=0x210\n" \ |
| 2107 | " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \ |
| 2108 | " which are the default for alias 'tulip2' overriden by the options 'irq=2 io=0x210'\n\n" \ |
| 2109 | " from the command line\n" |
Eric Andersen | 8d79ce8 | 2001-07-22 23:00:15 +0000 | [diff] [blame] | 2110 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2111 | #define more_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2112 | "[FILE ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2113 | #define more_full_usage \ |
| 2114 | "More is a filter for viewing FILE one screenful at a time." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2115 | #define more_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2116 | "$ dmesg | more\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2117 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2118 | #ifdef CONFIG_FEATURE_MOUNT_LOOP |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2119 | # define USAGE_MOUNT_LOOP(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2120 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2121 | # define USAGE_MOUNT_LOOP(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2122 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2123 | #ifdef CONFIG_FEATURE_MTAB_SUPPORT |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2124 | # define USAGE_MTAB(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2125 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2126 | # define USAGE_MTAB(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2127 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2128 | #define mount_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2129 | "[flags] DEVICE NODE [-o options,more-options]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2130 | #define mount_full_usage \ |
Mike Frysinger | 29ed59e | 2006-01-04 00:04:08 +0000 | [diff] [blame] | 2131 | "Mount a filesystem. Filesystem autodetection requires /proc be mounted.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2132 | "Flags:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2133 | "\t-a:\t\tMount all filesystems in fstab\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 2134 | USAGE_MTAB( \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2135 | "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it\n" \ |
| 2136 | "\t-n:\t\tDon't write a mount table entry\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2137 | ) \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2138 | "\t-o option:\tOne of many filesystem options, listed below\n" \ |
| 2139 | "\t-r:\t\tMount the filesystem read-only\n" \ |
| 2140 | "\t-t fs-type:\tSpecify the filesystem type\n" \ |
| 2141 | "\t-w:\t\tMount for reading and writing (default)\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2142 | "\n" \ |
| 2143 | "Options for use with the \"-o\" flag:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2144 | "\tasync/sync:\tWrites are asynchronous / synchronous\n" \ |
| 2145 | "\tatime/noatime:\tEnable / disable updates to inode access times\n" \ |
| 2146 | "\tdev/nodev:\tAllow use of special device files / disallow them\n" \ |
| 2147 | "\texec/noexec:\tAllow use of executable files / disallow them\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 2148 | USAGE_MOUNT_LOOP( \ |
Rob Landley | 1d589b2 | 2005-11-29 23:47:10 +0000 | [diff] [blame] | 2149 | "\tloop:\t\t Ignored (loop devices are autodetected)\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2150 | ) \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2151 | "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them\n" \ |
| 2152 | "\tremount:\tRe-mount a mounted filesystem, changing its flags\n" \ |
| 2153 | "\tro/rw:\t\tMount for read-only / read-write\n" \ |
Rob Landley | 1d589b2 | 2005-11-29 23:47:10 +0000 | [diff] [blame] | 2154 | "\tbind:\t\tBind a directory to an additional location\n" \ |
| 2155 | "\tmove:\t\tRelocate an existing mount point.\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2156 | "\nThere are EVEN MORE flags that are specific to each filesystem\n" \ |
| 2157 | "You'll have to see the written documentation for those filesystems" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2158 | #define mount_example_usage \ |
| 2159 | "$ mount\n" \ |
| 2160 | "/dev/hda3 on / type minix (rw)\n" \ |
| 2161 | "proc on /proc type proc (rw)\n" \ |
| 2162 | "devpts on /dev/pts type devpts (rw)\n" \ |
| 2163 | "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \ |
Rob Landley | 1d589b2 | 2005-11-29 23:47:10 +0000 | [diff] [blame] | 2164 | "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \ |
| 2165 | "$ mount cd_image.iso mydir\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2166 | |
Rob Landley | d00b3a5 | 2005-08-20 05:07:08 +0000 | [diff] [blame] | 2167 | #define mountpoint_trivial_usage \ |
| 2168 | "[-q] <[-d] DIR | -x DEVICE>" |
| 2169 | #define mountpoint_full_usage \ |
| 2170 | "mountpoint checks if the directory is a mountpoint\n\n" \ |
| 2171 | "Options:\n" \ |
| 2172 | "\t-q:\t\tBe more quiet\n" \ |
| 2173 | "\t-d:\t\tPrint major/minor device number of the filesystem\n" \ |
| 2174 | "\t-x:\t\tPrint major/minor device number of the blockdevice" |
| 2175 | #define mountpoint_example_usage \ |
| 2176 | "$ mountpoint /proc\n" \ |
| 2177 | "/proc is not a mountpoint\n" \ |
| 2178 | "$ mountpoint /sys\n" \ |
| 2179 | "/sys is a mountpoint\n" |
| 2180 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2181 | #define mt_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2182 | "[-f device] opcode value" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2183 | #define mt_full_usage \ |
| 2184 | "Control magnetic tape drive operation\n" \ |
| 2185 | "\nAvailable Opcodes:\n\n" \ |
| 2186 | "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \ |
| 2187 | "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \ |
Eric Andersen | 92fb939 | 2003-08-08 20:09:03 +0000 | [diff] [blame] | 2188 | "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2189 | "setpart tell unload unlock weof wset" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2190 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2191 | #define mv_trivial_usage \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 2192 | "[OPTION]... SOURCE DEST\n" \ |
| 2193 | "or: mv [OPTION]... SOURCE... DIRECTORY" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2194 | #define mv_full_usage \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 2195 | "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.\n\n" \ |
| 2196 | "Options:\n" \ |
| 2197 | "\t-f\tdon't prompt before overwriting\n" \ |
| 2198 | "\t-i\tinteractive, prompt before overwrite" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2199 | #define mv_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2200 | "$ mv /tmp/foo /bin/bar\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2201 | |
Glenn L McGrath | f03c933 | 2002-12-13 00:01:44 +0000 | [diff] [blame] | 2202 | #define nameif_trivial_usage \ |
Glenn L McGrath | a9adef0 | 2003-01-19 13:34:21 +0000 | [diff] [blame] | 2203 | "[-s] [-c FILE] [{IFNAME MACADDR}]" |
Glenn L McGrath | f03c933 | 2002-12-13 00:01:44 +0000 | [diff] [blame] | 2204 | #define nameif_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2205 | "Nameif renaming network interface while it in the down state.\n\n" \ |
| 2206 | "Options:\n" \ |
| 2207 | "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2208 | "\t-s\t\tUse syslog (LOCAL0 facility)\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2209 | "\tIFNAME MACADDR\tnew_interface_name interface_mac_address" |
Glenn L McGrath | f03c933 | 2002-12-13 00:01:44 +0000 | [diff] [blame] | 2210 | #define nameif_example_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2211 | "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \ |
| 2212 | " or\n" \ |
| 2213 | "$ nameif -c /etc/my_mactab_file\n" \ |
Glenn L McGrath | f03c933 | 2002-12-13 00:01:44 +0000 | [diff] [blame] | 2214 | |
Mike Frysinger | 7dc7f40 | 2005-05-06 05:00:34 +0000 | [diff] [blame] | 2215 | #ifdef CONFIG_NC_GAPING_SECURITY_HOLE |
| 2216 | # define USAGE_NC_EXEC(a) a |
| 2217 | #else |
| 2218 | # define USAGE_NC_EXEC(a) |
| 2219 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2220 | #define nc_trivial_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2221 | "[OPTIONS] [IP] [port]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2222 | #define nc_full_usage \ |
Eric Andersen | 00a6a75 | 2002-04-26 23:53:10 +0000 | [diff] [blame] | 2223 | "Netcat opens a pipe to IP:port\n\n" \ |
| 2224 | "Options:\n" \ |
| 2225 | "\t-l\t\tlisten mode, for inbound connects\n" \ |
| 2226 | "\t-p PORT\t\tlocal port number\n" \ |
Eric Andersen | 1323c94 | 2002-04-26 23:59:12 +0000 | [diff] [blame] | 2227 | "\t-i SECS\t\tdelay interval for lines sent\n" \ |
Mike Frysinger | 7dc7f40 | 2005-05-06 05:00:34 +0000 | [diff] [blame] | 2228 | USAGE_NC_EXEC( \ |
| 2229 | "\t-e PROG\t\tprogram to exec after connect (dangerous!)\n" \ |
| 2230 | ) \ |
| 2231 | "\t-w SECS\t\ttimeout for connects and final net reads" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2232 | #define nc_example_usage \ |
| 2233 | "$ nc foobar.somedomain.com 25\n" \ |
| 2234 | "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \ |
| 2235 | "help\n" \ |
| 2236 | "214-Commands supported:\n" \ |
| 2237 | "214- HELO EHLO MAIL RCPT DATA AUTH\n" \ |
| 2238 | "214 NOOP QUIT RSET HELP\n" \ |
| 2239 | "quit\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2240 | "221 foobar closing connection\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2241 | |
Eric Andersen | 1552ff7 | 2001-10-31 11:07:12 +0000 | [diff] [blame] | 2242 | #define netstat_trivial_usage \ |
Robert Griebl | 8187bb4 | 2002-05-14 23:10:58 +0000 | [diff] [blame] | 2243 | "[-laenrtuwx]" |
Eric Andersen | 1552ff7 | 2001-10-31 11:07:12 +0000 | [diff] [blame] | 2244 | #define netstat_full_usage \ |
Eric Andersen | a151d19 | 2004-04-06 17:16:36 +0000 | [diff] [blame] | 2245 | "Netstat displays Linux networking information.\n\n" \ |
| 2246 | "Options:\n" \ |
| 2247 | "\t-l display listening server sockets\n" \ |
| 2248 | "\t-a display all sockets (default: connected)\n" \ |
| 2249 | "\t-e display other/more information\n" \ |
| 2250 | "\t-n don't resolve names\n" \ |
| 2251 | "\t-r display routing table\n" \ |
| 2252 | "\t-t tcp sockets\n" \ |
| 2253 | "\t-u udp sockets\n" \ |
| 2254 | "\t-w raw sockets\n" \ |
| 2255 | "\t-x unix sockets" |
Eric Andersen | 1552ff7 | 2001-10-31 11:07:12 +0000 | [diff] [blame] | 2256 | |
Manuel Novoa III | 2c51160 | 2005-02-13 20:14:05 +0000 | [diff] [blame] | 2257 | #define nice_trivial_usage \ |
| 2258 | "[-n ADJUST] [COMMAND [ARG] ...]" |
| 2259 | #define nice_full_usage \ |
| 2260 | "Nice runs a program with modified scheduling priority.\n\n" \ |
| 2261 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2262 | "\t-n ADJUST\tAdjust the scheduling priority by ADJUST" |
Manuel Novoa III | 2c51160 | 2005-02-13 20:14:05 +0000 | [diff] [blame] | 2263 | |
Bernhard Reutner-Fischer | 9d7010c | 2005-09-21 18:25:05 +0000 | [diff] [blame] | 2264 | #define nohup_trivial_usage \ |
| 2265 | "COMMAND [ARGS]" |
| 2266 | #define nohup_full_usage \ |
| 2267 | "run a command immune to hangups, with output to a non-tty" |
| 2268 | #define nohup_example_usage \ |
| 2269 | "$ nohup make &" |
| 2270 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2271 | #define nslookup_trivial_usage \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 2272 | "[HOST] [SERVER]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2273 | #define nslookup_full_usage \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 2274 | "Queries the nameserver for the IP address of the given HOST\n" \ |
| 2275 | "optionally using a specified DNS server" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2276 | #define nslookup_example_usage \ |
| 2277 | "$ nslookup localhost\n" \ |
| 2278 | "Server: default\n" \ |
| 2279 | "Address: default\n" \ |
| 2280 | "\n" \ |
| 2281 | "Name: debian\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2282 | "Address: 127.0.0.1\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2283 | |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 2284 | #define od_trivial_usage \ |
| 2285 | "[-aBbcDdeFfHhIiLlOovXx] [FILE]" |
| 2286 | #define od_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2287 | "Write an unambiguous representation, octal bytes by default, of FILE\n" \ |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 2288 | "to standard output. With no FILE, or when FILE is -, read standard input." |
| 2289 | |
Glenn L McGrath | ec0c48c | 2002-09-16 03:16:06 +0000 | [diff] [blame] | 2290 | #define openvt_trivial_usage \ |
| 2291 | "<vtnum> <COMMAND> [ARGS...]" |
| 2292 | #define openvt_full_usage \ |
| 2293 | "Start a command on a new virtual terminal" |
| 2294 | #define openvt_example_usage \ |
| 2295 | "openvt 2 /bin/ash\n" |
| 2296 | |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 2297 | #ifdef CONFIG_FEATURE_SHA1_PASSWORDS |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2298 | # define PASSWORD_ALG_TYPES(a) a |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2299 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2300 | # define PASSWORD_ALG_TYPES(a) |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 2301 | #endif |
| 2302 | #define passwd_trivial_usage \ |
| 2303 | "[OPTION] [name]" |
| 2304 | #define passwd_full_usage \ |
Eric Andersen | c38678d | 2002-09-16 06:22:25 +0000 | [diff] [blame] | 2305 | "Change a user password. If no name is specified,\n" \ |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 2306 | "changes the password for the current user.\n" \ |
| 2307 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2308 | "\t-a\tDefine which algorithm shall be used for the password\n" \ |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 2309 | "\t\t\t(Choices: des, md5" \ |
Eric Andersen | 7f90ed4 | 2002-07-03 05:55:14 +0000 | [diff] [blame] | 2310 | PASSWORD_ALG_TYPES(", sha1") \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2311 | ")\n\t-d\tDelete the password for the specified user account\n" \ |
| 2312 | "\t-l\tLocks (disables) the specified user account\n" \ |
| 2313 | "\t-u\tUnlocks (re-enables) the specified user account" |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 2314 | |
Glenn L McGrath | 655d814 | 2003-06-22 15:32:41 +0000 | [diff] [blame] | 2315 | #define patch_trivial_usage \ |
Rob Landley | 078bacf | 2005-09-01 03:02:23 +0000 | [diff] [blame] | 2316 | "[-p<num>] [-i<patch.diff>]" |
Glenn L McGrath | 655d814 | 2003-06-22 15:32:41 +0000 | [diff] [blame] | 2317 | #define patch_full_usage \ |
Rob Landley | 078bacf | 2005-09-01 03:02:23 +0000 | [diff] [blame] | 2318 | "[-p<num>]\n" \ |
| 2319 | "[-i<diff>]" |
Glenn L McGrath | 655d814 | 2003-06-22 15:32:41 +0000 | [diff] [blame] | 2320 | #define patch_example_usage \ |
Rob Landley | 078bacf | 2005-09-01 03:02:23 +0000 | [diff] [blame] | 2321 | "$ patch -p1 <example.diff\n" \ |
| 2322 | "$ patch -p0 -i example.diff" |
Glenn L McGrath | 655d814 | 2003-06-22 15:32:41 +0000 | [diff] [blame] | 2323 | |
Bernhard Reutner-Fischer | 81c3a51 | 2005-10-06 15:37:02 +0000 | [diff] [blame] | 2324 | #if ENABLE_FEATURE_PIDOF_SINGLE |
| 2325 | #define USAGE_FEATURE_PIDOF_SINGLE(a) a |
| 2326 | #else |
| 2327 | #define USAGE_FEATURE_PIDOF_SINGLE(a) |
| 2328 | #endif |
| 2329 | #if ENABLE_FEATURE_PIDOF_OMIT |
| 2330 | #define USAGE_FEATURE_PIDOF_OMIT(a) a |
| 2331 | #else |
| 2332 | #define USAGE_FEATURE_PIDOF_OMIT(a) |
| 2333 | #endif |
| 2334 | #if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT) |
| 2335 | #define USAGE_PIDOF "Options:" |
| 2336 | #else |
| 2337 | #define USAGE_PIDOF "\n\tThis version of pidof accepts no options." |
| 2338 | #endif |
| 2339 | |
Eric Andersen | 221b2ea | 2001-07-31 19:06:07 +0000 | [diff] [blame] | 2340 | #define pidof_trivial_usage \ |
Glenn L McGrath | c0dd26f | 2004-07-23 06:06:21 +0000 | [diff] [blame] | 2341 | "process-name [OPTION] [process-name ...]" |
Bernhard Reutner-Fischer | 81c3a51 | 2005-10-06 15:37:02 +0000 | [diff] [blame] | 2342 | |
Eric Andersen | 221b2ea | 2001-07-31 19:06:07 +0000 | [diff] [blame] | 2343 | #define pidof_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2344 | "Lists the PIDs of all processes with names that match the\n" \ |
Glenn L McGrath | c0dd26f | 2004-07-23 06:06:21 +0000 | [diff] [blame] | 2345 | "names on the command line.\n" \ |
Bernhard Reutner-Fischer | 81c3a51 | 2005-10-06 15:37:02 +0000 | [diff] [blame] | 2346 | USAGE_PIDOF \ |
| 2347 | USAGE_FEATURE_PIDOF_SINGLE("\n\t-s\t\tdisplay only a single PID") \ |
| 2348 | USAGE_FEATURE_PIDOF_OMIT("\n\t-o\t\tomit given pid.") \ |
| 2349 | USAGE_FEATURE_PIDOF_OMIT("\n\t\t\tUse %PPID to omit the parent pid of pidof itself") |
Eric Andersen | 221b2ea | 2001-07-31 19:06:07 +0000 | [diff] [blame] | 2350 | #define pidof_example_usage \ |
| 2351 | "$ pidof init\n" \ |
Bernhard Reutner-Fischer | 81c3a51 | 2005-10-06 15:37:02 +0000 | [diff] [blame] | 2352 | "1\n" \ |
| 2353 | USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh\n20351 5973 5950\n") \ |
| 2354 | USAGE_FEATURE_PIDOF_OMIT("$ pidof /bin/sh -o %PPID\n20351 5950") |
Eric Andersen | 221b2ea | 2001-07-31 19:06:07 +0000 | [diff] [blame] | 2355 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2356 | #ifndef CONFIG_FEATURE_FANCY_PING |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2357 | #define ping_trivial_usage "host" |
| 2358 | #define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts" |
| 2359 | #else |
| 2360 | #define ping_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2361 | "[OPTION]... host" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2362 | #define ping_full_usage \ |
| 2363 | "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \ |
| 2364 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2365 | "\t-c COUNT\tSend only COUNT pings\n" \ |
| 2366 | "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2367 | "\t-q\t\tQuiet mode, only displays output at start\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2368 | "\t\t\tand when finished" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2369 | #endif |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2370 | #define ping_example_usage \ |
| 2371 | "$ ping localhost\n" \ |
| 2372 | "PING slag (127.0.0.1): 56 data bytes\n" \ |
| 2373 | "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \ |
| 2374 | "\n" \ |
| 2375 | "--- debian ping statistics ---\n" \ |
| 2376 | "1 packets transmitted, 1 packets received, 0% packet loss\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2377 | "round-trip min/avg/max = 20.1/20.1/20.1 ms\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2378 | |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 2379 | #ifndef CONFIG_FEATURE_FANCY_PING6 |
| 2380 | #define ping6_trivial_usage "host" |
| 2381 | #define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts" |
| 2382 | #else |
| 2383 | #define ping6_trivial_usage \ |
| 2384 | "[OPTION]... host" |
| 2385 | #define ping6_full_usage \ |
| 2386 | "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \ |
| 2387 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2388 | "\t-c COUNT\tSend only COUNT pings\n" \ |
| 2389 | "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56)\n" \ |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 2390 | "\t-q\t\tQuiet mode, only displays output at start\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2391 | "\t\t\tand when finished" |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 2392 | #endif |
| 2393 | #define ping6_example_usage \ |
| 2394 | "$ ping6 ip6-localhost\n" \ |
| 2395 | "PING ip6-localhost (::1): 56 data bytes\n" \ |
| 2396 | "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \ |
| 2397 | "\n" \ |
| 2398 | "--- ip6-localhost ping statistics ---\n" \ |
| 2399 | "1 packets transmitted, 1 packets received, 0% packet loss\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2400 | "round-trip min/avg/max = 20.1/20.1/20.1 ms\n" |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 2401 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2402 | #define pivot_root_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2403 | "NEW_ROOT PUT_OLD" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2404 | #define pivot_root_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2405 | "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2406 | "the new root file system." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2407 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2408 | #define poweroff_trivial_usage \ |
Rob Landley | 6461291 | 2006-01-30 08:31:37 +0000 | [diff] [blame] | 2409 | "[-d<delay>] [-n<nosync>] [-f<force>]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2410 | #define poweroff_full_usage \ |
Rob Landley | 6461291 | 2006-01-30 08:31:37 +0000 | [diff] [blame] | 2411 | "Halt and shut off power.\n" \ |
Glenn L McGrath | c0dd26f | 2004-07-23 06:06:21 +0000 | [diff] [blame] | 2412 | "Options:\n" \ |
Rob Landley | 6461291 | 2006-01-30 08:31:37 +0000 | [diff] [blame] | 2413 | "\t-d\t\tdelay interval for halting\n" \ |
| 2414 | "\t-n\t\tno call to sync()\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 2415 | "\t-f\t\tforce power off (don't go through init)" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2416 | |
Mike Frysinger | 95d3c45 | 2005-04-21 23:29:24 +0000 | [diff] [blame] | 2417 | #define printenv_trivial_usage \ |
| 2418 | "[VARIABLES...]" |
| 2419 | #define printenv_full_usage \ |
| 2420 | "print all or part of environment\n\n" \ |
| 2421 | "If no environment VARIABLE specified, print them all." |
| 2422 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2423 | #define printf_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2424 | "FORMAT [ARGUMENT...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2425 | #define printf_full_usage \ |
| 2426 | "Formats and prints ARGUMENT(s) according to FORMAT,\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2427 | "Where FORMAT controls the output exactly as in C printf." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2428 | #define printf_example_usage \ |
Mike Frysinger | 5c63a72 | 2005-04-16 04:23:58 +0000 | [diff] [blame] | 2429 | "$ printf \"Val=%d\\n\" 5\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2430 | "Val=5\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2431 | |
Bernhard Reutner-Fischer | 6d6a40c | 2005-10-04 14:31:18 +0000 | [diff] [blame] | 2432 | #if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE |
Rob Landley | 6eb1e41 | 2005-06-20 04:30:36 +0000 | [diff] [blame] | 2433 | #define USAGE_PS "\n\tThis version of ps accepts no options." |
| 2434 | #else |
| 2435 | #define USAGE_PS "\nOptions:" |
| 2436 | #endif |
Bernhard Reutner-Fischer | 6d6a40c | 2005-10-04 14:31:18 +0000 | [diff] [blame] | 2437 | #if ENABLE_FEATURE_PS_WIDE |
Rob Landley | 6eb1e41 | 2005-06-20 04:30:36 +0000 | [diff] [blame] | 2438 | #define USAGE_PS_WIDE(a) a |
| 2439 | #else |
| 2440 | #define USAGE_PS_WIDE(a) |
| 2441 | #endif |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 2442 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2443 | #define ps_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2444 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2445 | #define ps_full_usage \ |
| 2446 | "Report process status\n" \ |
Rob Landley | 6eb1e41 | 2005-06-20 04:30:36 +0000 | [diff] [blame] | 2447 | USAGE_PS \ |
| 2448 | USAGE_SELINUX("\n\t-c\tshow SE Linux context") \ |
| 2449 | USAGE_PS_WIDE("\n\tw\twide output") |
| 2450 | |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2451 | #define ps_example_usage \ |
| 2452 | "$ ps\n" \ |
| 2453 | " PID Uid Gid State Command\n" \ |
| 2454 | " 1 root root S init\n" \ |
| 2455 | " 2 root root S [kflushd]\n" \ |
| 2456 | " 3 root root S [kupdate]\n" \ |
| 2457 | " 4 root root S [kpiod]\n" \ |
| 2458 | " 5 root root S [kswapd]\n" \ |
| 2459 | " 742 andersen andersen S [bash]\n" \ |
| 2460 | " 743 andersen andersen S -bash\n" \ |
| 2461 | " 745 root root S [getty]\n" \ |
| 2462 | " 2990 andersen andersen R ps\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2463 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2464 | #define pwd_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2465 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2466 | #define pwd_full_usage \ |
| 2467 | "Print the full filename of the current working directory." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2468 | #define pwd_example_usage \ |
| 2469 | "$ pwd\n" \ |
| 2470 | "/root\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2471 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2472 | #define rdate_trivial_usage \ |
Eric Andersen | 725db19 | 2003-07-22 08:26:05 +0000 | [diff] [blame] | 2473 | "[-sp] HOST" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2474 | #define rdate_full_usage \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 2475 | "Get and possibly set the system date and time from a remote HOST.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2476 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2477 | "\t-s\tSet the system date and time (default)\n" \ |
| 2478 | "\t-p\tPrint the date and time" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2479 | |
Ned Ludd | c6fbed5 | 2004-12-08 16:47:28 +0000 | [diff] [blame] | 2480 | #ifdef CONFIG_FEATURE_READLINK_FOLLOW |
| 2481 | #define USAGE_READLINK_FOLLOW(a) a |
| 2482 | #else |
| 2483 | #define USAGE_READLINK_FOLLOW(a) |
| 2484 | #endif |
| 2485 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2486 | #define readlink_trivial_usage \ |
Ned Ludd | c6fbed5 | 2004-12-08 16:47:28 +0000 | [diff] [blame] | 2487 | USAGE_READLINK_FOLLOW("[-f] ") "FILE" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2488 | #define readlink_full_usage \ |
Ned Ludd | c6fbed5 | 2004-12-08 16:47:28 +0000 | [diff] [blame] | 2489 | "Displays the value of a symbolic link." \ |
| 2490 | USAGE_READLINK_FOLLOW("\n\nOptions:\n" \ |
| 2491 | "\t-f\tcanonicalize by following all symlinks") |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2492 | |
Paul Mundt | 8b2d02e | 2005-05-20 17:22:18 +0000 | [diff] [blame] | 2493 | #define readprofile_trivial_usage \ |
| 2494 | "[OPTIONS]..." |
| 2495 | #define readprofile_full_usage \ |
| 2496 | "Options:\n" \ |
| 2497 | "\t -m <mapfile> (default: /boot/System.map)\n" \ |
| 2498 | "\t -p <profile> (default: /proc/profile)\n" \ |
| 2499 | "\t -M <mult> set the profiling multiplier to <mult>\n" \ |
| 2500 | "\t -i print only info about the sampling step\n" \ |
| 2501 | "\t -v print verbose data\n" \ |
| 2502 | "\t -a print all symbols, even if count is 0\n" \ |
| 2503 | "\t -b print individual histogram-bin counts\n" \ |
| 2504 | "\t -s print individual counters within functions\n" \ |
| 2505 | "\t -r reset all the counters (root only)\n" \ |
| 2506 | "\t -n disable byte order auto-detection" |
| 2507 | |
Glenn L McGrath | 62fae30 | 2002-12-10 00:14:33 +0000 | [diff] [blame] | 2508 | #define realpath_trivial_usage \ |
| 2509 | "pathname ..." |
| 2510 | #define realpath_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2511 | "Returns the absolute pathnames of given argument." |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2512 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2513 | #define reboot_trivial_usage \ |
Rob Landley | 6461291 | 2006-01-30 08:31:37 +0000 | [diff] [blame] | 2514 | "[-d<delay>] [-n<nosync>] [-f<force>]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2515 | #define reboot_full_usage \ |
Glenn L McGrath | 72b14a8 | 2004-07-23 03:33:38 +0000 | [diff] [blame] | 2516 | "Reboot the system.\n" \ |
| 2517 | "Options:\n" \ |
Rob Landley | 6461291 | 2006-01-30 08:31:37 +0000 | [diff] [blame] | 2518 | "\t-d\t\tdelay interval for rebooting\n" \ |
| 2519 | "\t-n\t\tno call to sync()\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 2520 | "\t-f\t\tforce reboot (don't go through init)" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2521 | |
| 2522 | #define renice_trivial_usage \ |
Manuel Novoa III | 2c51160 | 2005-02-13 20:14:05 +0000 | [diff] [blame] | 2523 | "{{-n INCREMENT} | PRIORITY} [[ -p | -g | -u ] ID ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2524 | #define renice_full_usage \ |
Manuel Novoa III | 2c51160 | 2005-02-13 20:14:05 +0000 | [diff] [blame] | 2525 | "Changes priority of running processes.\n\n" \ |
| 2526 | "Options:\n" \ |
| 2527 | "\t-n\tadjusts current nice value (smaller is faster)\n" \ |
| 2528 | "\t-p\tprocess id(s) (default)\n" \ |
| 2529 | "\t-g\tprocess group id(s)\n" \ |
| 2530 | "\t-u\tprocess user name(s) and/or id(s)" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2531 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2532 | #define reset_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2533 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2534 | #define reset_full_usage \ |
| 2535 | "Resets the screen." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2536 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2537 | #define rm_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2538 | "[OPTION]... FILE..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2539 | #define rm_full_usage \ |
| 2540 | "Remove (unlink) the FILE(s). You may use '--' to\n" \ |
| 2541 | "indicate that all following arguments are non-options.\n\n" \ |
| 2542 | "Options:\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2543 | "\t-i\t\talways prompt before removing each destination\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2544 | "\t-f\t\tremove existing destinations, never prompt\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2545 | "\t-r or -R\tremove the contents of directories recursively" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2546 | #define rm_example_usage \ |
| 2547 | "$ rm -rf /tmp/foo\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2548 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2549 | #define rmdir_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2550 | "[OPTION]... DIRECTORY..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2551 | #define rmdir_full_usage \ |
| 2552 | "Remove the DIRECTORY(ies), if they are empty." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2553 | #define rmdir_example_usage \ |
| 2554 | "# rmdir /tmp/foo\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2555 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2556 | #define rmmod_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2557 | "[OPTION]... [MODULE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2558 | #define rmmod_full_usage \ |
| 2559 | "Unloads the specified kernel modules from the kernel.\n\n" \ |
| 2560 | "Options:\n" \ |
Tim Riker | cf93274 | 2002-12-14 01:58:59 +0000 | [diff] [blame] | 2561 | "\t-a\tRemove all unused modules (recursively)" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2562 | #define rmmod_example_usage \ |
| 2563 | "$ rmmod tulip\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2564 | |
Manuel Novoa III | 7d0c519 | 2004-03-10 07:42:38 +0000 | [diff] [blame] | 2565 | #ifdef CONFIG_FEATURE_IPV6 |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2566 | # define USAGE_ROUTE_IPV6(a) a |
Manuel Novoa III | 7d0c519 | 2004-03-10 07:42:38 +0000 | [diff] [blame] | 2567 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2568 | # define USAGE_ROUTE_IPV6(a) "\t" |
Manuel Novoa III | 7d0c519 | 2004-03-10 07:42:38 +0000 | [diff] [blame] | 2569 | #endif |
| 2570 | |
| 2571 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2572 | #define route_trivial_usage \ |
Manuel Novoa III | 7d0c519 | 2004-03-10 07:42:38 +0000 | [diff] [blame] | 2573 | "[{add|del|delete}]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2574 | #define route_full_usage \ |
Matt Kraai | 9758e7d | 2002-01-03 17:32:29 +0000 | [diff] [blame] | 2575 | "Edit the kernel's routing tables.\n\n" \ |
Eric Andersen | fb74a45 | 2001-12-18 14:06:03 +0000 | [diff] [blame] | 2576 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2577 | "\t-n\t\tDont resolve names\n" \ |
| 2578 | "\t-e\t\tDisplay other/more information\n" \ |
| 2579 | "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2580 | |
Glenn L McGrath | b72a735 | 2002-12-10 00:17:22 +0000 | [diff] [blame] | 2581 | #define rpm_trivial_usage \ |
| 2582 | "-i -q[ildc]p package.rpm" |
| 2583 | #define rpm_full_usage \ |
| 2584 | "Manipulates RPM packages" \ |
Eric Andersen | dfce353 | 2003-06-15 07:00:54 +0000 | [diff] [blame] | 2585 | "\n\nOptions:" \ |
| 2586 | "\n\t-i Install package" \ |
| 2587 | "\n\t-q Query package" \ |
| 2588 | "\n\t-p Query uninstalled package" \ |
| 2589 | "\n\t-i Show information" \ |
| 2590 | "\n\t-l List contents" \ |
| 2591 | "\n\t-d List documents" \ |
| 2592 | "\n\t-c List config files" |
Glenn L McGrath | b72a735 | 2002-12-10 00:17:22 +0000 | [diff] [blame] | 2593 | |
Glenn L McGrath | f8736d2 | 2001-06-26 01:19:34 +0000 | [diff] [blame] | 2594 | #define rpm2cpio_trivial_usage \ |
| 2595 | "package.rpm" |
| 2596 | #define rpm2cpio_full_usage \ |
| 2597 | "Outputs a cpio archive of the rpm file." |
| 2598 | |
Eric Andersen | 6cf47a7 | 2001-10-31 10:24:36 +0000 | [diff] [blame] | 2599 | #define run_parts_trivial_usage \ |
| 2600 | "[-t] [-a ARG] [-u MASK] DIRECTORY" |
| 2601 | #define run_parts_full_usage \ |
| 2602 | "Run a bunch of scripts in a directory.\n\n" \ |
| 2603 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2604 | "\t-t\tPrints what would be run, but does not actually run anything\n" \ |
| 2605 | "\t-a ARG\tPass ARG as an argument for every program invoked\n" \ |
| 2606 | "\t-u MASK\tSet the umask to MASK before executing every program" |
Eric Andersen | 6cf47a7 | 2001-10-31 10:24:36 +0000 | [diff] [blame] | 2607 | |
Bernhard Reutner-Fischer | 62d7acc | 2005-10-28 20:37:03 +0000 | [diff] [blame] | 2608 | #define runlevel_trivial_usage \ |
| 2609 | "[utmp]" |
| 2610 | #define runlevel_full_usage \ |
| 2611 | "Find the current and previous system runlevel.\n\n" \ |
| 2612 | "If no utmp file exists or if no runlevel record can be found,\n" \ |
| 2613 | "runlevel prints \"unknown\"" |
| 2614 | #define runlevel_example_usage \ |
| 2615 | "$ runlevel /var/run/utmp\n" \ |
| 2616 | "N 2" |
Bernhard Reutner-Fischer | 62d7acc | 2005-10-28 20:37:03 +0000 | [diff] [blame] | 2617 | |
Glenn L McGrath | 8f3bc4c | 2003-12-20 07:30:35 +0000 | [diff] [blame] | 2618 | #define rx_trivial_usage \ |
| 2619 | "FILE" |
| 2620 | #define rx_full_usage \ |
| 2621 | "Receive a file using the xmodem protocol." |
| 2622 | #define rx_example_usage \ |
| 2623 | "$ rx /tmp/foo\n" |
| 2624 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2625 | #define sed_trivial_usage \ |
Rob Landley | 1ce5968 | 2004-05-26 21:59:31 +0000 | [diff] [blame] | 2626 | "[-efinr] pattern [files...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2627 | #define sed_full_usage \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 2628 | "Options:\n" \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 2629 | "\t-e script\tadd the script to the commands to be executed\n" \ |
Eric Andersen | f802ff7 | 2004-04-12 15:12:06 +0000 | [diff] [blame] | 2630 | "\t-f scriptfile\tadd script-file contents to the\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2631 | "\t\t\tcommands to be executed\n" \ |
Rob Landley | 1ce5968 | 2004-05-26 21:59:31 +0000 | [diff] [blame] | 2632 | "\t-i\t\tedit files in-place\n" \ |
| 2633 | "\t-n\t\tsuppress automatic printing of pattern space\n" \ |
Rob Landley | 58b118a | 2004-05-26 22:09:37 +0000 | [diff] [blame] | 2634 | "\t-r\t\tuse extended regular expression syntax\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2635 | "\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2636 | "If no -e or -f is given, the first non-option argument is taken as the sed\n" \ |
| 2637 | "script to interpret. All remaining arguments are names of input files; if no\n" \ |
Eric Andersen | f802ff7 | 2004-04-12 15:12:06 +0000 | [diff] [blame] | 2638 | "input files are specified, then the standard input is read. Source files\n" \ |
| 2639 | "will not be modified unless -i option is given." |
| 2640 | |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2641 | #define sed_example_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2642 | "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2643 | "bar\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2644 | |
Glenn L McGrath | 82364bb | 2004-01-27 09:22:20 +0000 | [diff] [blame] | 2645 | #define seq_trivial_usage \ |
| 2646 | "[first [increment]] last" |
| 2647 | #define seq_full_usage \ |
| 2648 | "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \ |
| 2649 | "FIRST, INCREMENT default to 1\n" \ |
| 2650 | "Arguments:\n" \ |
| 2651 | "\tLAST\n" \ |
| 2652 | "\tFIRST\tLAST\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2653 | "\tFIRST\tINCREMENT\tLAST" |
Glenn L McGrath | 82364bb | 2004-01-27 09:22:20 +0000 | [diff] [blame] | 2654 | |
Paul Fox | fc2256a | 2005-08-01 18:12:30 +0000 | [diff] [blame] | 2655 | #define setconsole_trivial_usage \ |
| 2656 | "[-r|--reset] [DEVICE]" |
| 2657 | #define setconsole_full_usage \ |
| 2658 | "Redirects system console output to DEVICE (default: /dev/tty).\n\n" \ |
| 2659 | "Options:\n" \ |
| 2660 | "\t-r\tReset output to /dev/console." |
| 2661 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2662 | #define setkeycodes_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2663 | "SCANCODE KEYCODE ..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2664 | #define setkeycodes_full_usage \ |
| 2665 | "Set entries into the kernel's scancode-to-keycode map,\n" \ |
| 2666 | "allowing unusual keyboards to generate usable keycodes.\n\n" \ |
| 2667 | "SCANCODE may be either xx or e0xx (hexadecimal),\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2668 | "and KEYCODE is given in decimal" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2669 | #define setkeycodes_example_usage \ |
| 2670 | "$ setkeycodes e030 127\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2671 | |
Rob Landley | 87848d9 | 2006-03-27 23:23:43 +0000 | [diff] [blame] | 2672 | #define setlogcons_trivial_usage \ |
| 2673 | "N" |
| 2674 | #define setlogcons_full_usage \ |
| 2675 | "Redirects the kernel output to console N (0 for current)." |
| 2676 | |
Paul Fox | 4240364 | 2005-08-01 22:52:09 +0000 | [diff] [blame] | 2677 | #define setsid_trivial_usage \ |
| 2678 | "program [arg ...]" |
| 2679 | #define setsid_full_usage \ |
| 2680 | "Runs any program in a new session by calling setsid() before\n" \ |
| 2681 | "exec'ing the rest of its arguments. See setsid(2) for details." |
| 2682 | |
Matt Kraai | 2d91deb | 2001-08-01 17:21:35 +0000 | [diff] [blame] | 2683 | #define lash_trivial_usage \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 2684 | "[FILE]...\n" \ |
| 2685 | "or: sh -c command [args]..." |
Matt Kraai | 2d91deb | 2001-08-01 17:21:35 +0000 | [diff] [blame] | 2686 | #define lash_full_usage \ |
Eric Andersen | 2e9c257 | 2003-08-08 22:26:06 +0000 | [diff] [blame] | 2687 | "The BusyBox LAme SHell (command interpreter)" |
Matt Kraai | 2d91deb | 2001-08-01 17:21:35 +0000 | [diff] [blame] | 2688 | #define lash_notes_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2689 | "This command does not yet have proper documentation.\n\n" \ |
| 2690 | "Use lash just as you would use any other shell. It properly handles pipes,\n" \ |
| 2691 | "redirects, job control, can be used as the shell for scripts, and has a\n" \ |
| 2692 | "sufficient set of builtins to do what is needed. It does not (yet) support\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2693 | "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2694 | "use ash or bash. If you just need a very simple and extremely small shell,\n" \ |
| 2695 | "this will do the job." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2696 | |
Eric Andersen | 2e9c257 | 2003-08-08 22:26:06 +0000 | [diff] [blame] | 2697 | #define last_trivial_usage \ |
| 2698 | "" |
| 2699 | #define last_full_usage \ |
| 2700 | "Shows listing of the last users that logged into the system" |
| 2701 | |
Glenn L McGrath | ae0f1e7 | 2003-02-17 08:23:22 +0000 | [diff] [blame] | 2702 | #define sha1sum_trivial_usage \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 2703 | "[OPTION] [FILEs...]" \ |
| 2704 | USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]") |
Glenn L McGrath | ae0f1e7 | 2003-02-17 08:23:22 +0000 | [diff] [blame] | 2705 | #define sha1sum_full_usage \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 2706 | "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \ |
| 2707 | "Options:\n" \ |
Glenn L McGrath | c83e3a6 | 2003-12-04 13:06:44 +0000 | [diff] [blame] | 2708 | "With no FILE, or when FILE is -, read standard input." \ |
| 2709 | USAGE_MD5_SHA1_SUM_CHECK("\n\n" \ |
| 2710 | "\t-c\tcheck SHA1 sums against given list\n" \ |
| 2711 | "\nThe following two options are useful only when verifying checksums:\n" \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 2712 | "\t-s\tdon't output anything, status code shows success\n" \ |
Glenn L McGrath | c83e3a6 | 2003-12-04 13:06:44 +0000 | [diff] [blame] | 2713 | "\t-w\twarn about improperly formated SHA1 checksum lines") |
Glenn L McGrath | ae0f1e7 | 2003-02-17 08:23:22 +0000 | [diff] [blame] | 2714 | |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2715 | #ifdef CONFIG_FEATURE_FANCY_SLEEP |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2716 | # define USAGE_FANCY_SLEEP(a) a |
| 2717 | # define USAGE_NOT_FANCY_SLEEP(a) |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2718 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2719 | # define USAGE_FANCY_SLEEP(a) |
| 2720 | # define USAGE_NOT_FANCY_SLEEP(a) a |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2721 | #endif |
| 2722 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2723 | #define sleep_trivial_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2724 | USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...") |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2725 | #define sleep_full_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2726 | USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \ |
| 2727 | USAGE_FANCY_SLEEP( \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2728 | "Pause for a time equal to the total of the args given, where each arg can\n" \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 2729 | "\t\thave an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays.") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2730 | #define sleep_example_usage \ |
| 2731 | "$ sleep 2\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2732 | "[2 second delay results]\n" \ |
| 2733 | USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \ |
| 2734 | "[98528 second delay results]\n") |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2735 | |
Rob Landley | 6130b9b | 2006-01-23 21:10:38 +0000 | [diff] [blame] | 2736 | #if ENABLE_FEATURE_SORT_BIG |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2737 | # define USAGE_SORT_BIG(a) a |
Mark Whitley | fccaa36 | 2001-04-17 18:56:18 +0000 | [diff] [blame] | 2738 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2739 | # define USAGE_SORT_BIG(a) |
Mark Whitley | fccaa36 | 2001-04-17 18:56:18 +0000 | [diff] [blame] | 2740 | #endif |
Rob Landley | c0dedd0 | 2005-01-24 07:00:02 +0000 | [diff] [blame] | 2741 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2742 | #define sort_trivial_usage \ |
Rob Landley | c0dedd0 | 2005-01-24 07:00:02 +0000 | [diff] [blame] | 2743 | "[-nru" USAGE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") "] [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2744 | #define sort_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2745 | "Sorts lines of text in the specified files\n\n" \ |
Mark Whitley | fccaa36 | 2001-04-17 18:56:18 +0000 | [diff] [blame] | 2746 | "Options:\n" \ |
Rob Landley | c0dedd0 | 2005-01-24 07:00:02 +0000 | [diff] [blame] | 2747 | USAGE_SORT_BIG( \ |
| 2748 | "\t-b\tignore leading blanks\n" \ |
| 2749 | "\t-c\tcheck whether input is sorted\n" \ |
| 2750 | "\t-d\tdictionary order (blank or alphanumeric only)\n" \ |
| 2751 | "\t-f\tignore case\n" \ |
| 2752 | "\t-g\tgeneral numerical sort\n" \ |
| 2753 | "\t-i\tignore unprintable characters\n" \ |
| 2754 | "\t-k\tspecify sort key\n" \ |
| 2755 | "\t-M\tsort month\n" \ |
| 2756 | ) \ |
| 2757 | "\t-n\tsort numbers\n" \ |
| 2758 | USAGE_SORT_BIG( \ |
| 2759 | "\t-o\toutput to file\n" \ |
| 2760 | "\t-k\tsort by key\n" \ |
| 2761 | "\t-t\tuse key separator other than whitespace\n" \ |
| 2762 | ) \ |
| 2763 | "\t-r\treverse sort order\n" \ |
| 2764 | USAGE_SORT_BIG("\t-s\tstable (don't sort ties alphabetically)\n") \ |
| 2765 | "\t-u\tsuppress duplicate lines" \ |
| 2766 | USAGE_SORT_BIG("\n\t-z\tinput terminated by nulls, not newlines\n") \ |
Bernhard Reutner-Fischer | a1bccc0 | 2006-04-02 20:17:55 +0000 | [diff] [blame] | 2767 | USAGE_SORT_BIG("\t-mST\tignored for GNU compatibility") \ |
Rob Landley | c0dedd0 | 2005-01-24 07:00:02 +0000 | [diff] [blame] | 2768 | "" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2769 | #define sort_example_usage \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 2770 | "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2771 | "a\n" \ |
| 2772 | "b\n" \ |
| 2773 | "c\n" \ |
| 2774 | "d\n" \ |
| 2775 | "e\n" \ |
Rob Landley | c0dedd0 | 2005-01-24 07:00:02 +0000 | [diff] [blame] | 2776 | "f\n" \ |
| 2777 | USAGE_SORT_BIG( \ |
| 2778 | "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \ |
| 2779 | "d 2\n" \ |
| 2780 | "b 2\n" \ |
| 2781 | "c 3\n" \ |
| 2782 | ) \ |
| 2783 | "" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2784 | |
Eric Andersen | c2af1ee | 2001-10-18 19:33:06 +0000 | [diff] [blame] | 2785 | #define start_stop_daemon_trivial_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2786 | "[OPTIONS] [--start|--stop] ... [-- arguments...]" |
Eric Andersen | c2af1ee | 2001-10-18 19:33:06 +0000 | [diff] [blame] | 2787 | #define start_stop_daemon_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2788 | "Program to start and stop services." \ |
| 2789 | "\n\nOptions:" \ |
| 2790 | "\n\t-S|--start\t\t\tstart" \ |
| 2791 | "\n\t-K|--stop\t\t\tstop" \ |
| 2792 | "\n\t-a|--startas <pathname>\t\tstarts process specified by pathname" \ |
| 2793 | "\n\t-b|--background\t\t\tforce process into background" \ |
| 2794 | "\n\t-u|--user <username>|<uid>\tstop this user's processes" \ |
| 2795 | "\n\t-x|--exec <executable>\t\tprogram to either start or check" \ |
| 2796 | "\n\t-m|--make-pidfile <filename>\tcreate the -p file and enter pid in it" \ |
| 2797 | "\n\t-n|--name <process-name>\tstop processes with this name" \ |
| 2798 | "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 2799 | "\n\t-q|--quiet\t\t\tbe quiet" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2800 | "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)" |
Eric Andersen | c2af1ee | 2001-10-18 19:33:06 +0000 | [diff] [blame] | 2801 | |
Mike Frysinger | 9b5f71e | 2005-04-23 06:26:38 +0000 | [diff] [blame] | 2802 | #ifdef CONFIG_FEATURE_STAT_FORMAT |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2803 | # define USAGE_STAT_FORMAT(a) a |
Mike Frysinger | 9b5f71e | 2005-04-23 06:26:38 +0000 | [diff] [blame] | 2804 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2805 | # define USAGE_STAT_FORMAT(a) |
Mike Frysinger | 9b5f71e | 2005-04-23 06:26:38 +0000 | [diff] [blame] | 2806 | #endif |
| 2807 | #define stat_trivial_usage \ |
| 2808 | "[OPTION] FILE..." |
| 2809 | #define stat_full_usage \ |
| 2810 | "display file (default) or filesystem status.\n\n" \ |
| 2811 | "Options:\n" \ |
| 2812 | USAGE_STAT_FORMAT("\t-c fmt\tuse the specified format\n") \ |
| 2813 | "\t-f\tdisplay filesystem status\n" \ |
| 2814 | "\t-L,-l\tdereference links\n" \ |
| 2815 | "\t-t\tdisplay info in terse form\n" \ |
| 2816 | USAGE_STAT_FORMAT( \ |
| 2817 | "\nValid format sequences for files:\n" \ |
| 2818 | " %a Access rights in octal\n" \ |
| 2819 | " %A Access rights in human readable form\n" \ |
| 2820 | " %b Number of blocks allocated (see %B)\n" \ |
| 2821 | " %B The size in bytes of each block reported by %b\n" \ |
| 2822 | " %d Device number in decimal\n" \ |
| 2823 | " %D Device number in hex\n" \ |
| 2824 | " %f Raw mode in hex\n" \ |
| 2825 | " %F File type\n" \ |
| 2826 | " %g Group ID of owner\n" \ |
| 2827 | " %G Group name of owner\n" \ |
| 2828 | " %h Number of hard links\n" \ |
| 2829 | " %i Inode number\n" \ |
| 2830 | " %n File name\n" \ |
| 2831 | " %N Quoted file name with dereference if symbolic link\n" \ |
| 2832 | " %o I/O block size\n" \ |
| 2833 | " %s Total size, in bytes\n" \ |
| 2834 | " %t Major device type in hex\n" \ |
| 2835 | " %T Minor device type in hex\n" \ |
| 2836 | " %u User ID of owner\n" \ |
| 2837 | " %U User name of owner\n" \ |
| 2838 | " %x Time of last access\n" \ |
| 2839 | " %X Time of last access as seconds since Epoch\n" \ |
| 2840 | " %y Time of last modification\n" \ |
| 2841 | " %Y Time of last modification as seconds since Epoch\n" \ |
| 2842 | " %z Time of last change\n" \ |
| 2843 | " %Z Time of last change as seconds since Epoch\n" \ |
| 2844 | "\nValid format sequences for file systems:\n" \ |
| 2845 | " %a Free blocks available to non-superuser\n" \ |
| 2846 | " %b Total data blocks in file system\n" \ |
| 2847 | " %c Total file nodes in file system\n" \ |
| 2848 | " %d Free file nodes in file system\n" \ |
| 2849 | " %f Free blocks in file system\n" \ |
| 2850 | " %i File System ID in hex\n" \ |
| 2851 | " %l Maximum length of filenames\n" \ |
| 2852 | " %n File name\n" \ |
| 2853 | " %s Block size (for faster transfers)\n" \ |
| 2854 | " %S Fundamental block size (for block counts)\n" \ |
| 2855 | " %t Type in hex\n" \ |
| 2856 | " %T Type in human readable form\n" \ |
| 2857 | ) |
| 2858 | |
Eric Andersen | ef5e8f8 | 2002-11-07 02:09:37 +0000 | [diff] [blame] | 2859 | #define strings_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2860 | "[-afo] [-n length] [file ... ]" |
Eric Andersen | ef5e8f8 | 2002-11-07 02:09:37 +0000 | [diff] [blame] | 2861 | #define strings_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2862 | "Display printable strings in a binary file." \ |
| 2863 | "\n\nOptions:" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2864 | "\n\t-a\tScan the whole files (this is the default)." \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2865 | "\n\t-f\tPrecede each string with the name of the file where it was found." \ |
| 2866 | "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2867 | "\n\t-o\tEach string is preceded by its decimal offset in the file" |
Eric Andersen | ef5e8f8 | 2002-11-07 02:09:37 +0000 | [diff] [blame] | 2868 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2869 | #define stty_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2870 | "[-a|g] [-F DEVICE] [SETTING]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2871 | #define stty_full_usage \ |
| 2872 | "Without arguments, prints baud rate, line discipline," \ |
| 2873 | "\nand deviations from stty sane." \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 2874 | "\n\nOptions:" \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2875 | "\n\t-F DEVICE\topen device instead of stdin" \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 2876 | "\n\t-a\t\tprint all current settings in human-readable form" \ |
| 2877 | "\n\t-g\t\tprint in stty-readable form" \ |
Eric Andersen | abec344 | 2001-05-21 17:58:01 +0000 | [diff] [blame] | 2878 | "\n\t[SETTING]\tsee manpage" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2879 | |
Robert Griebl | 1fca558 | 2002-06-04 20:45:46 +0000 | [diff] [blame] | 2880 | #define su_trivial_usage \ |
| 2881 | "[OPTION]... [-] [username]" |
| 2882 | #define su_full_usage \ |
| 2883 | "Change user id or become root.\n" \ |
| 2884 | "Options:\n" \ |
Bernhard Reutner-Fischer | 5a620ea | 2006-01-19 18:04:15 +0000 | [diff] [blame] | 2885 | "\t-p, -m\tPreserve environment" \ |
| 2886 | "\n\t-c\tCommand to pass to 'sh -c'" \ |
| 2887 | "\n\t-s\tShell to use instead of default shell" |
Robert Griebl | 1fca558 | 2002-06-04 20:45:46 +0000 | [diff] [blame] | 2888 | |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 2889 | #define sulogin_trivial_usage \ |
| 2890 | "[OPTION]... [tty-device]" |
| 2891 | #define sulogin_full_usage \ |
| 2892 | "Single user login\n" \ |
| 2893 | "Options:\n" \ |
| 2894 | "\t-f\tDo not authenticate (user already authenticated)\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2895 | "\t-h\tName of the remote host for this login\n" \ |
| 2896 | "\t-p\tPreserve environment" |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 2897 | |
Mike Frysinger | 95d3c45 | 2005-04-21 23:29:24 +0000 | [diff] [blame] | 2898 | #define sum_trivial_usage \ |
| 2899 | "[rs] [files...]" |
| 2900 | #define sum_full_usage \ |
| 2901 | "checksum and count the blocks in a file\n\n" \ |
| 2902 | "Options:\n" \ |
| 2903 | "\t-r\tuse BSD sum algorithm (1K blocks)\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2904 | "\t-s\tuse System V sum algorithm (512byte blocks)" |
Mike Frysinger | 95d3c45 | 2005-04-21 23:29:24 +0000 | [diff] [blame] | 2905 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2906 | #define swapoff_trivial_usage \ |
Mike Frysinger | 68071e4 | 2005-09-13 02:26:24 +0000 | [diff] [blame] | 2907 | "[-a] [DEVICE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2908 | #define swapoff_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2909 | "Stop swapping virtual memory pages on DEVICE.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2910 | "Options:\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2911 | "\t-a\tStop swapping on all swap devices" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2912 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2913 | #define swapon_trivial_usage \ |
Mike Frysinger | 68071e4 | 2005-09-13 02:26:24 +0000 | [diff] [blame] | 2914 | "[-a] [DEVICE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2915 | #define swapon_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2916 | "Start swapping virtual memory pages on DEVICE.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2917 | "Options:\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2918 | "\t-a\tStart swapping on all swap devices" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2919 | |
Rob Landley | 0f34a82 | 2005-10-27 22:55:50 +0000 | [diff] [blame] | 2920 | #define switch_root_trivial_usage \ |
Rob Landley | 70f7ef7 | 2005-12-13 08:21:33 +0000 | [diff] [blame] | 2921 | "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]" |
Rob Landley | 0f34a82 | 2005-10-27 22:55:50 +0000 | [diff] [blame] | 2922 | #define switch_root_full_usage \ |
| 2923 | "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \ |
Rob Landley | 70f7ef7 | 2005-12-13 08:21:33 +0000 | [diff] [blame] | 2924 | "and exec NEW_INIT.\n\n" \ |
| 2925 | "Options:\n" \ |
| 2926 | "\t-c\tRedirect console to device on new root" |
Rob Landley | 0f34a82 | 2005-10-27 22:55:50 +0000 | [diff] [blame] | 2927 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2928 | #define sync_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2929 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2930 | #define sync_full_usage \ |
| 2931 | "Write all buffered filesystem blocks to disk." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2932 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2933 | |
Eric Andersen | 29c77f7 | 2003-10-09 09:43:18 +0000 | [diff] [blame] | 2934 | #ifdef CONFIG_FEATURE_ROTATE_LOGFILE |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2935 | # define USAGE_ROTATE_LOGFILE(a) a |
Eric Andersen | 29c77f7 | 2003-10-09 09:43:18 +0000 | [diff] [blame] | 2936 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2937 | # define USAGE_ROTATE_LOGFILE(a) |
Eric Andersen | 29c77f7 | 2003-10-09 09:43:18 +0000 | [diff] [blame] | 2938 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2939 | #ifdef CONFIG_FEATURE_REMOTE_LOG |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2940 | # define USAGE_REMOTE_LOG(a) a |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2941 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2942 | # define USAGE_REMOTE_LOG(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2943 | #endif |
Robert Griebl | 65d415d | 2002-08-07 21:10:19 +0000 | [diff] [blame] | 2944 | #ifdef CONFIG_FEATURE_IPC_SYSLOG |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2945 | # define USAGE_IPC_LOG(a) a |
Robert Griebl | 65d415d | 2002-08-07 21:10:19 +0000 | [diff] [blame] | 2946 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2947 | # define USAGE_IPC_LOG(a) |
Robert Griebl | 65d415d | 2002-08-07 21:10:19 +0000 | [diff] [blame] | 2948 | #endif |
| 2949 | |
Eric Andersen | b905028 | 2003-12-24 06:02:11 +0000 | [diff] [blame] | 2950 | #define sysctl_trivial_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2951 | "[OPTIONS]... [VALUE]..." |
Eric Andersen | 5d38f5b | 2005-09-12 21:42:48 +0000 | [diff] [blame] | 2952 | #define sysctl_full_usage \ |
| 2953 | "configure kernel parameters at runtime\n\n" \ |
Eric Andersen | b905028 | 2003-12-24 06:02:11 +0000 | [diff] [blame] | 2954 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 2955 | "\t-n\tUse this option to disable printing of the key name when printing values\n" \ |
| 2956 | "\t-w\tUse this option when you want to change a sysctl setting\n" \ |
| 2957 | "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given\n" \ |
| 2958 | "\t-a\tDisplay all values currently available\n" \ |
| 2959 | "\t-A\tDisplay all values currently available in table form" |
Eric Andersen | 5d38f5b | 2005-09-12 21:42:48 +0000 | [diff] [blame] | 2960 | #define sysctl_example_usage \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 2961 | "sysctl [-n] variable ...\n" \ |
| 2962 | "sysctl [-n] -w variable=value ...\n" \ |
| 2963 | "sysctl [-n] -a\n" \ |
| 2964 | "sysctl [-n] -p <file>\t(default /etc/sysctl.conf)\n" \ |
| 2965 | "sysctl [-n] -A\n" |
Eric Andersen | b905028 | 2003-12-24 06:02:11 +0000 | [diff] [blame] | 2966 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2967 | #define syslogd_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2968 | "[OPTION]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2969 | #define syslogd_full_usage \ |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 2970 | "Linux system and kernel logging utility.\n" \ |
| 2971 | "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2972 | "Options:\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2973 | "\t-m MIN\t\tMinutes between MARK lines (default=20, 0=off)\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2974 | "\t-n\t\tRun as a foreground process\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 2975 | "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)\n" \ |
| 2976 | "\t-S\t\tMake logging output smaller." \ |
Eric Andersen | 29c77f7 | 2003-10-09 09:43:18 +0000 | [diff] [blame] | 2977 | USAGE_ROTATE_LOGFILE( \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 2978 | "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \ |
| 2979 | "\t-b NUM\t\tNumber of rotated logs to keep (default=1, max=99, 0=purge)") \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 2980 | USAGE_REMOTE_LOG( \ |
Eric Andersen | dc12190 | 2001-02-24 18:52:36 +0000 | [diff] [blame] | 2981 | "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \ |
Robert Griebl | 65d415d | 2002-08-07 21:10:19 +0000 | [diff] [blame] | 2982 | "\t-L\t\tLog locally and via network logging (default is network only)") \ |
| 2983 | USAGE_IPC_LOG( \ |
Eric Andersen | d4a5e25 | 2003-12-19 11:32:14 +0000 | [diff] [blame] | 2984 | "\n\t-C [size(KiB)]\tLog to a circular buffer (read the buffer using logread)") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2985 | #define syslogd_example_usage \ |
| 2986 | "$ syslogd -R masterlog:514\n" \ |
| 2987 | "$ syslogd -R 192.168.1.1:601\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2988 | |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2989 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2990 | #ifndef CONFIG_FEATURE_FANCY_TAIL |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2991 | # define USAGE_UNSIMPLE_TAIL(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2992 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 2993 | # define USAGE_UNSIMPLE_TAIL(a) a |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2994 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2995 | #define tail_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2996 | "[OPTION]... [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2997 | #define tail_full_usage \ |
| 2998 | "Print last 10 lines of each FILE to standard output.\n" \ |
| 2999 | "With more than one FILE, precede each with a header giving the\n" \ |
| 3000 | "file name. With no FILE, or when FILE is -, read standard input.\n\n" \ |
| 3001 | "Options:\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 3002 | USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3003 | "\t-n N[kbm]\tprint last N lines instead of last 10\n" \ |
| 3004 | "\t-f\t\toutput data as the file grows" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3005 | USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3006 | "\t-s SEC\t\twait SEC seconds between reads with -f\n" \ |
| 3007 | "\t-v\t\talways output headers giving file names\n\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3008 | "If the first character of N (bytes or lines) is a '+', output begins with \n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3009 | "the Nth item from the start of each file, otherwise, print the last N items\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3010 | "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) |
| 3011 | #define tail_example_usage \ |
| 3012 | "$ tail -n 1 /etc/resolv.conf\n" \ |
| 3013 | "nameserver 10.0.0.1\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3014 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 3015 | #ifdef CONFIG_FEATURE_TAR_CREATE |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3016 | # define USAGE_TAR_CREATE(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3017 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3018 | # define USAGE_TAR_CREATE(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3019 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 3020 | #ifdef CONFIG_FEATURE_TAR_EXCLUDE |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3021 | # define USAGE_TAR_EXCLUDE(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3022 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3023 | # define USAGE_TAR_EXCLUDE(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3024 | #endif |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 3025 | #ifdef CONFIG_FEATURE_TAR_GZIP |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3026 | # define USAGE_TAR_GZIP(a) a |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 3027 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3028 | # define USAGE_TAR_GZIP(a) |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 3029 | #endif |
| 3030 | #ifdef CONFIG_FEATURE_TAR_BZIP2 |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3031 | # define USAGE_TAR_BZIP2(a) a |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 3032 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3033 | # define USAGE_TAR_BZIP2(a) |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 3034 | #endif |
Rob Landley | c1d6990 | 2006-01-20 18:28:50 +0000 | [diff] [blame] | 3035 | #ifdef CONFIG_FEATURE_TAR_LZMA |
| 3036 | # define USAGE_TAR_LZMA(a) a |
| 3037 | #else |
| 3038 | # define USAGE_TAR_LZMA(a) |
| 3039 | #endif |
Glenn L McGrath | 7370f62 | 2003-11-18 21:49:23 +0000 | [diff] [blame] | 3040 | #ifdef CONFIG_FEATURE_TAR_COMPRESS |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3041 | # define USAGE_TAR_COMPRESS(a) a |
Glenn L McGrath | 7370f62 | 2003-11-18 21:49:23 +0000 | [diff] [blame] | 3042 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3043 | # define USAGE_TAR_COMPRESS(a) |
Glenn L McGrath | 7370f62 | 2003-11-18 21:49:23 +0000 | [diff] [blame] | 3044 | #endif |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 3045 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3046 | #define tar_trivial_usage \ |
Rob Landley | c1d6990 | 2006-01-20 18:28:50 +0000 | [diff] [blame] | 3047 | "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") USAGE_TAR_LZMA("a") USAGE_TAR_COMPRESS("Z") "xtvO] " \ |
Glenn L McGrath | ce91c8a | 2003-12-26 14:01:37 +0000 | [diff] [blame] | 3048 | USAGE_TAR_EXCLUDE("[-X FILE]") \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 3049 | "[-f TARFILE] [-C DIR] [FILE(s)] ..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3050 | #define tar_full_usage \ |
| 3051 | "Create, extract, or list files from a tar file.\n\n" \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 3052 | "Options:\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 3053 | USAGE_TAR_CREATE("\tc\t\tcreate\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3054 | "\tx\t\textract\n" \ |
| 3055 | "\tt\t\tlist\n" \ |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 3056 | "\nArchive format selection:\n" \ |
| 3057 | USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \ |
| 3058 | USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \ |
Rob Landley | c1d6990 | 2006-01-20 18:28:50 +0000 | [diff] [blame] | 3059 | USAGE_TAR_LZMA("\ta\t\tFilter the archive through lzma\n") \ |
Glenn L McGrath | 0c5d9c2 | 2003-11-18 23:27:49 +0000 | [diff] [blame] | 3060 | USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3061 | "\nFile selection:\n" \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 3062 | "\tf\t\tname of TARFILE or \"-\" for stdin\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3063 | "\tO\t\textract to stdout\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 3064 | USAGE_TAR_EXCLUDE( \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3065 | "\texclude\t\tfile to exclude\n" \ |
| 3066 | "\tX\t\tfile with names to exclude\n" \ |
| 3067 | ) \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 3068 | "\tC\t\tchange to directory DIR before operation\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3069 | "\tv\t\tverbosely list files processed" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3070 | #define tar_example_usage \ |
| 3071 | "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \ |
| 3072 | "$ tar -cf /tmp/tarball.tar /usr/local\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3073 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3074 | #define tee_trivial_usage \ |
| 3075 | "[OPTION]... [FILE]..." |
| 3076 | #define tee_full_usage \ |
| 3077 | "Copy standard input to each FILE, and also to standard output.\n\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 3078 | "Options:\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 3079 | "\t-a\tappend to the given FILEs, do not overwrite\n" \ |
| 3080 | "\t-i\tignore interrupt signals (SIGINT)" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3081 | #define tee_example_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3082 | "$ echo \"Hello\" | tee /tmp/foo\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3083 | "$ cat /tmp/foo\n" \ |
| 3084 | "Hello\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3085 | |
Eric Andersen | 539ffc9 | 2004-02-22 12:25:47 +0000 | [diff] [blame] | 3086 | #ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN |
| 3087 | #define telnet_trivial_usage \ |
| 3088 | "[-a] [-l USER] HOST [PORT]" |
| 3089 | #define telnet_full_usage \ |
| 3090 | "Telnet is used to establish interactive communication with another\n" \ |
| 3091 | "computer over a network using the TELNET protocol.\n\n" \ |
| 3092 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3093 | "\t-a\t\tAttempt an automatic login with the USER variable\n" \ |
| 3094 | "\t-l USER\t\tAttempt an automatic login with the USER argument\n" \ |
Eric Andersen | 539ffc9 | 2004-02-22 12:25:47 +0000 | [diff] [blame] | 3095 | "\tHOST\t\tThe official name, alias or the IP address of the\n" \ |
| 3096 | "\t\t\tremote host.\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3097 | "\tPORT\t\tThe remote port number to connect to. If it is not\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 3098 | "\t\t\tspecified, the default telnet (23) port is used." |
Eric Andersen | 539ffc9 | 2004-02-22 12:25:47 +0000 | [diff] [blame] | 3099 | #else |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3100 | #define telnet_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 3101 | "HOST [PORT]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3102 | #define telnet_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3103 | "Telnet is used to establish interactive communication with another\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3104 | "computer over a network using the TELNET protocol." |
Eric Andersen | 539ffc9 | 2004-02-22 12:25:47 +0000 | [diff] [blame] | 3105 | #endif |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3106 | |
Glenn L McGrath | 4a4c677 | 2003-02-15 11:50:33 +0000 | [diff] [blame] | 3107 | #ifdef CONFIG_FEATURE_TELNETD_INETD |
| 3108 | #define telnetd_trivial_usage \ |
| 3109 | "(inetd mode) [OPTION]" |
| 3110 | #define telnetd_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3111 | "Telnetd uses incoming TELNET connections via inetd.\n" \ |
Glenn L McGrath | 4a4c677 | 2003-02-15 11:50:33 +0000 | [diff] [blame] | 3112 | "Options:\n" \ |
Glenn L McGrath | ab1955c | 2004-09-14 16:23:56 +0000 | [diff] [blame] | 3113 | "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3114 | "\t-f issue_file\tDisplay issue_file instead of /etc/issue" |
Glenn L McGrath | 4a4c677 | 2003-02-15 11:50:33 +0000 | [diff] [blame] | 3115 | #else |
Eric Andersen | 08a7220 | 2002-09-30 20:52:10 +0000 | [diff] [blame] | 3116 | #define telnetd_trivial_usage \ |
| 3117 | "[OPTION]" |
| 3118 | #define telnetd_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3119 | "Telnetd listens for incoming TELNET connections on PORT.\n" \ |
Eric Andersen | 08a7220 | 2002-09-30 20:52:10 +0000 | [diff] [blame] | 3120 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3121 | "\t-p PORT\tlisten for connections on PORT (default 23)\n" \ |
| 3122 | "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)\n" \ |
| 3123 | "\t-f issue_file\tDisplay issue_file instead of /etc/issue" |
Glenn L McGrath | 4a4c677 | 2003-02-15 11:50:33 +0000 | [diff] [blame] | 3124 | #endif |
Eric Andersen | 08a7220 | 2002-09-30 20:52:10 +0000 | [diff] [blame] | 3125 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3126 | #define test_trivial_usage \ |
| 3127 | "EXPRESSION\n or [ EXPRESSION ]" |
| 3128 | #define test_full_usage \ |
| 3129 | "Checks file types and compares values returning an exit\n" \ |
| 3130 | "code determined by the value of EXPRESSION." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3131 | #define test_example_usage \ |
| 3132 | "$ test 1 -eq 2\n" \ |
| 3133 | "$ echo $?\n" \ |
| 3134 | "1\n" \ |
| 3135 | "$ test 1 -eq 1\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 3136 | "$ echo $?\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3137 | "0\n" \ |
| 3138 | "$ [ -d /etc ]\n" \ |
| 3139 | "$ echo $?\n" \ |
| 3140 | "0\n" \ |
| 3141 | "$ [ -d /junk ]\n" \ |
| 3142 | "$ echo $?\n" \ |
| 3143 | "1\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3144 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 3145 | #ifdef CONFIG_FEATURE_TFTP_GET |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3146 | # define USAGE_TFTP_GET(a) a |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 3147 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3148 | # define USAGE_TFTP_GET(a) |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 3149 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 3150 | #ifdef CONFIG_FEATURE_TFTP_PUT |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3151 | # define USAGE_TFTP_PUT(a) a |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 3152 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3153 | # define USAGE_TFTP_PUT(a) |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 3154 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 3155 | #ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3156 | # define USAGE_TFTP_BS(a) a |
Glenn L McGrath | ad117d8 | 2001-10-05 04:40:37 +0000 | [diff] [blame] | 3157 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3158 | # define USAGE_TFTP_BS(a) |
Glenn L McGrath | ad117d8 | 2001-10-05 04:40:37 +0000 | [diff] [blame] | 3159 | #endif |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 3160 | |
| 3161 | #define tftp_trivial_usage \ |
Matt Kraai | 3be3430 | 2001-09-21 14:42:30 +0000 | [diff] [blame] | 3162 | "[OPTION]... HOST [PORT]" |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 3163 | #define tftp_full_usage \ |
| 3164 | "Transfers a file from/to a tftp server using \"octet\" mode.\n\n" \ |
Matt Kraai | 3be3430 | 2001-09-21 14:42:30 +0000 | [diff] [blame] | 3165 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3166 | "\t-l FILE\tLocal FILE\n" \ |
| 3167 | "\t-r FILE\tRemote FILE" \ |
| 3168 | USAGE_TFTP_GET( \ |
| 3169 | "\n\t-g\tGet file" \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3170 | ) \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3171 | USAGE_TFTP_PUT( \ |
| 3172 | "\n\t-p\tPut file" \ |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 3173 | ) \ |
Glenn L McGrath | ad117d8 | 2001-10-05 04:40:37 +0000 | [diff] [blame] | 3174 | USAGE_TFTP_BS( \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3175 | "\n\t-b SIZE\tTransfer blocks of SIZE octets" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3176 | ) |
Eric Andersen | c365742 | 2001-11-30 07:54:32 +0000 | [diff] [blame] | 3177 | #define time_trivial_usage \ |
| 3178 | "[OPTION]... COMMAND [ARGS...]" |
| 3179 | #define time_full_usage \ |
Eric Andersen | 356b6db | 2001-12-06 07:42:04 +0000 | [diff] [blame] | 3180 | "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \ |
| 3181 | "COMMAND's resource usage information is displayed\n\n" \ |
Eric Andersen | c365742 | 2001-11-30 07:54:32 +0000 | [diff] [blame] | 3182 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3183 | "\t-v\tDisplays verbose resource usage information" |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 3184 | |
Eric Andersen | 420b208 | 2002-09-17 22:14:58 +0000 | [diff] [blame] | 3185 | #define top_trivial_usage \ |
| 3186 | "[-d <seconds>]" |
| 3187 | #define top_full_usage \ |
| 3188 | "top provides an view of processor activity in real time.\n" \ |
| 3189 | "This utility reads the status for all processes in /proc each <seconds>\n" \ |
| 3190 | "and shows the status for however many processes will fit on the screen.\n" \ |
| 3191 | "This utility will not show processes that are started after program startup,\n" \ |
| 3192 | "but it will show the EXIT status for and PIDs that exit while it is running." |
| 3193 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3194 | #define touch_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 3195 | "[-c] FILE [FILE ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3196 | #define touch_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 3197 | "Update the last-modified date on the given FILE[s].\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3198 | "Options:\n" \ |
| 3199 | "\t-c\tDo not create any files" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3200 | #define touch_example_usage \ |
| 3201 | "$ ls -l /tmp/foo\n" \ |
| 3202 | "/bin/ls: /tmp/foo: No such file or directory\n" \ |
| 3203 | "$ touch /tmp/foo\n" \ |
| 3204 | "$ ls -l /tmp/foo\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3205 | "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3206 | |
| 3207 | #define tr_trivial_usage \ |
| 3208 | "[-cds] STRING1 [STRING2]" |
| 3209 | #define tr_full_usage \ |
| 3210 | "Translate, squeeze, and/or delete characters from\n" \ |
| 3211 | "standard input, writing to standard output.\n\n" \ |
| 3212 | "Options:\n" \ |
| 3213 | "\t-c\ttake complement of STRING1\n" \ |
| 3214 | "\t-d\tdelete input characters coded STRING1\n" \ |
| 3215 | "\t-s\tsqueeze multiple output characters of STRING2 into one character" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3216 | #define tr_example_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3217 | "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3218 | "hello world\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3219 | |
Eric Andersen | 5c58d28 | 2001-07-10 16:29:00 +0000 | [diff] [blame] | 3220 | #define traceroute_trivial_usage \ |
"Vladimir N. Oleynik" | 45a8ed8 | 2005-09-06 16:08:33 +0000 | [diff] [blame] | 3221 | "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \ |
| 3222 | "\t[-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \ |
| 3223 | "\t[-z pausemsecs] host [data size]" |
Eric Andersen | 5c58d28 | 2001-07-10 16:29:00 +0000 | [diff] [blame] | 3224 | #define traceroute_full_usage \ |
| 3225 | "trace the route ip packets follow going to \"host\"\n" \ |
| 3226 | "Options:\n" \ |
"Vladimir N. Oleynik" | 45a8ed8 | 2005-09-06 16:08:33 +0000 | [diff] [blame] | 3227 | "\t-F\tSet the don't fragment bit\n" \ |
| 3228 | "\t-I\tUse ICMP ECHO instead of UDP datagrams\n" \ |
| 3229 | "\t-l\tDisplay the ttl value of the returned packet\n" \ |
| 3230 | "\t-d\tSet SO_DEBUG options to socket\n" \ |
Eric Andersen | 5c58d28 | 2001-07-10 16:29:00 +0000 | [diff] [blame] | 3231 | "\t-n\tPrint hop addresses numerically rather than symbolically\n" \ |
| 3232 | "\t-r\tBypass the normal routing tables and send directly to a host\n" \ |
| 3233 | "\t-v\tVerbose output\n" \ |
| 3234 | "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \ |
| 3235 | "\t-p port#\tSet the base UDP port number used in probes\n" \ |
| 3236 | "\t\t(default is 33434)\n" \ |
| 3237 | "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \ |
| 3238 | "\t\t(default is 3)\n" \ |
| 3239 | "\t-s src_addr\tUse the following IP address as the source address\n" \ |
| 3240 | "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \ |
| 3241 | "\t\t(default 0)\n" \ |
| 3242 | "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \ |
Mike Frysinger | 036f299 | 2005-09-24 23:50:14 +0000 | [diff] [blame] | 3243 | "\t\t(default 3 sec)\n" \ |
| 3244 | "\t-g\tSpecify a loose source route gateway (8 maximum)" |
Eric Andersen | 5c58d28 | 2001-07-10 16:29:00 +0000 | [diff] [blame] | 3245 | |
| 3246 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3247 | #define true_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3248 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3249 | #define true_full_usage \ |
| 3250 | "Return an exit code of TRUE (0)." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3251 | #define true_example_usage \ |
| 3252 | "$ true\n" \ |
| 3253 | "$ echo $?\n" \ |
| 3254 | "0\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3255 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3256 | #define tty_trivial_usage \ |
| 3257 | "" |
| 3258 | #define tty_full_usage \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3259 | "Print the file name of the terminal connected to standard input.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3260 | "Options:\n" \ |
| 3261 | "\t-s\tprint nothing, only return an exit status" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3262 | #define tty_example_usage \ |
| 3263 | "$ tty\n" \ |
| 3264 | "/dev/tty2\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3265 | |
Mike Frysinger | 174808c | 2005-06-11 01:14:09 +0000 | [diff] [blame] | 3266 | #define tune2fs_trivial_usage \ |
| 3267 | "[-c max-mounts-count] [-e errors-behavior] [-g group] " \ |
| 3268 | "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \ |
| 3269 | "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \ |
| 3270 | "[-r reserved-blocks-count] [-u user] [-C mount-count] " \ |
| 3271 | "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \ |
| 3272 | "[-T last-check-time] [-U UUID] device" |
| 3273 | #define tune2fs_full_usage \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 3274 | "Adjust filesystem options on ext[23] filesystems." |
Mike Frysinger | 174808c | 2005-06-11 01:14:09 +0000 | [diff] [blame] | 3275 | |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 3276 | #define udhcpc_trivial_usage \ |
Rob Landley | a2841e6 | 2006-02-20 23:26:38 +0000 | [diff] [blame] | 3277 | "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]" |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 3278 | #define udhcpc_full_usage \ |
Paul Fox | a39bba3 | 2005-08-01 14:31:13 +0000 | [diff] [blame] | 3279 | "\t-c,\t--clientid=CLIENTID\tSet client identifier\n" \ |
| 3280 | "\t-C,\t--clientid-none\tSuppress default client identifier\n" \ |
Paul Fox | 28de951 | 2005-09-22 18:59:13 +0000 | [diff] [blame] | 3281 | "\t-V,\t--vendorclass=CLASSID\tSet vendor class identifier\n" \ |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 3282 | "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \ |
Russ Dill | 0288c8e | 2002-11-05 20:13:41 +0000 | [diff] [blame] | 3283 | "\t-h,\t \tAlias for -H\n" \ |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 3284 | "\t-f,\t--foreground\tDo not fork after getting lease\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3285 | "\t-b,\t--background\tFork to background if lease cannot be immediately negotiated\n" \ |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 3286 | "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3287 | "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated\n" \ |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 3288 | "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \ |
| 3289 | "\t-q,\t--quit\tQuit after obtaining lease\n" \ |
| 3290 | "\t-r,\t--request=IP\tIP address to request (default: none)\n" \ |
| 3291 | "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \ |
Rob Landley | a2841e6 | 2006-02-20 23:26:38 +0000 | [diff] [blame] | 3292 | "\t-t,\t--retries=NUM\tSend up to NUM request packets\n"\ |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 3293 | "\t-v,\t--version\tDisplay version" |
| 3294 | |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 3295 | #define udhcpd_trivial_usage \ |
| 3296 | "[configfile]\n" \ |
| 3297 | |
| 3298 | #define udhcpd_full_usage \ |
Glenn L McGrath | 9130c85 | 2002-12-12 12:56:18 +0000 | [diff] [blame] | 3299 | "" |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 3300 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 3301 | #ifdef CONFIG_FEATURE_MOUNT_FORCE |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3302 | # define USAGE_MOUNT_FORCE(a) a |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3303 | #else |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3304 | # define USAGE_MOUNT_FORCE(a) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3305 | #endif |
| 3306 | #define umount_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 3307 | "[flags] FILESYSTEM|DIRECTORY" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3308 | #define umount_full_usage \ |
| 3309 | "Unmount file systems\n" \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 3310 | "\nFlags:\n" "\t-a\tUnmount all file systems" \ |
| 3311 | USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \ |
| 3312 | "\n\t-r\tTry to remount devices as read-only if mount is busy" \ |
Rob Landley | 1672255 | 2005-09-24 22:41:08 +0000 | [diff] [blame] | 3313 | "\n\t-l\tLazy umount (detach filesystem)" \ |
| 3314 | "\n\t-f\tForce umount (i.e., unreachable NFS server)" \ |
| 3315 | USAGE_MOUNT_LOOP("\n\t-D\tDo not free loop device (if a loop device has been used)") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3316 | #define umount_example_usage \ |
| 3317 | "$ umount /dev/hdc1 \n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3318 | |
| 3319 | #define uname_trivial_usage \ |
| 3320 | "[OPTION]..." |
| 3321 | #define uname_full_usage \ |
| 3322 | "Print certain system information. With no OPTION, same as -s.\n\n" \ |
| 3323 | "Options:\n" \ |
| 3324 | "\t-a\tprint all information\n" \ |
| 3325 | "\t-m\tthe machine (hardware) type\n" \ |
| 3326 | "\t-n\tprint the machine's network node hostname\n" \ |
| 3327 | "\t-r\tprint the operating system release\n" \ |
| 3328 | "\t-s\tprint the operating system name\n" \ |
| 3329 | "\t-p\tprint the host processor type\n" \ |
| 3330 | "\t-v\tprint the operating system version" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3331 | #define uname_example_usage \ |
| 3332 | "$ uname -a\n" \ |
Eric Andersen | 7f48a95 | 2003-12-28 05:06:56 +0000 | [diff] [blame] | 3333 | "Linux debian 2.4.23 #2 Tue Dec 23 17:09:10 MST 2003 i686 GNU/Linux\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3334 | |
Glenn L McGrath | bf1cc8b | 2002-11-01 23:38:54 +0000 | [diff] [blame] | 3335 | #define uncompress_trivial_usage \ |
| 3336 | "[-c] [-f] [ name ... ]" |
| 3337 | #define uncompress_full_usage \ |
| 3338 | "Uncompress .Z file[s]\n" \ |
| 3339 | "Options:\n" \ |
| 3340 | "\t-c\textract to stdout\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 3341 | "\t-f\tforce overwrite an existing file" |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3342 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3343 | #define uniq_trivial_usage \ |
Rob Landley | 14efdc5 | 2005-09-07 04:18:36 +0000 | [diff] [blame] | 3344 | "[-fscdu]... [INPUT [OUTPUT]]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3345 | #define uniq_full_usage \ |
| 3346 | "Discard all but one of successive identical lines from INPUT\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 3347 | "(or standard input), writing to OUTPUT (or standard output).\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3348 | "Options:\n" \ |
| 3349 | "\t-c\tprefix lines by the number of occurrences\n" \ |
| 3350 | "\t-d\tonly print duplicate lines\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 3351 | "\t-u\tonly print unique lines\n" \ |
| 3352 | "\t-f N\tskip the first N fields\n" \ |
| 3353 | "\t-s N\tskip the first N chars (after any skipped fields)" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3354 | #define uniq_example_usage \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 3355 | "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3356 | "a\n" \ |
| 3357 | "b\n" \ |
| 3358 | "c\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3359 | |
| 3360 | #define unix2dos_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 3361 | "[option] [FILE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3362 | #define unix2dos_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 3363 | "Converts FILE from unix format to dos format. When no option\n" \ |
| 3364 | "is given, the input is converted to the opposite output format.\n" \ |
Eric Andersen | 3200f5a | 2001-05-22 22:39:10 +0000 | [diff] [blame] | 3365 | "When no file is given, uses stdin for input and stdout for output.\n" \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 3366 | "Options:\n" \ |
| 3367 | "\t-u\toutput will be in UNIX format\n" \ |
Eric Andersen | 3200f5a | 2001-05-22 22:39:10 +0000 | [diff] [blame] | 3368 | "\t-d\toutput will be in DOS format" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3369 | |
Glenn L McGrath | 87ac702 | 2002-01-02 13:52:26 +0000 | [diff] [blame] | 3370 | #define unzip_trivial_usage \ |
| 3371 | "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]" |
| 3372 | #define unzip_full_usage \ |
Matt Kraai | 9758e7d | 2002-01-03 17:32:29 +0000 | [diff] [blame] | 3373 | "Extracts files from ZIP archives.\n\n" \ |
Glenn L McGrath | 87ac702 | 2002-01-02 13:52:26 +0000 | [diff] [blame] | 3374 | "Options:\n" \ |
| 3375 | "\t-l\tlist archive contents (short form)\n" \ |
| 3376 | "\t-n\tnever overwrite existing files (default)\n" \ |
| 3377 | "\t-o\toverwrite files without prompting\n" \ |
| 3378 | "\t-p\tsend output to stdout\n" \ |
| 3379 | "\t-q\tbe quiet\n" \ |
| 3380 | "\t-x\texclude these files\n" \ |
| 3381 | "\t-d\textract files into this directory" |
| 3382 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3383 | #define uptime_trivial_usage \ |
| 3384 | "" |
| 3385 | #define uptime_full_usage \ |
| 3386 | "Display the time since the last boot." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3387 | #define uptime_example_usage \ |
| 3388 | "$ uptime\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3389 | " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3390 | |
| 3391 | #define usleep_trivial_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3392 | "N" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3393 | #define usleep_full_usage \ |
| 3394 | "Pause for N microseconds." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3395 | #define usleep_example_usage \ |
| 3396 | "$ usleep 1000000\n" \ |
| 3397 | "[pauses for 1 second]\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3398 | |
| 3399 | #define uudecode_trivial_usage \ |
| 3400 | "[FILE]..." |
| 3401 | #define uudecode_full_usage \ |
| 3402 | "Uudecode a file that is uuencoded.\n\n" \ |
| 3403 | "Options:\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3404 | "\t-o FILE\tdirect output to FILE" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3405 | #define uudecode_example_usage \ |
| 3406 | "$ uudecode -o busybox busybox.uu\n" \ |
| 3407 | "$ ls -l busybox\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3408 | "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3409 | |
| 3410 | #define uuencode_trivial_usage \ |
| 3411 | "[OPTION] [INFILE] REMOTEFILE" |
| 3412 | #define uuencode_full_usage \ |
| 3413 | "Uuencode a file.\n\n" \ |
| 3414 | "Options:\n" \ |
Eric Andersen | abec344 | 2001-05-21 17:58:01 +0000 | [diff] [blame] | 3415 | "\t-m\tuse base64 encoding per RFC1521" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3416 | #define uuencode_example_usage \ |
| 3417 | "$ uuencode busybox busybox\n" \ |
| 3418 | "begin 755 busybox\n" \ |
| 3419 | "<encoded file snipped>\n" \ |
| 3420 | "$ uudecode busybox busybox > busybox.uu\n" \ |
| 3421 | "$\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3422 | |
Eric Andersen | 853c494 | 2003-01-23 05:59:32 +0000 | [diff] [blame] | 3423 | #define vconfig_trivial_usage \ |
| 3424 | "COMMAND [OPTIONS] ..." |
Eric Andersen | 853c494 | 2003-01-23 05:59:32 +0000 | [diff] [blame] | 3425 | #define vconfig_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 3426 | "vconfig lets you create and remove virtual ethernet devices.\n\n" \ |
| 3427 | "Options:\n" \ |
| 3428 | "\tadd [interface-name] [vlan_id]\n" \ |
| 3429 | "\trem [vlan-name]\n" \ |
| 3430 | "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \ |
| 3431 | "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \ |
| 3432 | "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \ |
| 3433 | "\tset_name_type [name-type]" |
Eric Andersen | 853c494 | 2003-01-23 05:59:32 +0000 | [diff] [blame] | 3434 | |
Eric Andersen | 3f98040 | 2001-04-04 17:31:15 +0000 | [diff] [blame] | 3435 | #define vi_trivial_usage \ |
| 3436 | "[OPTION] [FILE]..." |
| 3437 | #define vi_full_usage \ |
| 3438 | "edit FILE.\n\n" \ |
| 3439 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3440 | "\t-R\tRead-only- do not write to the file" |
Eric Andersen | 3f98040 | 2001-04-04 17:31:15 +0000 | [diff] [blame] | 3441 | |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 3442 | #define vlock_trivial_usage \ |
| 3443 | "[OPTIONS]" |
| 3444 | #define vlock_full_usage \ |
| 3445 | "Lock a virtual terminal. A password is required to unlock\n" \ |
| 3446 | "Options:\n" \ |
| 3447 | "\t-a\tLock all VTs" |
| 3448 | |
Glenn L McGrath | 18b76e6 | 2002-09-16 09:10:04 +0000 | [diff] [blame] | 3449 | #define watch_trivial_usage \ |
| 3450 | "[-n <seconds>] COMMAND..." |
| 3451 | #define watch_full_usage \ |
| 3452 | "Executes a program periodically.\n" \ |
| 3453 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3454 | "\t-n\tLoop period in seconds - default is 2" |
Glenn L McGrath | 18b76e6 | 2002-09-16 09:10:04 +0000 | [diff] [blame] | 3455 | #define watch_example_usage \ |
| 3456 | "$ watch date\n" \ |
| 3457 | "Mon Dec 17 10:31:40 GMT 2000\n" \ |
| 3458 | "Mon Dec 17 10:31:42 GMT 2000\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3459 | "Mon Dec 17 10:31:44 GMT 2000" |
Glenn L McGrath | 18b76e6 | 2002-09-16 09:10:04 +0000 | [diff] [blame] | 3460 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3461 | #define watchdog_trivial_usage \ |
Eric Andersen | cde8f53 | 2003-07-22 07:39:18 +0000 | [diff] [blame] | 3462 | "[-t <seconds>] DEV" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3463 | #define watchdog_full_usage \ |
Eric Andersen | cde8f53 | 2003-07-22 07:39:18 +0000 | [diff] [blame] | 3464 | "Periodically write to watchdog device DEV.\n" \ |
| 3465 | "Options:\n" \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3466 | "\t-t\tTimer period in seconds - default is 30" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3467 | |
| 3468 | #define wc_trivial_usage \ |
| 3469 | "[OPTION]... [FILE]..." |
| 3470 | #define wc_full_usage \ |
| 3471 | "Print line, word, and byte counts for each FILE, and a total line if\n" \ |
| 3472 | "more than one FILE is specified. With no FILE, read standard input.\n\n" \ |
| 3473 | "Options:\n" \ |
| 3474 | "\t-c\tprint the byte counts\n" \ |
| 3475 | "\t-l\tprint the newline counts\n" \ |
| 3476 | "\t-L\tprint the length of the longest line\n" \ |
| 3477 | "\t-w\tprint the word counts" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3478 | #define wc_example_usage \ |
| 3479 | "$ wc /etc/passwd\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3480 | " 31 46 1365 /etc/passwd\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3481 | |
| 3482 | #define wget_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 3483 | "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \ |
Eric Andersen | 15c03c3 | 2004-04-06 17:52:02 +0000 | [diff] [blame] | 3484 | "\t\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3485 | #define wget_full_usage \ |
Eric Andersen | 79757c9 | 2001-04-05 21:45:54 +0000 | [diff] [blame] | 3486 | "wget retrieves files via HTTP or FTP\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3487 | "Options:\n" \ |
| 3488 | "\t-c\tcontinue retrieval of aborted transfers\n" \ |
Eric Andersen | 79757c9 | 2001-04-05 21:45:54 +0000 | [diff] [blame] | 3489 | "\t-q\tquiet mode - do not print\n" \ |
Eric Andersen | 8071c02 | 2001-06-21 19:45:06 +0000 | [diff] [blame] | 3490 | "\t-P\tSet directory prefix to DIR\n" \ |
Robert Griebl | d776011 | 2002-05-14 23:36:45 +0000 | [diff] [blame] | 3491 | "\t-O\tsave to filename ('-' for stdout)\n" \ |
| 3492 | "\t-Y\tuse proxy ('on' or 'off')" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3493 | |
| 3494 | #define which_trivial_usage \ |
| 3495 | "[COMMAND ...]" |
| 3496 | #define which_full_usage \ |
| 3497 | "Locates a COMMAND." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3498 | #define which_example_usage \ |
| 3499 | "$ which login\n" \ |
| 3500 | "/bin/login\n" |
Glenn L McGrath | 8f0722a | 2002-11-11 03:00:12 +0000 | [diff] [blame] | 3501 | |
Eric Andersen | 00a6a75 | 2002-04-26 23:53:10 +0000 | [diff] [blame] | 3502 | #define who_trivial_usage \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3503 | " " |
Eric Andersen | 00a6a75 | 2002-04-26 23:53:10 +0000 | [diff] [blame] | 3504 | #define who_full_usage \ |
Mike Frysinger | 82e6c0b | 2005-04-23 06:35:06 +0000 | [diff] [blame] | 3505 | "Prints the current user names and related information" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3506 | |
| 3507 | #define whoami_trivial_usage \ |
| 3508 | "" |
| 3509 | #define whoami_full_usage \ |
| 3510 | "Prints the user name associated with the current effective user id." |
| 3511 | |
Glenn L McGrath | d12061b | 2003-10-10 23:15:23 +0000 | [diff] [blame] | 3512 | #ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION |
| 3513 | #define USAGE_XARGS_CONFIRMATION(a) a |
| 3514 | #else |
| 3515 | #define USAGE_XARGS_CONFIRMATION(a) |
| 3516 | #endif |
| 3517 | #ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT |
| 3518 | #define USAGE_XARGS_TERMOPT(a) a |
| 3519 | #else |
| 3520 | #define USAGE_XARGS_TERMOPT(a) |
| 3521 | #endif |
| 3522 | #ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM |
| 3523 | #define USAGE_XARGS_ZERO_TERM(a) a |
| 3524 | #else |
| 3525 | #define USAGE_XARGS_ZERO_TERM(a) |
| 3526 | #endif |
| 3527 | |
| 3528 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3529 | #define xargs_trivial_usage \ |
Glenn L McGrath | d12061b | 2003-10-10 23:15:23 +0000 | [diff] [blame] | 3530 | "[COMMAND] [OPTIONS] [ARGS...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3531 | #define xargs_full_usage \ |
Glenn L McGrath | f57674e | 2002-11-10 21:47:17 +0000 | [diff] [blame] | 3532 | "Executes COMMAND on every item given by standard input.\n\n" \ |
| 3533 | "Options:\n" \ |
Glenn L McGrath | d12061b | 2003-10-10 23:15:23 +0000 | [diff] [blame] | 3534 | USAGE_XARGS_CONFIRMATION("\t-p\tPrompt the user about whether to run each command\n") \ |
Glenn L McGrath | f57674e | 2002-11-10 21:47:17 +0000 | [diff] [blame] | 3535 | "\t-r\tDo not run command for empty readed lines\n" \ |
Glenn L McGrath | d12061b | 2003-10-10 23:15:23 +0000 | [diff] [blame] | 3536 | USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \ |
| 3537 | USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \ |
Mike Frysinger | 058e740 | 2005-04-23 07:00:33 +0000 | [diff] [blame] | 3538 | "\t-t\tPrint the command line on stderr before executing it" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3539 | #define xargs_example_usage \ |
| 3540 | "$ ls | xargs gzip\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 3541 | "$ find . -name '*.c' -print | xargs rm\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3542 | |
| 3543 | #define yes_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3544 | "[OPTION]... [STRING]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3545 | #define yes_full_usage \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 3546 | "Repeatedly outputs a line with all specified STRING(s), or 'y'." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 3547 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 3548 | #define zcat_trivial_usage \ |
| 3549 | "FILE" |
| 3550 | #define zcat_full_usage \ |
| 3551 | "Uncompress to stdout." |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 3552 | |
Rob Landley | ad8071f | 2005-04-30 03:49:37 +0000 | [diff] [blame] | 3553 | #define zcip_trivial_usage \ |
| 3554 | "[OPTIONS] ifname script" |
| 3555 | #define zcip_full_usage \ |
| 3556 | "zcip manages a ZeroConf IPv4 link-local address.\n" \ |
| 3557 | "Options:\n" \ |
| 3558 | "\t-f foreground mode\n" \ |
| 3559 | "\t-q quit after address (no daemon)\n" \ |
| 3560 | "\t-r 169.254.x.x request this address first\n" \ |
Mike Frysinger | bf28ed8 | 2006-02-21 04:32:03 +0000 | [diff] [blame] | 3561 | "\t-v verbose; show version" |
Rob Landley | ad8071f | 2005-04-30 03:49:37 +0000 | [diff] [blame] | 3562 | |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame] | 3563 | #endif /* __BB_USAGE_H__ */ |