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