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 \ |
| 7 | "Adds a group to the system" \ |
| 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 \ |
| 14 | "Adds a user to the system" \ |
| 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 \ |
| 49 | "[-fqbDUA] [-c count] [-w timeout] [-I device] [-s sender] target\n" |
| 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" \ |
| 61 | "\t-I device\tOutgoing interface name, default is eth0\n" \ |
| 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" \ |
| 67 | "or: ash -c command [args]...\n" |
| 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" \ |
Eric Andersen | 08f59e3 | 2004-03-12 22:07:10 +0000 | [diff] [blame] | 75 | "\t-v var=val\t\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" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 77 | "\t-f progname\t\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 | |
Glenn L McGrath | fff11f1 | 2001-11-18 14:20:25 +0000 | [diff] [blame] | 100 | #define bzcat_trivial_usage \ |
| 101 | "FILE" |
| 102 | #define bzcat_full_usage \ |
| 103 | "Uncompress to stdout." |
| 104 | |
Eric Andersen | c98c062 | 2001-12-06 15:16:43 +0000 | [diff] [blame] | 105 | #define cal_trivial_usage \ |
| 106 | "[-jy] [[month] year]" |
| 107 | #define cal_full_usage \ |
| 108 | "Display a calendar.\n" \ |
| 109 | "\nOptions:\n" \ |
| 110 | "\t-j\tUse julian dates.\n" \ |
| 111 | "\t-y\tDisplay the entire year." |
| 112 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 113 | #define cat_trivial_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 114 | "[-u] [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 115 | #define cat_full_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 116 | "Concatenates FILE(s) and prints them to stdout.\n\n" \ |
| 117 | "Options:\n" \ |
| 118 | "\t-u\tignored since unbuffered i/o is always used" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 119 | #define cat_example_usage \ |
| 120 | "$ cat /proc/uptime\n" \ |
| 121 | "110716.72 17.67" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 122 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 123 | #define chgrp_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 124 | "[OPTION]... GROUP FILE..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 125 | #define chgrp_full_usage \ |
| 126 | "Change the group membership of each FILE to GROUP.\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 127 | "\nOptions:\n" \ |
| 128 | "\t-R\tChanges files and directories recursively." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 129 | #define chgrp_example_usage \ |
| 130 | "$ ls -l /tmp/foo\n" \ |
| 131 | "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ |
| 132 | "$ chgrp root /tmp/foo\n" \ |
| 133 | "$ ls -l /tmp/foo\n" \ |
| 134 | "-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] | 135 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 136 | #define chmod_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 137 | "[-R] MODE[,MODE]... FILE..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 138 | #define chmod_full_usage \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 139 | "Each MODE is one or more of the letters ugoa, one of the\n" \ |
| 140 | "symbols +-= and one or more of the letters rwxst.\n\n" \ |
| 141 | "Options:\n" \ |
| 142 | "\t-R\tChanges files and directories recursively." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 143 | #define chmod_example_usage \ |
| 144 | "$ ls -l /tmp/foo\n" \ |
| 145 | "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \ |
| 146 | "$ chmod u+x /tmp/foo\n" \ |
| 147 | "$ ls -l /tmp/foo\n" \ |
| 148 | "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \ |
| 149 | "$ chmod 444 /tmp/foo\n" \ |
| 150 | "$ ls -l /tmp/foo\n" \ |
| 151 | "-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] | 152 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 153 | #define chown_trivial_usage \ |
Eric Andersen | 238da24 | 2001-05-11 16:31:46 +0000 | [diff] [blame] | 154 | "[ -Rh ]... OWNER[<.|:>[GROUP]] FILE..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 155 | #define chown_full_usage \ |
| 156 | "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] | 157 | "\nOptions:\n" \ |
Eric Andersen | 238da24 | 2001-05-11 16:31:46 +0000 | [diff] [blame] | 158 | "\t-R\tChanges files and directories recursively.\n" \ |
| 159 | "\t-h\tDo not dereference symbolic links." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 160 | #define chown_example_usage \ |
| 161 | "$ ls -l /tmp/foo\n" \ |
| 162 | "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ |
| 163 | "$ chown root /tmp/foo\n" \ |
| 164 | "$ ls -l /tmp/foo\n" \ |
| 165 | "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ |
| 166 | "$ chown root.root /tmp/foo\n" \ |
| 167 | "ls -l /tmp/foo\n" \ |
| 168 | "-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] | 169 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 170 | #define chroot_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 171 | "NEWROOT [COMMAND...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 172 | #define chroot_full_usage \ |
| 173 | "Run COMMAND with root directory set to NEWROOT." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 174 | #define chroot_example_usage \ |
| 175 | "$ ls -l /bin/ls\n" \ |
| 176 | "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^] | 177 | "# mount /dev/hdc1 /mnt -t minix\n" \ |
| 178 | "# chroot /mnt\n" \ |
| 179 | "# ls -l /bin/ls\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 180 | "-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] | 181 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 182 | #define chvt_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 183 | "N" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 184 | #define chvt_full_usage \ |
| 185 | "Changes the foreground virtual terminal to /dev/ttyN" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 186 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 187 | #define clear_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 188 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 189 | #define clear_full_usage \ |
| 190 | "Clear screen." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 191 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 192 | #define cmp_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 193 | "[-l] [-s] FILE1 [FILE2]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 194 | #define cmp_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 195 | "Compare files. Compares FILE1 vs stdin if FILE2 is not specified.\n\n" \ |
Manuel Novoa III | 4baef0c | 2003-03-19 18:40:42 +0000 | [diff] [blame] | 196 | "Options:\n" \ |
| 197 | "\t-l\tWrite the byte numbers (decimal) and values (octal)\n" \ |
| 198 | "\t\t for all differing bytes.\n" \ |
| 199 | "\t-s\tquiet mode - do not print" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 200 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 201 | #define cp_trivial_usage \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 202 | "[OPTION]... SOURCE DEST" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 203 | #define cp_full_usage \ |
| 204 | "Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.\n" \ |
| 205 | "\n" \ |
| 206 | "\t-a\tSame as -dpR\n" \ |
| 207 | "\t-d\tPreserves links\n" \ |
| 208 | "\t-p\tPreserves file attributes if possible\n" \ |
| 209 | "\t-f\tforce (implied; ignored) - always set\n" \ |
Eric Andersen | ced9705 | 2004-02-20 09:55:37 +0000 | [diff] [blame] | 210 | "\t-i\tinteractive, prompt before overwrite\n" \ |
| 211 | "\t-R,-r\tCopies directories recursively" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 212 | |
Glenn L McGrath | 8f5b63e | 2001-06-22 09:22:06 +0000 | [diff] [blame] | 213 | #define cpio_trivial_usage \ |
| 214 | "-[dimtuv][F cpiofile]" |
| 215 | #define cpio_full_usage \ |
| 216 | "Extract or list files from a cpio archive\n" \ |
| 217 | "Main operation mode:\n" \ |
Glenn L McGrath | 2e6d3cf | 2001-06-24 12:36:54 +0000 | [diff] [blame] | 218 | "\td\t\tmake leading directories\n" \ |
Glenn L McGrath | 8f5b63e | 2001-06-22 09:22:06 +0000 | [diff] [blame] | 219 | "\ti\t\textract\n" \ |
Glenn L McGrath | 2e6d3cf | 2001-06-24 12:36:54 +0000 | [diff] [blame] | 220 | "\tm\t\tpreserve mtime\n" \ |
Glenn L McGrath | 8f5b63e | 2001-06-22 09:22:06 +0000 | [diff] [blame] | 221 | "\tt\t\tlist\n" \ |
Eric Andersen | 6925d50 | 2001-12-16 09:23:09 +0000 | [diff] [blame] | 222 | "\tu\t\tunconditional overwrite\n" \ |
| 223 | "\tF\t\tinput from file" |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 224 | |
Eric Andersen | f6f7bfb | 2002-10-22 12:24:59 +0000 | [diff] [blame] | 225 | #define crond_trivial_usage \ |
| 226 | "-d[#] -c <crondir> -f -b" |
| 227 | #define crond_full_usage \ |
| 228 | "\t-d [#] -l [#] -S -L logfile -f -b -c dir\n" \ |
| 229 | "\t-d num\tdebug level\n" \ |
| 230 | "\t-l num\tlog level (8 - default)\n" \ |
Glenn L McGrath | 2af3044 | 2003-09-12 10:58:54 +0000 | [diff] [blame] | 231 | "\t-S\tlog to syslod (default)\n" \ |
Eric Andersen | f6f7bfb | 2002-10-22 12:24:59 +0000 | [diff] [blame] | 232 | "\t-L file\tlog to file\n" \ |
| 233 | "\t-f\trun in fordeground\n" \ |
| 234 | "\t-b\trun in background (default)\n" \ |
| 235 | "\t-c dir\tworking dir" |
| 236 | |
| 237 | #define crontab_trivial_usage \ |
Glenn L McGrath | d1daf8b | 2004-02-25 10:35:55 +0000 | [diff] [blame] | 238 | "[-c dir] {file|-}|[-u|-l|-e|-d user]" |
Eric Andersen | f6f7bfb | 2002-10-22 12:24:59 +0000 | [diff] [blame] | 239 | #define crontab_full_usage \ |
| 240 | "\tfile <opts> replace crontab from file\n" \ |
| 241 | "\t- <opts> replace crontab from stdin\n" \ |
| 242 | "\t-u user specify user\n" \ |
| 243 | "\t-l [user] list crontab for user\n" \ |
| 244 | "\t-e [user] edit crontab for user\n" \ |
| 245 | "\t-d [user] delete crontab for user\n" \ |
| 246 | "\t-c dir specify crontab directory" |
| 247 | |
| 248 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 249 | #define cut_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 250 | "[OPTION]... [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 251 | #define cut_full_usage \ |
| 252 | "Prints selected fields from each input FILE to standard output.\n\n" \ |
| 253 | "Options:\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 254 | "\t-b LIST\t\tOutput only bytes from LIST\n" \ |
| 255 | "\t-c LIST\t\tOutput only characters from LIST\n" \ |
| 256 | "\t-d CHAR\t\tUse CHAR instead of tab as the field delimiter\n" \ |
| 257 | "\t-s\t\tOutput only the lines containing delimiter\n" \ |
| 258 | "\t-f N\t\tPrint only these fields\n" \ |
| 259 | "\t-n\t\tIgnored" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 260 | #define cut_example_usage \ |
| 261 | "$ echo "Hello world" | cut -f 1 -d ' '\n" \ |
| 262 | "Hello\n" \ |
| 263 | "$ echo "Hello world" | cut -f 2 -d ' '\n" \ |
| 264 | "world\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 265 | |
Glenn L McGrath | 2ce002a | 2003-08-29 14:18:26 +0000 | [diff] [blame] | 266 | #ifdef CONFIG_FEATURE_DATE_ISOFMT |
| 267 | #define USAGE_DATE_ISOFMT(a) a |
| 268 | #else |
| 269 | #define USAGE_DATE_ISOFMT(a) |
| 270 | #endif |
| 271 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 272 | #define date_trivial_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 273 | "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 274 | #define date_full_usage \ |
| 275 | "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] | 276 | "\nOptions:\n" \ |
Eric Andersen | 41492d6 | 2001-02-23 00:05:56 +0000 | [diff] [blame] | 277 | "\t-R\t\tOutputs RFC-822 compliant date string\n" \ |
Glenn L McGrath | 2ce002a | 2003-08-29 14:18:26 +0000 | [diff] [blame] | 278 | "\t-d STRING\tDisplays time described by STRING, not `now'\n" \ |
| 279 | USAGE_DATE_ISOFMT("\t-I[TIMESPEC]\tOutputs an ISO-8601 compliant date/time string.\n" \ |
| 280 | "\t\t\tTIMESPEC=`date' (or missing) for date only,\n" \ |
| 281 | "\t\t\t`hours', `minutes', or `seconds' for date and,\n" \ |
| 282 | "\t\t\ttime to the indicated precision.\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 283 | "\t-s\t\tSets time described by STRING\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 284 | "\t-u\t\tPrints or sets Coordinated Universal Time" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 285 | #define date_example_usage \ |
| 286 | "$ date\n" \ |
| 287 | "Wed Apr 12 18:52:41 MDT 2000\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 288 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 289 | #define dc_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 290 | "expression ..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 291 | #define dc_full_usage \ |
| 292 | "This is a Tiny RPN calculator that understands the\n" \ |
Eric Andersen | a928774 | 2003-10-22 11:24:39 +0000 | [diff] [blame] | 293 | "following operations: +, add, -, sub, *, mul, /, div, %, mod, "\ |
| 294 | "**, exp, and, or, not, eor.\n" \ |
| 295 | "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16.\n" \ |
| 296 | "\nOptions:\n" \ |
Glenn L McGrath | 6d07432 | 2002-12-12 10:31:53 +0000 | [diff] [blame] | 297 | "p - Prints the value on the top of the stack, without altering the stack.\n" \ |
| 298 | "f - Prints the entire contents of the stack without altering anything.\n" \ |
| 299 | "o - Pops the value off the top of the stack and uses it to set the output radix.\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 300 | " Only 10 and 16 are supported." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 301 | #define dc_example_usage \ |
| 302 | "$ dc 2 2 +\n" \ |
| 303 | "4\n" \ |
Aaron Lehmann | 933d10d | 2002-08-23 22:09:50 +0000 | [diff] [blame] | 304 | "$ dc 8 8 * 2 2 + /\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 305 | "16\n" \ |
| 306 | "$ dc 0 1 and\n" \ |
| 307 | "0\n" \ |
| 308 | "$ dc 0 1 or\n" \ |
| 309 | "1\n" \ |
| 310 | "$ echo 72 9 div 8 mul | dc\n" \ |
| 311 | "64\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 312 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 313 | #define dd_trivial_usage \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 314 | "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \ |
Eric Andersen | ef38b39 | 2002-04-27 01:31:43 +0000 | [diff] [blame] | 315 | "\t [seek=N] [conv=notrunc|noerror|sync]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 316 | #define dd_full_usage \ |
| 317 | "Copy a file, converting and formatting according to options\n\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 318 | "\tif=FILE\t\tread from FILE instead of stdin\n" \ |
| 319 | "\tof=FILE\t\twrite to FILE instead of stdout\n" \ |
| 320 | "\tbs=N\t\tread and write N bytes at a time\n" \ |
| 321 | "\tcount=N\t\tcopy only N input blocks\n" \ |
| 322 | "\tskip=N\t\tskip N input blocks\n" \ |
| 323 | "\tseek=N\t\tskip N output blocks\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 324 | "\tconv=notrunc\tdon't truncate output file\n" \ |
Eric Andersen | ef38b39 | 2002-04-27 01:31:43 +0000 | [diff] [blame] | 325 | "\tconv=noerror\tcontinue after read errors\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 326 | "\tconv=sync\tpad blocks with zeros\n" \ |
| 327 | "\n" \ |
| 328 | "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 329 | "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 330 | #define dd_example_usage \ |
| 331 | "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \ |
| 332 | "4+0 records in\n" \ |
| 333 | "4+0 records out\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 334 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 335 | #define deallocvt_trivial_usage \ |
Glenn L McGrath | 17b4a20 | 2004-01-15 11:50:19 +0000 | [diff] [blame] | 336 | "[N]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 337 | #define deallocvt_full_usage \ |
| 338 | "Deallocate unused virtual terminal /dev/ttyN" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 339 | |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 340 | #define delgroup_trivial_usage \ |
| 341 | "GROUP" |
| 342 | #define delgroup_full_usage \ |
| 343 | "Deletes group GROUP from the system" |
| 344 | |
| 345 | #define deluser_trivial_usage \ |
| 346 | "USER" |
| 347 | #define deluser_full_usage \ |
| 348 | "Deletes user USER from the system" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 349 | |
Eric Andersen | f18bd89 | 2003-12-19 11:07:59 +0000 | [diff] [blame] | 350 | #ifdef CONFIG_DEVFSD_FG_NP |
| 351 | #define USAGE_DEVFSD_FG_NP(a) a |
| 352 | #else |
| 353 | #define USAGE_DEVFSD_FG_NP(a) |
| 354 | #endif |
| 355 | |
Glenn L McGrath | 17d21fa | 2003-10-09 11:46:23 +0000 | [diff] [blame] | 356 | #define devfsd_trivial_usage \ |
Eric Andersen | f18bd89 | 2003-12-19 11:07:59 +0000 | [diff] [blame] | 357 | "mntpnt [-v]"\ |
| 358 | USAGE_DEVFSD_FG_NP("[-fg][-np]" ) |
Glenn L McGrath | 17d21fa | 2003-10-09 11:46:23 +0000 | [diff] [blame] | 359 | #define devfsd_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 360 | "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] | 361 | "\nOptions:\n" \ |
| 362 | "\tmntpnt\tThe mount point where devfs is mounted.\n\n" \ |
| 363 | "\t-v\tPrint the protocol version numbers for devfsd\n" \ |
Eric Andersen | f18bd89 | 2003-12-19 11:07:59 +0000 | [diff] [blame] | 364 | "\t\tand the kernel-side protocol version and exits." \ |
| 365 | USAGE_DEVFSD_FG_NP( "\n\n\t-fg\tRun the daemon in the foreground.\n\n" \ |
| 366 | "\t-np\tExit after parsing the configuration file\n" \ |
| 367 | "\t\tand processing synthetic REGISTER events.\n" \ |
| 368 | "\t\tDo not poll for events.") |
Glenn L McGrath | 17d21fa | 2003-10-09 11:46:23 +0000 | [diff] [blame] | 369 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 370 | #ifdef CONFIG_FEATURE_HUMAN_READABLE |
Eric Andersen | ed0d958 | 2001-02-23 13:23:03 +0000 | [diff] [blame] | 371 | #define USAGE_HUMAN_READABLE(a) a |
| 372 | #define USAGE_NOT_HUMAN_READABLE(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 373 | #else |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 374 | #define USAGE_HUMAN_READABLE(a) |
Eric Andersen | ed0d958 | 2001-02-23 13:23:03 +0000 | [diff] [blame] | 375 | #define USAGE_NOT_HUMAN_READABLE(a) a |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 376 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 377 | #define df_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 378 | "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 379 | #define df_full_usage \ |
| 380 | "Print the filesystem space used and space available.\n\n" \ |
| 381 | "Options:\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 382 | USAGE_HUMAN_READABLE( \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 383 | "\n\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \ |
| 384 | "\t-m\tprint sizes in megabytes\n" \ |
Eric Andersen | ed0d958 | 2001-02-23 13:23:03 +0000 | [diff] [blame] | 385 | "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 386 | "\n\t-k\tprint sizes in kilobytes(compatibility)") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 387 | #define df_example_usage \ |
| 388 | "$ df\n" \ |
| 389 | "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ |
| 390 | "/dev/sda3 8690864 8553540 137324 98% /\n" \ |
| 391 | "/dev/sda1 64216 36364 27852 57% /boot\n" \ |
| 392 | "$ df /dev/sda3\n" \ |
| 393 | "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ |
| 394 | "/dev/sda3 8690864 8553540 137324 98% /\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 395 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 396 | #define dirname_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 397 | "FILENAME" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 398 | #define dirname_full_usage \ |
| 399 | "Strips non-directory suffix from FILENAME" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 400 | #define dirname_example_usage \ |
| 401 | "$ dirname /tmp/foo\n" \ |
| 402 | "/tmp\n" \ |
| 403 | "$ dirname /tmp/foo/\n" \ |
| 404 | "/tmp\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 405 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 406 | #define dmesg_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 407 | "[-c] [-n LEVEL] [-s SIZE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 408 | #define dmesg_full_usage \ |
| 409 | "Prints or controls the kernel ring buffer\n\n" \ |
| 410 | "Options:\n" \ |
| 411 | "\t-c\t\tClears the ring buffer's contents after printing\n" \ |
| 412 | "\t-n LEVEL\tSets console logging level\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 413 | "\t-s SIZE\t\tUse a buffer of size SIZE" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 414 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 415 | #define dos2unix_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 416 | "[option] [FILE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 417 | #define dos2unix_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 418 | "Converts FILE from dos format to unix format. When no option\n" \ |
| 419 | "is given, the input is converted to the opposite output format.\n" \ |
Eric Andersen | 3200f5a | 2001-05-22 22:39:10 +0000 | [diff] [blame] | 420 | "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] | 421 | "Options:\n" \ |
| 422 | "\t-u\toutput will be in UNIX format\n" \ |
Eric Andersen | 3200f5a | 2001-05-22 22:39:10 +0000 | [diff] [blame] | 423 | "\t-d\toutput will be in DOS format" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 424 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 425 | #define dpkg_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 426 | "[-iCPru] package_name" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 427 | #define dpkg_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 428 | "dpkg is a utility to install, remove and manage Debian packages.\n\n" \ |
| 429 | "Options:\n" \ |
Glenn L McGrath | b9e4ce9 | 2001-07-18 05:16:31 +0000 | [diff] [blame] | 430 | "\t-i\tInstall the package\n" \ |
| 431 | "\t-C\tConfigure an unpackaged package\n" \ |
| 432 | "\t-P\tPurge all files of a package\n" \ |
| 433 | "\t-r\tRemove all but the configuration files for a package\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 434 | "\t-u\tUnpack a package, but dont configure it" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 435 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 436 | #define dpkg_deb_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 437 | "[-cefItxX] FILE [argument]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 438 | #define dpkg_deb_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 439 | "Perform actions on Debian packages (.debs)\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 440 | "Options:\n" \ |
Glenn L McGrath | 3e2ab88 | 2001-04-12 13:49:09 +0000 | [diff] [blame] | 441 | "\t-c\tList contents of filesystem tree\n" \ |
Glenn L McGrath | 3136904 | 2001-04-15 12:53:24 +0000 | [diff] [blame] | 442 | "\t-e\tExtract control files to [argument] directory\n" \ |
| 443 | "\t-f\tDisplay control field name starting with [argument]\n" \ |
| 444 | "\t-I\tDisplay the control filenamed [argument]\n" \ |
| 445 | "\t-t\tExtract filesystem tree to stdout in tar format\n" \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 446 | "\t-x\tExtract packages filesystem tree to directory\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 447 | "\t-X\tVerbose extract" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 448 | #define dpkg_deb_example_usage \ |
| 449 | "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 450 | |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 451 | #ifdef CONFIG_FEATURE_DU_DEFALT_BLOCKSIZE_1K |
| 452 | #define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) a |
| 453 | #define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) |
| 454 | #else |
| 455 | #define USAGE_DU_DEFALT_BLOCKSIZE_1k(a) |
| 456 | #define USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k(a) a |
| 457 | #endif |
| 458 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 459 | #define du_trivial_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 460 | "[-aHLdclsx" USAGE_HUMAN_READABLE("hm") "k] [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 461 | #define du_full_usage \ |
| 462 | "Summarizes disk space used for each FILE and/or directory.\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 463 | "Disk space is printed in units of " \ |
| 464 | USAGE_DU_DEFALT_BLOCKSIZE_1k("1024") USAGE_NOT_DU_DEFALT_BLOCKSIZE_1k("512") \ |
| 465 | " bytes.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 466 | "Options:\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 467 | "\t-a\tshow sizes of files in addition to directories\n" \ |
| 468 | "\t-H\tfollow symbolic links that are FILE command line args\n" \ |
| 469 | "\t-L\tfollow all symbolic links encountered\n" \ |
| 470 | "\t-d N\tlimit output to directories (and files with -a) of depth < N\n" \ |
| 471 | "\t-c\toutput a grand total\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 472 | "\t-l\tcount sizes many times if hard linked\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 473 | "\t-s\tdisplay only a total for each argument\n" \ |
Eric Andersen | 265d229 | 2002-04-06 23:16:44 +0000 | [diff] [blame] | 474 | "\t-x\tskip directories on different filesystems\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 475 | USAGE_HUMAN_READABLE( \ |
| 476 | "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \ |
| 477 | "\t-m\tprint sizes in megabytes\n" ) \ |
| 478 | "\t-k\tprint sizes in kilobytes" USAGE_DU_DEFALT_BLOCKSIZE_1k("(default)") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 479 | #define du_example_usage \ |
| 480 | "$ du\n" \ |
| 481 | "16 ./CVS\n" \ |
| 482 | "12 ./kernel-patches/CVS\n" \ |
| 483 | "80 ./kernel-patches\n" \ |
| 484 | "12 ./tests/CVS\n" \ |
| 485 | "36 ./tests\n" \ |
| 486 | "12 ./scripts/CVS\n" \ |
| 487 | "16 ./scripts\n" \ |
| 488 | "12 ./docs/CVS\n" \ |
| 489 | "104 ./docs\n" \ |
| 490 | "2417 .\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 491 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 492 | #define dumpkmap_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 493 | "> keymap" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 494 | #define dumpkmap_full_usage \ |
| 495 | "Prints out a binary keyboard translation table to standard output." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 496 | #define dumpkmap_example_usage \ |
| 497 | "$ dumpkmap > keymap\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 498 | |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 499 | #define dumpleases_trivial_usage \ |
| 500 | "[-r|-a] [-f LEASEFILE]" |
| 501 | #define dumpleases_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 502 | "Displays the DHCP leases granted by udhcpd.\n\n" \ |
| 503 | "Options:\n" \ |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 504 | "\t-f,\t--file=FILENAME\tLeases file to load\n" \ |
| 505 | "\t-r,\t--remaining\tInterepret lease times as time remaing\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 506 | "\t-a,\t--absolute\tInterepret lease times as expire time" |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 507 | |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 508 | #ifdef CONFIG_FEATURE_FANCY_ECHO |
| 509 | #define USAGE_FANCY_ECHO(a) a |
| 510 | #else |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 511 | #define USAGE_FANCY_ECHO(a) |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 512 | #endif |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 513 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 514 | #define echo_trivial_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 515 | USAGE_FANCY_ECHO("[-neE] ") "[ARG ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 516 | #define echo_full_usage \ |
| 517 | "Prints the specified ARGs to stdout\n\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 518 | USAGE_FANCY_ECHO("Options:\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 519 | "\t-n\tsuppress trailing newline\n" \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 520 | "\t-e\tinterpret backslash-escaped characters (i.e., \\t=tab)\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 521 | "\t-E\tdisable interpretation of backslash-escaped characters") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 522 | #define echo_example_usage \ |
| 523 | "$ echo "Erik is cool"\n" \ |
| 524 | "Erik is cool\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 525 | USAGE_FANCY_ECHO("$ echo -e "Erik\\nis\\ncool"\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 526 | "Erik\n" \ |
| 527 | "is\n" \ |
| 528 | "cool\n" \ |
Eric Andersen | 6197c51 | 2001-05-18 23:14:53 +0000 | [diff] [blame] | 529 | "$ echo "Erik\\nis\\ncool"\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 530 | "Erik\\nis\\ncool\n") |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 531 | |
Eric Andersen | 84e229c | 2001-03-29 22:48:33 +0000 | [diff] [blame] | 532 | #define env_trivial_usage \ |
Matt Kraai | c96381b | 2001-05-11 14:28:17 +0000 | [diff] [blame] | 533 | "[-iu] [-] [name=value]... [command]" |
Eric Andersen | 84e229c | 2001-03-29 22:48:33 +0000 | [diff] [blame] | 534 | #define env_full_usage \ |
| 535 | "Prints the current environment or runs a program after setting\n" \ |
| 536 | "up the specified environment.\n\n" \ |
| 537 | "Options:\n" \ |
| 538 | "\t-, -i\tstart with an empty environment\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 539 | "\t-u\tremove variable from the environment" |
Eric Andersen | 84e229c | 2001-03-29 22:48:33 +0000 | [diff] [blame] | 540 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 541 | #define expr_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 542 | "EXPRESSION" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 543 | #define expr_full_usage \ |
| 544 | "Prints the value of EXPRESSION to standard output.\n\n" \ |
| 545 | "EXPRESSION may be:\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 546 | "\tARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \ |
| 547 | "\tARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \ |
| 548 | "\tARG1 < ARG2 ARG1 is less than ARG2\n" \ |
| 549 | "\tARG1 <= ARG2 ARG1 is less than or equal to ARG2\n" \ |
| 550 | "\tARG1 = ARG2 ARG1 is equal to ARG2\n" \ |
| 551 | "\tARG1 != ARG2 ARG1 is unequal to ARG2\n" \ |
| 552 | "\tARG1 >= ARG2 ARG1 is greater than or equal to ARG2\n" \ |
| 553 | "\tARG1 > ARG2 ARG1 is greater than ARG2\n" \ |
| 554 | "\tARG1 + ARG2 arithmetic sum of ARG1 and ARG2\n" \ |
| 555 | "\tARG1 - ARG2 arithmetic difference of ARG1 and ARG2\n" \ |
| 556 | "\tARG1 * ARG2 arithmetic product of ARG1 and ARG2\n" \ |
| 557 | "\tARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2\n" \ |
| 558 | "\tARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2\n" \ |
Eric Andersen | 3757f98 | 2001-02-23 17:47:51 +0000 | [diff] [blame] | 559 | "\tSTRING : REGEXP anchored pattern match of REGEXP in STRING\n" \ |
| 560 | "\tmatch STRING REGEXP same as STRING : REGEXP\n" \ |
| 561 | "\tsubstr STRING POS LENGTH substring of STRING, POS counted from 1\n" \ |
| 562 | "\tindex STRING CHARS index in STRING where any CHARS is found,\n" \ |
| 563 | "\t or 0\n" \ |
| 564 | "\tlength STRING length of STRING\n" \ |
| 565 | "\tquote TOKEN interpret TOKEN as a string, even if\n" \ |
| 566 | "\t it is a keyword like `match' or an\n" \ |
| 567 | "\t operator like `/'\n" \ |
| 568 | "\t( EXPRESSION ) value of EXPRESSION\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 569 | "Beware that many operators need to be escaped or quoted for shells.\n" \ |
| 570 | "Comparisons are arithmetic if both ARGs are numbers, else\n" \ |
| 571 | "lexicographical. Pattern matches return the string matched between \n" \ |
| 572 | "\\( and \\) or null; if \\( and \\) are not used, they return the number \n" \ |
| 573 | "of characters matched or 0." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 574 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 575 | #define false_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 576 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 577 | #define false_full_usage \ |
| 578 | "Return an exit code of FALSE (1)." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 579 | #define false_example_usage \ |
| 580 | "$ false\n" \ |
| 581 | "$ echo $?\n" \ |
| 582 | "1\n" |
| 583 | |
| 584 | #define fbset_trivial_usage \ |
| 585 | "[options] [mode]" |
| 586 | #define fbset_full_usage \ |
| 587 | "Show and modify frame buffer settings" |
| 588 | #define fbset_example_usage \ |
| 589 | "$ fbset\n" \ |
| 590 | "mode "1024x768-76"\n" \ |
| 591 | "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \ |
| 592 | "\tgeometry 1024 768 1024 768 16\n" \ |
| 593 | "\ttimings 12714 128 32 16 4 128 4\n" \ |
| 594 | "\taccel false\n" \ |
| 595 | "\trgba 5/11,6/5,5/0,0/0\n" \ |
| 596 | "endmode\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 597 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 598 | #define fdflush_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 599 | "DEVICE" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 600 | #define fdflush_full_usage \ |
| 601 | "Forces floppy disk drive to detect disk change" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 602 | |
Eric Andersen | 01c3d40 | 2003-07-05 07:51:31 +0000 | [diff] [blame] | 603 | #define fdformat_trivial_usage \ |
| 604 | "[-n] DEVICE" |
| 605 | #define fdformat_full_usage \ |
| 606 | "Low-level formats a floppy disk\n\n" \ |
| 607 | "Options:\n" \ |
| 608 | "\t-n\tDon't verify after format" |
| 609 | |
Glenn L McGrath | 441e7ef | 2002-11-26 22:00:21 +0000 | [diff] [blame] | 610 | #define fdisk_trivial_usage \ |
| 611 | "[-l] [-v] [-b SSZ] [-u] DISK" |
| 612 | #define fdisk_full_usage \ |
| 613 | "Change partition table\n" \ |
| 614 | "Options:\n" \ |
| 615 | "-l List partition table(s)\n" \ |
| 616 | "-u Give Start and End in sector (instead of cylinder) units\n" \ |
| 617 | "-s PARTITION Give partition size(s) in blocks\n" \ |
| 618 | "-b 2048: (for certain MO disks) use 2048-byte sectors\n" \ |
Glenn L McGrath | 062c74f | 2002-11-27 09:29:49 +0000 | [diff] [blame] | 619 | "-v Give fdisk version" |
Glenn L McGrath | 441e7ef | 2002-11-26 22:00:21 +0000 | [diff] [blame] | 620 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 621 | #ifdef CONFIG_FEATURE_FIND_TYPE |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 622 | #define USAGE_FIND_TYPE(a) a |
| 623 | #else |
| 624 | #define USAGE_FIND_TYPE(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 625 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 626 | #ifdef CONFIG_FEATURE_FIND_PERM |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 627 | #define USAGE_FIND_PERM(a) a |
| 628 | #else |
| 629 | #define USAGE_FIND_PERM(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 630 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 631 | #ifdef CONFIG_FEATURE_FIND_MTIME |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 632 | #define USAGE_FIND_MTIME(a) a |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 633 | #else |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 634 | #define USAGE_FIND_MTIME(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 635 | #endif |
Eric Andersen | 97d86f2 | 2003-01-23 05:27:42 +0000 | [diff] [blame] | 636 | #ifdef CONFIG_FEATURE_FIND_NEWER |
| 637 | #define USAGE_FIND_NEWER(a) a |
| 638 | #else |
| 639 | #define USAGE_FIND_NEWER(a) |
| 640 | #endif |
| 641 | #ifdef CONFIG_FEATURE_FIND_INUM |
| 642 | #define USAGE_FIND_INUM(a) a |
| 643 | #else |
| 644 | #define USAGE_FIND_INUM(a) |
| 645 | #endif |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 646 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 647 | #define find_trivial_usage \ |
| 648 | "[PATH...] [EXPRESSION]" |
| 649 | #define find_full_usage \ |
| 650 | "Search for files in a directory hierarchy. The default PATH is\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 651 | "the current directory; default EXPRESSION is '-print'\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 652 | "\nEXPRESSION may consist of:\n" \ |
| 653 | "\t-follow\t\tDereference symbolic links.\n" \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 654 | "\t-name PATTERN\tFile name (leading directories removed) matches PATTERN.\n" \ |
Mark Whitley | e0a7f91 | 2001-03-28 22:04:42 +0000 | [diff] [blame] | 655 | "\t-print\t\tPrint (default and assumed).\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 656 | USAGE_FIND_TYPE( \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 657 | "\n\t-type X\t\tFiletype matches X (where X is one of: f,d,l,b,c,...)" \ |
| 658 | ) USAGE_FIND_PERM( \ |
| 659 | "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \ |
| 660 | ) USAGE_FIND_MTIME( \ |
Eric Andersen | 97d86f2 | 2003-01-23 05:27:42 +0000 | [diff] [blame] | 661 | "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days" \ |
| 662 | ) USAGE_FIND_NEWER( \ |
| 663 | "\n\t-newer FILE\tModified time is more recent than FILE's" \ |
| 664 | ) USAGE_FIND_INUM( \ |
| 665 | "\n\t-inum N\t\tFile has inode number N") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 666 | #define find_example_usage \ |
Eric Andersen | 75eb90f | 2004-03-29 08:20:08 +0000 | [diff] [blame] | 667 | "$ find / -name passwd\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 668 | "/etc/passwd\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 669 | |
Glenn L McGrath | f01b805 | 2003-04-27 06:02:14 +0000 | [diff] [blame] | 670 | #define fold_trivial_usage \ |
| 671 | "[bsw] [FILE]" |
| 672 | #define fold_full_usage \ |
| 673 | "Wrap input lines in each FILE (standard input by default), writing to\n" \ |
| 674 | "standard output.\n\n" \ |
| 675 | "Options:\n" \ |
| 676 | "\t-b\tcount bytes rather than columns\n" \ |
| 677 | "\t-s\tbreak at spaces\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 678 | "\t-w\tuse WIDTH columns instead of 80" |
Glenn L McGrath | f01b805 | 2003-04-27 06:02:14 +0000 | [diff] [blame] | 679 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 680 | #define free_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 681 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 682 | #define free_full_usage \ |
| 683 | "Displays the amount of free and used system memory" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 684 | #define free_example_usage \ |
| 685 | "$ free\n" \ |
| 686 | " total used free shared buffers\n" \ |
| 687 | " Mem: 257628 248724 8904 59644 93124\n" \ |
| 688 | " Swap: 128516 8404 120112\n" \ |
| 689 | "Total: 386144 257128 129016\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 690 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 691 | #define freeramdisk_trivial_usage \ |
| 692 | "DEVICE" |
| 693 | #define freeramdisk_full_usage \ |
| 694 | "Frees all memory used by the specified ramdisk." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 695 | #define freeramdisk_example_usage \ |
| 696 | "$ freeramdisk /dev/ram2\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 697 | |
| 698 | #define fsck_minix_trivial_usage \ |
| 699 | "[-larvsmf] /dev/name" |
| 700 | #define fsck_minix_full_usage \ |
| 701 | "Performs a consistency check for MINIX filesystems.\n\n" \ |
| 702 | "Options:\n" \ |
| 703 | "\t-l\tLists all filenames\n" \ |
| 704 | "\t-r\tPerform interactive repairs\n" \ |
| 705 | "\t-a\tPerform automatic repairs\n" \ |
| 706 | "\t-v\tverbose\n" \ |
| 707 | "\t-s\tOutputs super-block information\n" \ |
| 708 | "\t-m\tActivates MINIX-like \"mode not cleared\" warnings\n" \ |
| 709 | "\t-f\tForce file system check." |
| 710 | |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 711 | #define ftpget_trivial_usage \ |
Glenn L McGrath | 58fd67f | 2004-02-22 04:12:58 +0000 | [diff] [blame] | 712 | "[options] remote-host local-file remote-file" |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 713 | #define ftpget_full_usage \ |
| 714 | "Retrieve a remote file via FTP.\n\n" \ |
| 715 | "Options:\n" \ |
| 716 | "\t-c, --continue Continue a previous transfer\n" \ |
| 717 | "\t-v, --verbose Verbose\n" \ |
| 718 | "\t-u, --username Username to be used\n" \ |
| 719 | "\t-p, --password Password to be used\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 720 | "\t-P, --port Port number to be used" |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 721 | |
| 722 | #define ftpput_trivial_usage \ |
Glenn L McGrath | 58fd67f | 2004-02-22 04:12:58 +0000 | [diff] [blame] | 723 | "[options] remote-host remote-file local-file" |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 724 | #define ftpput_full_usage \ |
| 725 | "Store a local file on a remote machine via FTP.\n\n" \ |
| 726 | "Options:\n" \ |
| 727 | "\t-v, --verbose Verbose\n" \ |
| 728 | "\t-u, --username Username to be used\n" \ |
| 729 | "\t-p, --password Password to be used\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 730 | "\t-P, --port Port number to be used" |
Glenn L McGrath | 02d7cbf | 2002-12-13 02:43:50 +0000 | [diff] [blame] | 731 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 732 | #define getopt_trivial_usage \ |
| 733 | "[OPTIONS]..." |
| 734 | #define getopt_full_usage \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 735 | "Parse command options\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 736 | "\t-a, --alternative Allow long options starting with single -\n" \ |
| 737 | "\t-l, --longoptions=longopts Long options to be recognized\n" \ |
| 738 | "\t-n, --name=progname The name under which errors are reported\n" \ |
| 739 | "\t-o, --options=optstring Short options to be recognized\n" \ |
| 740 | "\t-q, --quiet Disable error reporting by getopt(3)\n" \ |
| 741 | "\t-Q, --quiet-output No normal output\n" \ |
| 742 | "\t-s, --shell=shell Set shell quoting conventions\n" \ |
| 743 | "\t-T, --test Test for getopt(1) version\n" \ |
| 744 | "\t-u, --unqote Do not quote the output" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 745 | #define getopt_example_usage \ |
| 746 | "$ cat getopt.test\n" \ |
| 747 | "#!/bin/sh\n" \ |
| 748 | "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \ |
| 749 | " -n 'example.busybox' -- "$@"`\n" \ |
| 750 | "if [ $? != 0 ] ; then exit 1 ; fi\n" \ |
| 751 | "eval set -- "$GETOPT"\n" \ |
| 752 | "while true ; do\n" \ |
| 753 | " case $1 in\n" \ |
| 754 | " -a|--a-long) echo \"Option a\" ; shift ;;\n" \ |
Aaron Lehmann | 933d10d | 2002-08-23 22:09:50 +0000 | [diff] [blame] | 755 | " -b|--b-long) echo \"Option b, argument `$2'\" ; shift 2 ;;\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 756 | " -c|--c-long)\n" \ |
| 757 | " case "$2" in\n" \ |
| 758 | " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \ |
Aaron Lehmann | 933d10d | 2002-08-23 22:09:50 +0000 | [diff] [blame] | 759 | " *) echo \"Option c, argument `$2'\" ; shift 2 ;;\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 760 | " esac ;;\n" \ |
| 761 | " --) shift ; break ;;\n" \ |
| 762 | " *) echo \"Internal error!\" ; exit 1 ;;\n" \ |
| 763 | " esac\n" \ |
| 764 | "done\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 765 | |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 766 | #define getty_trivial_usage \ |
Glenn L McGrath | d1daf8b | 2004-02-25 10:35:55 +0000 | [diff] [blame] | 767 | "[OPTIONS]... baud_rate,... line [termtype]" |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 768 | #define getty_full_usage \ |
| 769 | "\nOpens a tty, prompts for a login name, then invokes /bin/login\n\n" \ |
| 770 | "Options:\n" \ |
| 771 | "\t-h\t\tEnable hardware (RTS/CTS) flow control.\n" \ |
| 772 | "\t-i\t\tDo not display /etc/issue before running login.\n" \ |
| 773 | "\t-L\t\tLocal line, so do not do carrier detect.\n" \ |
| 774 | "\t-m\t\tGet baud rate from modem's CONNECT status message.\n" \ |
| 775 | "\t-w\t\tWait for a CR or LF before sending /etc/issue.\n" \ |
Glenn L McGrath | 49e74ef | 2003-05-13 14:59:07 +0000 | [diff] [blame] | 776 | "\t-n\t\tDo not prompt the user for a login name.\n" \ |
| 777 | "\t-f issue_file\tDisplay issue_file instead of /etc/issue.\n" \ |
Eric Andersen | f349e97 | 2001-08-21 16:18:59 +0000 | [diff] [blame] | 778 | "\t-l login_app\tInvoke login_app instead of /bin/login.\n" \ |
| 779 | "\t-t timeout\tTerminate after timeout if no username is read.\n" \ |
| 780 | "\t-I initstring\tSets the init string to send before anything else.\n" \ |
| 781 | "\t-H login_host\tLog login_host into the utmp file as the hostname." |
| 782 | |
| 783 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 784 | #define grep_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 785 | "[-ihHnqvs] PATTERN [FILEs...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 786 | #define grep_full_usage \ |
| 787 | "Search for PATTERN in each FILE or standard input.\n\n" \ |
| 788 | "Options:\n" \ |
| 789 | "\t-H\tprefix output lines with filename where match was found\n" \ |
| 790 | "\t-h\tsuppress the prefixing filename on output\n" \ |
| 791 | "\t-i\tignore case distinctions\n" \ |
Eric Andersen | 303dd28 | 2001-04-09 23:26:31 +0000 | [diff] [blame] | 792 | "\t-l\tlist names of files that match\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 793 | "\t-n\tprint line number with output lines\n" \ |
| 794 | "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \ |
| 795 | "\t-v\tselect non-matching lines\n" \ |
| 796 | "\t-s\tsuppress file open/read error messages" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 797 | #define grep_example_usage \ |
| 798 | "$ grep root /etc/passwd\n" \ |
| 799 | "root:x:0:0:root:/root:/bin/bash\n" \ |
| 800 | "$ grep ^[rR]oo. /etc/passwd\n" \ |
| 801 | "root:x:0:0:root:/root:/bin/bash\n" |
Mark Whitley | 40e5e7c | 2001-03-14 17:45:45 +0000 | [diff] [blame] | 802 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 803 | #define gunzip_trivial_usage \ |
| 804 | "[OPTION]... FILE" |
| 805 | #define gunzip_full_usage \ |
| 806 | "Uncompress FILE (or standard input if FILE is '-').\n\n" \ |
| 807 | "Options:\n" \ |
| 808 | "\t-c\tWrite output to standard output\n" \ |
| 809 | "\t-t\tTest compressed file integrity" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 810 | #define gunzip_example_usage \ |
| 811 | "$ ls -la /tmp/BusyBox*\n" \ |
| 812 | "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \ |
| 813 | "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \ |
| 814 | "$ ls -la /tmp/BusyBox*\n" \ |
| 815 | "-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] | 816 | |
| 817 | #define gzip_trivial_usage \ |
Matt Kraai | 9bd49d6 | 2002-02-05 22:31:48 +0000 | [diff] [blame] | 818 | "[OPTION]... [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 819 | #define gzip_full_usage \ |
Matt Kraai | 9bd49d6 | 2002-02-05 22:31:48 +0000 | [diff] [blame] | 820 | "Compress FILE(s) with maximum compression.\n" \ |
Matt Kraai | 273af73 | 2002-02-05 19:25:29 +0000 | [diff] [blame] | 821 | "When FILE is '-' or unspecified, reads standard input. Implies -c.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 822 | "Options:\n" \ |
| 823 | "\t-c\tWrite output to standard output instead of FILE.gz\n" \ |
| 824 | "\t-d\tdecompress" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 825 | #define gzip_example_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 826 | "$ ls -la /tmp/busybox*\n" \ |
| 827 | "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \ |
| 828 | "$ gzip /tmp/busybox.tar\n" \ |
| 829 | "$ ls -la /tmp/busybox*\n" \ |
| 830 | "-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] | 831 | |
| 832 | #define halt_trivial_usage \ |
| 833 | "" |
| 834 | #define halt_full_usage \ |
| 835 | "Halt the system." |
| 836 | |
Eric Andersen | 3443bd7 | 2003-07-22 07:30:36 +0000 | [diff] [blame] | 837 | #ifdef CONFIG_FEATURE_HDPARM_GET_IDENTITY |
| 838 | #define USAGE_HDPARM_IDENT(a) a |
| 839 | #else |
| 840 | #define USAGE_HDPARM_IDENT(a) |
| 841 | #endif |
| 842 | |
| 843 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_SCAN_HWIF |
| 844 | #define USAGE_SCAN_HWIF(a) a |
| 845 | #else |
| 846 | #define USAGE_SCAN_HWIF(a) |
| 847 | #endif |
| 848 | |
| 849 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF |
| 850 | #define USAGE_UNREGISTER_HWIF(a) a |
| 851 | #else |
| 852 | #define USAGE_UNREGISTER_HWIF(a) |
| 853 | #endif |
| 854 | |
| 855 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_DRIVE_RESET |
| 856 | #define USAGE_DRIVE_RESET(a) a |
| 857 | #else |
| 858 | #define USAGE_DRIVE_RESET(a) |
| 859 | #endif |
| 860 | |
| 861 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_TRISTATE_HWIF |
| 862 | #define USAGE_TRISTATE_HWIF(a) a |
| 863 | #else |
| 864 | #define USAGE_TRISTATE_HWIF(a) |
| 865 | #endif |
| 866 | |
Eric Andersen | 0a57a79 | 2003-08-06 08:57:35 +0000 | [diff] [blame] | 867 | #ifdef CONFIG_FEATURE_HDPARM_HDIO_GETSET_DMA |
| 868 | #define USAGE_GETSET_DMA(a) a |
| 869 | #else |
| 870 | #define USAGE_GETSET_DMA(a) |
| 871 | #endif |
| 872 | |
Eric Andersen | 3443bd7 | 2003-07-22 07:30:36 +0000 | [diff] [blame] | 873 | #define hdparm_trivial_usage \ |
| 874 | "[options] [device] .." |
| 875 | #define hdparm_full_usage \ |
| 876 | "Options:" \ |
| 877 | " -a get/set fs readahead\n" \ |
| 878 | " -A set drive read-lookahead flag (0/1)\n" \ |
| 879 | " -b get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \ |
| 880 | " -B set Advanced Power Management setting (1-255)\n" \ |
| 881 | " -c get/set IDE 32-bit IO setting\n" \ |
| 882 | " -C check IDE power mode status\n" \ |
Eric Andersen | 0a57a79 | 2003-08-06 08:57:35 +0000 | [diff] [blame] | 883 | USAGE_GETSET_DMA(" -d get/set using_dma flag\n") \ |
Eric Andersen | 3443bd7 | 2003-07-22 07:30:36 +0000 | [diff] [blame] | 884 | " -D enable/disable drive defect-mgmt\n" \ |
| 885 | " -f flush buffer cache for device on exit\n" \ |
| 886 | " -g display drive geometry\n" \ |
| 887 | " -h display terse usage information\n" \ |
| 888 | " -i display drive identification\n" \ |
| 889 | USAGE_HDPARM_IDENT(" -I detailed/current information directly from drive\n") \ |
| 890 | USAGE_HDPARM_IDENT(" -Istdin similar to -I, but wants /proc/ide/" "*" "/hd?/identify as input\n") \ |
| 891 | " -k get/set keep_settings_over_reset flag (0/1)\n" \ |
| 892 | " -K set drive keep_features_over_reset flag (0/1)\n" \ |
| 893 | " -L set drive doorlock (0/1) (removable harddisks only)\n" \ |
| 894 | " -m get/set multiple sector count\n" \ |
| 895 | " -n get/set ignore-write-errors flag (0/1)\n" \ |
| 896 | " -p set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \ |
| 897 | " -P set drive prefetch count\n" \ |
| 898 | " -q change next setting quietly\n" \ |
| 899 | " -Q get/set DMA tagged-queuing depth (if supported)\n" \ |
| 900 | " -r get/set readonly flag (DANGEROUS to set)\n" \ |
| 901 | USAGE_SCAN_HWIF(" -R register an IDE interface (DANGEROUS)\n") \ |
| 902 | " -S set standby (spindown) timeout\n" \ |
| 903 | " -t perform device read timings\n" \ |
| 904 | " -T perform cache read timings\n" \ |
| 905 | " -u get/set unmaskirq flag (0/1)\n" \ |
| 906 | USAGE_UNREGISTER_HWIF(" -U un-register an IDE interface (DANGEROUS)\n") \ |
| 907 | " -v defaults; same as -mcudkrag for IDE drives\n" \ |
| 908 | " -V display program version and exit immediately\n" \ |
| 909 | USAGE_DRIVE_RESET(" -w perform device reset (DANGEROUS)\n") \ |
| 910 | " -W set drive write-caching flag (0/1) (DANGEROUS)\n" \ |
| 911 | USAGE_TRISTATE_HWIF(" -x tristate device for hotswap (0/1) (DANGEROUS)\n") \ |
| 912 | " -X set IDE xfer mode (DANGEROUS)\n" \ |
| 913 | " -y put IDE drive in standby mode\n" \ |
| 914 | " -Y put IDE drive to sleep\n" \ |
| 915 | " -Z disable Seagate auto-powersaving mode\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 916 | " -z re-read partition table" |
Eric Andersen | 3443bd7 | 2003-07-22 07:30:36 +0000 | [diff] [blame] | 917 | |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 918 | #ifdef CONFIG_FEATURE_FANCY_HEAD |
| 919 | #define USAGE_FANCY_HEAD(a) a |
| 920 | #else |
| 921 | #define USAGE_FANCY_HEAD(a) |
| 922 | #endif |
| 923 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 924 | #define head_trivial_usage \ |
Manuel Novoa III | 4baef0c | 2003-03-19 18:40:42 +0000 | [diff] [blame] | 925 | "[OPTION]... [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 926 | #define head_full_usage \ |
| 927 | "Print first 10 lines of each FILE to standard output.\n" \ |
| 928 | "With more than one FILE, precede each with a header giving the\n" \ |
| 929 | "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] | 930 | "Options:\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 931 | "\t-n NUM\t\tPrint first NUM lines instead of first 10" \ |
| 932 | USAGE_FANCY_HEAD( \ |
| 933 | "\n\t-c NUM\t\toutput the first NUM bytes\n" \ |
| 934 | "\t-q\t\tnever output headers giving file names\n" \ |
| 935 | "\t-v\t\talways output headers giving file names" ) |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 936 | #define head_example_usage \ |
| 937 | "$ head -n 2 /etc/passwd\n" \ |
| 938 | "root:x:0:0:root:/root:/bin/bash\n" \ |
| 939 | "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 940 | |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 941 | #define hexdump_trivial_usage \ |
| 942 | "[-[bcdefnosvx]] [OPTION] FILE" |
| 943 | #define hexdump_full_usage \ |
| 944 | "The hexdump utility is a filter which displays the specified files,\n" \ |
| 945 | "or the standard input, if no files are specified, in a user specified\n"\ |
| 946 | "format\n" \ |
| 947 | "\t-b\t\tOne-byte octal display\n" \ |
| 948 | "\t-c\t\tOne-byte character display\n" \ |
| 949 | "\t-d\t\tTwo-byte decimal display\n" \ |
| 950 | "\t-e FORMAT STRING\n" \ |
| 951 | "\t-f FORMAT FILE\n" \ |
| 952 | "\t-n LENGTH\tInterpret only length bytes of input\n" \ |
| 953 | "\t-o\t\tTwo-byte octal display\n" \ |
| 954 | "\t-s OFFSET\tSkip offset byte\n" \ |
| 955 | "\t-v\t\tdisplay all input data\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 956 | "\t-x\t\tTwo-byte hexadecimal display" |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 957 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 958 | #define hostid_trivial_usage \ |
| 959 | "" |
| 960 | #define hostid_full_usage \ |
| 961 | "Print out a unique 32-bit identifier for the machine." |
| 962 | |
| 963 | #define hostname_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 964 | "[OPTION] {hostname | -F FILE}" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 965 | #define hostname_full_usage \ |
| 966 | "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] | 967 | "(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] | 968 | "Options:\n" \ |
Matt Kraai | 54805af | 2001-12-06 17:37:51 +0000 | [diff] [blame] | 969 | "\t-s\tShort\n" \ |
| 970 | "\t-i\tAddresses for the hostname\n" \ |
| 971 | "\t-d\tDNS domain name\n" \ |
| 972 | "\t-f\tFully qualified domain name\n" \ |
| 973 | "\t-F FILE\tUse the contents of FILE to specify the hostname" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 974 | #define hostname_example_usage \ |
| 975 | "$ hostname\n" \ |
Eric Andersen | 08f59e3 | 2004-03-12 22:07:10 +0000 | [diff] [blame] | 976 | "sage\n" |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 977 | |
Glenn L McGrath | 58c708a | 2003-01-05 04:01:56 +0000 | [diff] [blame] | 978 | #ifdef CONFIG_FEATURE_HTTPD_BASIC_AUTH |
| 979 | #define USAGE_HTTPD_BASIC_AUTH(a) a |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 980 | #ifdef CONFIG_FEATURE_HTTPD_AUTH_MD5 |
| 981 | #define USAGE_HTTPD_AUTH_MD5(a) a |
| 982 | #else |
| 983 | #define USAGE_HTTPD_AUTH_MD5(a) |
| 984 | #endif |
Glenn L McGrath | 58c708a | 2003-01-05 04:01:56 +0000 | [diff] [blame] | 985 | #else |
| 986 | #define USAGE_HTTPD_BASIC_AUTH(a) |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 987 | #define USAGE_HTTPD_AUTH_MD5(a) |
| 988 | #endif |
| 989 | #ifdef CONFIG_FEATURE_HTTPD_USAGE_FROM_INETD_ONLY |
| 990 | #define USAGE_HTTPD_STANDALONE(a) |
| 991 | #define USAGE_HTTPD_SETUID(a) |
| 992 | #else |
| 993 | #define USAGE_HTTPD_STANDALONE(a) a |
| 994 | #ifdef CONFIG_FEATURE_HTTPD_SETUID |
| 995 | #define USAGE_HTTPD_SETUID(a) a |
| 996 | #else |
| 997 | #define USAGE_HTTPD_SETUID(a) |
| 998 | #endif |
Glenn L McGrath | 58c708a | 2003-01-05 04:01:56 +0000 | [diff] [blame] | 999 | #endif |
| 1000 | #define httpd_trivial_usage \ |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 1001 | "[-c <conf file>]" \ |
| 1002 | USAGE_HTTPD_STANDALONE(" [-p <port>]") \ |
| 1003 | USAGE_HTTPD_SETUID(" [-u user]") \ |
| 1004 | USAGE_HTTPD_BASIC_AUTH(" [-r <realm>]") \ |
| 1005 | USAGE_HTTPD_AUTH_MD5(" [-m pass]") \ |
| 1006 | " [-d/-e <string>]" |
Glenn L McGrath | 58c708a | 2003-01-05 04:01:56 +0000 | [diff] [blame] | 1007 | #define httpd_full_usage \ |
| 1008 | "Listens for incoming http server requests.\n"\ |
| 1009 | "Options:\n" \ |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 1010 | "\t-c FILE\tSpecifies configuration file. (default httpd.conf)\n" \ |
| 1011 | USAGE_HTTPD_STANDALONE("\t-p PORT\tServer port (default 80)\n") \ |
| 1012 | USAGE_HTTPD_SETUID("\t-u USER\tSet uid to USER after listening privilegies port\n") \ |
| 1013 | USAGE_HTTPD_BASIC_AUTH("\t-r REALM\tAuthentication Realm for Basic Authentication\n") \ |
| 1014 | USAGE_HTTPD_AUTH_MD5("\t-m PASS\tCrypt PASS with md5 algorithm\n") \ |
Glenn L McGrath | 58c708a | 2003-01-05 04:01:56 +0000 | [diff] [blame] | 1015 | "\t-e STRING\tHtml encode STRING\n" \ |
Eric Andersen | 4052051 | 2003-07-28 09:59:05 +0000 | [diff] [blame] | 1016 | "\t-d STRING\tURL decode STRING" |
| 1017 | |
Robert Griebl | 1cd0445 | 2002-07-21 16:50:49 +0000 | [diff] [blame] | 1018 | #define hwclock_trivial_usage \ |
| 1019 | "[-r|--show] [-s|--hctosys] [-w|--systohc] [-l|--localtime] [-u|--utc]" |
| 1020 | #define hwclock_full_usage \ |
| 1021 | "Query and set the hardware clock (RTC)\n\n" \ |
| 1022 | "Options:\n" \ |
| 1023 | "\t-r\tread hardware clock and print result\n" \ |
| 1024 | "\t-s\tset the system time from the hardware clock\n" \ |
| 1025 | "\t-w\tset the hardware clock to the current system time\n" \ |
| 1026 | "\t-u\tthe hardware clock is kept in coordinated universal time\n" \ |
| 1027 | "\t-l\tthe hardware clock is kept in local time" |
| 1028 | |
Eric Andersen | 9e48045 | 2003-07-03 10:07:04 +0000 | [diff] [blame] | 1029 | #ifdef CONFIG_SELINUX |
| 1030 | #define USAGE_SELINUX(a, b) a |
| 1031 | #else |
| 1032 | #define USAGE_SELINUX(a, b) b |
| 1033 | #endif |
| 1034 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1035 | #define id_trivial_usage \ |
| 1036 | "[OPTIONS]... [USERNAME]" |
| 1037 | #define id_full_usage \ |
| 1038 | "Print information for USERNAME or the current user\n\n" \ |
| 1039 | "Options:\n" \ |
| 1040 | "\t-g\tprints only the group ID\n" \ |
| 1041 | "\t-u\tprints only the user ID\n" \ |
Eric Andersen | 9e48045 | 2003-07-03 10:07:04 +0000 | [diff] [blame] | 1042 | USAGE_SELINUX("\t-c\tprints only the security context\n", "") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1043 | "\t-n\tprint a name instead of a number (with for -ug)\n" \ |
| 1044 | "\t-r\tprints the real user ID instead of the effective ID (with -ug)" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1045 | #define id_example_usage \ |
| 1046 | "$ id\n" \ |
| 1047 | "uid=1000(andersen) gid=1000(andersen)\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1048 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1049 | #ifdef CONFIG_FEATURE_IFCONFIG_SLIP |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1050 | #define USAGE_SIOCSKEEPALIVE(a) a |
| 1051 | #else |
| 1052 | #define USAGE_SIOCSKEEPALIVE(a) |
| 1053 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1054 | #ifdef CONFIG_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1055 | #define USAGE_IFCONFIG_MII(a) a |
| 1056 | #else |
| 1057 | #define USAGE_IFCONFIG_MII(a) |
| 1058 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1059 | #ifdef CONFIG_FEATURE_IFCONFIG_HW |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1060 | #define USAGE_IFCONFIG_HW(a) a |
| 1061 | #else |
| 1062 | #define USAGE_IFCONFIG_HW(a) |
| 1063 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1064 | #ifdef CONFIG_FEATURE_IFCONFIG_STATUS |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1065 | #define USAGE_IFCONFIG_OPT_A(a) a |
| 1066 | #else |
| 1067 | #define USAGE_IFCONFIG_OPT_A(a) |
| 1068 | #endif |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 1069 | #ifdef CONFIG_FEATURE_IPV6 |
| 1070 | #define USAGE_IPV6(a) a |
| 1071 | #else |
| 1072 | #define USAGE_IPV6(a) |
| 1073 | #endif |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1074 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1075 | #define ifconfig_trivial_usage \ |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1076 | USAGE_IFCONFIG_OPT_A("[-a]") " <interface> [<address>]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1077 | #define ifconfig_full_usage \ |
| 1078 | "configure a network interface\n\n" \ |
| 1079 | "Options:\n" \ |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 1080 | USAGE_IPV6("[add <address>[/<prefixlen>]]\n") \ |
| 1081 | USAGE_IPV6("[del <address>[/<prefixlen>]]\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1082 | "\t[[-]broadcast [<address>]] [[-]pointopoint [<address>]]\n" \ |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1083 | "\t[netmask <address>] [dstaddr <address>]\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1084 | USAGE_SIOCSKEEPALIVE("\t[outfill <NN>] [keepalive <NN>]\n") \ |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1085 | "\t" USAGE_IFCONFIG_HW("[hw ether <address>] ") \ |
| 1086 | "[metric <NN>] [mtu <NN>]\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1087 | "\t[[-]trailers] [[-]arp] [[-]allmulti]\n" \ |
Manuel Novoa III | 22b889a | 2001-03-12 09:58:51 +0000 | [diff] [blame] | 1088 | "\t[multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic]\n" \ |
| 1089 | 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] | 1090 | "\t[up|down] ..." |
| 1091 | |
Glenn L McGrath | 021fa7d | 2002-11-09 09:34:15 +0000 | [diff] [blame] | 1092 | #define ifup_trivial_usage \ |
| 1093 | "<-ahinv> <ifaces...>" |
| 1094 | #define ifup_full_usage \ |
| 1095 | "Usage: ifup <options> <ifaces...>\n\n" \ |
| 1096 | "Options:\n" \ |
Glenn L McGrath | d66370c | 2003-01-13 21:40:38 +0000 | [diff] [blame] | 1097 | "\t-h\tthis help\n" \ |
| 1098 | "\t-a\tde/configure all interfaces automatically\n" \ |
| 1099 | "\t-i FILE\tuse FILE for interface definitions\n" \ |
| 1100 | "\t-n\tprint out what would happen, but don't do it\n" \ |
| 1101 | "\t\t\t(note that this option doesn't disable mappings)\n" \ |
| 1102 | "\t-v\tprint out what would happen before doing it\n" \ |
| 1103 | "\t-m\tdon't run any mappings\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1104 | "\t-f\tforce de/configuration" |
Glenn L McGrath | 021fa7d | 2002-11-09 09:34:15 +0000 | [diff] [blame] | 1105 | |
| 1106 | #define ifdown_trivial_usage \ |
| 1107 | "<-ahinv> <ifaces...>" |
| 1108 | #define ifdown_full_usage \ |
| 1109 | "Usage: ifdown <options> <ifaces...>\n\n" \ |
| 1110 | "Options:\n" \ |
Glenn L McGrath | d66370c | 2003-01-13 21:40:38 +0000 | [diff] [blame] | 1111 | "\t-h\tthis help\n" \ |
| 1112 | "\t-a\tde/configure all interfaces automatically\n" \ |
| 1113 | "\t-i FILE\tuse FILE for interface definitions\n" \ |
| 1114 | "\t-n\tprint out what would happen, but don't do it\n" \ |
| 1115 | "\t\t(note that this option doesn't disable mappings)\n" \ |
| 1116 | "\t-v\tprint out what would happen before doing it\n" \ |
| 1117 | "\t-m\tdon't run any mappings\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1118 | "\t-f\tforce de/configuration" |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1119 | |
Glenn L McGrath | 06e9565 | 2003-02-09 06:51:14 +0000 | [diff] [blame] | 1120 | #define inetd_trivial_usage \ |
| 1121 | "[-q len] [conf]" |
| 1122 | #define inetd_full_usage \ |
| 1123 | "Usage: [-q len] [conf]\n\n" \ |
| 1124 | "Option:\n" \ |
| 1125 | "\t-q\tSets the size of the socket listen queue to\n" \ |
| 1126 | "the specified value. Default is 128." |
| 1127 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1128 | #define init_trivial_usage \ |
| 1129 | "" |
| 1130 | #define init_full_usage \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1131 | "Init is the parent of all processes." |
| 1132 | #define init_notes_usage \ |
| 1133 | "This version of init is designed to be run only by the kernel.\n" \ |
| 1134 | "\n" \ |
| 1135 | "BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \ |
| 1136 | "the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \ |
| 1137 | "runlevels, use sysvinit.\n" \ |
| 1138 | "\n" \ |
| 1139 | "BusyBox init works just fine without an inittab. If no inittab is found, \n" \ |
| 1140 | "it has the following default behavior:\n" \ |
| 1141 | "\n" \ |
| 1142 | " ::sysinit:/etc/init.d/rcS\n" \ |
| 1143 | " ::askfirst:/bin/sh\n" \ |
Eric Andersen | c97ec34 | 2001-04-03 18:01:51 +0000 | [diff] [blame] | 1144 | " ::ctrlaltdel:/sbin/reboot\n" \ |
| 1145 | " ::shutdown:/sbin/swapoff -a\n" \ |
| 1146 | " ::shutdown:/bin/umount -a -r\n" \ |
Eric Andersen | 730f826 | 2001-12-17 23:13:08 +0000 | [diff] [blame] | 1147 | " ::restart:/sbin/init\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1148 | "\n" \ |
| 1149 | "if it detects that /dev/console is _not_ a serial console, it will also run:\n" \ |
| 1150 | "\n" \ |
| 1151 | " tty2::askfirst:/bin/sh\n" \ |
Eric Andersen | c97ec34 | 2001-04-03 18:01:51 +0000 | [diff] [blame] | 1152 | " tty3::askfirst:/bin/sh\n" \ |
| 1153 | " tty4::askfirst:/bin/sh\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1154 | "\n" \ |
| 1155 | "If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \ |
| 1156 | "\n" \ |
| 1157 | " <id>:<runlevels>:<action>:<process>\n" \ |
| 1158 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1159 | " <id>:\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1160 | "\n" \ |
| 1161 | " WARNING: This field has a non-traditional meaning for BusyBox init!\n" \ |
| 1162 | " The id field is used by BusyBox init to specify the controlling tty for\n" \ |
| 1163 | " the specified process to run on. The contents of this field are\n" \ |
| 1164 | " appended to "/dev/" and used as-is. There is no need for this field to\n" \ |
| 1165 | " be unique, although if it isn't you may have strange results. If this\n" \ |
| 1166 | " field is left blank, the controlling tty is set to the console. Also\n" \ |
| 1167 | " note that if BusyBox detects that a serial console is in use, then only\n" \ |
| 1168 | " entries whose controlling tty is either the serial console or /dev/null\n" \ |
| 1169 | " will be run. BusyBox init does nothing with utmp. We don't need no\n" \ |
| 1170 | " stinkin' utmp.\n" \ |
| 1171 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1172 | " <runlevels>:\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1173 | "\n" \ |
| 1174 | " The runlevels field is completely ignored.\n" \ |
| 1175 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1176 | " <action>:\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1177 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1178 | " Valid actions include: sysinit, respawn, askfirst, wait,\n" \ |
Eric Andersen | 730f826 | 2001-12-17 23:13:08 +0000 | [diff] [blame] | 1179 | " once, restart, ctrlaltdel, and shutdown.\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1180 | "\n" \ |
| 1181 | " The available actions can be classified into two groups: actions\n" \ |
| 1182 | " that are run only once, and actions that are re-run when the specified\n" \ |
| 1183 | " process exits.\n" \ |
| 1184 | "\n" \ |
| 1185 | " Run only-once actions:\n" \ |
| 1186 | "\n" \ |
| 1187 | " 'sysinit' is the first item run on boot. init waits until all\n" \ |
| 1188 | " sysinit actions are completed before continuing. Following the\n" \ |
| 1189 | " completion of all sysinit actions, all 'wait' actions are run.\n" \ |
| 1190 | " 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 1191 | " the specified task completes. 'once' actions are asynchronous,\n" \ |
Eric Andersen | 730f826 | 2001-12-17 23:13:08 +0000 | [diff] [blame] | 1192 | " therefore, init does not wait for them to complete. 'restart' is\n" \ |
| 1193 | " the action taken to restart the init process. By default this should\n" \ |
| 1194 | " simply run /sbin/init, but can be a script which runs pivot_root or it\n" \ |
| 1195 | " can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \ |
Eric Andersen | c97ec34 | 2001-04-03 18:01:51 +0000 | [diff] [blame] | 1196 | " actions are run when the system detects that someone on the system\n" \ |
| 1197 | " console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \ |
| 1198 | " wants to run 'reboot' at this point to cause the system to reboot.\n" \ |
| 1199 | " Finally the 'shutdown' action specifies the actions to taken when\n" \ |
| 1200 | " init is told to reboot. Unmounting filesystems and disabling swap\n" \ |
| 1201 | " is a very good here\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1202 | "\n" \ |
| 1203 | " Run repeatedly actions:\n" \ |
| 1204 | "\n" \ |
| 1205 | " 'respawn' actions are run after the 'once' actions. When a process\n" \ |
| 1206 | " started with a 'respawn' action exits, init automatically restarts\n" \ |
| 1207 | " it. Unlike sysvinit, BusyBox init does not stop processes from\n" \ |
| 1208 | " respawning out of control. The 'askfirst' actions acts just like\n" \ |
| 1209 | " respawn, except that before running the specified process it\n" \ |
| 1210 | " displays the line "Please press Enter to activate this console."\n" \ |
| 1211 | " 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] | 1212 | " specified process.\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1213 | "\n" \ |
| 1214 | " Unrecognized actions (like initdefault) will cause init to emit an\n" \ |
| 1215 | " 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] | 1216 | " run in the order they appear in /etc/inittab.\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1217 | "\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1218 | " <process>:\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1219 | "\n" \ |
| 1220 | " Specifies the process to be executed and it's command line.\n" \ |
| 1221 | "\n" \ |
| 1222 | "Example /etc/inittab file:\n" \ |
Mark Whitley | 0a6f1d3 | 2001-03-15 21:19:09 +0000 | [diff] [blame] | 1223 | "\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1224 | " # This is run first except when booting in single-user mode.\n" \ |
| 1225 | " #\n" \ |
| 1226 | " ::sysinit:/etc/init.d/rcS\n" \ |
| 1227 | " \n" \ |
| 1228 | " # /bin/sh invocations on selected ttys\n" \ |
| 1229 | " #\n" \ |
| 1230 | " # Start an "askfirst" shell on the console (whatever that may be)\n" \ |
| 1231 | " ::askfirst:-/bin/sh\n" \ |
| 1232 | " # Start an "askfirst" shell on /dev/tty2-4\n" \ |
| 1233 | " tty2::askfirst:-/bin/sh\n" \ |
| 1234 | " tty3::askfirst:-/bin/sh\n" \ |
| 1235 | " tty4::askfirst:-/bin/sh\n" \ |
| 1236 | " \n" \ |
| 1237 | " # /sbin/getty invocations for selected ttys\n" \ |
| 1238 | " #\n" \ |
Eric Andersen | 1713a11 | 2002-11-07 02:26:59 +0000 | [diff] [blame] | 1239 | " tty4::respawn:/sbin/getty 38400 tty4\n" \ |
| 1240 | " tty5::respawn:/sbin/getty 38400 tty5\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1241 | " \n" \ |
| 1242 | " \n" \ |
| 1243 | " # Example of how to put a getty on a serial line (for a terminal)\n" \ |
| 1244 | " #\n" \ |
| 1245 | " #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \ |
| 1246 | " #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \ |
| 1247 | " #\n" \ |
| 1248 | " # Example how to put a getty on a modem line.\n" \ |
| 1249 | " #::respawn:/sbin/getty 57600 ttyS2\n" \ |
| 1250 | " \n" \ |
Eric Andersen | 730f826 | 2001-12-17 23:13:08 +0000 | [diff] [blame] | 1251 | " # Stuff to do when restarting the init process\n" \ |
| 1252 | " ::restart:/sbin/init\n" \ |
| 1253 | " \n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1254 | " # Stuff to do before rebooting\n" \ |
Eric Andersen | c97ec34 | 2001-04-03 18:01:51 +0000 | [diff] [blame] | 1255 | " ::ctrlaltdel:/sbin/reboot\n" \ |
| 1256 | " ::shutdown:/bin/umount -a -r\n" \ |
| 1257 | " ::shutdown:/sbin/swapoff -a\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1258 | |
Eric Andersen | be65c35 | 2003-01-23 04:57:35 +0000 | [diff] [blame] | 1259 | #ifdef CONFIG_FEATURE_INSMOD_LOAD_MAP |
| 1260 | #define USAGE_INSMOD_MAP(a) a |
| 1261 | #else |
| 1262 | #define USAGE_INSMOD_MAP(a) |
| 1263 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1264 | #define insmod_trivial_usage \ |
| 1265 | "[OPTION]... MODULE [symbol=value]..." |
| 1266 | #define insmod_full_usage \ |
| 1267 | "Loads the specified kernel modules into the kernel.\n\n" \ |
| 1268 | "Options:\n" \ |
| 1269 | "\t-f\tForce module to load into the wrong kernel version.\n" \ |
| 1270 | "\t-k\tMake module autoclean-able.\n" \ |
| 1271 | "\t-v\tverbose output\n" \ |
| 1272 | "\t-L\tLock to prevent simultaneous loads of a module\n" \ |
Eric Andersen | be65c35 | 2003-01-23 04:57:35 +0000 | [diff] [blame] | 1273 | USAGE_INSMOD_MAP("\t-m\tOutput load map to stdout") \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1274 | "\t-x\tdo not export externs" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1275 | |
Glenn L McGrath | eebcc1d | 2003-09-24 03:22:57 +0000 | [diff] [blame] | 1276 | #define install_trivial_usage \ |
| 1277 | "[cgmops] [sources] <dest|directory>" |
| 1278 | #define install_full_usage \ |
| 1279 | "copy files and set attributes\n\n" \ |
| 1280 | "Options:\n" \ |
| 1281 | "\t-c\tcopy the file, default\n" \ |
| 1282 | "\t-g\tset group ownership\n" \ |
| 1283 | "\t-m\tset permission modes\n" \ |
| 1284 | "\t-o\tset ownership\n" \ |
| 1285 | "\t-p\tpreserve date\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1286 | "\t-s\tstrip symbol tables" |
Glenn L McGrath | eebcc1d | 2003-09-24 03:22:57 +0000 | [diff] [blame] | 1287 | |
Glenn L McGrath | 9a2d272 | 2002-11-10 01:33:55 +0000 | [diff] [blame] | 1288 | #define ip_trivial_usage \ |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1289 | "[ OPTIONS ] { address | link | route | tunnel } { COMMAND | help }" |
Glenn L McGrath | 9a2d272 | 2002-11-10 01:33:55 +0000 | [diff] [blame] | 1290 | #define ip_full_usage \ |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1291 | "ip [ OPTIONS ] OBJECT { COMMAND | help }\n" \ |
| 1292 | "where OBJECT := { link | addr | route | tunnel }\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1293 | "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1294 | |
| 1295 | #define ipaddr_trivial_usage \ |
| 1296 | "{ {add|del} IFADDR dev STRING | {show|flush} [ dev STRING ] [ to PREFIX ] }" |
| 1297 | #define ipaddr_full_usage \ |
| 1298 | "ipaddr {add|del} IFADDR dev STRING\n" \ |
| 1299 | "ipaddr {show|flush} [ dev STRING ] [ scope SCOPE-ID ]\n" \ |
| 1300 | " [ to PREFIX ] [ label PATTERN ]\n" \ |
| 1301 | "IFADDR := PREFIX | ADDR peer PREFIX\n" \ |
| 1302 | " [ broadcast ADDR ] [ anycast ADDR ]\n" \ |
| 1303 | " [ label STRING ] [ scope SCOPE-ID ]\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1304 | "SCOPE-ID := [ host | link | global | NUMBER ]" |
Glenn L McGrath | 9a2d272 | 2002-11-10 01:33:55 +0000 | [diff] [blame] | 1305 | |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1306 | #ifndef CONFIG_FEATURE_IPCALC_FANCY |
Eric Andersen | de4f07e | 2003-12-11 01:18:07 +0000 | [diff] [blame] | 1307 | #define ipcalc_trivial_usage \ |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1308 | "[--broadcast] [--netmask] [--network] ipaddr <netmask>" |
| 1309 | |
Eric Andersen | de4f07e | 2003-12-11 01:18:07 +0000 | [diff] [blame] | 1310 | #define ipcalc_full_usage \ |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1311 | "Calculate IP network settings from a IP address\n\n" \ |
| 1312 | "Options:\n" \ |
| 1313 | "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \ |
| 1314 | "\t-n\t--netmask\tDisplay default netmask for IP.\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1315 | "\t-w\t--network\tDisplay calculated network address." |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1316 | #else |
Eric Andersen | de4f07e | 2003-12-11 01:18:07 +0000 | [diff] [blame] | 1317 | #define ipcalc_trivial_usage \ |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1318 | "[OPTION]... ipaddr <netmask>" |
| 1319 | |
Eric Andersen | de4f07e | 2003-12-11 01:18:07 +0000 | [diff] [blame] | 1320 | #define ipcalc_full_usage \ |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1321 | "Calculate IP network settings from a IP address\n\n" \ |
| 1322 | "Options:\n" \ |
| 1323 | "\t-b\t--broadcast\tDisplay calculated broadcast address.\n" \ |
| 1324 | "\t-n\t--netmask\tDisplay default netmask for IP.\n" \ |
| 1325 | "\t-w\t--network\tDisplay calculated network address.\n" \ |
| 1326 | "\t-h\t--hostname\tDisplay first resolved host name.\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1327 | "\t-s\t--silent\tDon't ever display error messages." |
Glenn L McGrath | c11986d | 2002-11-10 23:42:27 +0000 | [diff] [blame] | 1328 | #endif |
| 1329 | |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1330 | #define iplink_trivial_usage \ |
| 1331 | "{ set DEVICE { up | down | arp { on | off } | show [ DEVICE ] }" |
| 1332 | #define iplink_full_usage \ |
| 1333 | "iplink set DEVICE { up | down | arp { on | off } |\n" \ |
| 1334 | " dynamic { on | off } |\n" \ |
| 1335 | " mtu MTU }\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1336 | "iplink show [ DEVICE ]" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1337 | |
| 1338 | #define iproute_trivial_usage \ |
| 1339 | "{ list | flush | { add | del | change | append | replace | monitor } ROUTE }" |
| 1340 | #define iproute_full_usage \ |
| 1341 | "iproute { list | flush } SELECTOR\n" \ |
| 1342 | "iproute get ADDRESS [ from ADDRESS iif STRING ]\n" \ |
| 1343 | " [ oif STRING ] [ tos TOS ]\n" \ |
| 1344 | "iproute { add | del | change | append | replace | monitor } ROUTE\n" \ |
| 1345 | "SELECTOR := [ root PREFIX ] [ match PREFIX ] [ proto RTPROTO ]\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1346 | "ROUTE := [ TYPE ] PREFIX [ tos TOS ] [ proto RTPROTO ]" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1347 | |
| 1348 | #define iptunnel_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1349 | "{ add | change | del | show } [ NAME ] [ mode { ipip | gre | sit } ]\n" \ |
| 1350 | "\t[ remote ADDR ] [ local ADDR ] [ ttl TTL ]" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1351 | #define iptunnel_full_usage \ |
| 1352 | "iptunnel { add | change | del | show } [ NAME ]\n" \ |
| 1353 | " [ mode { ipip | gre | sit } ] [ remote ADDR ] [ local ADDR ]\n" \ |
| 1354 | " [ [i|o]seq ] [ [i|o]key KEY ] [ [i|o]csum ]\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1355 | " [ ttl TTL ] [ tos TOS ] [ [no]pmtudisc ] [ dev PHYS_DEV ]" |
Glenn L McGrath | f112daa | 2002-12-01 23:04:06 +0000 | [diff] [blame] | 1356 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1357 | #define kill_trivial_usage \ |
| 1358 | "[-signal] process-id [process-id ...]" |
| 1359 | #define kill_full_usage \ |
| 1360 | "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] | 1361 | "Options:\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1362 | "\t-l\tList all signal names and numbers." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1363 | #define kill_example_usage \ |
| 1364 | "$ ps | grep apache\n" \ |
| 1365 | "252 root root S [apache]\n" \ |
| 1366 | "263 www-data www-data S [apache]\n" \ |
| 1367 | "264 www-data www-data S [apache]\n" \ |
| 1368 | "265 www-data www-data S [apache]\n" \ |
| 1369 | "266 www-data www-data S [apache]\n" \ |
| 1370 | "267 www-data www-data S [apache]\n" \ |
| 1371 | "$ kill 252\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1372 | |
| 1373 | #define killall_trivial_usage \ |
| 1374 | "[-signal] process-name [process-name ...]" |
| 1375 | #define killall_full_usage \ |
| 1376 | "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] | 1377 | "Options:\n" \ |
| 1378 | "\t-l\tList all signal names and numbers." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1379 | #define killall_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1380 | "$ killall apache\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1381 | |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1382 | #define klogd_trivial_usage \ |
Glenn L McGrath | f0a360e | 2002-12-05 20:56:31 +0000 | [diff] [blame] | 1383 | "[-c n] [-n]" |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1384 | #define klogd_full_usage \ |
| 1385 | "Kernel logger.\n"\ |
| 1386 | "Options:\n"\ |
Glenn L McGrath | f0a360e | 2002-12-05 20:56:31 +0000 | [diff] [blame] | 1387 | "\t-c n\tSets the default log level of console messages to n.\n"\ |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1388 | "\t-n\tRun as a foreground process." |
| 1389 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1390 | #define length_trivial_usage \ |
| 1391 | "STRING" |
| 1392 | #define length_full_usage \ |
| 1393 | "Prints out the length of the specified STRING." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1394 | #define length_example_usage \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 1395 | "$ length Hello\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1396 | "5\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1397 | |
| 1398 | #define ln_trivial_usage \ |
| 1399 | "[OPTION] TARGET... LINK_NAME|DIRECTORY" |
| 1400 | #define ln_full_usage \ |
| 1401 | "Create a link named LINK_NAME or DIRECTORY to the specified TARGET\n"\ |
| 1402 | "\nYou may use '--' to indicate that all following arguments are non-options.\n\n" \ |
| 1403 | "Options:\n" \ |
| 1404 | "\t-s\tmake symbolic links instead of hard links\n" \ |
| 1405 | "\t-f\tremove existing destination files\n" \ |
| 1406 | "\t-n\tno dereference symlinks - treat like normal file" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1407 | #define ln_example_usage \ |
| 1408 | "$ ln -s BusyBox /tmp/ls\n" \ |
| 1409 | "$ ls -l /tmp/ls\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1410 | "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1411 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1412 | #define loadfont_trivial_usage \ |
| 1413 | "< font" |
| 1414 | #define loadfont_full_usage \ |
| 1415 | "Loads a console font from standard input." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1416 | #define loadfont_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1417 | "$ loadfont < /etc/i18n/fontname\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1418 | |
| 1419 | #define loadkmap_trivial_usage \ |
| 1420 | "< keymap" |
| 1421 | #define loadkmap_full_usage \ |
| 1422 | "Loads a binary keyboard translation table from standard input." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1423 | #define loadkmap_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1424 | "$ loadkmap < /etc/i18n/lang-keymap\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1425 | |
| 1426 | #define logger_trivial_usage \ |
| 1427 | "[OPTION]... [MESSAGE]" |
| 1428 | #define logger_full_usage \ |
| 1429 | "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin.\n\n" \ |
| 1430 | "Options:\n" \ |
| 1431 | "\t-s\tLog to stderr as well as the system log.\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1432 | "\t-t TAG\tLog using the specified tag (defaults to user name).\n" \ |
| 1433 | "\t-p PRIORITY\tEnter the message with the specified priority.\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1434 | "\t\tThis may be numerical or a ``facility.level'' pair." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1435 | #define logger_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1436 | "$ logger "hello"\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1437 | |
Robert Griebl | 1fca558 | 2002-06-04 20:45:46 +0000 | [diff] [blame] | 1438 | #define login_trivial_usage \ |
| 1439 | "[OPTION]... [username] [ENV=VAR ...]" |
| 1440 | #define login_full_usage \ |
| 1441 | "Begin a new session on the system\n\n" \ |
| 1442 | "Options:\n" \ |
| 1443 | "\t-f\tDo not authenticate (user already authenticated)\n" \ |
| 1444 | "\t-h\tName of the remote host for this login.\n" \ |
| 1445 | "\t-p\tPreserve environment." |
| 1446 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1447 | #define logname_trivial_usage \ |
| 1448 | "" |
| 1449 | #define logname_full_usage \ |
| 1450 | "Print the name of the current user." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1451 | #define logname_example_usage \ |
| 1452 | "$ logname\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1453 | "root\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1454 | |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1455 | #define logread_trivial_usage \ |
Eric Andersen | d4a5e25 | 2003-12-19 11:32:14 +0000 | [diff] [blame] | 1456 | "[OPTION]..." |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1457 | #define logread_full_usage \ |
Eric Andersen | d4a5e25 | 2003-12-19 11:32:14 +0000 | [diff] [blame] | 1458 | "Shows the messages from syslogd (using circular buffer).\n\n" |
| 1459 | "Options:\n" \ |
| 1460 | "\t-f\t\toutput data as the log grows" |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 1461 | |
Matt Kraai | 83788da | 2002-03-20 17:38:37 +0000 | [diff] [blame] | 1462 | #define losetup_trivial_usage \ |
| 1463 | "[OPTION]... LOOPDEVICE FILE\n" \ |
| 1464 | "or: losetup [OPTION]... -d LOOPDEVICE" |
| 1465 | #define losetup_full_usage \ |
| 1466 | "Associate LOOPDEVICE with FILE.\n\n" \ |
| 1467 | "Options:\n" \ |
| 1468 | "\t-d\t\tDisassociate LOOPDEVICE.\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1469 | "\t-o OFFSET\tStart OFFSET bytes into FILE." |
Matt Kraai | 83788da | 2002-03-20 17:38:37 +0000 | [diff] [blame] | 1470 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1471 | #ifdef CONFIG_FEATURE_LS_TIMESTAMPS |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1472 | #define USAGE_LS_TIMESTAMPS(a) a |
| 1473 | #else |
| 1474 | #define USAGE_LS_TIMESTAMPS(a) |
| 1475 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1476 | #ifdef CONFIG_FEATURE_LS_FILETYPES |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1477 | #define USAGE_LS_FILETYPES(a) a |
| 1478 | #else |
| 1479 | #define USAGE_LS_FILETYPES(a) |
| 1480 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1481 | #ifdef CONFIG_FEATURE_LS_FOLLOWLINKS |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1482 | #define USAGE_LS_FOLLOWLINKS(a) a |
| 1483 | #else |
| 1484 | #define USAGE_LS_FOLLOWLINKS(a) |
| 1485 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1486 | #ifdef CONFIG_FEATURE_LS_RECURSIVE |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1487 | #define USAGE_LS_RECURSIVE(a) a |
| 1488 | #else |
| 1489 | #define USAGE_LS_RECURSIVE(a) |
| 1490 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1491 | #ifdef CONFIG_FEATURE_LS_SORTFILES |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1492 | #define USAGE_LS_SORTFILES(a) a |
| 1493 | #else |
| 1494 | #define USAGE_LS_SORTFILES(a) |
| 1495 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1496 | #ifdef CONFIG_FEATURE_AUTOWIDTH |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1497 | #define USAGE_AUTOWIDTH(a) a |
| 1498 | #else |
| 1499 | #define USAGE_AUTOWIDTH(a) |
| 1500 | #endif |
| 1501 | #define ls_trivial_usage \ |
Eric Andersen | 9e48045 | 2003-07-03 10:07:04 +0000 | [diff] [blame] | 1502 | "[-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] | 1503 | #define ls_full_usage \ |
| 1504 | "List directory contents\n\n" \ |
| 1505 | "Options:\n" \ |
| 1506 | "\t-1\tlist files in a single column\n" \ |
| 1507 | "\t-A\tdo not list implied . and ..\n" \ |
| 1508 | "\t-a\tdo not hide entries starting with .\n" \ |
| 1509 | "\t-C\tlist entries by columns\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1510 | USAGE_LS_TIMESTAMPS("\t-c\twith -l: show ctime\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1511 | "\t-d\tlist directory entries instead of contents\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1512 | USAGE_LS_TIMESTAMPS("\t-e\tlist both full date and full time\n") \ |
| 1513 | USAGE_LS_FILETYPES("\t-F\tappend indicator (one of */=@|) to entries\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1514 | "\t-i\tlist the i-node for each file\n" \ |
| 1515 | "\t-l\tuse a long listing format\n" \ |
| 1516 | "\t-n\tlist numeric UIDs and GIDs instead of names\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1517 | USAGE_LS_FILETYPES("\t-p\tappend indicator (one of /=@|) to entries\n") \ |
| 1518 | USAGE_LS_FOLLOWLINKS("\t-L\tlist entries pointed to by symbolic links\n") \ |
| 1519 | USAGE_LS_RECURSIVE("\t-R\tlist subdirectories recursively\n") \ |
| 1520 | USAGE_LS_SORTFILES("\t-r\tsort the listing in reverse order\n") \ |
| 1521 | USAGE_LS_SORTFILES("\t-S\tsort the listing by file size\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1522 | "\t-s\tlist the size of each file, in blocks\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1523 | USAGE_AUTOWIDTH("\t-T NUM\tassume Tabstop every NUM columns\n") \ |
| 1524 | USAGE_LS_TIMESTAMPS("\t-t\twith -l: show modification time\n") \ |
| 1525 | USAGE_LS_TIMESTAMPS("\t-u\twith -l: show access time\n") \ |
| 1526 | USAGE_LS_SORTFILES("\t-v\tsort the listing by version\n") \ |
| 1527 | 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] | 1528 | "\t-x\tlist entries by lines instead of by columns\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1529 | USAGE_LS_SORTFILES("\t-X\tsort the listing by extension\n") \ |
| 1530 | USAGE_HUMAN_READABLE( \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1531 | "\t-h\tprint sizes in human readable format (e.g., 1K 243M 2G )\n" \ |
Eric Andersen | bccb315 | 2003-07-03 10:19:20 +0000 | [diff] [blame] | 1532 | USAGE_SELINUX("\t-k\tprint security context\n\t-K\tprint security context in long format\n", "")) |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1533 | |
| 1534 | #define lsmod_trivial_usage \ |
| 1535 | "" |
| 1536 | #define lsmod_full_usage \ |
| 1537 | "List the currently loaded kernel modules." |
| 1538 | |
| 1539 | #define makedevs_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1540 | "NAME TYPE MAJOR MINOR FIRST LAST [s]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1541 | #define makedevs_full_usage \ |
| 1542 | "Creates a range of block or character special files\n\n" \ |
| 1543 | "TYPEs include:\n" \ |
| 1544 | "\tb:\tMake a block (buffered) device.\n" \ |
| 1545 | "\tc or u:\tMake a character (un-buffered) device.\n" \ |
| 1546 | "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes.\n\n" \ |
| 1547 | "FIRST specifies the number appended to NAME to create the first device.\n" \ |
| 1548 | "LAST specifies the number of the last item that should be created.\n" \ |
| 1549 | "If 's' is the last argument, the base device is created as well.\n\n" \ |
| 1550 | "For example:\n" \ |
| 1551 | "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1552 | "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1553 | #define makedevs_example_usage \ |
| 1554 | "$ makedevs /dev/ttyS c 4 66 2 63\n" \ |
| 1555 | "[creates ttyS2-ttyS63]\n" \ |
| 1556 | "$ makedevs /dev/hda b 3 0 0 8 s\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1557 | "[creates hda,hda1-hda8]\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1558 | |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 1559 | #ifdef CONFIG_FEATURE_MD5_SHA1_SUM_CHECK |
| 1560 | #define USAGE_MD5_SHA1_SUM_CHECK(a) a |
| 1561 | #else |
| 1562 | #define USAGE_MD5_SHA1_SUM_CHECK(a) |
| 1563 | #endif |
| 1564 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1565 | #define md5sum_trivial_usage \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 1566 | "[OPTION] [FILEs...]" \ |
| 1567 | USAGE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]") |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1568 | #define md5sum_full_usage \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 1569 | "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1570 | "Options:\n" \ |
Glenn L McGrath | c83e3a6 | 2003-12-04 13:06:44 +0000 | [diff] [blame] | 1571 | "With no FILE, or when FILE is -, read standard input." \ |
| 1572 | USAGE_MD5_SHA1_SUM_CHECK("\n\n" \ |
| 1573 | "\t-c\tcheck MD5 sums against given list\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1574 | "\nThe following two options are useful only when verifying checksums:\n" \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 1575 | "\t-s\tdon't output anything, status code shows success\n" \ |
Glenn L McGrath | c83e3a6 | 2003-12-04 13:06:44 +0000 | [diff] [blame] | 1576 | "\t-w\twarn about improperly formated MD5 checksum lines") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1577 | #define md5sum_example_usage \ |
| 1578 | "$ md5sum < busybox\n" \ |
| 1579 | "6fd11e98b98a58f64ff3398d7b324003\n" \ |
| 1580 | "$ md5sum busybox\n" \ |
| 1581 | "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ |
| 1582 | "$ md5sum -c -\n" \ |
| 1583 | "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ |
| 1584 | "busybox: OK\n" \ |
| 1585 | "^D\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1586 | |
Glenn L McGrath | 061c900 | 2002-09-16 04:21:46 +0000 | [diff] [blame] | 1587 | #define mesg_trivial_usage \ |
| 1588 | "mesg [y|n]" |
| 1589 | #define mesg_full_usage \ |
| 1590 | "mesg [Y|N], controls write access to your terminal\n" \ |
| 1591 | "\ty\tAllow write access to your terminal.\n" \ |
| 1592 | "\tn\tDisallow write access to your terminal.\n" |
| 1593 | |
Glenn L McGrath | 1e11c34 | 2003-05-11 14:52:39 +0000 | [diff] [blame] | 1594 | #define minit_trivial_usage \ |
| 1595 | "[-spPrRC]" |
| 1596 | #define minit_full_usage \ |
| 1597 | "[-spPrRC]" |
| 1598 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1599 | #define mkdir_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1600 | "[OPTION] DIRECTORY..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1601 | #define mkdir_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 1602 | "Create the DIRECTORY(ies) if they do not already exist\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1603 | "Options:\n" \ |
| 1604 | "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1605 | "\t-p\tno error if existing, make parent directories as needed" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1606 | #define mkdir_example_usage \ |
| 1607 | "$ mkdir /tmp/foo\n" \ |
| 1608 | "$ mkdir /tmp/foo\n" \ |
| 1609 | "/tmp/foo: File exists\n" \ |
| 1610 | "$ mkdir /tmp/foo/bar/baz\n" \ |
| 1611 | "/tmp/foo/bar/baz: No such file or directory\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1612 | "$ mkdir -p /tmp/foo/bar/baz\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1613 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1614 | #define mkfifo_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1615 | "[OPTIONS] name" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1616 | #define mkfifo_full_usage \ |
| 1617 | "Creates a named pipe (identical to 'mknod name p')\n\n" \ |
| 1618 | "Options:\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1619 | "\t-m\tcreate the pipe using the specified mode (default a=rw)" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1620 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1621 | #define mkfs_minix_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1622 | "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1623 | #define mkfs_minix_full_usage \ |
| 1624 | "Make a MINIX filesystem.\n\n" \ |
| 1625 | "Options:\n" \ |
| 1626 | "\t-c\t\tCheck the device for bad blocks\n" \ |
| 1627 | "\t-n [14|30]\tSpecify the maximum length of filenames\n" \ |
| 1628 | "\t-i INODES\tSpecify the number of inodes for the filesystem\n" \ |
| 1629 | "\t-l FILENAME\tRead the bad blocks list from FILENAME\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1630 | "\t-v\t\tMake a Minix version 2 filesystem" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1631 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1632 | #define mknod_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1633 | "[OPTIONS] NAME TYPE MAJOR MINOR" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1634 | #define mknod_full_usage \ |
| 1635 | "Create a special file (block, character, or pipe).\n\n" \ |
| 1636 | "Options:\n" \ |
| 1637 | "\t-m\tcreate the special file using the specified mode (default a=rw)\n\n" \ |
| 1638 | "TYPEs include:\n" \ |
| 1639 | "\tb:\tMake a block (buffered) device.\n" \ |
| 1640 | "\tc or u:\tMake a character (un-buffered) device.\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1641 | "\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] | 1642 | #define mknod_example_usage \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 1643 | "$ mknod /dev/fd0 b 2 0\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1644 | "$ mknod -m 644 /tmp/pipe p\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1645 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1646 | #define mkswap_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1647 | "[-c] [-v0|-v1] device [block-count]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1648 | #define mkswap_full_usage \ |
| 1649 | "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] | 1650 | "Options:\n" \ |
| 1651 | "\t-c\t\tCheck for read-ability.\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1652 | "\t-v0\t\tMake version 0 swap [max 128 Megs].\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 1653 | "\t-v1\t\tMake version 1 swap [big!] (default for kernels >\n\t\t\t2.1.117).\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1654 | "\tblock-count\tNumber of block to use (default is entire partition)." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1655 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1656 | #define mktemp_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1657 | "[-q] TEMPLATE" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1658 | #define mktemp_full_usage \ |
| 1659 | "Creates a temporary file with its name based on TEMPLATE.\n" \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 1660 | "TEMPLATE is any name with six `Xs' (i.e., /tmp/temp.XXXXXX)." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1661 | #define mktemp_example_usage \ |
| 1662 | "$ mktemp /tmp/temp.XXXXXX\n" \ |
| 1663 | "/tmp/temp.mWiLjM\n" \ |
| 1664 | "$ ls -la /tmp/temp.mWiLjM\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1665 | "-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] | 1666 | |
Eric Andersen | 8d79ce8 | 2001-07-22 23:00:15 +0000 | [diff] [blame] | 1667 | #define modprobe_trivial_usage \ |
| 1668 | "[FILE ...]" |
| 1669 | #define modprobe_full_usage \ |
Eric Andersen | abc9568 | 2002-07-03 02:52:35 +0000 | [diff] [blame] | 1670 | "Used for high level module loading and unloading." |
Eric Andersen | 8d79ce8 | 2001-07-22 23:00:15 +0000 | [diff] [blame] | 1671 | #define modprobe_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1672 | "$ modprobe cdrom\n" |
Eric Andersen | 8d79ce8 | 2001-07-22 23:00:15 +0000 | [diff] [blame] | 1673 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1674 | #define more_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1675 | "[FILE ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1676 | #define more_full_usage \ |
| 1677 | "More is a filter for viewing FILE one screenful at a time." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1678 | #define more_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1679 | "$ dmesg | more\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1680 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1681 | #ifdef CONFIG_FEATURE_MOUNT_LOOP |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1682 | #define USAGE_MOUNT_LOOP(a) a |
| 1683 | #else |
| 1684 | #define USAGE_MOUNT_LOOP(a) |
| 1685 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1686 | #ifdef CONFIG_FEATURE_MTAB_SUPPORT |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1687 | #define USAGE_MTAB(a) a |
| 1688 | #else |
| 1689 | #define USAGE_MTAB(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1690 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1691 | #define mount_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 1692 | "[flags] DEVICE NODE [-o options,more-options]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1693 | #define mount_full_usage \ |
Eric Andersen | 2715fa1 | 2004-03-09 21:32:57 +0000 | [diff] [blame] | 1694 | "Mount a filesystem. Autodetection of filesystem type requires the\n" \ |
| 1695 | "/proc filesystem be already mounted.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1696 | "Flags:\n" \ |
| 1697 | "\t-a:\t\tMount all filesystems in fstab.\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1698 | USAGE_MTAB( \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 1699 | "\t-f:\t\t\"Fake\" Add entry to mount table but don't mount it.\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1700 | "\t-n:\t\tDon't write a mount table entry.\n" \ |
| 1701 | ) \ |
| 1702 | "\t-o option:\tOne of many filesystem options, listed below.\n" \ |
| 1703 | "\t-r:\t\tMount the filesystem read-only.\n" \ |
| 1704 | "\t-t fs-type:\tSpecify the filesystem type.\n" \ |
| 1705 | "\t-w:\t\tMount for reading and writing (default).\n" \ |
| 1706 | "\n" \ |
| 1707 | "Options for use with the \"-o\" flag:\n" \ |
| 1708 | "\tasync/sync:\tWrites are asynchronous / synchronous.\n" \ |
| 1709 | "\tatime/noatime:\tEnable / disable updates to inode access times.\n" \ |
| 1710 | "\tdev/nodev:\tAllow use of special device files / disallow them.\n" \ |
| 1711 | "\texec/noexec:\tAllow use of executable files / disallow them.\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1712 | USAGE_MOUNT_LOOP( \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1713 | "\tloop:\t\tMounts a file via loop device.\n" \ |
| 1714 | ) \ |
| 1715 | "\tsuid/nosuid:\tAllow set-user-id-root programs / disallow them.\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 1716 | "\tremount:\tRe-mount a mounted filesystem, changing its flags.\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1717 | "\tro/rw:\t\tMount for read-only / read-write.\n" \ |
Eric Andersen | 2f6e1f8 | 2001-05-21 15:59:34 +0000 | [diff] [blame] | 1718 | "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1719 | "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 1720 | "You'll have to see the written documentation for those filesystems." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1721 | #define mount_example_usage \ |
| 1722 | "$ mount\n" \ |
| 1723 | "/dev/hda3 on / type minix (rw)\n" \ |
| 1724 | "proc on /proc type proc (rw)\n" \ |
| 1725 | "devpts on /dev/pts type devpts (rw)\n" \ |
| 1726 | "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1727 | "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1728 | |
Glenn L McGrath | 1e11c34 | 2003-05-11 14:52:39 +0000 | [diff] [blame] | 1729 | #define msvc_trivial_usage \ |
| 1730 | "-[udorspchaitkx] service" |
Eric Andersen | 335816b | 2003-07-14 22:14:49 +0000 | [diff] [blame] | 1731 | #define msvc_full_usage \ |
Glenn L McGrath | 1e11c34 | 2003-05-11 14:52:39 +0000 | [diff] [blame] | 1732 | "[option] service\n" \ |
| 1733 | "Where option is one of\n" \ |
| 1734 | "\t-u\tUp. If the service is not running, start it. If the service stops, restart it.\n" \ |
| 1735 | "\t-d\tDown. If the service is running, stop it, do not restart it.\n" \ |
| 1736 | "\t-o\tOnce. If the service is not running, start it. Do not restart it if it stops.\n" \ |
| 1737 | "\t-r\tTell supervise that the service is normally running; this affects status messages.\n" \ |
| 1738 | "\t-s\tTell supervise that the service is normally stopped; this affects status messages.\n" \ |
| 1739 | "\t-p\tPause. Send the service a STOP signal.\n" \ |
| 1740 | "\t-c\tContinue. Send the service a CONT signal.\n" \ |
| 1741 | "\t-h\tHangup. Send the service a HUP signal.\n" \ |
| 1742 | "\t-a\tAlarm. Send the service an ALRM signal.\n" \ |
| 1743 | "\t-i\tInterrupt. Send the service an INT signal.\n" \ |
| 1744 | "\t-t\tTerminate. Send the service a TERM signal.\n" \ |
| 1745 | "\t-k\tKill. Send the service a KILL signal.\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1746 | "\t-x\tExit. supervise will quit as soon as the service is down." |
Glenn L McGrath | 1e11c34 | 2003-05-11 14:52:39 +0000 | [diff] [blame] | 1747 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1748 | #define mt_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1749 | "[-f device] opcode value" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1750 | #define mt_full_usage \ |
| 1751 | "Control magnetic tape drive operation\n" \ |
| 1752 | "\nAvailable Opcodes:\n\n" \ |
| 1753 | "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \ |
| 1754 | "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \ |
Eric Andersen | 92fb939 | 2003-08-08 20:09:03 +0000 | [diff] [blame] | 1755 | "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1756 | "setpart tell unload unlock weof wset" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1757 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1758 | #define mv_trivial_usage \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 1759 | "SOURCE DEST\n" \ |
| 1760 | "or: mv SOURCE... DIRECTORY" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1761 | #define mv_full_usage \ |
| 1762 | "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1763 | #define mv_example_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1764 | "$ mv /tmp/foo /bin/bar\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1765 | |
Glenn L McGrath | f03c933 | 2002-12-13 00:01:44 +0000 | [diff] [blame] | 1766 | #define nameif_trivial_usage \ |
Glenn L McGrath | a9adef0 | 2003-01-19 13:34:21 +0000 | [diff] [blame] | 1767 | "[-s] [-c FILE] [{IFNAME MACADDR}]" |
Glenn L McGrath | f03c933 | 2002-12-13 00:01:44 +0000 | [diff] [blame] | 1768 | #define nameif_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1769 | "Nameif renaming network interface while it in the down state.\n\n" \ |
| 1770 | "Options:\n" \ |
| 1771 | "\t-c FILE\t\tUse configuration file (default is /etc/mactab)\n" \ |
| 1772 | "\t-s\t\tUse syslog (LOCAL0 facility).\n" \ |
| 1773 | "\tIFNAME MACADDR\tnew_interface_name interface_mac_address" |
Glenn L McGrath | f03c933 | 2002-12-13 00:01:44 +0000 | [diff] [blame] | 1774 | #define nameif_example_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1775 | "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \ |
| 1776 | " or\n" \ |
| 1777 | "$ nameif -c /etc/my_mactab_file\n" \ |
Glenn L McGrath | f03c933 | 2002-12-13 00:01:44 +0000 | [diff] [blame] | 1778 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1779 | #define nc_trivial_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1780 | "[OPTIONS] [IP] [port]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1781 | #define nc_full_usage \ |
Eric Andersen | 00a6a75 | 2002-04-26 23:53:10 +0000 | [diff] [blame] | 1782 | "Netcat opens a pipe to IP:port\n\n" \ |
| 1783 | "Options:\n" \ |
| 1784 | "\t-l\t\tlisten mode, for inbound connects\n" \ |
| 1785 | "\t-p PORT\t\tlocal port number\n" \ |
Eric Andersen | 1323c94 | 2002-04-26 23:59:12 +0000 | [diff] [blame] | 1786 | "\t-i SECS\t\tdelay interval for lines sent\n" \ |
Eric Andersen | 00a6a75 | 2002-04-26 23:53:10 +0000 | [diff] [blame] | 1787 | "\t-e PROG\t\tprogram to exec after connect (dangerous!)" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1788 | #define nc_example_usage \ |
| 1789 | "$ nc foobar.somedomain.com 25\n" \ |
| 1790 | "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \ |
| 1791 | "help\n" \ |
| 1792 | "214-Commands supported:\n" \ |
| 1793 | "214- HELO EHLO MAIL RCPT DATA AUTH\n" \ |
| 1794 | "214 NOOP QUIT RSET HELP\n" \ |
| 1795 | "quit\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1796 | "221 foobar closing connection\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1797 | |
Eric Andersen | 1552ff7 | 2001-10-31 11:07:12 +0000 | [diff] [blame] | 1798 | #define netstat_trivial_usage \ |
Robert Griebl | 8187bb4 | 2002-05-14 23:10:58 +0000 | [diff] [blame] | 1799 | "[-laenrtuwx]" |
Eric Andersen | 1552ff7 | 2001-10-31 11:07:12 +0000 | [diff] [blame] | 1800 | #define netstat_full_usage \ |
| 1801 | "-l display listening server sockets\n" \ |
| 1802 | "-a display all sockets (default: connected)\n" \ |
Robert Griebl | 8187bb4 | 2002-05-14 23:10:58 +0000 | [diff] [blame] | 1803 | "-e display other/more information\n" \ |
Eric Andersen | 1552ff7 | 2001-10-31 11:07:12 +0000 | [diff] [blame] | 1804 | "-n don't resolve names\n" \ |
Robert Griebl | 8187bb4 | 2002-05-14 23:10:58 +0000 | [diff] [blame] | 1805 | "-r display routing table\n" \ |
Eric Andersen | 1552ff7 | 2001-10-31 11:07:12 +0000 | [diff] [blame] | 1806 | "-t tcp sockets\n" \ |
| 1807 | "-u udp sockets\n" \ |
| 1808 | "-w raw sockets\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1809 | "-x unix sockets" |
Eric Andersen | 1552ff7 | 2001-10-31 11:07:12 +0000 | [diff] [blame] | 1810 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1811 | #define nslookup_trivial_usage \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 1812 | "[HOST] [SERVER]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1813 | #define nslookup_full_usage \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 1814 | "Queries the nameserver for the IP address of the given HOST\n" \ |
| 1815 | "optionally using a specified DNS server" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1816 | #define nslookup_example_usage \ |
| 1817 | "$ nslookup localhost\n" \ |
| 1818 | "Server: default\n" \ |
| 1819 | "Address: default\n" \ |
| 1820 | "\n" \ |
| 1821 | "Name: debian\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1822 | "Address: 127.0.0.1\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1823 | |
Glenn L McGrath | 6028111 | 2001-11-02 11:39:46 +0000 | [diff] [blame] | 1824 | #define od_trivial_usage \ |
| 1825 | "[-aBbcDdeFfHhIiLlOovXx] [FILE]" |
| 1826 | #define od_full_usage \ |
| 1827 | "Write an unambiguous representation, octal bytes by default, of FILE\n"\ |
| 1828 | "to standard output. With no FILE, or when FILE is -, read standard input." |
| 1829 | |
Glenn L McGrath | ec0c48c | 2002-09-16 03:16:06 +0000 | [diff] [blame] | 1830 | #define openvt_trivial_usage \ |
| 1831 | "<vtnum> <COMMAND> [ARGS...]" |
| 1832 | #define openvt_full_usage \ |
| 1833 | "Start a command on a new virtual terminal" |
| 1834 | #define openvt_example_usage \ |
| 1835 | "openvt 2 /bin/ash\n" |
| 1836 | |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 1837 | #ifdef CONFIG_FEATURE_SHA1_PASSWORDS |
| 1838 | #define PASSWORD_ALG_TYPES(a) a |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1839 | #else |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 1840 | #define PASSWORD_ALG_TYPES(a) |
| 1841 | #endif |
| 1842 | #define passwd_trivial_usage \ |
| 1843 | "[OPTION] [name]" |
| 1844 | #define passwd_full_usage \ |
Eric Andersen | c38678d | 2002-09-16 06:22:25 +0000 | [diff] [blame] | 1845 | "Change a user password. If no name is specified,\n" \ |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 1846 | "changes the password for the current user.\n" \ |
| 1847 | "Options:\n" \ |
| 1848 | "\t-a\tDefine which algorithm shall be used for the password.\n" \ |
| 1849 | "\t\t\t(Choices: des, md5" \ |
Eric Andersen | 7f90ed4 | 2002-07-03 05:55:14 +0000 | [diff] [blame] | 1850 | PASSWORD_ALG_TYPES(", sha1") \ |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 1851 | ")\n\t-d\tDelete the password for the specified user account.\n" \ |
| 1852 | "\t-l\tLocks (disables) the specified user account.\n" \ |
Eric Andersen | 7f90ed4 | 2002-07-03 05:55:14 +0000 | [diff] [blame] | 1853 | "\t-u\tUnlocks (re-enables) the specified user account." |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 1854 | |
Glenn L McGrath | 655d814 | 2003-06-22 15:32:41 +0000 | [diff] [blame] | 1855 | #define patch_trivial_usage \ |
| 1856 | "[-p<num>]" |
| 1857 | #define patch_full_usage \ |
| 1858 | "[-p<num>]" |
| 1859 | #define patch_example_usage \ |
| 1860 | "$ patch -p1 <example.diff" |
| 1861 | |
Glenn L McGrath | 1e11c34 | 2003-05-11 14:52:39 +0000 | [diff] [blame] | 1862 | #define pidfilehack_trivial_usage \ |
| 1863 | "[daemon.pid] [daemon]" |
| 1864 | #define pidfilehack_full_usage \ |
| 1865 | "service /var/run/daemon.pid /usr/sbin/daemon args...\n" |
| 1866 | |
Eric Andersen | 221b2ea | 2001-07-31 19:06:07 +0000 | [diff] [blame] | 1867 | #define pidof_trivial_usage \ |
| 1868 | "process-name [process-name ...]" |
| 1869 | #define pidof_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1870 | "Lists the PIDs of all processes with names that match the\n" \ |
| 1871 | "names on the command line" |
Eric Andersen | 221b2ea | 2001-07-31 19:06:07 +0000 | [diff] [blame] | 1872 | #define pidof_example_usage \ |
| 1873 | "$ pidof init\n" \ |
| 1874 | "1\n" |
| 1875 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 1876 | #ifndef CONFIG_FEATURE_FANCY_PING |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1877 | #define ping_trivial_usage "host" |
| 1878 | #define ping_full_usage "Send ICMP ECHO_REQUEST packets to network hosts" |
| 1879 | #else |
| 1880 | #define ping_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1881 | "[OPTION]... host" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1882 | #define ping_full_usage \ |
| 1883 | "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \ |
| 1884 | "Options:\n" \ |
| 1885 | "\t-c COUNT\tSend only COUNT pings.\n" \ |
| 1886 | "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \ |
| 1887 | "\t-q\t\tQuiet mode, only displays output at start\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1888 | "\t\t\tand when finished." |
| 1889 | #endif |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1890 | #define ping_example_usage \ |
| 1891 | "$ ping localhost\n" \ |
| 1892 | "PING slag (127.0.0.1): 56 data bytes\n" \ |
| 1893 | "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \ |
| 1894 | "\n" \ |
| 1895 | "--- debian ping statistics ---\n" \ |
| 1896 | "1 packets transmitted, 1 packets received, 0% packet loss\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1897 | "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] | 1898 | |
Eric Andersen | 51b8bd6 | 2002-07-03 11:46:38 +0000 | [diff] [blame] | 1899 | #ifndef CONFIG_FEATURE_FANCY_PING6 |
| 1900 | #define ping6_trivial_usage "host" |
| 1901 | #define ping6_full_usage "Send ICMP ECHO_REQUEST packets to network hosts" |
| 1902 | #else |
| 1903 | #define ping6_trivial_usage \ |
| 1904 | "[OPTION]... host" |
| 1905 | #define ping6_full_usage \ |
| 1906 | "Send ICMP ECHO_REQUEST packets to network hosts.\n\n" \ |
| 1907 | "Options:\n" \ |
| 1908 | "\t-c COUNT\tSend only COUNT pings.\n" \ |
| 1909 | "\t-s SIZE\t\tSend SIZE data bytes in packets (default=56).\n" \ |
| 1910 | "\t-q\t\tQuiet mode, only displays output at start\n" \ |
| 1911 | "\t\t\tand when finished." |
| 1912 | #endif |
| 1913 | #define ping6_example_usage \ |
| 1914 | "$ ping6 ip6-localhost\n" \ |
| 1915 | "PING ip6-localhost (::1): 56 data bytes\n" \ |
| 1916 | "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \ |
| 1917 | "\n" \ |
| 1918 | "--- ip6-localhost ping statistics ---\n" \ |
| 1919 | "1 packets transmitted, 1 packets received, 0% packet loss\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1920 | "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] | 1921 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1922 | #define pivot_root_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 1923 | "NEW_ROOT PUT_OLD" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1924 | #define pivot_root_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 1925 | "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] | 1926 | "the new root file system." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1927 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1928 | #define poweroff_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1929 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1930 | #define poweroff_full_usage \ |
| 1931 | "Halt the system and request that the kernel shut off the power." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1932 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1933 | #define printf_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1934 | "FORMAT [ARGUMENT...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1935 | #define printf_full_usage \ |
| 1936 | "Formats and prints ARGUMENT(s) according to FORMAT,\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1937 | "Where FORMAT controls the output exactly as in C printf." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1938 | #define printf_example_usage \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 1939 | "$ printf "Val=%d\\n" 5\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1940 | "Val=5\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1941 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1942 | #define ps_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1943 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1944 | #define ps_full_usage \ |
| 1945 | "Report process status\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1946 | USAGE_SELINUX("\nOptions:\n\t-c\tshow SE Linux context", \ |
| 1947 | "\nThis version of ps accepts no options.") |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1948 | |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1949 | #define ps_example_usage \ |
| 1950 | "$ ps\n" \ |
| 1951 | " PID Uid Gid State Command\n" \ |
| 1952 | " 1 root root S init\n" \ |
| 1953 | " 2 root root S [kflushd]\n" \ |
| 1954 | " 3 root root S [kupdate]\n" \ |
| 1955 | " 4 root root S [kpiod]\n" \ |
| 1956 | " 5 root root S [kswapd]\n" \ |
| 1957 | " 742 andersen andersen S [bash]\n" \ |
| 1958 | " 743 andersen andersen S -bash\n" \ |
| 1959 | " 745 root root S [getty]\n" \ |
| 1960 | " 2990 andersen andersen R ps\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1961 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1962 | #define pwd_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1963 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1964 | #define pwd_full_usage \ |
| 1965 | "Print the full filename of the current working directory." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 1966 | #define pwd_example_usage \ |
| 1967 | "$ pwd\n" \ |
| 1968 | "/root\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1969 | |
Eric Andersen | 92fb939 | 2003-08-08 20:09:03 +0000 | [diff] [blame] | 1970 | #define raid_start_trivial_usage \ |
| 1971 | "MD_DEVICE DISK_DEVICE" |
| 1972 | #define raid_start_full_usage \ |
| 1973 | "Start MD_DEVICE, taking superblock from DISK_DEVICE.\n" \ |
| 1974 | "Example: raid_start /dev/md0 /dev/sdb" |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1975 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1976 | #define rdate_trivial_usage \ |
Eric Andersen | 725db19 | 2003-07-22 08:26:05 +0000 | [diff] [blame] | 1977 | "[-sp] HOST" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1978 | #define rdate_full_usage \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 1979 | "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] | 1980 | "Options:\n" \ |
| 1981 | "\t-s\tSet the system date and time (default).\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1982 | "\t-p\tPrint the date and time." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1983 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1984 | #define readlink_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1985 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1986 | #define readlink_full_usage \ |
| 1987 | "Read a symbolic link." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1988 | |
Glenn L McGrath | 62fae30 | 2002-12-10 00:14:33 +0000 | [diff] [blame] | 1989 | #define realpath_trivial_usage \ |
| 1990 | "pathname ..." |
| 1991 | #define realpath_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 1992 | "Returns the absolute pathnames of given argument." |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 1993 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1994 | #define reboot_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 1995 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 1996 | #define reboot_full_usage \ |
| 1997 | "Reboot the system." |
| 1998 | |
| 1999 | #define renice_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2000 | "priority pid [pid ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2001 | #define renice_full_usage \ |
| 2002 | "Changes priority of running processes. Allowed priorities range\n" \ |
| 2003 | "from 20 (the process runs only when nothing else is running) to 0\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2004 | "(default priority) to -20 (almost nothing else ever gets to run)." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2005 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2006 | #define reset_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2007 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2008 | #define reset_full_usage \ |
| 2009 | "Resets the screen." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2010 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2011 | #define rm_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2012 | "[OPTION]... FILE..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2013 | #define rm_full_usage \ |
| 2014 | "Remove (unlink) the FILE(s). You may use '--' to\n" \ |
| 2015 | "indicate that all following arguments are non-options.\n\n" \ |
| 2016 | "Options:\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2017 | "\t-i\t\talways prompt before removing each destination\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2018 | "\t-f\t\tremove existing destinations, never prompt\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2019 | "\t-r or -R\tremove the contents of directories recursively" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2020 | #define rm_example_usage \ |
| 2021 | "$ rm -rf /tmp/foo\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2022 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2023 | #define rmdir_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2024 | "[OPTION]... DIRECTORY..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2025 | #define rmdir_full_usage \ |
| 2026 | "Remove the DIRECTORY(ies), if they are empty." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2027 | #define rmdir_example_usage \ |
| 2028 | "# rmdir /tmp/foo\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2029 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2030 | #define rmmod_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2031 | "[OPTION]... [MODULE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2032 | #define rmmod_full_usage \ |
| 2033 | "Unloads the specified kernel modules from the kernel.\n\n" \ |
| 2034 | "Options:\n" \ |
Tim Riker | cf93274 | 2002-12-14 01:58:59 +0000 | [diff] [blame] | 2035 | "\t-a\tRemove all unused modules (recursively)" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2036 | #define rmmod_example_usage \ |
| 2037 | "$ rmmod tulip\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2038 | |
Manuel Novoa III | 7d0c519 | 2004-03-10 07:42:38 +0000 | [diff] [blame] | 2039 | #ifdef CONFIG_FEATURE_IPV6 |
| 2040 | #define USAGE_ROUTE_IPV6(a) a |
| 2041 | #else |
| 2042 | #define USAGE_ROUTE_IPV6(a) "\t" |
| 2043 | #endif |
| 2044 | |
| 2045 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2046 | #define route_trivial_usage \ |
Manuel Novoa III | 7d0c519 | 2004-03-10 07:42:38 +0000 | [diff] [blame] | 2047 | "[{add|del|delete}]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2048 | #define route_full_usage \ |
Matt Kraai | 9758e7d | 2002-01-03 17:32:29 +0000 | [diff] [blame] | 2049 | "Edit the kernel's routing tables.\n\n" \ |
Eric Andersen | fb74a45 | 2001-12-18 14:06:03 +0000 | [diff] [blame] | 2050 | "Options:\n" \ |
Manuel Novoa III | 7d0c519 | 2004-03-10 07:42:38 +0000 | [diff] [blame] | 2051 | "\t-n\t\tDont resolve names.\n" \ |
| 2052 | "\t-e\t\tDisplay other/more information.\n" \ |
| 2053 | "\t-A inet" USAGE_ROUTE_IPV6("{6}") "\tSelect address family." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2054 | |
Glenn L McGrath | b72a735 | 2002-12-10 00:17:22 +0000 | [diff] [blame] | 2055 | #define rpm_trivial_usage \ |
| 2056 | "-i -q[ildc]p package.rpm" |
| 2057 | #define rpm_full_usage \ |
| 2058 | "Manipulates RPM packages" \ |
Eric Andersen | dfce353 | 2003-06-15 07:00:54 +0000 | [diff] [blame] | 2059 | "\n\nOptions:" \ |
| 2060 | "\n\t-i Install package" \ |
| 2061 | "\n\t-q Query package" \ |
| 2062 | "\n\t-p Query uninstalled package" \ |
| 2063 | "\n\t-i Show information" \ |
| 2064 | "\n\t-l List contents" \ |
| 2065 | "\n\t-d List documents" \ |
| 2066 | "\n\t-c List config files" |
Glenn L McGrath | b72a735 | 2002-12-10 00:17:22 +0000 | [diff] [blame] | 2067 | |
Glenn L McGrath | f8736d2 | 2001-06-26 01:19:34 +0000 | [diff] [blame] | 2068 | #define rpm2cpio_trivial_usage \ |
| 2069 | "package.rpm" |
| 2070 | #define rpm2cpio_full_usage \ |
| 2071 | "Outputs a cpio archive of the rpm file." |
| 2072 | |
Eric Andersen | 6cf47a7 | 2001-10-31 10:24:36 +0000 | [diff] [blame] | 2073 | #define run_parts_trivial_usage \ |
| 2074 | "[-t] [-a ARG] [-u MASK] DIRECTORY" |
| 2075 | #define run_parts_full_usage \ |
| 2076 | "Run a bunch of scripts in a directory.\n\n" \ |
| 2077 | "Options:\n" \ |
| 2078 | "\t-t\t\tTest only what file will be executed, without execute them.\n" \ |
| 2079 | "\t-a ARG\tPass ARG as an argument for every program invoked.\n" \ |
| 2080 | "\t-u MASK\tSet the umask to MASK before executing every program." |
| 2081 | |
Glenn L McGrath | 8f3bc4c | 2003-12-20 07:30:35 +0000 | [diff] [blame] | 2082 | #define rx_trivial_usage \ |
| 2083 | "FILE" |
| 2084 | #define rx_full_usage \ |
| 2085 | "Receive a file using the xmodem protocol." |
| 2086 | #define rx_example_usage \ |
| 2087 | "$ rx /tmp/foo\n" |
| 2088 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2089 | #define sed_trivial_usage \ |
Matt Kraai | 075228a | 2001-06-21 14:40:55 +0000 | [diff] [blame] | 2090 | "[-nef] pattern [files...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2091 | #define sed_full_usage \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 2092 | "Options:\n" \ |
| 2093 | "\t-n\t\tsuppress automatic printing of pattern space\n" \ |
| 2094 | "\t-e script\tadd the script to the commands to be executed\n" \ |
| 2095 | "\t-f scriptfile\tadd the contents of script-file to the commands to be executed\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2096 | "\n" \ |
| 2097 | "If no -e or -f is given, the first non-option argument is taken as the\n" \ |
| 2098 | "sed script to interpret. All remaining arguments are names of input\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2099 | "files; if no input files are specified, then the standard input is read." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2100 | #define sed_example_usage \ |
| 2101 | "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \ |
| 2102 | "bar\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2103 | |
Glenn L McGrath | 82364bb | 2004-01-27 09:22:20 +0000 | [diff] [blame] | 2104 | #define seq_trivial_usage \ |
| 2105 | "[first [increment]] last" |
| 2106 | #define seq_full_usage \ |
| 2107 | "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \ |
| 2108 | "FIRST, INCREMENT default to 1\n" \ |
| 2109 | "Arguments:\n" \ |
| 2110 | "\tLAST\n" \ |
| 2111 | "\tFIRST\tLAST\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2112 | "\tFIRST\tINCREMENT\tLAST" |
Glenn L McGrath | 82364bb | 2004-01-27 09:22:20 +0000 | [diff] [blame] | 2113 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2114 | #define setkeycodes_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2115 | "SCANCODE KEYCODE ..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2116 | #define setkeycodes_full_usage \ |
| 2117 | "Set entries into the kernel's scancode-to-keycode map,\n" \ |
| 2118 | "allowing unusual keyboards to generate usable keycodes.\n\n" \ |
| 2119 | "SCANCODE may be either xx or e0xx (hexadecimal),\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2120 | "and KEYCODE is given in decimal" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2121 | #define setkeycodes_example_usage \ |
| 2122 | "$ setkeycodes e030 127\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2123 | |
Matt Kraai | 2d91deb | 2001-08-01 17:21:35 +0000 | [diff] [blame] | 2124 | #define lash_trivial_usage \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 2125 | "[FILE]...\n" \ |
| 2126 | "or: sh -c command [args]..." |
Matt Kraai | 2d91deb | 2001-08-01 17:21:35 +0000 | [diff] [blame] | 2127 | #define lash_full_usage \ |
Eric Andersen | 2e9c257 | 2003-08-08 22:26:06 +0000 | [diff] [blame] | 2128 | "The BusyBox LAme SHell (command interpreter)" |
Matt Kraai | 2d91deb | 2001-08-01 17:21:35 +0000 | [diff] [blame] | 2129 | #define lash_notes_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2130 | "This command does not yet have proper documentation.\n\n" \ |
| 2131 | "Use lash just as you would use any other shell. It properly handles pipes,\n" \ |
| 2132 | "redirects, job control, can be used as the shell for scripts, and has a\n" \ |
| 2133 | "sufficient set of builtins to do what is needed. It does not (yet) support\n" \ |
| 2134 | "Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \ |
| 2135 | "use ash or bash. If you just need a very simple and extremely small shell,\n" \ |
| 2136 | "this will do the job." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2137 | |
Eric Andersen | 2e9c257 | 2003-08-08 22:26:06 +0000 | [diff] [blame] | 2138 | #define last_trivial_usage \ |
| 2139 | "" |
| 2140 | #define last_full_usage \ |
| 2141 | "Shows listing of the last users that logged into the system" |
| 2142 | |
Glenn L McGrath | ae0f1e7 | 2003-02-17 08:23:22 +0000 | [diff] [blame] | 2143 | #define sha1sum_trivial_usage \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 2144 | "[OPTION] [FILEs...]" \ |
| 2145 | USAGE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]") |
Glenn L McGrath | ae0f1e7 | 2003-02-17 08:23:22 +0000 | [diff] [blame] | 2146 | #define sha1sum_full_usage \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 2147 | "Print" USAGE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n\n" \ |
| 2148 | "Options:\n" \ |
Glenn L McGrath | c83e3a6 | 2003-12-04 13:06:44 +0000 | [diff] [blame] | 2149 | "With no FILE, or when FILE is -, read standard input." \ |
| 2150 | USAGE_MD5_SHA1_SUM_CHECK("\n\n" \ |
| 2151 | "\t-c\tcheck SHA1 sums against given list\n" \ |
| 2152 | "\nThe following two options are useful only when verifying checksums:\n" \ |
Glenn L McGrath | 0b6539f | 2003-11-18 21:40:30 +0000 | [diff] [blame] | 2153 | "\t-s\tdon't output anything, status code shows success\n" \ |
Glenn L McGrath | c83e3a6 | 2003-12-04 13:06:44 +0000 | [diff] [blame] | 2154 | "\t-w\twarn about improperly formated SHA1 checksum lines") |
Glenn L McGrath | ae0f1e7 | 2003-02-17 08:23:22 +0000 | [diff] [blame] | 2155 | |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2156 | #ifdef CONFIG_FEATURE_FANCY_SLEEP |
| 2157 | #define USAGE_FANCY_SLEEP(a) a |
| 2158 | #define USAGE_NOT_FANCY_SLEEP(a) |
| 2159 | #else |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2160 | #define USAGE_FANCY_SLEEP(a) |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2161 | #define USAGE_NOT_FANCY_SLEEP(a) a |
| 2162 | #endif |
| 2163 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2164 | #define sleep_trivial_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2165 | USAGE_FANCY_SLEEP("[") "N" USAGE_FANCY_SLEEP("]...") |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2166 | #define sleep_full_usage \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2167 | USAGE_NOT_FANCY_SLEEP("Pause for N seconds.") \ |
| 2168 | USAGE_FANCY_SLEEP( \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2169 | "Pause for a time equal to the total of the args given, where each arg can\n" \ |
| 2170 | "have 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] | 2171 | #define sleep_example_usage \ |
| 2172 | "$ sleep 2\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2173 | "[2 second delay results]\n" \ |
| 2174 | USAGE_FANCY_SLEEP("$ sleep 1d 3h 22m 8s\n" \ |
| 2175 | "[98528 second delay results]\n") |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2176 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2177 | #ifdef CONFIG_FEATURE_SORT_UNIQUE |
Mark Whitley | fccaa36 | 2001-04-17 18:56:18 +0000 | [diff] [blame] | 2178 | #define USAGE_SORT_UNIQUE(a) a |
| 2179 | #else |
| 2180 | #define USAGE_SORT_UNIQUE(a) |
| 2181 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2182 | #ifdef CONFIG_FEATURE_SORT_REVERSE |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2183 | #define USAGE_SORT_REVERSE(a) a |
| 2184 | #else |
| 2185 | #define USAGE_SORT_REVERSE(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2186 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2187 | #define sort_trivial_usage \ |
Mark Whitley | fccaa36 | 2001-04-17 18:56:18 +0000 | [diff] [blame] | 2188 | "[-n" USAGE_SORT_REVERSE("r") USAGE_SORT_UNIQUE("u") "] [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2189 | #define sort_full_usage \ |
Mark Whitley | fccaa36 | 2001-04-17 18:56:18 +0000 | [diff] [blame] | 2190 | "Sorts lines of text in the specified files\n\n"\ |
| 2191 | "Options:\n" \ |
| 2192 | USAGE_SORT_UNIQUE("\t-u\tsuppress duplicate lines\n") \ |
| 2193 | USAGE_SORT_REVERSE("\t-r\tsort in reverse order\n") \ |
| 2194 | "\t-n\tsort numerics" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2195 | #define sort_example_usage \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 2196 | "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2197 | "a\n" \ |
| 2198 | "b\n" \ |
| 2199 | "c\n" \ |
| 2200 | "d\n" \ |
| 2201 | "e\n" \ |
| 2202 | "f\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2203 | |
Eric Andersen | c2af1ee | 2001-10-18 19:33:06 +0000 | [diff] [blame] | 2204 | #define start_stop_daemon_trivial_usage \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 2205 | "[OPTIONS] [-S|--start|-K|--stop] ... [-- arguments...]\n" |
Eric Andersen | c2af1ee | 2001-10-18 19:33:06 +0000 | [diff] [blame] | 2206 | #define start_stop_daemon_full_usage \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 2207 | "Program to start and stop services."\ |
| 2208 | "\n\nOptions:"\ |
| 2209 | "\n\t-S|--start\t\t\tstart"\ |
| 2210 | "\n\t-K|--stop\t\t\tstop"\ |
| 2211 | "\n\t-a|--startas <pathname>\t\tstart the process specified by pathname"\ |
| 2212 | "\n\t-b|--background\t\t\tforce process into background"\ |
| 2213 | "\n\t-u|--user <username>|<uid>\tstop this user's processes"\ |
| 2214 | "\n\t-x|--exec <executable>\t\tprogram to start/check if it is running"\ |
| 2215 | "\n\t-n|--name <process-name>\tstop processes with this name"\ |
| 2216 | "\n\t-p|--pidfile <pid-file>\t\tsave or load pid using a pid-file"\ |
| 2217 | "\n\t-q|--quiet\t\t\tbe quiet" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2218 | "\n\t-s|--signal <signal>\t\tsignal to send (default TERM)" |
Eric Andersen | c2af1ee | 2001-10-18 19:33:06 +0000 | [diff] [blame] | 2219 | |
Eric Andersen | ef5e8f8 | 2002-11-07 02:09:37 +0000 | [diff] [blame] | 2220 | #define strings_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2221 | "[-afo] [-n length] [file ... ]" |
Eric Andersen | ef5e8f8 | 2002-11-07 02:09:37 +0000 | [diff] [blame] | 2222 | #define strings_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2223 | "Display printable strings in a binary file." \ |
| 2224 | "\n\nOptions:" \ |
| 2225 | "\n\t-f\tPrecede each string with the name of the file where it was found." \ |
| 2226 | "\n\t-n N\tSpecifies that at least N characters forms a sequence (default 4)" \ |
| 2227 | "\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] | 2228 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2229 | #define stty_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2230 | "[-a|g] [-F DEVICE] [SETTING]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2231 | #define stty_full_usage \ |
| 2232 | "Without arguments, prints baud rate, line discipline," \ |
| 2233 | "\nand deviations from stty sane." \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 2234 | "\n\nOptions:" \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2235 | "\n\t-F DEVICE\topen device instead of stdin" \ |
Eric Andersen | 7a9cc2d | 2001-02-23 16:58:44 +0000 | [diff] [blame] | 2236 | "\n\t-a\t\tprint all current settings in human-readable form" \ |
| 2237 | "\n\t-g\t\tprint in stty-readable form" \ |
Eric Andersen | abec344 | 2001-05-21 17:58:01 +0000 | [diff] [blame] | 2238 | "\n\t[SETTING]\tsee manpage" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2239 | |
Robert Griebl | 1fca558 | 2002-06-04 20:45:46 +0000 | [diff] [blame] | 2240 | #define su_trivial_usage \ |
| 2241 | "[OPTION]... [-] [username]" |
| 2242 | #define su_full_usage \ |
| 2243 | "Change user id or become root.\n" \ |
| 2244 | "Options:\n" \ |
| 2245 | "\t-p\tPreserve environment" |
| 2246 | |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 2247 | #define sulogin_trivial_usage \ |
| 2248 | "[OPTION]... [tty-device]" |
| 2249 | #define sulogin_full_usage \ |
| 2250 | "Single user login\n" \ |
| 2251 | "Options:\n" \ |
| 2252 | "\t-f\tDo not authenticate (user already authenticated)\n" \ |
| 2253 | "\t-h\tName of the remote host for this login.\n" \ |
| 2254 | "\t-p\tPreserve environment." |
| 2255 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2256 | #define swapoff_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2257 | "[OPTION] [DEVICE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2258 | #define swapoff_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2259 | "Stop swapping virtual memory pages on DEVICE.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2260 | "Options:\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2261 | "\t-a\tStop swapping on all swap devices" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2262 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2263 | #define swapon_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2264 | "[OPTION] [DEVICE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2265 | #define swapon_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2266 | "Start swapping virtual memory pages on DEVICE.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2267 | "Options:\n" \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2268 | "\t-a\tStart swapping on all swap devices" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2269 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2270 | #define sync_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2271 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2272 | #define sync_full_usage \ |
| 2273 | "Write all buffered filesystem blocks to disk." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2274 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2275 | |
Eric Andersen | 29c77f7 | 2003-10-09 09:43:18 +0000 | [diff] [blame] | 2276 | #ifdef CONFIG_FEATURE_ROTATE_LOGFILE |
| 2277 | #define USAGE_ROTATE_LOGFILE(a) a |
| 2278 | #else |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2279 | #define USAGE_ROTATE_LOGFILE(a) |
Eric Andersen | 29c77f7 | 2003-10-09 09:43:18 +0000 | [diff] [blame] | 2280 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2281 | #ifdef CONFIG_FEATURE_REMOTE_LOG |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2282 | #define USAGE_REMOTE_LOG(a) a |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2283 | #else |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2284 | #define USAGE_REMOTE_LOG(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2285 | #endif |
Robert Griebl | 65d415d | 2002-08-07 21:10:19 +0000 | [diff] [blame] | 2286 | #ifdef CONFIG_FEATURE_IPC_SYSLOG |
| 2287 | #define USAGE_IPC_LOG(a) a |
| 2288 | #else |
| 2289 | #define USAGE_IPC_LOG(a) |
| 2290 | #endif |
| 2291 | |
Eric Andersen | b905028 | 2003-12-24 06:02:11 +0000 | [diff] [blame] | 2292 | #ifdef CONFIG_SYSCTL |
| 2293 | #define sysctl_trivial_usage \ |
| 2294 | "[OPTIONS]... [VALUE]...\n" |
| 2295 | #define sysctl_full_usage |
| 2296 | "sysctl - configure kernel parameters at runtime\n\n" \ |
| 2297 | "Options:\n" \ |
| 2298 | "\t-n\tUse this option to disable printing of the key name when printing values.\n" \ |
| 2299 | "\t-e\tUse this option to ignore errors about unknown keys.\n" \ |
| 2300 | "\t-w\tUse this option when you want to change a sysctl setting.\n" \ |
| 2301 | "\t-p\tLoad in sysctl settings from the file specified or /etc/sysctl.conf if none given.\n" \ |
| 2302 | "\t-a\tDisplay all values currently available.\n" \ |
| 2303 | "\t-A\tDisplay all values currently available in table form." |
Eric Andersen | b905028 | 2003-12-24 06:02:11 +0000 | [diff] [blame] | 2304 | #define sysctl_example_usage |
| 2305 | "sysctl [-n] [-e] variable ...\n" \ |
| 2306 | "sysctl [-n] [-e] -w variable=value ...\n" \ |
| 2307 | "sysctl [-n] [-e] -a\n" \ |
| 2308 | "sysctl [-n] [-e] -p <file>\t(default /etc/sysctl.conf)\n" \ |
| 2309 | "sysctl [-n] [-e] -A\n" |
| 2310 | #endif |
| 2311 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2312 | #define syslogd_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2313 | "[OPTION]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2314 | #define syslogd_full_usage \ |
Mark Whitley | 6317c4b | 2001-03-12 22:51:50 +0000 | [diff] [blame] | 2315 | "Linux system and kernel logging utility.\n" \ |
| 2316 | "Note that this version of syslogd ignores /etc/syslog.conf.\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2317 | "Options:\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2318 | "\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] | 2319 | "\t-n\t\tRun as a foreground process\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2320 | "\t-O FILE\t\tUse an alternate log file (default=/var/log/messages)" \ |
Eric Andersen | 29c77f7 | 2003-10-09 09:43:18 +0000 | [diff] [blame] | 2321 | USAGE_ROTATE_LOGFILE( \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2322 | "\n\t-s SIZE\t\tMax size (KB) before rotate (default=200KB, 0=off)\n" \ |
| 2323 | "\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] | 2324 | USAGE_REMOTE_LOG( \ |
Eric Andersen | dc12190 | 2001-02-24 18:52:36 +0000 | [diff] [blame] | 2325 | "\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] | 2326 | "\t-L\t\tLog locally and via network logging (default is network only)") \ |
| 2327 | USAGE_IPC_LOG( \ |
Eric Andersen | d4a5e25 | 2003-12-19 11:32:14 +0000 | [diff] [blame] | 2328 | "\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] | 2329 | #define syslogd_example_usage \ |
| 2330 | "$ syslogd -R masterlog:514\n" \ |
| 2331 | "$ syslogd -R 192.168.1.1:601\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2332 | |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2333 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2334 | #ifndef CONFIG_FEATURE_FANCY_TAIL |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2335 | #define USAGE_UNSIMPLE_TAIL(a) |
| 2336 | #else |
| 2337 | #define USAGE_UNSIMPLE_TAIL(a) a |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2338 | #endif |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2339 | #define tail_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2340 | "[OPTION]... [FILE]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2341 | #define tail_full_usage \ |
| 2342 | "Print last 10 lines of each FILE to standard output.\n" \ |
| 2343 | "With more than one FILE, precede each with a header giving the\n" \ |
| 2344 | "file name. With no FILE, or when FILE is -, read standard input.\n\n" \ |
| 2345 | "Options:\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 2346 | 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] | 2347 | "\t-n N[kbm]\tprint last N lines instead of last 10\n" \ |
| 2348 | "\t-f\t\toutput data as the file grows" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2349 | 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] | 2350 | "\t-s SEC\t\twait SEC seconds between reads with -f\n" \ |
| 2351 | "\t-v\t\talways output headers giving file names\n\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2352 | "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] | 2353 | "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] | 2354 | "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) |
| 2355 | #define tail_example_usage \ |
| 2356 | "$ tail -n 1 /etc/resolv.conf\n" \ |
| 2357 | "nameserver 10.0.0.1\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2358 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2359 | #ifdef CONFIG_FEATURE_TAR_CREATE |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2360 | #define USAGE_TAR_CREATE(a) a |
| 2361 | #else |
| 2362 | #define USAGE_TAR_CREATE(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2363 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2364 | #ifdef CONFIG_FEATURE_TAR_EXCLUDE |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2365 | #define USAGE_TAR_EXCLUDE(a) a |
| 2366 | #else |
| 2367 | #define USAGE_TAR_EXCLUDE(a) |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2368 | #endif |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 2369 | #ifdef CONFIG_FEATURE_TAR_GZIP |
| 2370 | #define USAGE_TAR_GZIP(a) a |
| 2371 | #else |
| 2372 | #define USAGE_TAR_GZIP(a) |
| 2373 | #endif |
| 2374 | #ifdef CONFIG_FEATURE_TAR_BZIP2 |
| 2375 | #define USAGE_TAR_BZIP2(a) a |
| 2376 | #else |
| 2377 | #define USAGE_TAR_BZIP2(a) |
| 2378 | #endif |
Glenn L McGrath | 7370f62 | 2003-11-18 21:49:23 +0000 | [diff] [blame] | 2379 | #ifdef CONFIG_FEATURE_TAR_COMPRESS |
| 2380 | #define USAGE_TAR_COMPRESS(a) a |
| 2381 | #else |
| 2382 | #define USAGE_TAR_COMPRESS(a) |
| 2383 | #endif |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 2384 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2385 | #define tar_trivial_usage \ |
Glenn L McGrath | 7370f62 | 2003-11-18 21:49:23 +0000 | [diff] [blame] | 2386 | "-[" USAGE_TAR_CREATE("c") USAGE_TAR_GZIP("z") USAGE_TAR_BZIP2("j") USAGE_TAR_COMPRESS("Z") "xtvO] " \ |
Glenn L McGrath | ce91c8a | 2003-12-26 14:01:37 +0000 | [diff] [blame] | 2387 | USAGE_TAR_EXCLUDE("[-X FILE]") \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 2388 | "[-f TARFILE] [-C DIR] [FILE(s)] ..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2389 | #define tar_full_usage \ |
| 2390 | "Create, extract, or list files from a tar file.\n\n" \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 2391 | "Options:\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 2392 | USAGE_TAR_CREATE("\tc\t\tcreate\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2393 | "\tx\t\textract\n" \ |
| 2394 | "\tt\t\tlist\n" \ |
Glenn L McGrath | 87444ef | 2002-12-27 00:45:35 +0000 | [diff] [blame] | 2395 | "\nArchive format selection:\n" \ |
| 2396 | USAGE_TAR_GZIP("\tz\t\tFilter the archive through gzip\n") \ |
| 2397 | USAGE_TAR_BZIP2("\tj\t\tFilter the archive through bzip2\n") \ |
Glenn L McGrath | 0c5d9c2 | 2003-11-18 23:27:49 +0000 | [diff] [blame] | 2398 | USAGE_TAR_COMPRESS("\tZ\t\tFilter the archive through compress\n") \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2399 | "\nFile selection:\n" \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2400 | "\tf\t\tname of TARFILE or \"-\" for stdin\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2401 | "\tO\t\textract to stdout\n" \ |
Eric Andersen | 4b2e69a | 2001-02-22 23:32:59 +0000 | [diff] [blame] | 2402 | USAGE_TAR_EXCLUDE( \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2403 | "\texclude\t\tfile to exclude\n" \ |
| 2404 | "\tX\t\tfile with names to exclude\n" \ |
| 2405 | ) \ |
Eric Andersen | 091781e | 2001-06-21 19:30:10 +0000 | [diff] [blame] | 2406 | "\tC\t\tchange to directory DIR before operation\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2407 | "\tv\t\tverbosely list files processed" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2408 | #define tar_example_usage \ |
| 2409 | "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \ |
| 2410 | "$ tar -cf /tmp/tarball.tar /usr/local\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2411 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2412 | #define tee_trivial_usage \ |
| 2413 | "[OPTION]... [FILE]..." |
| 2414 | #define tee_full_usage \ |
| 2415 | "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] | 2416 | "Options:\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2417 | "\t-a\tappend to the given FILEs, do not overwrite\n" \ |
| 2418 | "\t-i\tignore interrupt signals (SIGINT)" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2419 | #define tee_example_usage \ |
| 2420 | "$ echo "Hello" | tee /tmp/foo\n" \ |
| 2421 | "$ cat /tmp/foo\n" \ |
| 2422 | "Hello\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2423 | |
Eric Andersen | 539ffc9 | 2004-02-22 12:25:47 +0000 | [diff] [blame] | 2424 | #ifdef CONFIG_FEATURE_TELNET_AUTOLOGIN |
| 2425 | #define telnet_trivial_usage \ |
| 2426 | "[-a] [-l USER] HOST [PORT]" |
| 2427 | #define telnet_full_usage \ |
| 2428 | "Telnet is used to establish interactive communication with another\n" \ |
| 2429 | "computer over a network using the TELNET protocol.\n\n" \ |
| 2430 | "Options:\n" \ |
| 2431 | "\t-a\t\tAttempt an automatic login with the USER variable.\n" \ |
| 2432 | "\t-l USER\t\tAttempt an automatic login with the USER argument.\n" \ |
| 2433 | "\tHOST\t\tThe official name, alias or the IP address of the\n" \ |
| 2434 | "\t\t\tremote host.\n" \ |
| 2435 | "\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^] | 2436 | "\t\t\tspecified, the default telnet (23) port is used." |
Eric Andersen | 539ffc9 | 2004-02-22 12:25:47 +0000 | [diff] [blame] | 2437 | #else |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2438 | #define telnet_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2439 | "HOST [PORT]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2440 | #define telnet_full_usage \ |
| 2441 | "Telnet is used to establish interactive communication with another\n"\ |
| 2442 | "computer over a network using the TELNET protocol." |
Eric Andersen | 539ffc9 | 2004-02-22 12:25:47 +0000 | [diff] [blame] | 2443 | #endif |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2444 | |
Glenn L McGrath | 4a4c677 | 2003-02-15 11:50:33 +0000 | [diff] [blame] | 2445 | #ifdef CONFIG_FEATURE_TELNETD_INETD |
| 2446 | #define telnetd_trivial_usage \ |
| 2447 | "(inetd mode) [OPTION]" |
| 2448 | #define telnetd_full_usage \ |
| 2449 | "Telnetd uses incoming TELNET connections via inetd.\n"\ |
| 2450 | "Options:\n" \ |
| 2451 | "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)" |
| 2452 | #else |
Eric Andersen | 08a7220 | 2002-09-30 20:52:10 +0000 | [diff] [blame] | 2453 | #define telnetd_trivial_usage \ |
| 2454 | "[OPTION]" |
| 2455 | #define telnetd_full_usage \ |
| 2456 | "Telnetd listens for incoming TELNET connections on PORT.\n"\ |
| 2457 | "Options:\n" \ |
| 2458 | "\t-p PORT\tlisten for connections on PORT (default 23)\n"\ |
| 2459 | "\t-l LOGIN\texec LOGIN on connect (default /bin/sh)" |
Glenn L McGrath | 4a4c677 | 2003-02-15 11:50:33 +0000 | [diff] [blame] | 2460 | #endif |
Eric Andersen | 08a7220 | 2002-09-30 20:52:10 +0000 | [diff] [blame] | 2461 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2462 | #define test_trivial_usage \ |
| 2463 | "EXPRESSION\n or [ EXPRESSION ]" |
| 2464 | #define test_full_usage \ |
| 2465 | "Checks file types and compares values returning an exit\n" \ |
| 2466 | "code determined by the value of EXPRESSION." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2467 | #define test_example_usage \ |
| 2468 | "$ test 1 -eq 2\n" \ |
| 2469 | "$ echo $?\n" \ |
| 2470 | "1\n" \ |
| 2471 | "$ test 1 -eq 1\n" \ |
Eric Andersen | 63a1a7a | 2004-03-13 08:33:10 +0000 | [diff] [blame] | 2472 | "$ echo $?\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2473 | "0\n" \ |
| 2474 | "$ [ -d /etc ]\n" \ |
| 2475 | "$ echo $?\n" \ |
| 2476 | "0\n" \ |
| 2477 | "$ [ -d /junk ]\n" \ |
| 2478 | "$ echo $?\n" \ |
| 2479 | "1\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2480 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2481 | #ifdef CONFIG_FEATURE_TFTP_GET |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 2482 | #define USAGE_TFTP_GET(a) a |
| 2483 | #else |
| 2484 | #define USAGE_TFTP_GET(a) |
| 2485 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2486 | #ifdef CONFIG_FEATURE_TFTP_PUT |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 2487 | #define USAGE_TFTP_PUT(a) a |
| 2488 | #else |
| 2489 | #define USAGE_TFTP_PUT(a) |
| 2490 | #endif |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2491 | #ifdef CONFIG_FEATURE_TFTP_BLOCKSIZE |
Glenn L McGrath | ad117d8 | 2001-10-05 04:40:37 +0000 | [diff] [blame] | 2492 | #define USAGE_TFTP_BS(a) a |
| 2493 | #else |
| 2494 | #define USAGE_TFTP_BS(a) |
| 2495 | #endif |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 2496 | |
| 2497 | #define tftp_trivial_usage \ |
Matt Kraai | 3be3430 | 2001-09-21 14:42:30 +0000 | [diff] [blame] | 2498 | "[OPTION]... HOST [PORT]" |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 2499 | #define tftp_full_usage \ |
| 2500 | "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] | 2501 | "Options:\n" \ |
Glenn L McGrath | ad117d8 | 2001-10-05 04:40:37 +0000 | [diff] [blame] | 2502 | "\t-l FILE\tLocal FILE.\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2503 | "\t-r FILE\tRemote FILE." \ |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 2504 | USAGE_TFTP_GET( \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2505 | "\n\t-g\tGet file." \ |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 2506 | ) \ |
| 2507 | USAGE_TFTP_PUT( \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2508 | "\n\t-p\tPut file." \ |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 2509 | ) \ |
Glenn L McGrath | ad117d8 | 2001-10-05 04:40:37 +0000 | [diff] [blame] | 2510 | USAGE_TFTP_BS( \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2511 | "\n\t-b SIZE\tTransfer blocks of SIZE octets." \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2512 | ) |
Eric Andersen | c365742 | 2001-11-30 07:54:32 +0000 | [diff] [blame] | 2513 | #define time_trivial_usage \ |
| 2514 | "[OPTION]... COMMAND [ARGS...]" |
| 2515 | #define time_full_usage \ |
Eric Andersen | 356b6db | 2001-12-06 07:42:04 +0000 | [diff] [blame] | 2516 | "Runs the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \ |
| 2517 | "COMMAND's resource usage information is displayed\n\n" \ |
Eric Andersen | c365742 | 2001-11-30 07:54:32 +0000 | [diff] [blame] | 2518 | "Options:\n" \ |
| 2519 | "\t-v\tDisplays verbose resource usage information." |
Mark Whitley | 450736c | 2001-03-02 19:08:50 +0000 | [diff] [blame] | 2520 | |
Eric Andersen | 420b208 | 2002-09-17 22:14:58 +0000 | [diff] [blame] | 2521 | #define top_trivial_usage \ |
| 2522 | "[-d <seconds>]" |
| 2523 | #define top_full_usage \ |
| 2524 | "top provides an view of processor activity in real time.\n" \ |
| 2525 | "This utility reads the status for all processes in /proc each <seconds>\n" \ |
| 2526 | "and shows the status for however many processes will fit on the screen.\n" \ |
| 2527 | "This utility will not show processes that are started after program startup,\n" \ |
| 2528 | "but it will show the EXIT status for and PIDs that exit while it is running." |
| 2529 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2530 | #define touch_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2531 | "[-c] FILE [FILE ...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2532 | #define touch_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2533 | "Update the last-modified date on the given FILE[s].\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2534 | "Options:\n" \ |
| 2535 | "\t-c\tDo not create any files" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2536 | #define touch_example_usage \ |
| 2537 | "$ ls -l /tmp/foo\n" \ |
| 2538 | "/bin/ls: /tmp/foo: No such file or directory\n" \ |
| 2539 | "$ touch /tmp/foo\n" \ |
| 2540 | "$ ls -l /tmp/foo\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2541 | "-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] | 2542 | |
| 2543 | #define tr_trivial_usage \ |
| 2544 | "[-cds] STRING1 [STRING2]" |
| 2545 | #define tr_full_usage \ |
| 2546 | "Translate, squeeze, and/or delete characters from\n" \ |
| 2547 | "standard input, writing to standard output.\n\n" \ |
| 2548 | "Options:\n" \ |
| 2549 | "\t-c\ttake complement of STRING1\n" \ |
| 2550 | "\t-d\tdelete input characters coded STRING1\n" \ |
| 2551 | "\t-s\tsqueeze multiple output characters of STRING2 into one character" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2552 | #define tr_example_usage \ |
| 2553 | "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2554 | "hello world\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2555 | |
Eric Andersen | 5c58d28 | 2001-07-10 16:29:00 +0000 | [diff] [blame] | 2556 | #define traceroute_trivial_usage \ |
| 2557 | "[-dnrv] [-m max_ttl] [-p port#] [-q nqueries]\n\ |
| 2558 | [-s src_addr] [-t tos] [-w wait] host [data size]" |
| 2559 | #define traceroute_full_usage \ |
| 2560 | "trace the route ip packets follow going to \"host\"\n" \ |
| 2561 | "Options:\n" \ |
| 2562 | "\t-d\tset SO_DEBUG options to socket\n" \ |
| 2563 | "\t-n\tPrint hop addresses numerically rather than symbolically\n" \ |
| 2564 | "\t-r\tBypass the normal routing tables and send directly to a host\n" \ |
| 2565 | "\t-v\tVerbose output\n" \ |
| 2566 | "\t-m max_ttl\tSet the max time-to-live (max number of hops)\n" \ |
| 2567 | "\t-p port#\tSet the base UDP port number used in probes\n" \ |
| 2568 | "\t\t(default is 33434)\n" \ |
| 2569 | "\t-q nqueries\tSet the number of probes per ``ttl'' to nqueries\n" \ |
| 2570 | "\t\t(default is 3)\n" \ |
| 2571 | "\t-s src_addr\tUse the following IP address as the source address\n" \ |
| 2572 | "\t-t tos\tSet the type-of-service in probe packets to the following value\n" \ |
| 2573 | "\t\t(default 0)\n" \ |
| 2574 | "\t-w wait\tSet the time (in seconds) to wait for a response to a probe\n" \ |
| 2575 | "\t\t(default 3 sec.)." |
| 2576 | |
| 2577 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2578 | #define true_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2579 | "" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2580 | #define true_full_usage \ |
| 2581 | "Return an exit code of TRUE (0)." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2582 | #define true_example_usage \ |
| 2583 | "$ true\n" \ |
| 2584 | "$ echo $?\n" \ |
| 2585 | "0\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2586 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2587 | #define tty_trivial_usage \ |
| 2588 | "" |
| 2589 | #define tty_full_usage \ |
| 2590 | "Print the file name of the terminal connected to standard input.\n\n"\ |
| 2591 | "Options:\n" \ |
| 2592 | "\t-s\tprint nothing, only return an exit status" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2593 | #define tty_example_usage \ |
| 2594 | "$ tty\n" \ |
| 2595 | "/dev/tty2\n" |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2596 | |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 2597 | #define udhcpc_trivial_usage \ |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 2598 | "[-fbnqv] [-c CLIENTID] [-H HOSTNAME] [-i INTERFACE]\n[-p pidfile] [-r IP] [-s script]" |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 2599 | #define udhcpc_full_usage \ |
| 2600 | "\t-c,\t--clientid=CLIENTID\tClient identifier\n" \ |
| 2601 | "\t-H,\t--hostname=HOSTNAME\tClient hostname\n" \ |
Russ Dill | 0288c8e | 2002-11-05 20:13:41 +0000 | [diff] [blame] | 2602 | "\t-h,\t \tAlias for -H\n" \ |
Glenn L McGrath | 8eb0dc1 | 2002-08-21 10:27:58 +0000 | [diff] [blame] | 2603 | "\t-f,\t--foreground\tDo not fork after getting lease\n" \ |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 2604 | "\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] | 2605 | "\t-i,\t--interface=INTERFACE\tInterface to use (default: eth0)\n" \ |
| 2606 | "\t-n,\t--now\tExit with failure if lease cannot be immediately negotiated.\n" \ |
| 2607 | "\t-p,\t--pidfile=file\tStore process ID of daemon in file\n" \ |
| 2608 | "\t-q,\t--quit\tQuit after obtaining lease\n" \ |
| 2609 | "\t-r,\t--request=IP\tIP address to request (default: none)\n" \ |
| 2610 | "\t-s,\t--script=file\tRun file at dhcp events (default: /usr/share/udhcpc/default.script)\n" \ |
| 2611 | "\t-v,\t--version\tDisplay version" |
| 2612 | |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 2613 | #define udhcpd_trivial_usage \ |
| 2614 | "[configfile]\n" \ |
| 2615 | |
| 2616 | #define udhcpd_full_usage \ |
Glenn L McGrath | 9130c85 | 2002-12-12 12:56:18 +0000 | [diff] [blame] | 2617 | "" |
Russ Dill | 61fb489 | 2002-10-14 21:41:28 +0000 | [diff] [blame] | 2618 | |
Eric Andersen | bdfd0d7 | 2001-10-24 05:00:29 +0000 | [diff] [blame] | 2619 | #ifdef CONFIG_FEATURE_MOUNT_FORCE |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2620 | #define USAGE_MOUNT_FORCE(a) a |
| 2621 | #else |
| 2622 | #define USAGE_MOUNT_FORCE(a) |
| 2623 | #endif |
| 2624 | #define umount_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2625 | "[flags] FILESYSTEM|DIRECTORY" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2626 | #define umount_full_usage \ |
| 2627 | "Unmount file systems\n" \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 2628 | "\nFlags:\n" "\t-a\tUnmount all file systems" \ |
| 2629 | USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \ |
| 2630 | "\n\t-r\tTry to remount devices as read-only if mount is busy" \ |
Eric Andersen | 77d9268 | 2001-05-23 20:32:09 +0000 | [diff] [blame] | 2631 | USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e., unreachable NFS server)") \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 2632 | USAGE_MOUNT_LOOP("\n\t-l\tDo not free loop device (if a loop device has been used)") |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2633 | #define umount_example_usage \ |
| 2634 | "$ umount /dev/hdc1 \n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2635 | |
| 2636 | #define uname_trivial_usage \ |
| 2637 | "[OPTION]..." |
| 2638 | #define uname_full_usage \ |
| 2639 | "Print certain system information. With no OPTION, same as -s.\n\n" \ |
| 2640 | "Options:\n" \ |
| 2641 | "\t-a\tprint all information\n" \ |
| 2642 | "\t-m\tthe machine (hardware) type\n" \ |
| 2643 | "\t-n\tprint the machine's network node hostname\n" \ |
| 2644 | "\t-r\tprint the operating system release\n" \ |
| 2645 | "\t-s\tprint the operating system name\n" \ |
| 2646 | "\t-p\tprint the host processor type\n" \ |
| 2647 | "\t-v\tprint the operating system version" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2648 | #define uname_example_usage \ |
| 2649 | "$ uname -a\n" \ |
Eric Andersen | 7f48a95 | 2003-12-28 05:06:56 +0000 | [diff] [blame] | 2650 | "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] | 2651 | |
Glenn L McGrath | bf1cc8b | 2002-11-01 23:38:54 +0000 | [diff] [blame] | 2652 | #define uncompress_trivial_usage \ |
| 2653 | "[-c] [-f] [ name ... ]" |
| 2654 | #define uncompress_full_usage \ |
| 2655 | "Uncompress .Z file[s]\n" \ |
| 2656 | "Options:\n" \ |
| 2657 | "\t-c\textract to stdout\n" \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2658 | "\t-f\tforce overwrite an existing file" |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2659 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2660 | #define uniq_trivial_usage \ |
| 2661 | "[OPTION]... [INPUT [OUTPUT]]" |
| 2662 | #define uniq_full_usage \ |
| 2663 | "Discard all but one of successive identical lines from INPUT\n" \ |
Eric Andersen | a0cfe94 | 2001-02-23 10:07:09 +0000 | [diff] [blame] | 2664 | "(or standard input), writing to OUTPUT (or standard output).\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2665 | "Options:\n" \ |
| 2666 | "\t-c\tprefix lines by the number of occurrences\n" \ |
| 2667 | "\t-d\tonly print duplicate lines\n" \ |
Manuel Novoa III | cad5364 | 2003-03-19 09:13:01 +0000 | [diff] [blame] | 2668 | "\t-u\tonly print unique lines\n" \ |
| 2669 | "\t-f N\tskip the first N fields\n" \ |
| 2670 | "\t-s N\tskip the first N chars (after any skipped fields)" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2671 | #define uniq_example_usage \ |
John Beppu | 5d81768 | 2001-04-17 17:09:34 +0000 | [diff] [blame] | 2672 | "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2673 | "a\n" \ |
| 2674 | "b\n" \ |
| 2675 | "c\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2676 | |
| 2677 | #define unix2dos_trivial_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2678 | "[option] [FILE]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2679 | #define unix2dos_full_usage \ |
Eric Andersen | 317827d | 2001-05-21 17:50:53 +0000 | [diff] [blame] | 2680 | "Converts FILE from unix format to dos format. When no option\n" \ |
| 2681 | "is given, the input is converted to the opposite output format.\n" \ |
Eric Andersen | 3200f5a | 2001-05-22 22:39:10 +0000 | [diff] [blame] | 2682 | "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] | 2683 | "Options:\n" \ |
| 2684 | "\t-u\toutput will be in UNIX format\n" \ |
Eric Andersen | 3200f5a | 2001-05-22 22:39:10 +0000 | [diff] [blame] | 2685 | "\t-d\toutput will be in DOS format" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2686 | |
Glenn L McGrath | 87ac702 | 2002-01-02 13:52:26 +0000 | [diff] [blame] | 2687 | #define unzip_trivial_usage \ |
| 2688 | "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]" |
| 2689 | #define unzip_full_usage \ |
Matt Kraai | 9758e7d | 2002-01-03 17:32:29 +0000 | [diff] [blame] | 2690 | "Extracts files from ZIP archives.\n\n" \ |
Glenn L McGrath | 87ac702 | 2002-01-02 13:52:26 +0000 | [diff] [blame] | 2691 | "Options:\n" \ |
| 2692 | "\t-l\tlist archive contents (short form)\n" \ |
| 2693 | "\t-n\tnever overwrite existing files (default)\n" \ |
| 2694 | "\t-o\toverwrite files without prompting\n" \ |
| 2695 | "\t-p\tsend output to stdout\n" \ |
| 2696 | "\t-q\tbe quiet\n" \ |
| 2697 | "\t-x\texclude these files\n" \ |
| 2698 | "\t-d\textract files into this directory" |
| 2699 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2700 | #define uptime_trivial_usage \ |
| 2701 | "" |
| 2702 | #define uptime_full_usage \ |
| 2703 | "Display the time since the last boot." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2704 | #define uptime_example_usage \ |
| 2705 | "$ uptime\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2706 | " 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] | 2707 | |
| 2708 | #define usleep_trivial_usage \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2709 | "N" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2710 | #define usleep_full_usage \ |
| 2711 | "Pause for N microseconds." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2712 | #define usleep_example_usage \ |
| 2713 | "$ usleep 1000000\n" \ |
| 2714 | "[pauses for 1 second]\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2715 | |
| 2716 | #define uudecode_trivial_usage \ |
| 2717 | "[FILE]..." |
| 2718 | #define uudecode_full_usage \ |
| 2719 | "Uudecode a file that is uuencoded.\n\n" \ |
| 2720 | "Options:\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2721 | "\t-o FILE\tdirect output to FILE" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2722 | #define uudecode_example_usage \ |
| 2723 | "$ uudecode -o busybox busybox.uu\n" \ |
| 2724 | "$ ls -l busybox\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2725 | "-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] | 2726 | |
| 2727 | #define uuencode_trivial_usage \ |
| 2728 | "[OPTION] [INFILE] REMOTEFILE" |
| 2729 | #define uuencode_full_usage \ |
| 2730 | "Uuencode a file.\n\n" \ |
| 2731 | "Options:\n" \ |
Eric Andersen | abec344 | 2001-05-21 17:58:01 +0000 | [diff] [blame] | 2732 | "\t-m\tuse base64 encoding per RFC1521" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2733 | #define uuencode_example_usage \ |
| 2734 | "$ uuencode busybox busybox\n" \ |
| 2735 | "begin 755 busybox\n" \ |
| 2736 | "<encoded file snipped>\n" \ |
| 2737 | "$ uudecode busybox busybox > busybox.uu\n" \ |
| 2738 | "$\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2739 | |
Eric Andersen | 853c494 | 2003-01-23 05:59:32 +0000 | [diff] [blame] | 2740 | #define vconfig_trivial_usage \ |
| 2741 | "COMMAND [OPTIONS] ..." |
Eric Andersen | 853c494 | 2003-01-23 05:59:32 +0000 | [diff] [blame] | 2742 | #define vconfig_full_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2743 | "vconfig lets you create and remove virtual ethernet devices.\n\n" \ |
| 2744 | "Options:\n" \ |
| 2745 | "\tadd [interface-name] [vlan_id]\n" \ |
| 2746 | "\trem [vlan-name]\n" \ |
| 2747 | "\tset_flag [interface-name] [flag-num] [0 | 1]\n" \ |
| 2748 | "\tset_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \ |
| 2749 | "\tset_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \ |
| 2750 | "\tset_name_type [name-type]" |
Eric Andersen | 853c494 | 2003-01-23 05:59:32 +0000 | [diff] [blame] | 2751 | |
Eric Andersen | 3f98040 | 2001-04-04 17:31:15 +0000 | [diff] [blame] | 2752 | #define vi_trivial_usage \ |
| 2753 | "[OPTION] [FILE]..." |
| 2754 | #define vi_full_usage \ |
| 2755 | "edit FILE.\n\n" \ |
| 2756 | "Options:\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2757 | "\t-R\tRead-only- do not write to the file." |
Eric Andersen | 3f98040 | 2001-04-04 17:31:15 +0000 | [diff] [blame] | 2758 | |
Eric Andersen | 27f64e1 | 2002-06-23 04:24:25 +0000 | [diff] [blame] | 2759 | #define vlock_trivial_usage \ |
| 2760 | "[OPTIONS]" |
| 2761 | #define vlock_full_usage \ |
| 2762 | "Lock a virtual terminal. A password is required to unlock\n" \ |
| 2763 | "Options:\n" \ |
| 2764 | "\t-a\tLock all VTs" |
| 2765 | |
Glenn L McGrath | 18b76e6 | 2002-09-16 09:10:04 +0000 | [diff] [blame] | 2766 | #define watch_trivial_usage \ |
| 2767 | "[-n <seconds>] COMMAND..." |
| 2768 | #define watch_full_usage \ |
| 2769 | "Executes a program periodically.\n" \ |
| 2770 | "Options:\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2771 | "\t-n\tLoop period in seconds - default is 2." |
Glenn L McGrath | 18b76e6 | 2002-09-16 09:10:04 +0000 | [diff] [blame] | 2772 | #define watch_example_usage \ |
| 2773 | "$ watch date\n" \ |
| 2774 | "Mon Dec 17 10:31:40 GMT 2000\n" \ |
| 2775 | "Mon Dec 17 10:31:42 GMT 2000\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2776 | "Mon Dec 17 10:31:44 GMT 2000" |
Glenn L McGrath | 18b76e6 | 2002-09-16 09:10:04 +0000 | [diff] [blame] | 2777 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2778 | #define watchdog_trivial_usage \ |
Eric Andersen | cde8f53 | 2003-07-22 07:39:18 +0000 | [diff] [blame] | 2779 | "[-t <seconds>] DEV" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2780 | #define watchdog_full_usage \ |
Eric Andersen | cde8f53 | 2003-07-22 07:39:18 +0000 | [diff] [blame] | 2781 | "Periodically write to watchdog device DEV.\n" \ |
| 2782 | "Options:\n" \ |
| 2783 | "\t-t\tTimer period in seconds - default is 30." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2784 | |
| 2785 | #define wc_trivial_usage \ |
| 2786 | "[OPTION]... [FILE]..." |
| 2787 | #define wc_full_usage \ |
| 2788 | "Print line, word, and byte counts for each FILE, and a total line if\n" \ |
| 2789 | "more than one FILE is specified. With no FILE, read standard input.\n\n" \ |
| 2790 | "Options:\n" \ |
| 2791 | "\t-c\tprint the byte counts\n" \ |
| 2792 | "\t-l\tprint the newline counts\n" \ |
| 2793 | "\t-L\tprint the length of the longest line\n" \ |
| 2794 | "\t-w\tprint the word counts" |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2795 | #define wc_example_usage \ |
| 2796 | "$ wc /etc/passwd\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2797 | " 31 46 1365 /etc/passwd\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2798 | |
| 2799 | #define wget_trivial_usage \ |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2800 | "[-c|--continue] [-q|--quiet] [-O|--output-document file]\n" \ |
| 2801 | "\t[--header 'header: value'] [-Y|--proxy on/off] [-P DIR] url" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2802 | #define wget_full_usage \ |
Eric Andersen | 79757c9 | 2001-04-05 21:45:54 +0000 | [diff] [blame] | 2803 | "wget retrieves files via HTTP or FTP\n\n" \ |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2804 | "Options:\n" \ |
| 2805 | "\t-c\tcontinue retrieval of aborted transfers\n" \ |
Eric Andersen | 79757c9 | 2001-04-05 21:45:54 +0000 | [diff] [blame] | 2806 | "\t-q\tquiet mode - do not print\n" \ |
Eric Andersen | 8071c02 | 2001-06-21 19:45:06 +0000 | [diff] [blame] | 2807 | "\t-P\tSet directory prefix to DIR\n" \ |
Robert Griebl | d776011 | 2002-05-14 23:36:45 +0000 | [diff] [blame] | 2808 | "\t-O\tsave to filename ('-' for stdout)\n" \ |
| 2809 | "\t-Y\tuse proxy ('on' or 'off')" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2810 | |
| 2811 | #define which_trivial_usage \ |
| 2812 | "[COMMAND ...]" |
| 2813 | #define which_full_usage \ |
| 2814 | "Locates a COMMAND." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2815 | #define which_example_usage \ |
| 2816 | "$ which login\n" \ |
| 2817 | "/bin/login\n" |
Glenn L McGrath | 8f0722a | 2002-11-11 03:00:12 +0000 | [diff] [blame] | 2818 | |
Eric Andersen | 00a6a75 | 2002-04-26 23:53:10 +0000 | [diff] [blame] | 2819 | #define who_trivial_usage \ |
| 2820 | " " |
| 2821 | #define who_full_usage \ |
| 2822 | "Prints the current user names and related information" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2823 | |
| 2824 | #define whoami_trivial_usage \ |
| 2825 | "" |
| 2826 | #define whoami_full_usage \ |
| 2827 | "Prints the user name associated with the current effective user id." |
| 2828 | |
Glenn L McGrath | d12061b | 2003-10-10 23:15:23 +0000 | [diff] [blame] | 2829 | #ifdef CONFIG_FEATURE_XARGS_SUPPORT_CONFIRMATION |
| 2830 | #define USAGE_XARGS_CONFIRMATION(a) a |
| 2831 | #else |
| 2832 | #define USAGE_XARGS_CONFIRMATION(a) |
| 2833 | #endif |
| 2834 | #ifdef CONFIG_FEATURE_XARGS_SUPPORT_TERMOPT |
| 2835 | #define USAGE_XARGS_TERMOPT(a) a |
| 2836 | #else |
| 2837 | #define USAGE_XARGS_TERMOPT(a) |
| 2838 | #endif |
| 2839 | #ifdef CONFIG_FEATURE_XARGS_SUPPORT_ZERO_TERM |
| 2840 | #define USAGE_XARGS_ZERO_TERM(a) a |
| 2841 | #else |
| 2842 | #define USAGE_XARGS_ZERO_TERM(a) |
| 2843 | #endif |
| 2844 | |
| 2845 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2846 | #define xargs_trivial_usage \ |
Glenn L McGrath | d12061b | 2003-10-10 23:15:23 +0000 | [diff] [blame] | 2847 | "[COMMAND] [OPTIONS] [ARGS...]" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2848 | #define xargs_full_usage \ |
Glenn L McGrath | f57674e | 2002-11-10 21:47:17 +0000 | [diff] [blame] | 2849 | "Executes COMMAND on every item given by standard input.\n\n" \ |
| 2850 | "Options:\n" \ |
Glenn L McGrath | d12061b | 2003-10-10 23:15:23 +0000 | [diff] [blame] | 2851 | 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] | 2852 | "\t-r\tDo not run command for empty readed lines\n" \ |
Glenn L McGrath | d12061b | 2003-10-10 23:15:23 +0000 | [diff] [blame] | 2853 | USAGE_XARGS_TERMOPT("\t-x\tExit if the size is exceeded\n") \ |
| 2854 | USAGE_XARGS_ZERO_TERM("\t-0\tInput filenames are terminated by a null character\n") \ |
Glenn L McGrath | f57674e | 2002-11-10 21:47:17 +0000 | [diff] [blame] | 2855 | "\t-t\tPrint the command line on stderr before executing it." |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2856 | #define xargs_example_usage \ |
| 2857 | "$ ls | xargs gzip\n" \ |
Tim Riker | 7b253f8 | 2003-12-28 05:02:40 +0000 | [diff] [blame] | 2858 | "$ find . -name '*.c' -print | xargs rm\n" |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2859 | |
| 2860 | #define yes_trivial_usage \ |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2861 | "[OPTION]... [STRING]..." |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2862 | #define yes_full_usage \ |
Eric Andersen | 0d3a02e | 2001-03-15 18:14:25 +0000 | [diff] [blame] | 2863 | "Repeatedly outputs a line with all specified STRING(s), or 'y'." |
Eric Andersen | 3ec8ffb | 2001-02-14 21:46:30 +0000 | [diff] [blame] | 2864 | |
Eric Andersen | 7e9276b | 2001-02-22 01:15:47 +0000 | [diff] [blame] | 2865 | #define zcat_trivial_usage \ |
| 2866 | "FILE" |
| 2867 | #define zcat_full_usage \ |
| 2868 | "Uncompress to stdout." |
Eric Andersen | 178de17 | 2004-04-06 16:36:20 +0000 | [diff] [blame^] | 2869 | |
| 2870 | #endif /* __BB_USAGE_H__ */ |