aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorPere Orga <gotrunks@gmail.com>2011-04-11 03:29:49 +0200
committerDenys Vlasenko <vda.linux@googlemail.com>2011-04-11 03:29:49 +0200
commit5bc8c005a8e15c43285bc595a8d404de67a482ac (patch)
tree98f2d35d1db26f4d8cba5f095ff63bf8e2e8d980 /include
parent73ef15cf3894716c1393ed21dee6e6bb2cdbc90f (diff)
downloadbusybox-w32-5bc8c005a8e15c43285bc595a8d404de67a482ac.tar.gz
busybox-w32-5bc8c005a8e15c43285bc595a8d404de67a482ac.tar.bz2
busybox-w32-5bc8c005a8e15c43285bc595a8d404de67a482ac.zip
move remaining help text from include/usage.src.h
Signed-off-by: Pere Orga <gotrunks@gmail.com> Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
Diffstat (limited to 'include')
-rw-r--r--include/usage.src.h2311
1 files changed, 0 insertions, 2311 deletions
diff --git a/include/usage.src.h b/include/usage.src.h
index 2c88c46a1..78beccf4d 100644
--- a/include/usage.src.h
+++ b/include/usage.src.h
@@ -12,2322 +12,11 @@
12#ifndef BB_USAGE_H 12#ifndef BB_USAGE_H
13#define BB_USAGE_H 1 13#define BB_USAGE_H 1
14 14
15
16#define NOUSAGE_STR "\b" 15#define NOUSAGE_STR "\b"
17 16
18INSERT 17INSERT
19 18
20#define acpid_trivial_usage \
21 "[-d] [-c CONFDIR] [-l LOGFILE] [-a ACTIONFILE] [-M MAPFILE] [-e PROC_EVENT_FILE] [-p PIDFILE]"
22#define acpid_full_usage "\n\n" \
23 "Listen to ACPI events and spawn specific helpers on event arrival\n" \
24 "\nOptions:" \
25 "\n -c DIR Config directory [/etc/acpi]" \
26 "\n -d Don't daemonize, (implies -f)" \
27 "\n -e FILE /proc event file [/proc/acpi/event]" \
28 "\n -f Run in foreground" \
29 "\n -l FILE Log file [/var/log/acpid.log]" \
30 "\n -p FILE Pid file [/var/run/acpid.pid]" \
31 "\n -a FILE Action file [/etc/acpid.conf]" \
32 "\n -M FILE Map file [/etc/acpi.map]" \
33 IF_FEATURE_ACPID_COMPAT( \
34 "\n\nAccept and ignore compatibility options -g -m -s -S -v" \
35 )
36
37#define acpid_example_usage \
38 "Without -e option, acpid uses all /dev/input/event* files\n" \
39 "# acpid\n" \
40 "# acpid -l /var/log/my-acpi-log\n" \
41 "# acpid -e /proc/acpi/event\n"
42
43#define adjtimex_trivial_usage \
44 "[-q] [-o OFF] [-f FREQ] [-p TCONST] [-t TICK]"
45#define adjtimex_full_usage "\n\n" \
46 "Read and optionally set system timebase parameters. See adjtimex(2)\n" \
47 "\nOptions:" \
48 "\n -q Quiet" \
49 "\n -o OFF Time offset, microseconds" \
50 "\n -f FREQ Frequency adjust, integer kernel units (65536 is 1ppm)" \
51 "\n (positive values make clock run faster)" \
52 "\n -t TICK Microseconds per tick, usually 10000" \
53 "\n -p TCONST" \
54
55#define arp_trivial_usage \
56 "\n[-vn] [-H HWTYPE] [-i IF] -a [HOSTNAME]" \
57 "\n[-v] [-i IF] -d HOSTNAME [pub]" \
58 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [temp]" \
59 "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [netmask MASK] pub" \
60 "\n[-v] [-H HWTYPE] [-i IF] -Ds HOSTNAME IFACE [netmask MASK] pub"
61#define arp_full_usage "\n\n" \
62 "Manipulate ARP cache\n" \
63 "\nOptions:" \
64 "\n -a Display (all) hosts" \
65 "\n -s Set new ARP entry" \
66 "\n -d Delete a specified entry" \
67 "\n -v Verbose" \
68 "\n -n Don't resolve names" \
69 "\n -i IF Network interface" \
70 "\n -D Read <hwaddr> from given device" \
71 "\n -A,-p AF Protocol family" \
72 "\n -H HWTYPE Hardware address type" \
73
74#define arping_trivial_usage \
75 "[-fqbDUA] [-c CNT] [-w TIMEOUT] [-I IFACE] [-s SRC_IP] DST_IP"
76#define arping_full_usage "\n\n" \
77 "Send ARP requests/replies\n" \
78 "\nOptions:" \
79 "\n -f Quit on first ARP reply" \
80 "\n -q Quiet" \
81 "\n -b Keep broadcasting, don't go unicast" \
82 "\n -D Duplicated address detection mode" \
83 "\n -U Unsolicited ARP mode, update your neighbors" \
84 "\n -A ARP answer mode, update your neighbors" \
85 "\n -c N Stop after sending N ARP requests" \
86 "\n -w TIMEOUT Time to wait for ARP reply, seconds" \
87 "\n -I IFACE Interface to use (default eth0)" \
88 "\n -s SRC_IP Sender IP address" \
89 "\n DST_IP Target IP address" \
90
91#define beep_trivial_usage \
92 "-f FREQ -l LEN -d DELAY -r COUNT -n"
93#define beep_full_usage "\n\n" \
94 "Options:" \
95 "\n -f Frequency in Hz" \
96 "\n -l Length in ms" \
97 "\n -d Delay in ms" \
98 "\n -r Repetitions" \
99 "\n -n Start new tone" \
100
101#define blkid_trivial_usage \
102 ""
103#define blkid_full_usage "\n\n" \
104 "Print UUIDs of all filesystems"
105
106#define brctl_trivial_usage \
107 "COMMAND [BRIDGE [INTERFACE]]"
108#define brctl_full_usage "\n\n" \
109 "Manage ethernet bridges\n" \
110 "\nCommands:" \
111 IF_FEATURE_BRCTL_SHOW( \
112 "\n show Show a list of bridges" \
113 ) \
114 "\n addbr BRIDGE Create BRIDGE" \
115 "\n delbr BRIDGE Delete BRIDGE" \
116 "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \
117 "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \
118 IF_FEATURE_BRCTL_FANCY( \
119 "\n setageing BRIDGE TIME Set ageing time" \
120 "\n setfd BRIDGE TIME Set bridge forward delay" \
121 "\n sethello BRIDGE TIME Set hello time" \
122 "\n setmaxage BRIDGE TIME Set max message age" \
123 "\n setpathcost BRIDGE COST Set path cost" \
124 "\n setportprio BRIDGE PRIO Set port priority" \
125 "\n setbridgeprio BRIDGE PRIO Set bridge priority" \
126 "\n stp BRIDGE [1/yes/on|0/no/off] STP on/off" \
127 ) \
128
129#define busybox_notes_usage \ 19#define busybox_notes_usage \
130 "Hello world!\n" 20 "Hello world!\n"
131 21
132#define chat_trivial_usage \
133 "EXPECT [SEND [EXPECT [SEND...]]]"
134#define chat_full_usage "\n\n" \
135 "Useful for interacting with a modem connected to stdin/stdout.\n" \
136 "A script consists of one or more \"expect-send\" pairs of strings,\n" \
137 "each pair is a pair of arguments. Example:\n" \
138 "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \
139
140#define chcon_trivial_usage \
141 "[OPTIONS] CONTEXT FILE..." \
142 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
143 IF_FEATURE_CHCON_LONG_OPTIONS( \
144 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
145 )
146#define chcon_full_usage "\n\n" \
147 "Change the security context of each FILE to CONTEXT\n" \
148 IF_FEATURE_CHCON_LONG_OPTIONS( \
149 "\n -v,--verbose Verbose" \
150 "\n -c,--changes Report changes made" \
151 "\n -h,--no-dereference Affect symlinks instead of their targets" \
152 "\n -f,--silent,--quiet Suppress most error messages" \
153 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
154 "\n -u,--user=USER Set user/role/type/range in the target" \
155 "\n -r,--role=ROLE security context" \
156 "\n -t,--type=TYPE" \
157 "\n -l,--range=RANGE" \
158 "\n -R,--recursive Recurse" \
159 ) \
160 IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \
161 "\n -v Verbose" \
162 "\n -c Report changes made" \
163 "\n -h Affect symlinks instead of their targets" \
164 "\n -f Suppress most error messages" \
165 "\n -u USER Set user/role/type/range in the target security context" \
166 "\n -r ROLE" \
167 "\n -t TYPE" \
168 "\n -l RNG" \
169 "\n -R Recurse" \
170 )
171
172#define chpst_trivial_usage \
173 "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \
174 " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \
175 " [-p N] [-f BYTES] [-c BYTES] PROG ARGS"
176#define chpst_full_usage "\n\n" \
177 "Change the process state, run PROG\n" \
178 "\nOptions:" \
179 "\n -u USER[:GRP] Set uid and gid" \
180 "\n -U USER[:GRP] Set $UID and $GID in environment" \
181 "\n -e DIR Set environment variables as specified by files" \
182 "\n in DIR: file=1st_line_of_file" \
183 "\n -/ DIR Chroot to DIR" \
184 "\n -n NICE Add NICE to nice value" \
185 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \
186 "\n -d BYTES Limit data segment" \
187 "\n -o N Limit number of open files per process" \
188 "\n -p N Limit number of processes per uid" \
189 "\n -f BYTES Limit output file sizes" \
190 "\n -c BYTES Limit core file size" \
191 "\n -v Verbose" \
192 "\n -P Create new process group" \
193 "\n -0 Close stdin" \
194 "\n -1 Close stdout" \
195 "\n -2 Close stderr" \
196
197#define setuidgid_trivial_usage \
198 "USER PROG ARGS"
199#define setuidgid_full_usage "\n\n" \
200 "Set uid and gid to USER's uid and gid, drop supplementary group ids,\n" \
201 "run PROG"
202#define envuidgid_trivial_usage \
203 "USER PROG ARGS"
204#define envuidgid_full_usage "\n\n" \
205 "Set $UID to USER's uid and $GID to USER's gid, run PROG"
206#define envdir_trivial_usage \
207 "DIR PROG ARGS"
208#define envdir_full_usage "\n\n" \
209 "Set various environment variables as specified by files\n" \
210 "in the directory DIR, run PROG"
211#define softlimit_trivial_usage \
212 "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \
213 " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \
214 " PROG ARGS"
215#define softlimit_full_usage "\n\n" \
216 "Set soft resource limits, then run PROG\n" \
217 "\nOptions:" \
218 "\n -a BYTES Limit total size of all segments" \
219 "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \
220 "\n -d BYTES Limit data segment" \
221 "\n -s BYTES Limit stack segment" \
222 "\n -l BYTES Limit locked memory size" \
223 "\n -o N Limit number of open files per process" \
224 "\n -p N Limit number of processes per uid" \
225 "\nOptions controlling file sizes:" \
226 "\n -f BYTES Limit output file sizes" \
227 "\n -c BYTES Limit core file size" \
228 "\nEfficiency opts:" \
229 "\n -r BYTES Limit resident set size" \
230 "\n -t N Limit CPU time, process receives" \
231 "\n a SIGXCPU after N seconds" \
232
233#define bbconfig_trivial_usage \
234 ""
235#define bbconfig_full_usage "\n\n" \
236 "Print the config file used by busybox build"
237
238#define chrt_trivial_usage \
239 "[-prfom] [PRIO] [PID | PROG ARGS]"
240#define chrt_full_usage "\n\n" \
241 "Change scheduling priority and class for a process\n" \
242 "\nOptions:" \
243 "\n -p Operate on PID" \
244 "\n -r Set SCHED_RR class" \
245 "\n -f Set SCHED_FIFO class" \
246 "\n -o Set SCHED_OTHER class" \
247 "\n -m Show min/max priorities" \
248
249#define chrt_example_usage \
250 "$ chrt -r 4 sleep 900; x=$!\n" \
251 "$ chrt -f -p 3 $x\n" \
252 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
253
254#define renice_trivial_usage \
255 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
256#define renice_full_usage "\n\n" \
257 "Change scheduling priority for a running process\n" \
258 "\nOptions:" \
259 "\n -n Adjust current nice value (smaller is faster)" \
260 "\n -p Process id(s) (default)" \
261 "\n -g Process group id(s)" \
262 "\n -u Process user name(s) and/or id(s)" \
263
264#define ionice_trivial_usage \
265 "[-c 1-3] [-n 0-7] [-p PID] [PROG]"
266#define ionice_full_usage "\n\n" \
267 "Change I/O priority and class\n" \
268 "\nOptions:" \
269 "\n -c Class. 1:realtime 2:best-effort 3:idle" \
270 "\n -n Priority" \
271
272#define crond_trivial_usage \
273 "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR"
274#define crond_full_usage "\n\n" \
275 " -f Foreground" \
276 "\n -b Background (default)" \
277 "\n -S Log to syslog (default)" \
278 "\n -l Set log level. 0 is the most verbose, default 8" \
279 IF_FEATURE_CROND_D( \
280 "\n -d Set log level, log to stderr" \
281 ) \
282 "\n -L Log to file" \
283 "\n -c Working dir" \
284
285#define crontab_trivial_usage \
286 "[-c DIR] [-u USER] [-ler]|[FILE]"
287#define crontab_full_usage "\n\n" \
288 " -c Crontab directory" \
289 "\n -u User" \
290 "\n -l List crontab" \
291 "\n -e Edit crontab" \
292 "\n -r Delete crontab" \
293 "\n FILE Replace crontab by FILE ('-': stdin)" \
294
295#define devmem_trivial_usage \
296 "ADDRESS [WIDTH [VALUE]]"
297
298#define devmem_full_usage "\n\n" \
299 "Read/write from physical address\n" \
300 "\n ADDRESS Address to act upon" \
301 "\n WIDTH Width (8/16/...)" \
302 "\n VALUE Data to be written" \
303
304#define devfsd_trivial_usage \
305 "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]")
306#define devfsd_full_usage "\n\n" \
307 "Manage devfs permissions and old device name symlinks\n" \
308 "\nOptions:" \
309 "\n mntpnt The mount point where devfs is mounted" \
310 "\n -v Print the protocol version numbers for devfsd" \
311 "\n and the kernel-side protocol version and exit" \
312 IF_DEVFSD_FG_NP( \
313 "\n -fg Run in foreground" \
314 "\n -np Exit after parsing the configuration file" \
315 "\n and processing synthetic REGISTER events," \
316 "\n don't poll for events" \
317 )
318
319#define dhcprelay_trivial_usage \
320 "CLIENT_IFACE[,CLIENT_IFACE2]... SERVER_IFACE [SERVER_IP]"
321#define dhcprelay_full_usage "\n\n" \
322 "Relay DHCP requests between clients and server" \
323
324#define dmesg_trivial_usage \
325 "[-c] [-n LEVEL] [-s SIZE]"
326#define dmesg_full_usage "\n\n" \
327 "Print or control the kernel ring buffer\n" \
328 "\nOptions:" \
329 "\n -c Clear ring buffer after printing" \
330 "\n -n LEVEL Set console logging level" \
331 "\n -s SIZE Buffer size" \
332
333#define dnsd_trivial_usage \
334 "[-dvs] [-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR]"
335#define dnsd_full_usage "\n\n" \
336 "Small static DNS server daemon\n" \
337 "\nOptions:" \
338 "\n -c FILE Config file" \
339 "\n -t SEC TTL" \
340 "\n -p PORT Listen on PORT" \
341 "\n -i ADDR Listen on ADDR" \
342 "\n -d Daemonize" \
343 "\n -v Verbose" \
344 "\n -s Send successful replies only. Use this if you want" \
345 "\n to use /etc/resolv.conf with two nameserver lines:" \
346 "\n nameserver DNSD_SERVER" \
347 "\n nameserver NORNAL_DNS_SERVER" \
348
349#define dumpleases_trivial_usage \
350 "[-r|-a] [-f LEASEFILE]"
351#define dumpleases_full_usage "\n\n" \
352 "Display DHCP leases granted by udhcpd\n" \
353 "\nOptions:" \
354 IF_LONG_OPTS( \
355 "\n -f,--file=FILE Lease file" \
356 "\n -r,--remaining Show remaining time" \
357 "\n -a,--absolute Show expiration time" \
358 ) \
359 IF_NOT_LONG_OPTS( \
360 "\n -f FILE Lease file" \
361 "\n -r Show remaining time" \
362 "\n -a Show expiration time" \
363 )
364
365/*
366#define e2fsck_trivial_usage \
367 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
368 "[-I inode_buffer_blocks] [-P process_inode_size] " \
369 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
370 "[-E extended-options] device"
371#define e2fsck_full_usage "\n\n" \
372 "Check ext2/ext3 file system\n" \
373 "\nOptions:" \
374 "\n -p Automatic repair (no questions)" \
375 "\n -n Make no changes to the filesystem" \
376 "\n -y Assume 'yes' to all questions" \
377 "\n -c Check for bad blocks and add them to the badblock list" \
378 "\n -f Force checking even if filesystem is marked clean" \
379 "\n -v Verbose" \
380 "\n -b superblock Use alternative superblock" \
381 "\n -B blocksize Force blocksize when looking for superblock" \
382 "\n -j journal Set location of the external journal" \
383 "\n -l file Add to badblocks list" \
384 "\n -L file Set badblocks list" \
385*/
386
387#define eject_trivial_usage \
388 "[-t] [-T] [DEVICE]"
389#define eject_full_usage "\n\n" \
390 "Eject DEVICE or default /dev/cdrom\n" \
391 "\nOptions:" \
392 IF_FEATURE_EJECT_SCSI( \
393 "\n -s SCSI device" \
394 ) \
395 "\n -t Close tray" \
396 "\n -T Open/close tray (toggle)" \
397
398#define ether_wake_trivial_usage \
399 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
400#define ether_wake_full_usage "\n\n" \
401 "Send a magic packet to wake up sleeping machines.\n" \
402 "MAC must be a station address (00:11:22:33:44:55) or\n" \
403 "a hostname with a known 'ethers' entry.\n" \
404 "\nOptions:" \
405 "\n -b Send wake-up packet to the broadcast address" \
406 "\n -i iface Interface to use (default eth0)" \
407 "\n -p pass Append four or six byte password PW to the packet" \
408
409#define fakeidentd_trivial_usage \
410 "[-fiw] [-b ADDR] [STRING]"
411#define fakeidentd_full_usage "\n\n" \
412 "Provide fake ident (auth) service\n" \
413 "\nOptions:" \
414 "\n -f Run in foreground" \
415 "\n -i Inetd mode" \
416 "\n -w Inetd 'wait' mode" \
417 "\n -b ADDR Bind to specified address" \
418 "\n STRING Ident answer string (default: nobody)" \
419
420#define fbsplash_trivial_usage \
421 "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
422#define fbsplash_full_usage "\n\n" \
423 "Options:" \
424 "\n -s Image" \
425 "\n -c Hide cursor" \
426 "\n -d Framebuffer device (default /dev/fb0)" \
427 "\n -i Config file (var=value):" \
428 "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \
429 "\n BAR_R,BAR_G,BAR_B" \
430 "\n -f Control pipe (else exit after drawing image)" \
431 "\n commands: 'NN' (% for progress bar) or 'exit'" \
432
433#define fbset_trivial_usage \
434 "[OPTIONS] [MODE]"
435#define fbset_full_usage "\n\n" \
436 "Show and modify frame buffer settings"
437
438#define fbset_example_usage \
439 "$ fbset\n" \
440 "mode \"1024x768-76\"\n" \
441 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
442 " geometry 1024 768 1024 768 16\n" \
443 " timings 12714 128 32 16 4 128 4\n" \
444 " accel false\n" \
445 " rgba 5/11,6/5,5/0,0/0\n" \
446 "endmode\n"
447
448#define fdflush_trivial_usage \
449 "DEVICE"
450#define fdflush_full_usage "\n\n" \
451 "Force floppy disk drive to detect disk change"
452
453#define fdformat_trivial_usage \
454 "[-n] DEVICE"
455#define fdformat_full_usage "\n\n" \
456 "Format floppy disk\n" \
457 "\nOptions:" \
458 "\n -n Don't verify after format" \
459
460/* Looks like someone forgot to add this to config system */
461#ifndef ENABLE_FEATURE_FDISK_BLKSIZE
462# define ENABLE_FEATURE_FDISK_BLKSIZE 0
463# define IF_FEATURE_FDISK_BLKSIZE(a)
464#endif
465
466#define fdisk_trivial_usage \
467 "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \
468 "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
469#define fdisk_full_usage "\n\n" \
470 "Change partition table\n" \
471 "\nOptions:" \
472 "\n -u Start and End are in sectors (instead of cylinders)" \
473 "\n -l Show partition table for each DISK, then exit" \
474 IF_FEATURE_FDISK_BLKSIZE( \
475 "\n -s Show partition sizes in kb for each DISK, then exit" \
476 ) \
477 "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \
478 "\n -C CYLINDERS Set number of cylinders/heads/sectors" \
479 "\n -H HEADS" \
480 "\n -S SECTORS" \
481
482#define findfs_trivial_usage \
483 "LABEL=label or UUID=uuid"
484#define findfs_full_usage "\n\n" \
485 "Find a filesystem device based on a label or UUID"
486#define findfs_example_usage \
487 "$ findfs LABEL=MyDevice"
488
489#define flash_lock_trivial_usage \
490 "MTD_DEVICE OFFSET SECTORS"
491#define flash_lock_full_usage "\n\n" \
492 "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \
493 "will be locked, regardless of the value of OFFSET"
494
495#define flash_unlock_trivial_usage \
496 "MTD_DEVICE"
497#define flash_unlock_full_usage "\n\n" \
498 "Unlock an MTD device"
499
500#define flash_eraseall_trivial_usage \
501 "[-jq] MTD_DEVICE"
502#define flash_eraseall_full_usage "\n\n" \
503 "Erase an MTD device\n" \
504 "\nOptions:" \
505 "\n -j Format the device for jffs2" \
506 "\n -q Don't display progress messages" \
507
508#define flashcp_trivial_usage \
509 "-v FILE MTD_DEVICE"
510#define flashcp_full_usage "\n\n" \
511 "Copy an image to MTD device\n" \
512 "\nOptions:" \
513 "\n -v Verbose" \
514
515#define flock_trivial_usage \
516 "[-sxun] FD|{FILE [-c] PROG ARGS}"
517#define flock_full_usage "\n\n" \
518 "[Un]lock file descriptor, or lock FILE, run PROG\n" \
519 "\nOptions:" \
520 "\n -s Shared lock" \
521 "\n -x Exclusive lock (default)" \
522 "\n -u Unlock FD" \
523 "\n -n Fail rather than wait" \
524
525#define free_trivial_usage \
526 "" IF_DESKTOP("[-b/k/m/g]")
527#define free_full_usage "\n\n" \
528 "Display the amount of free and used system memory"
529#define free_example_usage \
530 "$ free\n" \
531 " total used free shared buffers\n" \
532 " Mem: 257628 248724 8904 59644 93124\n" \
533 " Swap: 128516 8404 120112\n" \
534 "Total: 386144 257128 129016\n" \
535
536#define freeramdisk_trivial_usage \
537 "DEVICE"
538#define freeramdisk_full_usage "\n\n" \
539 "Free all memory used by the specified ramdisk"
540#define freeramdisk_example_usage \
541 "$ freeramdisk /dev/ram2\n"
542
543#define fsck_minix_trivial_usage \
544 "[-larvsmf] BLOCKDEV"
545#define fsck_minix_full_usage "\n\n" \
546 "Check MINIX filesystem\n" \
547 "\nOptions:" \
548 "\n -l List all filenames" \
549 "\n -r Perform interactive repairs" \
550 "\n -a Perform automatic repairs" \
551 "\n -v Verbose" \
552 "\n -s Output superblock information" \
553 "\n -m Show \"mode not cleared\" warnings" \
554 "\n -f Force file system check" \
555
556#define ftpget_trivial_usage \
557 "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE"
558#define ftpget_full_usage "\n\n" \
559 "Retrieve a remote file via FTP\n" \
560 "\nOptions:" \
561 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
562 "\n -c,--continue Continue previous transfer" \
563 "\n -v,--verbose Verbose" \
564 "\n -u,--username Username" \
565 "\n -p,--password Password" \
566 "\n -P,--port Port number" \
567 ) \
568 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
569 "\n -c Continue previous transfer" \
570 "\n -v Verbose" \
571 "\n -u Username" \
572 "\n -p Password" \
573 "\n -P Port number" \
574 )
575
576#define ftpput_trivial_usage \
577 "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE"
578#define ftpput_full_usage "\n\n" \
579 "Store a local file on a remote machine via FTP\n" \
580 "\nOptions:" \
581 IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \
582 "\n -v,--verbose Verbose" \
583 "\n -u,--username Username" \
584 "\n -p,--password Password" \
585 "\n -P,--port Port number" \
586 ) \
587 IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \
588 "\n -v Verbose" \
589 "\n -u Username" \
590 "\n -p Password" \
591 "\n -P Port number" \
592 )
593
594#define fuser_trivial_usage \
595 "[OPTIONS] FILE or PORT/PROTO"
596#define fuser_full_usage "\n\n" \
597 "Find processes which use FILEs or PORTs\n" \
598 "\nOptions:" \
599 "\n -m Find processes which use same fs as FILEs" \
600 "\n -4,-6 Search only IPv4/IPv6 space" \
601 "\n -s Don't display PIDs" \
602 "\n -k Kill found processes" \
603 "\n -SIGNAL Signal to send (default: KILL)" \
604
605#define getenforce_trivial_usage NOUSAGE_STR
606#define getenforce_full_usage ""
607
608#define getopt_trivial_usage \
609 "[OPTIONS]"
610#define getopt_full_usage "\n\n" \
611 "Options:" \
612 IF_LONG_OPTS( \
613 "\n -a,--alternative Allow long options starting with single -" \
614 "\n -l,--longoptions=longopts Long options to be recognized" \
615 "\n -n,--name=progname The name under which errors are reported" \
616 "\n -o,--options=optstring Short options to be recognized" \
617 "\n -q,--quiet Disable error reporting by getopt(3)" \
618 "\n -Q,--quiet-output No normal output" \
619 "\n -s,--shell=shell Set shell quoting conventions" \
620 "\n -T,--test Test for getopt(1) version" \
621 "\n -u,--unquoted Don't quote the output" \
622 ) \
623 IF_NOT_LONG_OPTS( \
624 "\n -a Allow long options starting with single -" \
625 "\n -l longopts Long options to be recognized" \
626 "\n -n progname The name under which errors are reported" \
627 "\n -o optstring Short options to be recognized" \
628 "\n -q Disable error reporting by getopt(3)" \
629 "\n -Q No normal output" \
630 "\n -s shell Set shell quoting conventions" \
631 "\n -T Test for getopt(1) version" \
632 "\n -u Don't quote the output" \
633 )
634#define getopt_example_usage \
635 "$ cat getopt.test\n" \
636 "#!/bin/sh\n" \
637 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
638 " -n 'example.busybox' -- \"$@\"`\n" \
639 "if [ $? != 0 ]; then exit 1; fi\n" \
640 "eval set -- \"$GETOPT\"\n" \
641 "while true; do\n" \
642 " case $1 in\n" \
643 " -a|--a-long) echo \"Option a\"; shift;;\n" \
644 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
645 " -c|--c-long)\n" \
646 " case \"$2\" in\n" \
647 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
648 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
649 " esac;;\n" \
650 " --) shift; break;;\n" \
651 " *) echo \"Internal error!\"; exit 1;;\n" \
652 " esac\n" \
653 "done\n"
654
655#define getsebool_trivial_usage \
656 "-a or getsebool boolean..."
657#define getsebool_full_usage "\n\n" \
658 " -a Show all selinux booleans"
659
660#define hdparm_trivial_usage \
661 "[OPTIONS] [DEVICE]"
662#define hdparm_full_usage "\n\n" \
663 "Options:" \
664 "\n -a Get/set fs readahead" \
665 "\n -A Set drive read-lookahead flag (0/1)" \
666 "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \
667 "\n -B Set Advanced Power Management setting (1-255)" \
668 "\n -c Get/set IDE 32-bit IO setting" \
669 "\n -C Check IDE power mode status" \
670 IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \
671 "\n -d Get/set using_dma flag") \
672 "\n -D Enable/disable drive defect-mgmt" \
673 "\n -f Flush buffer cache for device on exit" \
674 "\n -g Display drive geometry" \
675 "\n -h Display terse usage information" \
676 IF_FEATURE_HDPARM_GET_IDENTITY( \
677 "\n -i Display drive identification") \
678 IF_FEATURE_HDPARM_GET_IDENTITY( \
679 "\n -I Detailed/current information directly from drive") \
680 "\n -k Get/set keep_settings_over_reset flag (0/1)" \
681 "\n -K Set drive keep_features_over_reset flag (0/1)" \
682 "\n -L Set drive doorlock (0/1) (removable harddisks only)" \
683 "\n -m Get/set multiple sector count" \
684 "\n -n Get/set ignore-write-errors flag (0/1)" \
685 "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \
686 "\n -P Set drive prefetch count" \
687/* "\n -q Change next setting quietly" - not supported ib bbox */ \
688 "\n -Q Get/set DMA tagged-queuing depth (if supported)" \
689 "\n -r Get/set readonly flag (DANGEROUS to set)" \
690 IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
691 "\n -R Register an IDE interface (DANGEROUS)") \
692 "\n -S Set standby (spindown) timeout" \
693 "\n -t Perform device read timings" \
694 "\n -T Perform cache read timings" \
695 "\n -u Get/set unmaskirq flag (0/1)" \
696 IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
697 "\n -U Unregister an IDE interface (DANGEROUS)") \
698 "\n -v Defaults; same as -mcudkrag for IDE drives" \
699 "\n -V Display program version and exit immediately" \
700 IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
701 "\n -w Perform device reset (DANGEROUS)") \
702 "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \
703 IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
704 "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \
705 "\n -X Set IDE xfer mode (DANGEROUS)" \
706 "\n -y Put IDE drive in standby mode" \
707 "\n -Y Put IDE drive to sleep" \
708 "\n -Z Disable Seagate auto-powersaving mode" \
709 "\n -z Reread partition table" \
710
711#define hexdump_trivial_usage \
712 "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..."
713#define hexdump_full_usage "\n\n" \
714 "Display FILEs (or stdin) in a user specified format\n" \
715 "\nOptions:" \
716 "\n -b One-byte octal display" \
717 "\n -c One-byte character display" \
718 "\n -C Canonical hex+ASCII, 16 bytes per line" \
719 "\n -d Two-byte decimal display" \
720 "\n -e FORMAT_STRING" \
721 "\n -f FORMAT_FILE" \
722 "\n -n LENGTH Interpret only LENGTH bytes of input" \
723 "\n -o Two-byte octal display" \
724 "\n -s OFFSET Skip OFFSET bytes" \
725 "\n -v Display all input data" \
726 "\n -x Two-byte hexadecimal display" \
727 IF_FEATURE_HEXDUMP_REVERSE( \
728 "\n -R Reverse of 'hexdump -Cv'") \
729
730#define hd_trivial_usage \
731 "FILE..."
732#define hd_full_usage "\n\n" \
733 "hd is an alias for hexdump -C"
734
735#define hostname_trivial_usage \
736 "[OPTIONS] [HOSTNAME | -F FILE]"
737#define hostname_full_usage "\n\n" \
738 "Get or set hostname or DNS domain name\n" \
739 "\nOptions:" \
740 "\n -s Short" \
741 "\n -i Addresses for the hostname" \
742 "\n -d DNS domain name" \
743 "\n -f Fully qualified domain name" \
744 "\n -F FILE Use FILE's content as hostname" \
745
746#define hostname_example_usage \
747 "$ hostname\n" \
748 "sage\n"
749
750#define dnsdomainname_trivial_usage NOUSAGE_STR
751#define dnsdomainname_full_usage ""
752
753#define httpd_trivial_usage \
754 "[-ifv[v]]" \
755 " [-c CONFFILE]" \
756 " [-p [IP:]PORT]" \
757 IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \
758 IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \
759 " [-h HOME]\n" \
760 "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING"
761#define httpd_full_usage "\n\n" \
762 "Listen for incoming HTTP requests\n" \
763 "\nOptions:" \
764 "\n -i Inetd mode" \
765 "\n -f Don't daemonize" \
766 "\n -v[v] Verbose" \
767 "\n -p [IP:]PORT Bind to IP:PORT (default *:80)" \
768 IF_FEATURE_HTTPD_SETUID( \
769 "\n -u USER[:GRP] Set uid/gid after binding to port") \
770 IF_FEATURE_HTTPD_BASIC_AUTH( \
771 "\n -r REALM Authentication Realm for Basic Authentication") \
772 "\n -h HOME Home directory (default .)" \
773 "\n -c FILE Configuration file (default {/etc,HOME}/httpd.conf)" \
774 IF_FEATURE_HTTPD_AUTH_MD5( \
775 "\n -m STRING MD5 crypt STRING") \
776 "\n -e STRING HTML encode STRING" \
777 "\n -d STRING URL decode STRING" \
778
779#define ifconfig_trivial_usage \
780 IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
781#define ifconfig_full_usage "\n\n" \
782 "Configure a network interface\n" \
783 "\nOptions:" \
784 "\n" \
785 IF_FEATURE_IPV6( \
786 " [add ADDRESS[/PREFIXLEN]]\n") \
787 IF_FEATURE_IPV6( \
788 " [del ADDRESS[/PREFIXLEN]]\n") \
789 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
790 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
791 IF_FEATURE_IFCONFIG_SLIP( \
792 " [outfill NN] [keepalive NN]\n") \
793 " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \
794 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
795 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
796 IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
797 " [mem_start NN] [io_addr NN] [irq NN]\n") \
798 " [up|down] ..."
799
800#define ifenslave_trivial_usage \
801 "[-cdf] MASTER_IFACE SLAVE_IFACE..."
802#define ifenslave_full_usage "\n\n" \
803 "Configure network interfaces for parallel routing\n" \
804 "\nOptions:" \
805 "\n -c,--change-active Change active slave" \
806 "\n -d,--detach Remove slave interface from bonding device" \
807 "\n -f,--force Force, even if interface is not Ethernet" \
808/* "\n -r,--receive-slave Create a receive-only slave" */
809
810#define ifenslave_example_usage \
811 "To create a bond device, simply follow these three steps:\n" \
812 "- ensure that the required drivers are properly loaded:\n" \
813 " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \
814 "- assign an IP address to the bond device:\n" \
815 " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \
816 "- attach all the interfaces you need to the bond device:\n" \
817 " # ifenslave bond0 eth0 eth1 eth2\n" \
818 " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \
819 " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \
820 " To detach a dead interface without setting the bond device down:\n" \
821 " # ifenslave -d bond0 eth1\n\n" \
822 " To set the bond device down and automatically release all the slaves:\n" \
823 " # ifconfig bond0 down\n\n" \
824 " To change active slave:\n" \
825 " # ifenslave -c bond0 eth0\n" \
826
827#define ifplugd_trivial_usage \
828 "[OPTIONS]"
829#define ifplugd_full_usage "\n\n" \
830 "Network interface plug detection daemon\n" \
831 "\nOptions:" \
832 "\n -n Don't daemonize" \
833 "\n -s Don't log to syslog" \
834 "\n -i IFACE Interface" \
835 "\n -f/-F Treat link detection error as link down/link up" \
836 "\n (otherwise exit on error)" \
837 "\n -a Don't up interface at each link probe" \
838 "\n -M Monitor creation/destruction of interface" \
839 "\n (otherwise it must exist)" \
840 "\n -r PROG Script to run" \
841 "\n -x ARG Extra argument for script" \
842 "\n -I Don't exit on nonzero exit code from script" \
843 "\n -p Don't run script on daemon startup" \
844 "\n -q Don't run script on daemon quit" \
845 "\n -l Run script on startup even if no cable is detected" \
846 "\n -t SECS Poll time in seconds" \
847 "\n -u SECS Delay before running script after link up" \
848 "\n -d SECS Delay after link down" \
849 "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \
850 "\n -k Kill running daemon" \
851
852#define ifup_trivial_usage \
853 "[-an"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] [-i FILE] IFACE..."
854#define ifup_full_usage "\n\n" \
855 "Options:" \
856 "\n -a De/configure all interfaces automatically" \
857 "\n -i FILE Use FILE for interface definitions" \
858 "\n -n Print out what would happen, but don't do it" \
859 IF_FEATURE_IFUPDOWN_MAPPING( \
860 "\n (note: doesn't disable mappings)" \
861 "\n -m Don't run any mappings" \
862 ) \
863 "\n -v Print out what would happen before doing it" \
864 "\n -f Force de/configuration" \
865
866#define ifdown_trivial_usage \
867 "[-an"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] [-i FILE] IFACE..."
868#define ifdown_full_usage "\n\n" \
869 "Options:" \
870 "\n -a De/configure all interfaces automatically" \
871 "\n -i FILE Use FILE for interface definitions" \
872 "\n -n Print out what would happen, but don't do it" \
873 IF_FEATURE_IFUPDOWN_MAPPING( \
874 "\n (note: doesn't disable mappings)" \
875 "\n -m Don't run any mappings" \
876 ) \
877 "\n -v Print out what would happen before doing it" \
878 "\n -f Force de/configuration" \
879
880#define inetd_trivial_usage \
881 "[-fe] [-q N] [-R N] [CONFFILE]"
882#define inetd_full_usage "\n\n" \
883 "Listen for network connections and launch programs\n" \
884 "\nOptions:" \
885 "\n -f Run in foreground" \
886 "\n -e Log to stderr" \
887 "\n -q N Socket listen queue (default: 128)" \
888 "\n -R N Pause services after N connects/min" \
889 "\n (default: 0 - disabled)" \
890
891#define inotifyd_trivial_usage \
892 "PROG FILE1[:MASK]..."
893#define inotifyd_full_usage "\n\n" \
894 "Run PROG on filesystem changes." \
895 "\nWhen a filesystem event matching MASK occurs on FILEn," \
896 "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." \
897 "\nEvents:" \
898 "\n a File is accessed" \
899 "\n c File is modified" \
900 "\n e Metadata changed" \
901 "\n w Writable file is closed" \
902 "\n 0 Unwritable file is closed" \
903 "\n r File is opened" \
904 "\n D File is deleted" \
905 "\n M File is moved" \
906 "\n u Backing fs is unmounted" \
907 "\n o Event queue overflowed" \
908 "\n x File can't be watched anymore" \
909 "\nIf watching a directory:" \
910 "\n m Subfile is moved into dir" \
911 "\n y Subfile is moved out of dir" \
912 "\n n Subfile is created" \
913 "\n d Subfile is deleted" \
914 "\n" \
915 "\ninotifyd waits for PROG to exit." \
916 "\nWhen x event happens for all FILEs, inotifyd exits." \
917
918/* would need to make the " | " optional depending on more than one selected: */
919#define ip_trivial_usage \
920 "[OPTIONS] {" \
921 IF_FEATURE_IP_ADDRESS("address | ") \
922 IF_FEATURE_IP_ROUTE("route | ") \
923 IF_FEATURE_IP_LINK("link | ") \
924 IF_FEATURE_IP_TUNNEL("tunnel | ") \
925 IF_FEATURE_IP_RULE("rule") \
926 "} {COMMAND}"
927#define ip_full_usage "\n\n" \
928 "ip [OPTIONS] OBJECT {COMMAND}\n" \
929 "where OBJECT := {" \
930 IF_FEATURE_IP_ADDRESS("address | ") \
931 IF_FEATURE_IP_ROUTE("route | ") \
932 IF_FEATURE_IP_LINK("link | ") \
933 IF_FEATURE_IP_TUNNEL("tunnel | ") \
934 IF_FEATURE_IP_RULE("rule") \
935 "}\n" \
936 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \
937
938#define ipaddr_trivial_usage \
939 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
940 " [dev STRING] [to PREFIX] }"
941#define ipaddr_full_usage "\n\n" \
942 "ipaddr {add|delete} IFADDR dev STRING\n" \
943 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
944 " [to PREFIX] [label PATTERN]\n" \
945 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
946 " [broadcast ADDR] [anycast ADDR]\n" \
947 " [label STRING] [scope SCOPE-ID]\n" \
948 " SCOPE-ID := [host | link | global | NUMBER]" \
949
950#define ipcalc_trivial_usage \
951 "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]"
952#define ipcalc_full_usage "\n\n" \
953 "Calculate IP network settings from a IP address\n" \
954 "\nOptions:" \
955 IF_FEATURE_IPCALC_LONG_OPTIONS( \
956 "\n -b,--broadcast Display calculated broadcast address" \
957 "\n -n,--network Display calculated network address" \
958 "\n -m,--netmask Display default netmask for IP" \
959 IF_FEATURE_IPCALC_FANCY( \
960 "\n -p,--prefix Display the prefix for IP/NETMASK" \
961 "\n -h,--hostname Display first resolved host name" \
962 "\n -s,--silent Don't ever display error messages" \
963 ) \
964 ) \
965 IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \
966 "\n -b Display calculated broadcast address" \
967 "\n -n Display calculated network address" \
968 "\n -m Display default netmask for IP" \
969 IF_FEATURE_IPCALC_FANCY( \
970 "\n -p Display the prefix for IP/NETMASK" \
971 "\n -h Display first resolved host name" \
972 "\n -s Don't ever display error messages" \
973 ) \
974 )
975
976#define ipcrm_trivial_usage \
977 "[-MQS key] [-mqs id]"
978#define ipcrm_full_usage "\n\n" \
979 "Upper-case options MQS remove an object by shmkey value.\n" \
980 "Lower-case options remove an object by shmid value.\n" \
981 "\nOptions:" \
982 "\n -mM Remove memory segment after last detach" \
983 "\n -qQ Remove message queue" \
984 "\n -sS Remove semaphore" \
985
986#define ipcs_trivial_usage \
987 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
988#define ipcs_full_usage "\n\n" \
989 " -i Show specific resource" \
990 "\nResource specification:" \
991 "\n -m Shared memory segments" \
992 "\n -q Message queues" \
993 "\n -s Semaphore arrays" \
994 "\n -a All (default)" \
995 "\nOutput format:" \
996 "\n -t Time" \
997 "\n -c Creator" \
998 "\n -p Pid" \
999 "\n -l Limits" \
1000 "\n -u Summary" \
1001
1002#define iplink_trivial_usage \
1003 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
1004#define iplink_full_usage "\n\n" \
1005 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
1006 " dynamic { on | off } |\n" \
1007 " mtu MTU }\n" \
1008 "iplink show [DEVICE]" \
1009
1010#define iproute_trivial_usage \
1011 "{ list | flush | { add | del | change | append |\n" \
1012 " replace | monitor } ROUTE }"
1013#define iproute_full_usage "\n\n" \
1014 "iproute { list | flush } SELECTOR\n" \
1015 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1016 " [oif STRING] [tos TOS]\n" \
1017 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1018 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
1019 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \
1020 " [metric METRIC]" \
1021
1022#define iprule_trivial_usage \
1023 "{[list | add | del] RULE}"
1024#define iprule_full_usage "\n\n" \
1025 "iprule [list | add | del] SELECTOR ACTION\n" \
1026 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1027 " [dev STRING] [pref NUMBER]\n" \
1028 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1029 " [prohibit | reject | unreachable]\n" \
1030 " [realms [SRCREALM/]DSTREALM]\n" \
1031 " TABLE_ID := [local | main | default | NUMBER]" \
1032
1033#define iptunnel_trivial_usage \
1034 "{ add | change | del | show } [NAME]\n" \
1035 " [mode { ipip | gre | sit }]\n" \
1036 " [remote ADDR] [local ADDR] [ttl TTL]"
1037#define iptunnel_full_usage "\n\n" \
1038 "iptunnel { add | change | del | show } [NAME]\n" \
1039 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1040 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
1041 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
1042
1043#define kill_trivial_usage \
1044 "[-l] [-SIG] PID..."
1045#define kill_full_usage "\n\n" \
1046 "Send a signal (default: TERM) to given PIDs\n" \
1047 "\nOptions:" \
1048 "\n -l List all signal names and numbers" \
1049/* "\n -s SIG Yet another way of specifying SIG" */ \
1050
1051#define kill_example_usage \
1052 "$ ps | grep apache\n" \
1053 "252 root root S [apache]\n" \
1054 "263 www-data www-data S [apache]\n" \
1055 "264 www-data www-data S [apache]\n" \
1056 "265 www-data www-data S [apache]\n" \
1057 "266 www-data www-data S [apache]\n" \
1058 "267 www-data www-data S [apache]\n" \
1059 "$ kill 252\n"
1060
1061#define killall_trivial_usage \
1062 "[-l] [-q] [-SIG] PROCESS_NAME..."
1063#define killall_full_usage "\n\n" \
1064 "Send a signal (default: TERM) to given processes\n" \
1065 "\nOptions:" \
1066 "\n -l List all signal names and numbers" \
1067/* "\n -s SIG Yet another way of specifying SIG" */ \
1068 "\n -q Don't complain if no processes were killed" \
1069
1070#define killall_example_usage \
1071 "$ killall apache\n"
1072
1073#define killall5_trivial_usage \
1074 "[-l] [-SIG] [-o PID]..."
1075#define killall5_full_usage "\n\n" \
1076 "Send a signal (default: TERM) to all processes outside current session\n" \
1077 "\nOptions:" \
1078 "\n -l List all signal names and numbers" \
1079 "\n -o PID Don't signal this PID" \
1080/* "\n -s SIG Yet another way of specifying SIG" */ \
1081
1082#define klogd_trivial_usage \
1083 "[-c N] [-n]"
1084#define klogd_full_usage "\n\n" \
1085 "Kernel logger\n" \
1086 "\nOptions:" \
1087 "\n -c N Only messages with level < N are printed to console" \
1088 "\n -n Run in foreground" \
1089
1090#define less_trivial_usage \
1091 "[-EMNmh~I?] [FILE]..."
1092#define less_full_usage "\n\n" \
1093 "View FILE (or stdin) one screenful at a time\n" \
1094 "\nOptions:" \
1095 "\n -E Quit once the end of a file is reached" \
1096 "\n -M,-m Display status line with line numbers" \
1097 "\n and percentage through the file" \
1098 "\n -N Prefix line number to each line" \
1099 "\n -I Ignore case in all searches" \
1100 "\n -~ Suppress ~s displayed past the end of the file" \
1101
1102#define linux32_trivial_usage NOUSAGE_STR
1103#define linux32_full_usage ""
1104#define linux64_trivial_usage NOUSAGE_STR
1105#define linux64_full_usage ""
1106
1107#define setarch_trivial_usage \
1108 "personality PROG ARGS"
1109#define setarch_full_usage "\n\n" \
1110 "Personality may be:\n" \
1111 " linux32 Set 32bit uname emulation\n" \
1112 " linux64 Set 64bit uname emulation" \
1113
1114#define load_policy_trivial_usage NOUSAGE_STR
1115#define load_policy_full_usage ""
1116
1117#define logger_trivial_usage \
1118 "[OPTIONS] [MESSAGE]"
1119#define logger_full_usage "\n\n" \
1120 "Write MESSAGE (or stdin) to syslog\n" \
1121 "\nOptions:" \
1122 "\n -s Log to stderr as well as the system log" \
1123 "\n -t TAG Log using the specified tag (defaults to user name)" \
1124 "\n -p PRIO Priority (numeric or facility.level pair)" \
1125
1126#define logger_example_usage \
1127 "$ logger \"hello\"\n"
1128
1129#define logread_trivial_usage \
1130 "[-f]"
1131#define logread_full_usage "\n\n" \
1132 "Show messages in syslogd's circular buffer\n" \
1133 "\nOptions:" \
1134 "\n -f Output data as log grows" \
1135
1136#define losetup_trivial_usage \
1137 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
1138 " losetup -d LOOPDEV - disassociate\n" \
1139 " losetup [-f] - show"
1140#define losetup_full_usage "\n\n" \
1141 "Options:" \
1142 "\n -o OFS Start OFS bytes into FILE" \
1143 "\n -f Show first free loop device" \
1144
1145#define losetup_notes_usage \
1146 "No arguments will display all current associations.\n" \
1147 "One argument (losetup /dev/loop1) will display the current association\n" \
1148 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1149 "and filename of the file the loop device is currently bound to.\n\n" \
1150 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1151 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
1152 "losetup -f will show the first loop free loop device\n\n"
1153
1154#define lpd_trivial_usage \
1155 "SPOOLDIR [HELPER [ARGS]]"
1156#define lpd_full_usage "\n\n" \
1157 "SPOOLDIR must contain (symlinks to) device nodes or directories" \
1158 "\nwith names matching print queue names. In the first case, jobs are" \
1159 "\nsent directly to the device. Otherwise each job is stored in queue" \
1160 "\ndirectory and HELPER program is called. Name of file to print" \
1161 "\nis passed in $DATAFILE variable." \
1162 "\nExample:" \
1163 "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \
1164
1165#define lpq_trivial_usage \
1166 "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]"
1167#define lpq_full_usage "\n\n" \
1168 "Options:" \
1169 "\n -P lp service to connect to (else uses $PRINTER)" \
1170 "\n -d Delete jobs" \
1171 "\n -f Force any waiting job to be printed" \
1172 "\n -s Short display" \
1173
1174#define lpr_trivial_usage \
1175 "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..."
1176/* -C CLASS exists too, not shown.
1177 * CLASS is supposed to be printed on banner page, if one is requested */
1178#define lpr_full_usage "\n\n" \
1179 "Options:" \
1180 "\n -P lp service to connect to (else uses $PRINTER)"\
1181 "\n -m Send mail on completion" \
1182 "\n -h Print banner page too" \
1183 "\n -V Verbose" \
1184
1185#define lspci_trivial_usage \
1186 "[-mk]"
1187#define lspci_full_usage "\n\n" \
1188 "List all PCI devices" \
1189 "\n" \
1190 "\n -m Parseable output" \
1191 "\n -k Show driver" \
1192
1193#define lsusb_trivial_usage NOUSAGE_STR
1194#define lsusb_full_usage ""
1195
1196#if ENABLE_FEATURE_MAKEDEVS_LEAF
1197#define makedevs_trivial_usage \
1198 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
1199#define makedevs_full_usage "\n\n" \
1200 "Create a range of block or character special files" \
1201 "\n" \
1202 "\nTYPE is:" \
1203 "\n b Block device" \
1204 "\n c Character device" \
1205 "\n f FIFO, MAJOR and MINOR are ignored" \
1206 "\n" \
1207 "\nFIRST..LAST specify numbers appended to NAME." \
1208 "\nIf 's' is the last argument, the base device is created as well." \
1209 "\n" \
1210 "\nExamples:" \
1211 "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \
1212 "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
1213#define makedevs_example_usage \
1214 "# makedevs /dev/ttyS c 4 66 2 63\n" \
1215 "[creates ttyS2-ttyS63]\n" \
1216 "# makedevs /dev/hda b 3 0 0 8 s\n" \
1217 "[creates hda,hda1-hda8]\n"
1218#endif
1219
1220#if ENABLE_FEATURE_MAKEDEVS_TABLE
1221#define makedevs_trivial_usage \
1222 "[-d device_table] rootdir"
1223#define makedevs_full_usage "\n\n" \
1224 "Create a range of special files as specified in a device table.\n" \
1225 "Device table entries take the form of:\n" \
1226 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
1227 "Where name is the file name, type can be one of:\n" \
1228 " f Regular file\n" \
1229 " d Directory\n" \
1230 " c Character device\n" \
1231 " b Block device\n" \
1232 " p Fifo (named pipe)\n" \
1233 "uid is the user id for the target file, gid is the group id for the\n" \
1234 "target file. The rest of the entries (major, minor, etc) apply to\n" \
1235 "to device special files. A '-' may be used for blank entries."
1236#define makedevs_example_usage \
1237 "For example:\n" \
1238 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
1239 "/dev d 755 0 0 - - - - -\n" \
1240 "/dev/console c 666 0 0 5 1 - - -\n" \
1241 "/dev/null c 666 0 0 1 3 0 0 -\n" \
1242 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
1243 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
1244 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
1245 "Will Produce:\n" \
1246 "/dev\n" \
1247 "/dev/console\n" \
1248 "/dev/null\n" \
1249 "/dev/zero\n" \
1250 "/dev/hda\n" \
1251 "/dev/hda[0-15]\n"
1252#endif
1253
1254#define man_trivial_usage \
1255 "[-aw] [MANPAGE]..."
1256#define man_full_usage "\n\n" \
1257 "Format and display manual page\n" \
1258 "\nOptions:" \
1259 "\n -a Display all pages" \
1260 "\n -w Show page locations" \
1261
1262#define matchpathcon_trivial_usage \
1263 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
1264#define matchpathcon_full_usage "\n\n" \
1265 " -n Don't display path" \
1266 "\n -N Don't use translations" \
1267 "\n -f Use alternate file_context file" \
1268 "\n -p Use prefix to speed translations" \
1269 "\n -V Verify file context on disk matches defaults" \
1270
1271#define mdev_trivial_usage \
1272 "[-s]"
1273#define mdev_full_usage "\n\n" \
1274 " -s Scan /sys and populate /dev during system boot\n" \
1275 "\n" \
1276 "It can be run by kernel as a hotplug helper. To activate it:\n" \
1277 " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \
1278 IF_FEATURE_MDEV_CONF( \
1279 "It uses /etc/mdev.conf with lines\n" \
1280 "[-]DEVNAME UID:GID PERM" \
1281 IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \
1282 IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \
1283 ) \
1284
1285#define mdev_notes_usage "" \
1286 IF_FEATURE_MDEV_CONFIG( \
1287 "The mdev config file contains lines that look like:\n" \
1288 " hd[a-z][0-9]* 0:3 660\n\n" \
1289 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
1290 IF_FEATURE_MDEV_EXEC( \
1291 "Optionally, that can be followed (on the same line) by a special character\n" \
1292 "and a command line to run after creating/before deleting the corresponding\n" \
1293 "device(s). The environment variable $MDEV indicates the active device node\n" \
1294 "(which is useful if it's a regex match). For example:\n\n" \
1295 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
1296 "The special characters are @ (run after creating), $ (run before deleting),\n" \
1297 "and * (run both after creating and before deleting). The commands run in\n" \
1298 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
1299 ) \
1300 "Config file parsing stops on the first matching line. If no config\n" \
1301 "entry is matched, devices are created with default 0:0 660. (Make\n" \
1302 "the last line match .* to override this.)\n\n" \
1303 )
1304
1305#define microcom_trivial_usage \
1306 "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY"
1307#define microcom_full_usage "\n\n" \
1308 "Copy bytes for stdin to TTY and from TTY to stdout\n" \
1309 "\nOptions:" \
1310 "\n -d Wait up to DELAY ms for TTY output before sending every" \
1311 "\n next byte to it" \
1312 "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \
1313 "\n -s Set serial line to SPEED" \
1314 "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \
1315
1316#define mkfs_ext2_trivial_usage \
1317 "[-Fn] " \
1318 /* "[-c|-l filename] " */ \
1319 "[-b BLK_SIZE] " \
1320 /* "[-f fragment-size] [-g blocks-per-group] " */ \
1321 "[-i INODE_RATIO] [-I INODE_SIZE] " \
1322 /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \
1323 "[-m RESERVED_PERCENT] " \
1324 /* "[-o creator-os] [-O feature[,...]] [-q] " */ \
1325 /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \
1326 "[-L LABEL] " \
1327 /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \
1328 "BLOCKDEV [KBYTES]"
1329#define mkfs_ext2_full_usage "\n\n" \
1330 " -b BLK_SIZE Block size, bytes" \
1331/* "\n -c Check device for bad blocks" */ \
1332/* "\n -E opts Set extended options" */ \
1333/* "\n -f size Fragment size in bytes" */ \
1334 "\n -F Force" \
1335/* "\n -g N Number of blocks in a block group" */ \
1336 "\n -i RATIO Max number of files is filesystem_size / RATIO" \
1337 "\n -I BYTES Inode size (min 128)" \
1338/* "\n -j Create a journal (ext3)" */ \
1339/* "\n -J opts Set journal options (size/device)" */ \
1340/* "\n -l file Read bad blocks list from file" */ \
1341 "\n -L LBL Volume label" \
1342 "\n -m PERCENT Percent of blocks to reserve for admin" \
1343/* "\n -M dir Set last mounted directory" */ \
1344 "\n -n Dry run" \
1345/* "\n -N N Number of inodes to create" */ \
1346/* "\n -o os Set the 'creator os' field" */ \
1347/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \
1348/* "\n -q Quiet" */ \
1349/* "\n -r rev Set filesystem revision" */ \
1350/* "\n -S Write superblock and group descriptors only" */ \
1351/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \
1352/* "\n -v Verbose" */ \
1353
1354#define mkfs_minix_trivial_usage \
1355 "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]"
1356#define mkfs_minix_full_usage "\n\n" \
1357 "Make a MINIX filesystem\n" \
1358 "\nOptions:" \
1359 "\n -c Check device for bad blocks" \
1360 "\n -n [14|30] Maximum length of filenames" \
1361 "\n -i INODES Number of inodes for the filesystem" \
1362 "\n -l FILE Read bad blocks list from FILE" \
1363 "\n -v Make version 2 filesystem" \
1364
1365#define mkfs_reiser_trivial_usage \
1366 "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]"
1367
1368#define mkfs_reiser_full_usage "\n\n" \
1369 "Make a ReiserFS V3 filesystem\n" \
1370 "\nOptions:" \
1371 "\n -f Force" \
1372 "\n -l LBL Volume label" \
1373
1374#define mkfs_vfat_trivial_usage \
1375 "[-v] [-n LABEL] BLOCKDEV [KBYTES]"
1376/* Accepted but ignored:
1377 "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] "
1378 "[-m boot-msg-file] [-i volume-id] "
1379 "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] "
1380 "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] "
1381*/
1382#define mkfs_vfat_full_usage "\n\n" \
1383 "Make a FAT32 filesystem\n" \
1384 "\nOptions:" \
1385/* "\n -c Check device for bad blocks" */ \
1386 "\n -v Verbose" \
1387/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \
1388 "\n -n LBL Volume label" \
1389
1390#define mkswap_trivial_usage \
1391 "[-L LBL] BLOCKDEV [KBYTES]"
1392#define mkswap_full_usage "\n\n" \
1393 "Prepare BLOCKDEV to be used as swap partition\n" \
1394 "\nOptions:" \
1395 "\n -L LBL Label" \
1396
1397#define more_trivial_usage \
1398 "[FILE]..."
1399#define more_full_usage "\n\n" \
1400 "View FILE (or stdin) one screenful at a time"
1401
1402#define more_example_usage \
1403 "$ dmesg | more\n"
1404
1405#define mount_trivial_usage \
1406 "[OPTIONS] [-o OPTS] DEVICE NODE"
1407#define mount_full_usage "\n\n" \
1408 "Mount a filesystem. Filesystem autodetection requires /proc.\n" \
1409 "\nOptions:" \
1410 "\n -a Mount all filesystems in fstab" \
1411 IF_FEATURE_MOUNT_FAKE( \
1412 IF_FEATURE_MTAB_SUPPORT( \
1413 "\n -f Update /etc/mtab, but don't mount" \
1414 ) \
1415 IF_NOT_FEATURE_MTAB_SUPPORT( \
1416 "\n -f Dry run" \
1417 ) \
1418 ) \
1419 IF_FEATURE_MOUNT_HELPERS( \
1420 "\n -i Don't run mount helper" \
1421 ) \
1422 IF_FEATURE_MTAB_SUPPORT( \
1423 "\n -n Don't update /etc/mtab" \
1424 ) \
1425 "\n -r Read-only mount" \
1426 "\n -w Read-write mount (default)" \
1427 "\n -t FSTYPE Filesystem type" \
1428 "\n -O OPT Mount only filesystems with option OPT (-a only)" \
1429 "\n-o OPT:" \
1430 IF_FEATURE_MOUNT_LOOP( \
1431 "\n loop Ignored (loop devices are autodetected)" \
1432 ) \
1433 IF_FEATURE_MOUNT_FLAGS( \
1434 "\n [a]sync Writes are [a]synchronous" \
1435 "\n [no]atime Disable/enable updates to inode access times" \
1436 "\n [no]diratime Disable/enable atime updates to directories" \
1437 "\n [no]relatime Disable/enable atime updates relative to modification time" \
1438 "\n [no]dev (Dis)allow use of special device files" \
1439 "\n [no]exec (Dis)allow use of executable files" \
1440 "\n [no]suid (Dis)allow set-user-id-root programs" \
1441 "\n [r]shared Convert [recursively] to a shared subtree" \
1442 "\n [r]slave Convert [recursively] to a slave subtree" \
1443 "\n [r]private Convert [recursively] to a private subtree" \
1444 "\n [un]bindable Make mount point [un]able to be bind mounted" \
1445 "\n [r]bind Bind a file or directory [recursively] to another location" \
1446 "\n move Relocate an existing mount point" \
1447 ) \
1448 "\n remount Remount a mounted filesystem, changing flags" \
1449 "\n ro/rw Same as -r/-w" \
1450 "\n" \
1451 "\nThere are filesystem-specific -o flags." \
1452
1453#define mount_example_usage \
1454 "$ mount\n" \
1455 "/dev/hda3 on / type minix (rw)\n" \
1456 "proc on /proc type proc (rw)\n" \
1457 "devpts on /dev/pts type devpts (rw)\n" \
1458 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
1459 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
1460 "$ mount cd_image.iso mydir\n"
1461#define mount_notes_usage \
1462 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
1463
1464#define mountpoint_trivial_usage \
1465 "[-q] <[-dn] DIR | -x DEVICE>"
1466#define mountpoint_full_usage "\n\n" \
1467 "Check if the directory is a mountpoint\n" \
1468 "\nOptions:" \
1469 "\n -q Quiet" \
1470 "\n -d Print major/minor device number of the filesystem" \
1471 "\n -n Print device name of the filesystem" \
1472 "\n -x Print major/minor device number of the blockdevice" \
1473
1474#define mountpoint_example_usage \
1475 "$ mountpoint /proc\n" \
1476 "/proc is not a mountpoint\n" \
1477 "$ mountpoint /sys\n" \
1478 "/sys is a mountpoint\n"
1479
1480#define mt_trivial_usage \
1481 "[-f device] opcode value"
1482#define mt_full_usage "\n\n" \
1483 "Control magnetic tape drive operation\n" \
1484 "\n" \
1485 "Available Opcodes:\n" \
1486 "\n" \
1487 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
1488 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
1489 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
1490 "setpart tell unload unlock weof wset" \
1491
1492#define nslookup_trivial_usage \
1493 "[HOST] [SERVER]"
1494#define nslookup_full_usage "\n\n" \
1495 "Query the nameserver for the IP address of the given HOST\n" \
1496 "optionally using a specified DNS server"
1497#define nslookup_example_usage \
1498 "$ nslookup localhost\n" \
1499 "Server: default\n" \
1500 "Address: default\n" \
1501 "\n" \
1502 "Name: debian\n" \
1503 "Address: 127.0.0.1\n"
1504
1505#define ntpd_trivial_usage \
1506 "[-dnqNw"IF_FEATURE_NTPD_SERVER("l")"] [-S PROG] [-p PEER]..."
1507#define ntpd_full_usage "\n\n" \
1508 "NTP client/server\n" \
1509 "\nOptions:" \
1510 "\n -d Verbose" \
1511 "\n -n Do not daemonize" \
1512 "\n -q Quit after clock is set" \
1513 "\n -N Run at high priority" \
1514 "\n -w Do not set time (only query peers), implies -n" \
1515 IF_FEATURE_NTPD_SERVER( \
1516 "\n -l Run as server on port 123" \
1517 ) \
1518 "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \
1519 "\n -p PEER Obtain time from PEER (may be repeated)" \
1520
1521/*
1522#define parse_trivial_usage \
1523 "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
1524#define parse_full_usage ""
1525*/
1526
1527#define pgrep_trivial_usage \
1528 "[-flnovx] [-s SID|-P PPID|PATTERN]"
1529#define pgrep_full_usage "\n\n" \
1530 "Display process(es) selected by regex PATTERN\n" \
1531 "\nOptions:" \
1532 "\n -l Show command name too" \
1533 "\n -f Match against entire command line" \
1534 "\n -n Show the newest process only" \
1535 "\n -o Show the oldest process only" \
1536 "\n -v Negate the match" \
1537 "\n -x Match whole name (not substring)" \
1538 "\n -s Match session ID (0 for current)" \
1539 "\n -P Match parent process ID" \
1540
1541#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
1542#define pidof_trivial_usage \
1543 "[OPTIONS] [NAME]..."
1544#define USAGE_PIDOF "\n\nOptions:"
1545#else
1546#define pidof_trivial_usage \
1547 "[NAME]..."
1548#define USAGE_PIDOF /* none */
1549#endif
1550#define pidof_full_usage "\n\n" \
1551 "List PIDs of all processes with names that match NAMEs" \
1552 USAGE_PIDOF \
1553 IF_FEATURE_PIDOF_SINGLE( \
1554 "\n -s Show only one PID" \
1555 ) \
1556 IF_FEATURE_PIDOF_OMIT( \
1557 "\n -o PID Omit given pid" \
1558 "\n Use %PPID to omit pid of pidof's parent" \
1559 ) \
1560
1561#define pidof_example_usage \
1562 "$ pidof init\n" \
1563 "1\n" \
1564 IF_FEATURE_PIDOF_OMIT( \
1565 "$ pidof /bin/sh\n20351 5973 5950\n") \
1566 IF_FEATURE_PIDOF_OMIT( \
1567 "$ pidof /bin/sh -o %PPID\n20351 5950")
1568
1569#define pivot_root_trivial_usage \
1570 "NEW_ROOT PUT_OLD"
1571#define pivot_root_full_usage "\n\n" \
1572 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
1573 "the new root file system"
1574
1575#define pkill_trivial_usage \
1576 "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]"
1577#define pkill_full_usage "\n\n" \
1578 "Send a signal to process(es) selected by regex PATTERN\n" \
1579 "\nOptions:" \
1580 "\n -l List all signals" \
1581 "\n -f Match against entire command line" \
1582 "\n -n Signal the newest process only" \
1583 "\n -o Signal the oldest process only" \
1584 "\n -v Negate the match" \
1585 "\n -x Match whole name (not substring)" \
1586 "\n -s Match session ID (0 for current)" \
1587 "\n -P Match parent process ID" \
1588
1589
1590#if ENABLE_DESKTOP
1591
1592#define ps_trivial_usage \
1593 "[-o COL1,COL2=HEADER]" IF_FEATURE_SHOW_THREADS(" [-T]")
1594#define ps_full_usage "\n\n" \
1595 "Show list of processes\n" \
1596 "\nOptions:" \
1597 "\n -o COL1,COL2=HEADER Select columns for display" \
1598 IF_FEATURE_SHOW_THREADS( \
1599 "\n -T Show threads" \
1600 )
1601
1602#else /* !ENABLE_DESKTOP */
1603
1604#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE
1605#define USAGE_PS "\nThis version of ps accepts no options"
1606#else
1607#define USAGE_PS "\nOptions:"
1608#endif
1609
1610#define ps_trivial_usage \
1611 ""
1612#define ps_full_usage "\n\n" \
1613 "Show list of processes\n" \
1614 USAGE_PS \
1615 IF_SELINUX( \
1616 "\n -Z Show selinux context" \
1617 ) \
1618 IF_FEATURE_PS_WIDE( \
1619 "\n w Wide output" \
1620 )
1621
1622#endif /* ENABLE_DESKTOP */
1623
1624#define ps_example_usage \
1625 "$ ps\n" \
1626 " PID Uid Gid State Command\n" \
1627 " 1 root root S init\n" \
1628 " 2 root root S [kflushd]\n" \
1629 " 3 root root S [kupdate]\n" \
1630 " 4 root root S [kpiod]\n" \
1631 " 5 root root S [kswapd]\n" \
1632 " 742 andersen andersen S [bash]\n" \
1633 " 743 andersen andersen S -bash\n" \
1634 " 745 root root S [getty]\n" \
1635 " 2990 andersen andersen R ps\n" \
1636
1637#define pscan_trivial_usage \
1638 "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
1639#define pscan_full_usage "\n\n" \
1640 "Scan a host, print all open ports\n" \
1641 "\nOptions:" \
1642 "\n -c Show closed ports too" \
1643 "\n -b Show blocked ports too" \
1644 "\n -p Scan from this port (default 1)" \
1645 "\n -P Scan up to this port (default 1024)" \
1646 "\n -t Timeout (default 5000 ms)" \
1647 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
1648
1649#define raidautorun_trivial_usage \
1650 "DEVICE"
1651#define raidautorun_full_usage "\n\n" \
1652 "Tell the kernel to automatically search and start RAID arrays"
1653#define raidautorun_example_usage \
1654 "$ raidautorun /dev/md0"
1655
1656#define rdate_trivial_usage \
1657 "[-sp] HOST"
1658#define rdate_full_usage "\n\n" \
1659 "Get and possibly set the system date and time from a remote HOST\n" \
1660 "\nOptions:" \
1661 "\n -s Set the system date and time (default)" \
1662 "\n -p Print the date and time" \
1663
1664#define rdev_trivial_usage \
1665 ""
1666#define rdev_full_usage "\n\n" \
1667 "Print the device node associated with the filesystem mounted at '/'"
1668#define rdev_example_usage \
1669 "$ rdev\n" \
1670 "/dev/mtdblock9 /\n"
1671
1672#define readahead_trivial_usage \
1673 "[FILE]..."
1674#define readahead_full_usage "\n\n" \
1675 "Preload FILEs to RAM"
1676
1677#define readprofile_trivial_usage \
1678 "[OPTIONS]"
1679#define readprofile_full_usage "\n\n" \
1680 "Options:" \
1681 "\n -m mapfile (Default: /boot/System.map)" \
1682 "\n -p profile (Default: /proc/profile)" \
1683 "\n -M NUM Set the profiling multiplier to NUM" \
1684 "\n -i Print only info about the sampling step" \
1685 "\n -v Verbose" \
1686 "\n -a Print all symbols, even if count is 0" \
1687 "\n -b Print individual histogram-bin counts" \
1688 "\n -s Print individual counters within functions" \
1689 "\n -r Reset all the counters (root only)" \
1690 "\n -n Disable byte order auto-detection" \
1691
1692#define scriptreplay_trivial_usage \
1693 "timingfile [typescript [divisor]]"
1694#define scriptreplay_full_usage "\n\n" \
1695 "Play back typescripts, using timing information"
1696
1697#define restorecon_trivial_usage \
1698 "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]"
1699#define restorecon_full_usage "\n\n" \
1700 "Reset security contexts of files in pathname\n" \
1701 "\n -i Ignore files that don't exist" \
1702 "\n -f FILE File with list of files to process" \
1703 "\n -e DIR Directory to exclude" \
1704 "\n -R,-r Recurse" \
1705 "\n -n Don't change any file labels" \
1706 "\n -o FILE Save list of files with incorrect context" \
1707 "\n -v Verbose" \
1708 "\n -vv Show changed labels" \
1709 "\n -F Force reset of context to match file_context" \
1710 "\n for customizable files, or the user section," \
1711 "\n if it has changed" \
1712
1713#define rfkill_trivial_usage \
1714 "COMMAND [INDEX|TYPE]"
1715#define rfkill_full_usage "\n\n" \
1716 "Enable/disable wireless devices\n" \
1717 "\nCommands:" \
1718 "\n list [INDEX|TYPE] List current state" \
1719 "\n block INDEX|TYPE Disable device" \
1720 "\n unblock INDEX|TYPE Enable device" \
1721 "\n" \
1722 "\n TYPE: all, wlan(wifi), bluetooth, uwb(ultrawideband)," \
1723 "\n wimax, wwan, gps, fm" \
1724
1725#define route_trivial_usage \
1726 "[{add|del|delete}]"
1727#define route_full_usage "\n\n" \
1728 "Edit kernel routing tables\n" \
1729 "\nOptions:" \
1730 "\n -n Don't resolve names" \
1731 "\n -e Display other/more information" \
1732 "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \
1733
1734#define rtcwake_trivial_usage \
1735 "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]"
1736#define rtcwake_full_usage "\n\n" \
1737 "Enter a system sleep state until specified wakeup time\n" \
1738 IF_LONG_OPTS( \
1739 "\n -a,--auto Read clock mode from adjtime" \
1740 "\n -l,--local Clock is set to local time" \
1741 "\n -u,--utc Clock is set to UTC time" \
1742 "\n -d,--device=DEV Specify the RTC device" \
1743 "\n -m,--mode=MODE Set the sleep state (default: standby)" \
1744 "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \
1745 "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \
1746 ) \
1747 IF_NOT_LONG_OPTS( \
1748 "\n -a Read clock mode from adjtime" \
1749 "\n -l Clock is set to local time" \
1750 "\n -u Clock is set to UTC time" \
1751 "\n -d DEV Specify the RTC device" \
1752 "\n -m MODE Set the sleep state (default: standby)" \
1753 "\n -s SEC Set the timeout in SEC seconds from now" \
1754 "\n -t TIME Set the timeout to TIME seconds from epoch" \
1755 )
1756
1757#define runcon_trivial_usage \
1758 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" \
1759 "runcon CONTEXT PROG ARGS"
1760#define runcon_full_usage "\n\n" \
1761 "Run PROG in a different security context\n" \
1762 "\n CONTEXT Complete security context\n" \
1763 IF_FEATURE_RUNCON_LONG_OPTIONS( \
1764 "\n -c,--compute Compute process transition context before modifying" \
1765 "\n -t,--type=TYPE Type (for same role as parent)" \
1766 "\n -u,--user=USER User identity" \
1767 "\n -r,--role=ROLE Role" \
1768 "\n -l,--range=RNG Levelrange" \
1769 ) \
1770 IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \
1771 "\n -c Compute process transition context before modifying" \
1772 "\n -t TYPE Type (for same role as parent)" \
1773 "\n -u USER User identity" \
1774 "\n -r ROLE Role" \
1775 "\n -l RNG Levelrange" \
1776 )
1777
1778#define runlevel_trivial_usage \
1779 "[FILE]"
1780#define runlevel_full_usage "\n\n" \
1781 "Find the current and previous system runlevel\n" \
1782 "\n" \
1783 "If no utmp FILE exists or if no runlevel record can be found,\n" \
1784 "print \"unknown\""
1785#define runlevel_example_usage \
1786 "$ runlevel /var/run/utmp\n" \
1787 "N 2"
1788
1789#define runsv_trivial_usage \
1790 "DIR"
1791#define runsv_full_usage "\n\n" \
1792 "Start and monitor a service and optionally an appendant log service"
1793
1794#define runsvdir_trivial_usage \
1795 "[-P] [-s SCRIPT] DIR"
1796#define runsvdir_full_usage "\n\n" \
1797 "Start a runsv process for each subdirectory. If it exits, restart it.\n" \
1798 "\n -P Put each runsv in a new session" \
1799 "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \
1800
1801#define rx_trivial_usage \
1802 "FILE"
1803#define rx_full_usage "\n\n" \
1804 "Receive a file using the xmodem protocol"
1805#define rx_example_usage \
1806 "$ rx /tmp/foo\n"
1807
1808#define script_trivial_usage \
1809 "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]"
1810#define script_full_usage "\n\n" \
1811 "Options:" \
1812 "\n -a Append output" \
1813 "\n -c PROG Run PROG, not shell" \
1814 "\n -f Flush output after each write" \
1815 "\n -q Quiet" \
1816 IF_SCRIPTREPLAY( \
1817 "\n -t Send timing to stderr" \
1818 )
1819
1820#define selinuxenabled_trivial_usage NOUSAGE_STR
1821#define selinuxenabled_full_usage ""
1822
1823#define sestatus_trivial_usage \
1824 "[-vb]"
1825#define sestatus_full_usage "\n\n" \
1826 " -v Verbose" \
1827 "\n -b Display current state of booleans" \
1828
1829#define setenforce_trivial_usage \
1830 "[Enforcing | Permissive | 1 | 0]"
1831#define setenforce_full_usage ""
1832
1833#define setfiles_trivial_usage \
1834 "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \
1835 IF_FEATURE_SETFILES_CHECK_OPTION( \
1836 " [-c policyfile] spec_file" \
1837 ) \
1838 " pathname"
1839#define setfiles_full_usage "\n\n" \
1840 "Reset file contexts under pathname according to spec_file\n" \
1841 IF_FEATURE_SETFILES_CHECK_OPTION( \
1842 "\n -c FILE Check the validity of the contexts against the specified binary policy" \
1843 ) \
1844 "\n -d Show which specification matched each file" \
1845 "\n -l Log changes in file labels to syslog" \
1846 "\n -n Don't change any file labels" \
1847 "\n -q Suppress warnings" \
1848 "\n -r DIR Use an alternate root path" \
1849 "\n -e DIR Exclude DIR" \
1850 "\n -F Force reset of context to match file_context for customizable files" \
1851 "\n -o FILE Save list of files with incorrect context" \
1852 "\n -s Take a list of files from stdin (instead of command line)" \
1853 "\n -v Show changes in file labels, if type or role are changing" \
1854 "\n -vv Show changes in file labels, if type, role, or user are changing" \
1855 "\n -W Display warnings about entries that had no matching files" \
1856
1857#define setfont_trivial_usage \
1858 "FONT [-m MAPFILE] [-C TTY]"
1859#define setfont_full_usage "\n\n" \
1860 "Load a console font\n" \
1861 "\nOptions:" \
1862 "\n -m MAPFILE Load console screen map" \
1863 "\n -C TTY Affect TTY instead of /dev/tty" \
1864
1865#define setfont_example_usage \
1866 "$ setfont -m koi8-r /etc/i18n/fontname\n"
1867
1868#define setsebool_trivial_usage \
1869 "boolean value"
1870
1871#define setsebool_full_usage "\n\n" \
1872 "Change boolean setting"
1873
1874#define setsid_trivial_usage \
1875 "PROG ARGS"
1876#define setsid_full_usage "\n\n" \
1877 "Run PROG in a new session. PROG will have no controlling terminal\n" \
1878 "and will not be affected by keyboard signals (Ctrl-C etc).\n" \
1879 "See setsid(2) for details." \
1880
1881#define last_trivial_usage \
1882 ""IF_FEATURE_LAST_FANCY("[-HW] [-f FILE]")
1883#define last_full_usage "\n\n" \
1884 "Show listing of the last users that logged into the system" \
1885 IF_FEATURE_LAST_FANCY( "\n" \
1886 "\nOptions:" \
1887/* "\n -H Show header line" */ \
1888 "\n -W Display with no host column truncation" \
1889 "\n -f FILE Read from FILE instead of /var/log/wtmp" \
1890 )
1891
1892#define slattach_trivial_usage \
1893 "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
1894#define slattach_full_usage "\n\n" \
1895 "Attach network interface(s) to serial line(s)\n" \
1896 "\nOptions:" \
1897 "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
1898 "\n -s SPD Set line speed" \
1899 "\n -e Exit after initializing device" \
1900 "\n -h Exit when the carrier is lost" \
1901 "\n -c PROG Run PROG when the line is hung up" \
1902 "\n -m Do NOT initialize the line in raw 8 bits mode" \
1903 "\n -L Enable 3-wire operation" \
1904 "\n -F Disable RTS/CTS flow control" \
1905
1906#define strings_trivial_usage \
1907 "[-afo] [-n LEN] [FILE]..."
1908#define strings_full_usage "\n\n" \
1909 "Display printable strings in a binary file\n" \
1910 "\nOptions:" \
1911 "\n -a Scan whole file (default)" \
1912 "\n -f Precede strings with filenames" \
1913 "\n -n LEN At least LEN characters form a string (default 4)" \
1914 "\n -o Precede strings with decimal offsets" \
1915
1916#define sv_trivial_usage \
1917 "[-v] [-w SEC] CMD SERVICE_DIR..."
1918#define sv_full_usage "\n\n" \
1919 "Control services monitored by runsv supervisor.\n" \
1920 "Commands (only first character is enough):\n" \
1921 "\n" \
1922 "status: query service status\n" \
1923 "up: if service isn't running, start it. If service stops, restart it\n" \
1924 "once: like 'up', but if service stops, don't restart it\n" \
1925 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
1926 " if it exists. After it stops, don't restart service\n" \
1927 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
1928 " runsv exits too\n" \
1929 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
1930 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \
1931
1932#define swapoff_trivial_usage \
1933 "[-a] [DEVICE]"
1934#define swapoff_full_usage "\n\n" \
1935 "Stop swapping on DEVICE\n" \
1936 "\nOptions:" \
1937 "\n -a Stop swapping on all swap devices" \
1938
1939#define swapon_trivial_usage \
1940 "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]"
1941#define swapon_full_usage "\n\n" \
1942 "Start swapping on DEVICE\n" \
1943 "\nOptions:" \
1944 "\n -a Start swapping on all swap devices" \
1945 IF_FEATURE_SWAPON_PRI( \
1946 "\n -p PRI Set swap device priority" \
1947 ) \
1948
1949#define switch_root_trivial_usage \
1950 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]"
1951#define switch_root_full_usage "\n\n" \
1952 "Free initramfs and switch to another root fs:\n" \
1953 "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \
1954 "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \
1955 "\nOptions:" \
1956 "\n -c DEV Reopen stdio to DEV after switch" \
1957
1958#define sysctl_trivial_usage \
1959 "[OPTIONS] [VALUE]..."
1960#define sysctl_full_usage "\n\n" \
1961 "Configure kernel parameters at runtime\n" \
1962 "\nOptions:" \
1963 "\n -n Don't print key names" \
1964 "\n -e Don't warn about unknown keys" \
1965 "\n -w Change sysctl setting" \
1966 "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \
1967 "\n -a Display all values" \
1968 "\n -A Display all values in table form" \
1969
1970#define sysctl_example_usage \
1971 "sysctl [-n] [-e] variable...\n" \
1972 "sysctl [-n] [-e] -w variable=value...\n" \
1973 "sysctl [-n] [-e] -a\n" \
1974 "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \
1975 "sysctl [-n] [-e] -A\n"
1976
1977#define syslogd_trivial_usage \
1978 "[OPTIONS]"
1979#define syslogd_full_usage "\n\n" \
1980 "System logging utility.\n" \
1981 "This version of syslogd ignores /etc/syslog.conf\n" \
1982 "\nOptions:" \
1983 "\n -n Run in foreground" \
1984 "\n -O FILE Log to given file (default:/var/log/messages)" \
1985 "\n -l N Set local log level" \
1986 "\n -S Smaller logging output" \
1987 IF_FEATURE_ROTATE_LOGFILE( \
1988 "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \
1989 "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \
1990 IF_FEATURE_REMOTE_LOG( \
1991 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
1992 "\n -L Log locally and via network (default is network only if -R)") \
1993 IF_FEATURE_SYSLOGD_DUP( \
1994 "\n -D Drop duplicates") \
1995 IF_FEATURE_IPC_SYSLOG( \
1996 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \
1997 /* NB: -Csize shouldn't have space (because size is optional) */
1998/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */
1999
2000#define syslogd_example_usage \
2001 "$ syslogd -R masterlog:514\n" \
2002 "$ syslogd -R 192.168.1.1:601\n"
2003
2004#define taskset_trivial_usage \
2005 "[-p] [MASK] [PID | PROG ARGS]"
2006#define taskset_full_usage "\n\n" \
2007 "Set or get CPU affinity\n" \
2008 "\nOptions:" \
2009 "\n -p Operate on an existing PID" \
2010
2011#define taskset_example_usage \
2012 "$ taskset 0x7 ./dgemm_test&\n" \
2013 "$ taskset -p 0x1 $!\n" \
2014 "pid 4790's current affinity mask: 7\n" \
2015 "pid 4790's new affinity mask: 1\n" \
2016 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
2017 "pid 6671's current affinity mask: 1\n" \
2018 "pid 6671's new affinity mask: 1\n" \
2019 "$ taskset -p 1\n" \
2020 "pid 1's current affinity mask: 3\n"
2021
2022#if ENABLE_FEATURE_TELNET_AUTOLOGIN
2023#define telnet_trivial_usage \
2024 "[-a] [-l USER] HOST [PORT]"
2025#define telnet_full_usage "\n\n" \
2026 "Connect to telnet server\n" \
2027 "\nOptions:" \
2028 "\n -a Automatic login with $USER variable" \
2029 "\n -l USER Automatic login as USER" \
2030
2031#else
2032#define telnet_trivial_usage \
2033 "HOST [PORT]"
2034#define telnet_full_usage "\n\n" \
2035 "Connect to telnet server"
2036#endif
2037
2038#define telnetd_trivial_usage \
2039 "[OPTIONS]"
2040#define telnetd_full_usage "\n\n" \
2041 "Handle incoming telnet connections" \
2042 IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \
2043 "\nOptions:" \
2044 "\n -l LOGIN Exec LOGIN on connect" \
2045 "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \
2046 "\n -K Close connection as soon as login exits" \
2047 "\n (normally wait until all programs close slave pty)" \
2048 IF_FEATURE_TELNETD_STANDALONE( \
2049 "\n -p PORT Port to listen on" \
2050 "\n -b ADDR[:PORT] Address to bind to" \
2051 "\n -F Run in foreground" \
2052 "\n -i Inetd mode" \
2053 IF_FEATURE_TELNETD_INETD_WAIT( \
2054 "\n -w SEC Inetd 'wait' mode, linger time SEC" \
2055 "\n -S Log to syslog (implied by -i or without -F and -w)" \
2056 ) \
2057 )
2058
2059#define tc_trivial_usage \
2060 /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]"
2061#define tc_full_usage "\n\n" \
2062 "OBJECT: {qdisc|class|filter}\n" \
2063 "CMD: {add|del|change|replace|show}\n" \
2064 "\n" \
2065 "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \
2066 /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
2067 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
2068 " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \
2069 "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \
2070 "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \
2071 " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \
2072 "class show [ dev STRING ] [ root | parent CLASSID ]\n" \
2073 "filter [ pref PRIO ] [ protocol PROTO ]\n" \
2074 /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \
2075 " [ root | classid CLASSID ] [ handle FILTERID ]\n" \
2076 " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \
2077 "filter show [ dev STRING ] [ root | parent CLASSID ]"
2078
2079#define tcpsvd_trivial_usage \
2080 "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG"
2081/* with not-implemented options: */
2082/* "[-hpEvv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] [-i DIR|-x CDB] [-t SEC] IP PORT PROG" */
2083#define tcpsvd_full_usage "\n\n" \
2084 "Create TCP socket, bind to IP:PORT and listen\n" \
2085 "for incoming connection. Run PROG for each connection.\n" \
2086 "\n IP IP to listen on. '0' = all" \
2087 "\n PORT Port to listen on" \
2088 "\n PROG ARGS Program to run" \
2089 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
2090 "\n -u USER[:GRP] Change to user/group after bind" \
2091 "\n -c N Handle up to N connections simultaneously" \
2092 "\n -b N Allow a backlog of approximately N TCP SYNs" \
2093 "\n -C N[:MSG] Allow only up to N connections from the same IP." \
2094 "\n New connections from this IP address are closed" \
2095 "\n immediately. MSG is written to the peer before close" \
2096 "\n -h Look up peer's hostname" \
2097 "\n -E Don't set up environment variables" \
2098 "\n -v Verbose" \
2099
2100#define udpsvd_trivial_usage \
2101 "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG"
2102#define udpsvd_full_usage "\n\n" \
2103 "Create UDP socket, bind to IP:PORT and wait\n" \
2104 "for incoming packets. Run PROG for each packet,\n" \
2105 "redirecting all further packets with same peer ip:port to it.\n" \
2106 "\n IP IP to listen on. '0' = all" \
2107 "\n PORT Port to listen on" \
2108 "\n PROG ARGS Program to run" \
2109 "\n -l NAME Local hostname (else looks up local hostname in DNS)" \
2110 "\n -u USER[:GRP] Change to user/group after bind" \
2111 "\n -c N Handle up to N connections simultaneously" \
2112 "\n -h Look up peer's hostname" \
2113 "\n -E Don't set up environment variables" \
2114 "\n -v Verbose" \
2115
2116#define tftp_trivial_usage \
2117 "[OPTIONS] HOST [PORT]"
2118#define tftp_full_usage "\n\n" \
2119 "Transfer a file from/to tftp server\n" \
2120 "\nOptions:" \
2121 "\n -l FILE Local FILE" \
2122 "\n -r FILE Remote FILE" \
2123 IF_FEATURE_TFTP_GET( \
2124 "\n -g Get file" \
2125 ) \
2126 IF_FEATURE_TFTP_PUT( \
2127 "\n -p Put file" \
2128 ) \
2129 IF_FEATURE_TFTP_BLOCKSIZE( \
2130 "\n -b SIZE Transfer blocks of SIZE octets" \
2131 )
2132
2133#define tftpd_trivial_usage \
2134 "[-cr] [-u USER] [DIR]"
2135#define tftpd_full_usage "\n\n" \
2136 "Transfer a file on tftp client's request\n" \
2137 "\n" \
2138 "tftpd should be used as an inetd service.\n" \
2139 "tftpd's line for inetd.conf:\n" \
2140 " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \
2141 "It also can be ran from udpsvd:\n" \
2142 " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \
2143 "\nOptions:" \
2144 "\n -r Prohibit upload" \
2145 "\n -c Allow file creation via upload" \
2146 "\n -u Access files as USER" \
2147
2148#define time_trivial_usage \
2149 "[-v] PROG ARGS"
2150#define time_full_usage "\n\n" \
2151 "Run PROG, display resource usage when it exits\n" \
2152 "\nOptions:" \
2153 "\n -v Verbose" \
2154
2155#define timeout_trivial_usage \
2156 "[-t SECS] [-s SIG] PROG ARGS"
2157#define timeout_full_usage "\n\n" \
2158 "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \
2159 "Defaults: SECS: 10, SIG: TERM." \
2160
2161#define traceroute_trivial_usage \
2162 "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
2163 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \
2164 " [-z PAUSE_MSEC] HOST [BYTES]"
2165#define traceroute_full_usage "\n\n" \
2166 "Trace the route to HOST\n" \
2167 "\nOptions:" \
2168 IF_TRACEROUTE6( \
2169 "\n -4,-6 Force IP or IPv6 name resolution" \
2170 ) \
2171 "\n -F Set the don't fragment bit" \
2172 "\n -I Use ICMP ECHO instead of UDP datagrams" \
2173 "\n -l Display the TTL value of the returned packet" \
2174 "\n -d Set SO_DEBUG options to socket" \
2175 "\n -n Print numeric addresses" \
2176 "\n -r Bypass routing tables, send directly to HOST" \
2177 "\n -v Verbose" \
2178 "\n -m Max time-to-live (max number of hops)" \
2179 "\n -p Base UDP port number used in probes" \
2180 "\n (default 33434)" \
2181 "\n -q Number of probes per TTL (default 3)" \
2182 "\n -s IP address to use as the source address" \
2183 "\n -t Type-of-service in probe packets (default 0)" \
2184 "\n -w Time in seconds to wait for a response (default 3)" \
2185 "\n -g Loose source route gateway (8 max)" \
2186
2187#define traceroute6_trivial_usage \
2188 "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \
2189 " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \
2190 " HOST [BYTES]"
2191#define traceroute6_full_usage "\n\n" \
2192 "Trace the route to HOST\n" \
2193 "\nOptions:" \
2194 "\n -d Set SO_DEBUG options to socket" \
2195 "\n -n Print numeric addresses" \
2196 "\n -r Bypass routing tables, send directly to HOST" \
2197 "\n -v Verbose" \
2198 "\n -m Max time-to-live (max number of hops)" \
2199 "\n -p Base UDP port number used in probes" \
2200 "\n (default is 33434)" \
2201 "\n -q Number of probes per TTL (default 3)" \
2202 "\n -s IP address to use as the source address" \
2203 "\n -t Type-of-service in probe packets (default 0)" \
2204 "\n -w Time in seconds to wait for a response (default 3)" \
2205
2206#define ttysize_trivial_usage \
2207 "[w] [h]"
2208#define ttysize_full_usage "\n\n" \
2209 "Print dimension(s) of stdin's terminal, on error return 80x25"
2210
2211#define tunctl_trivial_usage \
2212 "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]")
2213#define tunctl_full_usage "\n\n" \
2214 "Create or delete tun interfaces\n" \
2215 "\nOptions:" \
2216 "\n -f name tun device (/dev/net/tun)" \
2217 "\n -t name Create iface 'name'" \
2218 "\n -d name Delete iface 'name'" \
2219 IF_FEATURE_TUNCTL_UG( \
2220 "\n -u owner Set iface owner" \
2221 "\n -g group Set iface group" \
2222 "\n -b Brief output" \
2223 )
2224#define tunctl_example_usage \
2225 "# tunctl\n" \
2226 "# tunctl -d tun0\n"
2227
2228#define udhcpd_trivial_usage \
2229 "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [CONFFILE]" \
2230
2231#define udhcpd_full_usage "\n\n" \
2232 "DHCP server\n" \
2233 "\n -f Run in foreground" \
2234 "\n -S Log to syslog too" \
2235 IF_FEATURE_UDHCP_PORT( \
2236 "\n -P N Use port N (default 67)" \
2237 )
2238
2239#define umount_trivial_usage \
2240 "[OPTIONS] FILESYSTEM|DIRECTORY"
2241#define umount_full_usage "\n\n" \
2242 "Unmount file systems\n" \
2243 "\nOptions:" \
2244 IF_FEATURE_UMOUNT_ALL( \
2245 "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \
2246 ) \
2247 IF_FEATURE_MTAB_SUPPORT( \
2248 "\n -n Don't erase /etc/mtab entries" \
2249 ) \
2250 "\n -r Try to remount devices as read-only if mount is busy" \
2251 "\n -l Lazy umount (detach filesystem)" \
2252 "\n -f Force umount (i.e., unreachable NFS server)" \
2253 IF_FEATURE_MOUNT_LOOP( \
2254 "\n -d Free loop device if it has been used" \
2255 )
2256
2257#define umount_example_usage \
2258 "$ umount /dev/hdc1\n"
2259
2260#define uptime_trivial_usage \
2261 ""
2262#define uptime_full_usage "\n\n" \
2263 "Display the time since the last boot"
2264
2265#define uptime_example_usage \
2266 "$ uptime\n" \
2267 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
2268
2269#define vconfig_trivial_usage \
2270 "COMMAND [OPTIONS]"
2271#define vconfig_full_usage "\n\n" \
2272 "Create and remove virtual ethernet devices\n" \
2273 "\nOptions:" \
2274 "\n add [interface-name] [vlan_id]" \
2275 "\n rem [vlan-name]" \
2276 "\n set_flag [interface-name] [flag-num] [0 | 1]" \
2277 "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \
2278 "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \
2279 "\n set_name_type [name-type]" \
2280
2281#define volname_trivial_usage \
2282 "[DEVICE]"
2283#define volname_full_usage "\n\n" \
2284 "Show CD volume name of the DEVICE (default /dev/cdrom)"
2285
2286#define wall_trivial_usage \
2287 "[FILE]"
2288#define wall_full_usage "\n\n" \
2289 "Write content of FILE or stdin to all logged-in users"
2290#define wall_sample_usage \
2291 "echo foo | wall\n" \
2292 "wall ./mymessage"
2293
2294#define watch_trivial_usage \
2295 "[-n SEC] [-t] PROG ARGS"
2296#define watch_full_usage "\n\n" \
2297 "Run PROG periodically\n" \
2298 "\nOptions:" \
2299 "\n -n Loop period in seconds (default 2)" \
2300 "\n -t Don't print header" \
2301
2302#define watch_example_usage \
2303 "$ watch date\n" \
2304 "Mon Dec 17 10:31:40 GMT 2000\n" \
2305 "Mon Dec 17 10:31:42 GMT 2000\n" \
2306 "Mon Dec 17 10:31:44 GMT 2000"
2307
2308#define watchdog_trivial_usage \
2309 "[-t N[ms]] [-T N[ms]] [-F] DEV"
2310#define watchdog_full_usage "\n\n" \
2311 "Periodically write to watchdog device DEV\n" \
2312 "\nOptions:" \
2313 "\n -T N Reboot after N seconds if not reset (default 60)" \
2314 "\n -t N Reset every N seconds (default 30)" \
2315 "\n -F Run in foreground" \
2316 "\n" \
2317 "\nUse 500ms to specify period in milliseconds" \
2318
2319#define zcip_trivial_usage \
2320 "[OPTIONS] IFACE SCRIPT"
2321#define zcip_full_usage "\n\n" \
2322 "Manage a ZeroConf IPv4 link-local address\n" \
2323 "\nOptions:" \
2324 "\n -f Run in foreground" \
2325 "\n -q Quit after obtaining address" \
2326 "\n -r 169.254.x.x Request this address first" \
2327 "\n -v Verbose" \
2328 "\n" \
2329 "\nWith no -q, runs continuously monitoring for ARP conflicts," \
2330 "\nexits only on I/O errors (link down etc)" \
2331
2332
2333#endif 22#endif
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2026-01-21 07:00:00 +0000