1 /* vi: set sw=8 ts=8: */
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:
8 * |<7 spaces>"text with tabs"....
11 #ifndef __BB_USAGE_H__
12 #define __BB_USAGE_H__
14 #define addgroup_trivial_usage \
15 "[-g GID]"USE_FEATURE_ADDUSER_TO_GROUP(" [user_name]")" group_name"
16 #define addgroup_full_usage \
17 "Add a group to the system"USE_FEATURE_ADDUSER_TO_GROUP(" or add an user to a group") \
21 #define adduser_trivial_usage \
23 #define adduser_full_usage \
24 "Add a user to the system" \
26 " -h DIR Home directory\n" \
27 " -g GECOS GECOS field\n" \
28 " -s SHELL Login shell\n" \
29 " -G GROUP Add user to existing group\n" \
30 " -S Create a system user\n" \
31 " -D Do not assign a password\n" \
32 " -H Do not create home directory"
34 #define adjtimex_trivial_usage \
35 "[-q] [-o offset] [-f frequency] [-p timeconstant] [-t tick]"
36 #define adjtimex_full_usage \
37 "Read and optionally set system timebase parameters.\n" \
41 " -o offset Time offset, microseconds\n" \
42 " -f frequency Frequency adjust, integer kernel units (65536 is 1ppm)\n" \
43 " (positive values make clock run faster)\n" \
44 " -t tick Microseconds per tick, usually 10000\n" \
47 #define ar_trivial_usage \
48 "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
49 #define ar_full_usage \
50 "Extract or list FILES from an ar archive" \
52 " -o Preserve original dates\n" \
53 " -p Extract to stdout\n" \
58 #define arp_trivial_usage \
60 "[-vn] [-H type] [-i if] -a [hostname]\n" \
61 "[-v] [-i if] -d hostname [pub]\n" \
62 "[-v] [-H type] [-i if] -s hostname hw_addr [temp]\n" \
63 "[-v] [-H type] [-i if] -s hostname hw_addr [netmask nm] pub\n" \
64 "[-v] [-H type] [-i if] -Ds hostname ifa [netmask nm] pub\n"
65 #define arp_full_usage \
66 "Manipulate the system ARP cache" \
68 "\n -a Display (all) hosts" \
69 "\n -s Set a new ARP entry" \
70 "\n -d Delete a specified entry" \
72 "\n -n Don't resolve names" \
73 "\n -i if Network interface (e.g. eth0)" \
74 "\n -D Read <hwaddr> from given device" \
75 "\n -A, -p Protocol family" \
76 "\n -H hwtype Hardware address type"
78 #define arping_trivial_usage \
79 "[-fqbDUA] [-c count] [-w timeout] [-i device] [-s sender] target"
80 #define arping_full_usage \
81 "Ping hosts by ARP requests/replies" \
83 " -f Quit on first ARP reply\n" \
85 " -b Keep broadcasting, don't go unicast\n" \
86 " -D Duplicated address detection mode\n" \
87 " -U Unsolicited ARP mode, update your neighbours\n" \
88 " -A ARP answer mode, update your neighbours\n" \
89 " -c count Stop after sending count ARP request packets\n" \
90 " -w timeout Time to wait for ARP reply, in seconds\n" \
91 " -I device Outgoing interface name, default is eth0\n" \
92 " -s sender Set specific sender IP address\n" \
93 " target Target IP address of ARP request"
95 #define ash_trivial_usage \
97 "or: ash -c command [args]..."
98 #define ash_full_usage \
99 "The ash shell (command interpreter)"
101 #define awk_trivial_usage \
102 "[OPTION]... [program-text] [FILE...]"
103 #define awk_full_usage \
105 " -v var=val Set variable\n" \
106 " -F sep Use sep as field separator\n" \
107 " -f file Read program from file"
109 #define basename_trivial_usage \
111 #define basename_full_usage \
112 "Strip directory path and suffixes from FILE.\n" \
113 "If specified, also remove any trailing SUFFIX."
114 #define basename_example_usage \
115 "$ basename /usr/local/bin/foo\n" \
117 "$ basename /usr/local/bin/\n" \
119 "$ basename /foo/bar.txt .txt\n" \
122 #define bunzip2_trivial_usage \
124 #define bunzip2_full_usage \
125 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
127 " -c Write output to standard output\n" \
130 #define bzip2_trivial_usage \
131 "[OPTION]... [FILE]..."
132 #define bzip2_full_usage \
133 "Compress FILE(s) with bzip2 algorithm.\n" \
134 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
136 "\n -c Write output to standard output instead of FILE.bz2" \
139 "\n -1..-9 Compression level"
141 #define busybox_notes_usage \
144 #define bzcat_trivial_usage \
146 #define bzcat_full_usage \
147 "Uncompress to stdout"
149 #define unlzma_trivial_usage \
151 #define unlzma_full_usage \
152 "Uncompress FILE (or standard input if FILE is '-' or omitted)" \
154 " -c Write output to standard output\n" \
157 #define lzmacat_trivial_usage \
159 #define lzmacat_full_usage \
160 "Uncompress to stdout"
162 #define cal_trivial_usage \
163 "[-jy] [[month] year]"
164 #define cal_full_usage \
165 "Display a calendar" \
167 "\n -j Use julian dates" \
168 "\n -y Display the entire year"
170 #define cat_trivial_usage \
172 #define cat_full_usage \
173 "Concatenate FILE(s) and print them to stdout" \
175 "\n -u Use unbuffered i/o (ignored)"
176 #define cat_example_usage \
177 "$ cat /proc/uptime\n" \
180 #define catv_trivial_usage \
182 #define catv_full_usage \
183 "Display nonprinting characters as ^x or M-x" \
185 " -e End each line with $\n" \
186 " -t Show tabs as ^I\n" \
187 " -v Don't use ^x or M-x escapes"
188 #define chattr_trivial_usage \
189 "[-R] [-+=AacDdijsStTu] [-v version] files..."
190 #define chattr_full_usage \
191 "Change file attributes on an ext2 fs\n\n" \
193 " - Remove attributes\n" \
194 " + Add attributes\n" \
195 " = Set attributes\n" \
197 " A Don't track atime\n" \
198 " a Append mode only\n" \
199 " c Enable compress\n" \
200 " D Write dir contents synchronously\n" \
201 " d Do not backup with dump\n" \
202 " i Cannot be modified (immutable)\n" \
203 " j Write all data to journal first\n" \
204 " s Zero disk storage when deleted\n" \
205 " S Write file contents synchronously\n" \
206 " t Disable tail-merging of partial blocks with other files\n" \
207 " u Allow file to be undeleted\n" \
209 " -R Recursively list subdirectories\n" \
210 " -v Set the file's version/generation number"
212 #define chcon_trivial_usage \
213 "[OPTIONS] CONTEXT FILE..." \
214 "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \
215 USE_FEATURE_CHCON_LONG_OPTIONS( \
216 "\n chcon [OPTIONS] --reference=RFILE FILE..." \
218 #define chcon_full_usage \
219 "Change the security context of each FILE to CONTEXT\n" \
220 USE_FEATURE_CHCON_LONG_OPTIONS( \
221 "\n -v,--verbose Verbose" \
222 "\n -c,--changes Report changes made" \
223 "\n -h,--no-dereference Affect symlinks instead of their targets" \
224 "\n -f,--silent,--quiet Suppress most error messages" \
225 "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \
226 "\n -u,--user=USER Set user USER in the target security context" \
227 "\n -r,--role=ROLE Set role ROLE in the target security context" \
228 "\n -t,--type=TYPE Set type TYPE in the target security context" \
229 "\n -l,--range=RANGE Set range RANGE in the target security context" \
230 "\n -R,--recursive Recurse subdirectories" \
232 SKIP_FEATURE_CHCON_LONG_OPTIONS( \
234 "\n -c Report changes made" \
235 "\n -h Affect symlinks instead of their targets" \
236 "\n -f Suppress most error messages" \
237 "\n -u USER Set user USER in the target security context" \
238 "\n -r ROLE Set role ROLE in the target security context" \
239 "\n -t TYPE Set type TYPE in the target security context" \
240 "\n -l RNG Set range RNE in the target security context" \
241 "\n -R Recurse subdirectories" \
245 #define chmod_trivial_usage \
246 "[-R"USE_DESKTOP("cvf")"] MODE[,MODE]... FILE..."
247 #define chmod_full_usage \
248 "Each MODE is one or more of the letters ugoa, one of the\n" \
249 "symbols +-= and one or more of the letters rwxst" \
251 "\n -R Recurse directories" \
253 "\n -c List changed files" \
254 "\n -v List all files" \
255 "\n -f Hide errors" \
257 #define chmod_example_usage \
258 "$ ls -l /tmp/foo\n" \
259 "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \
260 "$ chmod u+x /tmp/foo\n" \
261 "$ ls -l /tmp/foo\n" \
262 "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \
263 "$ chmod 444 /tmp/foo\n" \
264 "$ ls -l /tmp/foo\n" \
265 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
267 #define chgrp_trivial_usage \
268 "[-RhLHP"USE_DESKTOP("cvf")"]... GROUP FILE..."
269 #define chgrp_full_usage \
270 "Change the group membership of each FILE to GROUP" \
272 "\n -R Recurse directories" \
273 "\n -h Affect symlinks instead of symlink targets" \
274 "\n -L Traverse all symlinks to directories" \
275 "\n -H Traverse symlinks on command line only" \
276 "\n -P Do not traverse symlinks (default)" \
278 "\n -c List changed files" \
280 "\n -f Hide errors" \
282 #define chgrp_example_usage \
283 "$ ls -l /tmp/foo\n" \
284 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
285 "$ chgrp root /tmp/foo\n" \
286 "$ ls -l /tmp/foo\n" \
287 "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n"
289 #define chown_trivial_usage \
290 "[-RhLHP"USE_DESKTOP("cvf")"]... OWNER[<.|:>[GROUP]] FILE..."
291 #define chown_full_usage \
292 "Change the owner and/or group of each FILE to OWNER and/or GROUP" \
294 "\n -R Recurse directories" \
295 "\n -h Affect symlinks instead of symlink targets" \
296 "\n -L Traverse all symlinks to directories" \
297 "\n -H Traverse symlinks on command line only" \
298 "\n -P Do not traverse symlinks (default)" \
300 "\n -c List changed files" \
301 "\n -v List all files" \
302 "\n -f Hide errors" \
304 #define chown_example_usage \
305 "$ ls -l /tmp/foo\n" \
306 "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
307 "$ chown root /tmp/foo\n" \
308 "$ ls -l /tmp/foo\n" \
309 "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
310 "$ chown root.root /tmp/foo\n" \
312 "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
314 #define chpst_trivial_usage \
315 "[-vP012] [-u user[:group]] [-U user[:group]] [-e dir] " \
316 "[-/ dir] [-n nice] [-m bytes] [-d bytes] [-o files] " \
317 "[-p processes] [-f bytes] [-c bytes] prog args"
318 #define chpst_full_usage \
319 "Change the process state and run specified program" \
321 " -u user[:grp] Set uid and gid\n" \
322 " -U user[:grp] Set environment variables UID and GID\n" \
323 " -e dir Set environment variables as specified by files\n" \
324 " in the directory: file=1st_line_of_file\n" \
325 " -/ dir Chroot to dir\n" \
326 " -n inc Add inc to nice value\n" \
327 " -m bytes Limit data segment, stack segment, locked physical pages,\n" \
328 " and total of all segment per process to bytes bytes each\n" \
329 " -d bytes Limit data segment\n" \
330 " -o n Limit the number of open file descriptors per process to n\n" \
331 " -p n Limit number of processes per uid to n\n" \
332 " -f bytes Limit output file size to bytes bytes\n" \
333 " -c bytes Limit core file size to bytes bytes\n" \
335 " -P Run prog in a new process group\n" \
336 " -0 Close standard input\n" \
337 " -1 Close standard output\n" \
338 " -2 Close standard error"
339 #define setuidgid_trivial_usage \
341 #define setuidgid_full_usage \
342 "Set uid and gid to account's uid and gid, removing all supplementary\n" \
343 "groups, then run prog"
344 #define envuidgid_trivial_usage \
346 #define envuidgid_full_usage \
347 "Set $UID to account's uid and $GID to account's gid, then run prog"
348 #define envdir_trivial_usage \
350 #define envdir_full_usage \
351 "Set various environment variables as specified by files\n" \
352 "in the directory dir, then run prog"
353 #define softlimit_trivial_usage \
354 "[-a allbytes] [-c corebytes] [-d databytes] [-f filebytes] " \
355 "[-l lockbytes] [-m membytes] [-o openfiles] [-p processes] " \
356 "[-r residentbytes] [-s stackbytes] [-t cpusecs] prog args"
357 #define softlimit_full_usage \
358 "Set soft resource limits, then run prog" \
360 " -m n Same as -d n -s n -l n -a n\n" \
361 " -d n Limit the data segment per process to n bytes\n" \
362 " -s n Limit the stack segment per process to n bytes\n" \
363 " -l n Limit the locked physical pages per process to n bytes\n" \
364 " -a n Limit the total of all segments per process to n bytes\n" \
365 " -o n Limit the number of open file descriptors per process to n\n" \
366 " -p n Limit the number of processes per uid to n\n" \
367 "Options controlling file sizes:\n" \
368 " -f n Limit output file sizes to n bytes\n" \
369 " -c n Limit core file sizes to n bytes\n" \
370 "Efficiency opts:\n" \
371 " -r n Limit the resident set size to n bytes. This limit is not\n" \
372 " enforced unless physical memory is full\n" \
373 " -t n Limit the CPU time to n seconds. This limit is not enforced\n" \
374 " except that the process receives a SIGXCPU signal after n seconds\n" \
376 "Some options may have no effect on some operating systems\n" \
377 "n may be =, indicating that soft limit should be set equal to hard limit"
379 #define chroot_trivial_usage \
380 "NEWROOT [COMMAND...]"
381 #define chroot_full_usage \
382 "Run COMMAND with root directory set to NEWROOT"
383 #define chroot_example_usage \
384 "$ ls -l /bin/ls\n" \
385 "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \
386 "# mount /dev/hdc1 /mnt -t minix\n" \
388 "# ls -l /bin/ls\n" \
389 "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n"
391 #define chvt_trivial_usage \
393 #define chvt_full_usage \
394 "Change the foreground virtual terminal to /dev/ttyN"
396 #define cksum_trivial_usage \
398 #define cksum_full_usage \
399 "Calculate the CRC32 checksums of FILES"
401 #define clear_trivial_usage \
403 #define clear_full_usage \
406 #define cmp_trivial_usage \
407 "[-l] [-s] FILE1 [FILE2" USE_DESKTOP(" [SKIP1 [SKIP2]") "]]"
408 #define cmp_full_usage \
409 "Compares FILE1 vs stdin if FILE2 is not specified" \
411 " -l Write the byte numbers (decimal) and values (octal)\n" \
412 " for all differing bytes\n" \
415 #define comm_trivial_usage \
417 #define comm_full_usage \
418 "Compare FILE1 to FILE2, or to stdin if - is specified" \
420 " -1 Suppress lines unique to FILE1\n" \
421 " -2 Suppress lines unique to FILE2\n" \
422 " -3 Suppress lines common to both files"
424 #define bbconfig_trivial_usage \
426 #define bbconfig_full_usage \
427 "Print the config file which built busybox"
429 #define bbsh_trivial_usage \
431 "or: bbsh -c command [args]..."
432 #define bbsh_full_usage \
433 "The bbsh shell (command interpreter)"
435 #define chrt_trivial_usage \
436 "[OPTION]... [prio] [pid | command [arg]...]"
437 #define chrt_full_usage \
438 "manipulate real-time attributes of a process" \
440 " -p operate on pid\n" \
441 " -r set scheduling policy to SCHED_RR\n" \
442 " -f set scheduling policy to SCHED_FIFO\n" \
443 " -o set scheduling policy to SCHED_OTHER\n" \
444 " -m show min and max priorities"
446 #define chrt_example_usage \
447 "$ chrt -r 4 sleep 900; x=$!\n" \
448 "$ chrt -f -p 3 $x\n" \
449 "You need CAP_SYS_NICE privileges to set scheduling attributes of a process"
451 #define cp_trivial_usage \
452 "[OPTION]... SOURCE DEST"
453 #define cp_full_usage \
454 "Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY" \
456 "\n -a Same as -dpR" \
458 "\n -c Preserves security context" \
460 "\n -d,-P Preserve links" \
461 "\n -H,-L Dereference all symlinks (default)" \
462 "\n -p Preserve file attributes if possible" \
463 "\n -f Force overwrite" \
464 "\n -i Prompt before overwrite" \
465 "\n -R,-r Recurse directories" \
466 "\n -l,-s Create (sym)links"
468 #define cpio_trivial_usage \
469 "-[dimtuv][F cpiofile]"
470 #define cpio_full_usage \
471 "Extract or list files from a cpio archive\n" \
472 "Main operation mode:\n" \
473 " d Make leading directories\n" \
475 " m Preserve mtime\n" \
478 " u Unconditional overwrite\n" \
481 #define crond_trivial_usage \
482 "-d[#] -c crondir -f -b"
483 #define crond_full_usage \
484 " -d [#] -l [#] -S -L logfile -f -b -c dir\n" \
485 " -d num Debug level\n" \
486 " -l num Log level (8 - default)\n" \
487 " -S Log to syslog (default)\n" \
488 " -L file Log to file\n" \
489 " -f Run in foreground\n" \
490 " -b Run in background (default)\n" \
491 " -c dir Working dir"
493 #define crontab_trivial_usage \
494 "[-c dir] {file|-}|[-u|-l|-e|-d user]"
495 #define crontab_full_usage \
496 " file [opts] Replace crontab from file\n" \
497 " - [opts] Replace crontab from stdin\n" \
499 " -l [user] List crontab for user\n" \
500 " -e [user] Edit crontab for user\n" \
501 " -d [user] Delete crontab for user\n" \
502 " -c dir Crontab directory"
504 #define cryptpw_trivial_usage \
505 "[-a des|md5] [string]"
506 #define cryptpw_full_usage \
507 "Outputs crypted string.\n" \
508 "If string isn't supplied on cmdline, reads it from stdin.\n" \
510 "\n -a Algorithm to use (default: md5)"
512 #define cut_trivial_usage \
513 "[OPTION]... [FILE]..."
514 #define cut_full_usage \
515 "Print selected fields from each input FILE to standard output" \
517 " -b LIST Output only bytes from LIST\n" \
518 " -c LIST Output only characters from LIST\n" \
519 " -d CHAR Use CHAR instead of tab as the field delimiter\n" \
520 " -s Output only the lines containing delimiter\n" \
521 " -f N Print only these fields\n" \
523 #define cut_example_usage \
524 "$ echo \"Hello world\" | cut -f 1 -d ' '\n" \
526 "$ echo \"Hello world\" | cut -f 2 -d ' '\n" \
529 #define date_trivial_usage \
530 "[OPTION]... [MMDDhhmm[[CC]YY][.ss]] [+FORMAT]"
531 #define date_full_usage \
532 "Display current time in the given FORMAT, or set system date" \
534 " -R Outputs RFC-822 compliant date string\n" \
535 " -d STRING Displays time described by STRING, not 'now'\n" \
536 USE_FEATURE_DATE_ISOFMT( \
537 " -I[TIMESPEC] Outputs an ISO-8601 compliant date/time string\n" \
538 " TIMESPEC='date' (or missing) for date only,\n" \
539 " 'hours', 'minutes', or 'seconds' for date and\n" \
540 " time to the indicated precision\n" \
541 " -D hint Use 'hint' as date format, via strptime()\n" \
543 " -s STRING Sets time described by STRING\n" \
544 " -r FILE Displays the last modification time of FILE\n" \
545 " -u Prints or sets Coordinated Universal Time"
546 #define date_example_usage \
548 "Wed Apr 12 18:52:41 MDT 2000\n"
550 #define dc_trivial_usage \
552 #define dc_full_usage \
553 "This is a Tiny RPN calculator that understands the\n" \
554 "following operations: +, add, -, sub, *, mul, /, div, %, mod, " \
555 "**, exp, and, or, not, eor.\n" \
556 "For example: 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16." \
558 "p - Prints the value on the top of the stack, without altering the stack\n" \
559 "f - Prints the entire contents of the stack without altering anything\n" \
560 "o - Pops the value off the top of the stack and uses it to set the output radix\n" \
561 " Only 10 and 16 are supported"
562 #define dc_example_usage \
565 "$ dc 8 8 \\* 2 2 + / p\n" \
571 "$ echo 72 9 div 8 mul p | dc\n" \
574 #define dd_trivial_usage \
575 "[if=FILE] [of=FILE] " USE_FEATURE_DD_IBS_OBS("[ibs=N] [obs=N] ") "[bs=N] [count=N] [skip=N]\n" \
576 " [seek=N]" USE_FEATURE_DD_IBS_OBS(" [conv=notrunc|noerror|sync]")
577 #define dd_full_usage \
578 "Copy a file with converting and formatting" \
580 " if=FILE Read from FILE instead of stdin\n" \
581 " of=FILE Write to FILE instead of stdout\n" \
582 " bs=N Read and write N bytes at a time\n" \
583 USE_FEATURE_DD_IBS_OBS( \
584 " ibs=N Read N bytes at a time\n") \
585 USE_FEATURE_DD_IBS_OBS( \
586 " obs=N Write N bytes at a time\n") \
587 " count=N Copy only N input blocks\n" \
588 " skip=N Skip N input blocks\n" \
589 " seek=N Skip N output blocks\n" \
590 USE_FEATURE_DD_IBS_OBS( \
591 " conv=notrunc Don't truncate output file\n" \
592 " conv=noerror Continue after read errors\n" \
593 " conv=sync Pad blocks with zeros\n") \
595 "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \
596 "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)"
597 #define dd_example_usage \
598 "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \
602 #define deallocvt_trivial_usage \
604 #define deallocvt_full_usage \
605 "Deallocate unused virtual terminal /dev/ttyN"
607 #define delgroup_trivial_usage \
608 USE_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
609 #define delgroup_full_usage \
610 "Delete group GROUP from the system" \
611 USE_FEATURE_DEL_USER_FROM_GROUP(" or user USER from group GROUP")
613 #define deluser_trivial_usage \
615 #define deluser_full_usage \
616 "Delete user USER from the system"
618 #define devfsd_trivial_usage \
620 USE_DEVFSD_FG_NP("[-fg][-np]")
621 #define devfsd_full_usage \
622 "Manage devfs permissions and old device name symlinks" \
624 "\n mntpnt The mount point where devfs is mounted" \
625 "\n -v Print the protocol version numbers for devfsd" \
626 "\n and the kernel-side protocol version and exit" \
628 "\n -fg Run in foreground" \
629 "\n -np Exit after parsing the configuration file" \
630 "\n and processing synthetic REGISTER events," \
631 "\n do not poll for events")
633 /* -k is accepted but ignored for !HUMAN_READABLE,
634 * but we won't mention this (unimportant) */
635 #if ENABLE_FEATURE_HUMAN_READABLE || ENABLE_FEATURE_DF_INODE
636 #define DF_HAS_OPTIONS(x) x
638 #define DF_HAS_OPTIONS(x)
640 #define df_trivial_usage \
641 DF_HAS_OPTIONS("[-") \
642 USE_FEATURE_HUMAN_READABLE("hmk") USE_FEATURE_DF_INODE("i") \
643 DF_HAS_OPTIONS("] ") "[FILESYSTEM...]"
644 #define df_full_usage \
645 "Print filesystem usage statistics" \
646 DF_HAS_OPTIONS("\n\nOptions:") \
647 USE_FEATURE_HUMAN_READABLE( \
648 "\n -h Human readable (e.g. 1K 243M 2G)" \
649 "\n -m 1024*1024 blocks" \
650 "\n -k 1024 blocks" \
652 USE_FEATURE_DF_INODE( \
655 #define df_example_usage \
657 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
658 "/dev/sda3 8690864 8553540 137324 98% /\n" \
659 "/dev/sda1 64216 36364 27852 57% /boot\n" \
661 "Filesystem 1k-blocks Used Available Use% Mounted on\n" \
662 "/dev/sda3 8690864 8553540 137324 98% /\n"
664 #define dhcprelay_trivial_usage \
665 "[client_device_list] [server_device]"
666 #define dhcprelay_full_usage \
667 "Relay dhcp requests from client devices to server device"
669 #define dhcprelay_trivial_usage \
670 "[client_device_list] [server_device]"
671 #define dhcprelay_full_usage \
672 "Relay dhcp requests from client devices to server device"
674 #define diff_trivial_usage \
675 "[-abdiNqrTstw] [-L LABEL] [-S FILE] [-U LINES] FILE1 FILE2"
676 #define diff_full_usage \
677 "Compare files line by line and output the differences between them.\n" \
678 "This diff implementation only supports unified diffs." \
680 " -a Treat all files as text\n" \
681 " -b Ignore changes in the amount of whitespace\n" \
682 " -d Try hard to find a smaller set of changes\n" \
683 " -i Ignore case differences\n" \
684 " -L Use LABEL instead of the filename in the unified header\n" \
685 " -N Treat absent files as empty\n" \
686 " -q Output only whether files differ\n" \
687 " -r Recursively compare subdirectories\n" \
688 " -S Start with FILE when comparing directories\n" \
689 " -T Make tabs line up by prefixing a tab when necessary\n" \
690 " -s Report when two files are the same\n" \
691 " -t Expand tabs to spaces in output\n" \
692 " -U Output LINES lines of context\n" \
693 " -w Ignore all whitespace"
695 #define dirname_trivial_usage \
697 #define dirname_full_usage \
698 "Strip non-directory suffix from FILENAME"
699 #define dirname_example_usage \
700 "$ dirname /tmp/foo\n" \
702 "$ dirname /tmp/foo/\n" \
705 #define dmesg_trivial_usage \
706 "[-c] [-n LEVEL] [-s SIZE]"
707 #define dmesg_full_usage \
708 "Print or control the kernel ring buffer" \
710 " -c Clear ring buffer after printing\n" \
711 " -n LEVEL Set console logging level\n" \
712 " -s SIZE Buffer size"
714 #define dnsd_trivial_usage \
715 "[-c config] [-t seconds] [-p port] [-i iface-ip] [-d]"
716 #define dnsd_full_usage \
717 "Small and static DNS server daemon" \
719 " -c Config filename\n" \
720 " -t TTL in seconds\n" \
721 " -p Listening port\n" \
722 " -i Listening ip (default all)\n" \
725 #define dos2unix_trivial_usage \
727 #define dos2unix_full_usage \
728 "Convert FILE from dos format to unix format. When no option\n" \
729 "is given, the input is converted to the opposite output format.\n" \
730 "When no file is given, use stdin for input and stdout for output." \
732 " -u Output will be in UNIX format\n" \
733 " -d Output will be in DOS format"
735 #define dpkg_trivial_usage \
736 "[-ilCPru] [-F option] package_name"
737 #define dpkg_full_usage \
738 "Install, remove and manage Debian packages" \
740 " -i Install the package\n" \
741 " -l List of installed packages\n" \
742 " -C Configure an unpackaged package\n" \
743 " -F depends Ignore dependency problems\n" \
744 " -P Purge all files of a package\n" \
745 " -r Remove all but the configuration files for a package\n" \
746 " -u Unpack a package, but don't configure it"
748 #define dpkg_deb_trivial_usage \
749 "[-cefxX] FILE [argument]"
750 #define dpkg_deb_full_usage \
751 "Perform actions on Debian packages (.debs)" \
753 " -c List contents of filesystem tree\n" \
754 " -e Extract control files to [argument] directory\n" \
755 " -f Display control field name starting with [argument]\n" \
756 " -x Extract packages filesystem tree to directory\n" \
757 " -X Verbose extract"
758 #define dpkg_deb_example_usage \
759 "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n"
761 #define du_trivial_usage \
762 "[-aHLdclsx" USE_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
763 #define du_full_usage \
764 "Summarize disk space used for each FILE and/or directory.\n" \
765 "Disk space is printed in units of " \
766 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024") \
767 SKIP_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512") \
770 " -a Show sizes of files in addition to directories\n" \
771 " -H Follow symlinks that are FILE command line args\n" \
772 " -L Follow all symlinks encountered\n" \
773 " -d N Limit output to directories (and files with -a) of depth < N\n" \
774 " -c Output a grand total\n" \
775 " -l Count sizes many times if hard linked\n" \
776 " -s Display only a total for each argument\n" \
777 " -x Skip directories on different filesystems\n" \
778 USE_FEATURE_HUMAN_READABLE( \
779 " -h Print sizes in human readable format (e.g., 1K 243M 2G )\n" \
780 " -m Print sizes in megabytes\n" \
782 " -k Print sizes in kilobytes" \
783 USE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("(default)")
784 #define du_example_usage \
787 "12 ./kernel-patches/CVS\n" \
788 "80 ./kernel-patches\n" \
791 "12 ./scripts/CVS\n" \
797 #define dumpkmap_trivial_usage \
799 #define dumpkmap_full_usage \
800 "Print out a binary keyboard translation table to standard output"
801 #define dumpkmap_example_usage \
802 "$ dumpkmap > keymap\n"
804 #define dumpleases_trivial_usage \
805 "[-r|-a] [-f LEASEFILE]"
806 #define dumpleases_full_usage \
807 "Display DHCP leases granted by udhcpd" \
810 " -f,--file=FILE Leases file to load\n" \
811 " -r,--remaining Interpret lease times as time remaining\n" \
812 " -a,--absolute Interpret lease times as expire time" \
815 " -f FILE Leases file to load\n" \
816 " -r Interpret lease times as time remaining\n" \
817 " -a Interpret lease times as expire time" \
820 #define e2fsck_trivial_usage \
821 "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \
822 "[-I inode_buffer_blocks] [-P process_inode_size] " \
823 "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \
824 "[-E extended-options] device"
825 #define e2fsck_full_usage \
826 "Check ext2/ext3 file system" \
828 " -p Automatic repair (no questions)\n" \
829 " -n Make no changes to the filesystem\n" \
830 " -y Assume 'yes' to all questions\n" \
831 " -c Check for bad blocks and add them to the badblock list\n" \
832 " -f Force checking even if filesystem is marked clean\n" \
834 " -b superblock Use alternative superblock\n" \
835 " -B blocksize Force blocksize when looking for superblock\n" \
836 " -j journal Set location of the external journal\n" \
837 " -l file Add to badblocks list\n" \
838 " -L file Set badblocks list"
840 #define echo_trivial_usage \
841 USE_FEATURE_FANCY_ECHO("[-neE] ") "[ARG...]"
842 #define echo_full_usage \
843 "Print the specified ARGs to stdout" \
844 USE_FEATURE_FANCY_ECHO( \
846 " -n Suppress trailing newline\n" \
847 " -e Interpret backslash-escaped characters (i.e., \\t=tab)\n" \
848 " -E Disable interpretation of backslash-escaped characters" \
850 #define echo_example_usage \
851 "$ echo \"Erik is cool\"\n" \
853 USE_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n" \
857 "$ echo \"Erik\\nis\\ncool\"\n" \
858 "Erik\\nis\\ncool\n")
860 #define eject_trivial_usage \
862 #define eject_full_usage \
863 "Eject specified DEVICE (or default /dev/cdrom)" \
866 " -T Open/close tray (toggle)"
868 #define ed_trivial_usage ""
869 #define ed_full_usage ""
871 #define env_trivial_usage \
872 "[-iu] [-] [name=value]... [command]"
873 #define env_full_usage \
874 "Print the current environment or run a program after setting\n" \
875 "up the specified environment" \
877 " -, -i Start with an empty environment\n" \
878 " -u Remove variable from the environment"
880 #define ether_wake_trivial_usage \
881 "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
882 #define ether_wake_full_usage \
883 "Send a magic packet to wake up sleeping machines.\n" \
884 "MAC must be a station address (00:11:22:33:44:55) or\n" \
885 "a hostname with a known 'ethers' entry." \
887 " -b Send wake-up packet to the broadcast address\n" \
888 " -i iface Use interface ifname instead of the default \"eth0\"\n" \
889 " -p pass Append the four or six byte password PW to the packet"
891 #define expand_trivial_usage \
892 "[-i] [-t NUM] [FILE|-]"
893 #define expand_full_usage \
894 "Convert tabs to spaces, writing to standard output." \
896 USE_FEATURE_EXPAND_LONG_OPTIONS( \
897 "\n -i,--initial Do not convert tabs after non blanks" \
898 "\n -t,--tabs=N Tabstops every N chars" \
900 SKIP_FEATURE_EXPAND_LONG_OPTIONS( \
901 "\n -i Do not convert tabs after non blanks" \
902 "\n -t Tabstops every N chars" \
905 #define expr_trivial_usage \
907 #define expr_full_usage \
908 "Print the value of EXPRESSION to standard output.\n\n" \
909 "EXPRESSION may be:\n" \
910 " ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2\n" \
911 " ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0\n" \
912 " ARG1 < ARG2 1 if ARG1 is less than ARG2, else 0. Similarly:\n" \
918 " ARG1 + ARG2 Sum of ARG1 and ARG2. Similarly:\n" \
923 " STRING : REGEXP Anchored pattern match of REGEXP in STRING\n" \
924 " match STRING REGEXP Same as STRING : REGEXP\n" \
925 " substr STRING POS LENGTH Substring of STRING, POS counted from 1\n" \
926 " index STRING CHARS Index in STRING where any CHARS is found, or 0\n" \
927 " length STRING Length of STRING\n" \
928 " quote TOKEN Interpret TOKEN as a string, even if\n" \
929 " it is a keyword like 'match' or an\n" \
930 " operator like '/'\n" \
931 " (EXPRESSION) Value of EXPRESSION\n\n" \
932 "Beware that many operators need to be escaped or quoted for shells.\n" \
933 "Comparisons are arithmetic if both ARGs are numbers, else\n" \
934 "lexicographical. Pattern matches return the string matched between\n" \
935 "\\( and \\) or null; if \\( and \\) are not used, they return the number\n" \
936 "of characters matched or 0."
938 #define fakeidentd_trivial_usage \
939 "[-fiw] [-b ADDR] [STRING]"
940 #define fakeidentd_full_usage \
941 "Provide fake ident (auth) service" \
943 "\n -f Run in foreground" \
945 "\n -w Inetd 'wait' mode" \
946 "\n -b ADDR Bind to specified address" \
947 "\n STRING Ident answer string (default is 'nobody')"
949 #define false_trivial_usage \
951 #define false_full_usage \
952 "Return an exit code of FALSE (1)"
953 #define false_example_usage \
958 #define fbset_trivial_usage \
960 #define fbset_full_usage \
961 "Show and modify frame buffer settings"
962 #define fbset_example_usage \
964 "mode \"1024x768-76\"\n" \
965 " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \
966 " geometry 1024 768 1024 768 16\n" \
967 " timings 12714 128 32 16 4 128 4\n" \
969 " rgba 5/11,6/5,5/0,0/0\n" \
972 #define fdflush_trivial_usage \
974 #define fdflush_full_usage \
975 "Force floppy disk drive to detect disk change"
977 #define fdformat_trivial_usage \
979 #define fdformat_full_usage \
980 "Format floppy disk" \
982 " -n Don't verify after format"
984 #define fdisk_trivial_usage \
985 "[-luv] [-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK"
986 #define fdisk_full_usage \
987 "Change partition table" \
989 " -l List partition table(s)\n" \
990 " -u Give Start and End in sector (instead of cylinder) units\n" \
991 " -s PARTITION Give partition size(s) in blocks\n" \
992 " -b 2048 (for certain MO disks) use 2048-byte sectors\n" \
993 " -C CYLINDERS Set the number of cylinders\n" \
994 " -H HEADS Set the number of heads\n" \
995 " -S SECTORS Set the number of sectors\n" \
996 " -v Give fdisk version"
998 #define find_trivial_usage \
999 "[PATH...] [EXPRESSION]"
1000 #define find_full_usage \
1001 "Search for files in a directory hierarchy. The default PATH is\n" \
1002 "the current directory, default EXPRESSION is '-print'\n" \
1003 "\nEXPRESSION may consist of:" \
1004 "\n -follow Dereference symlinks" \
1005 USE_FEATURE_FIND_XDEV( \
1006 "\n -xdev Don't descend directories on other filesystems") \
1007 USE_FEATURE_FIND_MAXDEPTH( \
1008 "\n -maxdepth N Descend at most N levels. -maxdepth 0 applies" \
1009 "\n tests/actions to command line arguments only") \
1010 "\n -name PATTERN File name (w/o directory name) matches PATTERN" \
1011 USE_FEATURE_FIND_PATH( \
1012 "\n -path PATTERN Path matches PATTERN") \
1013 USE_FEATURE_FIND_REGEX( \
1014 "\n -regex PATTERN Path matches regex PATTERN") \
1015 USE_FEATURE_FIND_TYPE( \
1016 "\n -type X File type is X (X is one of: f,d,l,b,c,...)") \
1017 USE_FEATURE_FIND_PERM( \
1018 "\n -perm NNN Permissions match any of (+NNN), all of (-NNN)," \
1019 "\n or exactly (NNN)") \
1020 USE_FEATURE_FIND_MTIME( \
1021 "\n -mtime DAYS Modified time is greater than (+N), less than (-N)," \
1022 "\n or exactly (N) days") \
1023 USE_FEATURE_FIND_MMIN( \
1024 "\n -mmin MINS Modified time is greater than (+N), less than (-N)," \
1025 "\n or exactly (N) minutes") \
1026 USE_FEATURE_FIND_NEWER( \
1027 "\n -newer FILE Modified time is more recent than FILE's") \
1028 USE_FEATURE_FIND_INUM( \
1029 "\n -inum N File has inode number N") \
1030 USE_FEATURE_FIND_USER( \
1031 "\n -user NAME File is owned by user NAME (numeric user ID allowed)") \
1032 USE_FEATURE_FIND_GROUP( \
1033 "\n -group NAME File belongs to group NAME (numeric group ID allowed)") \
1034 USE_FEATURE_FIND_DEPTH( \
1035 "\n -depth Process directory name after traversing it") \
1036 USE_FEATURE_FIND_SIZE( \
1037 "\n -size N[bck] File size is N (c:bytes,k:kbytes,b:512 bytes(def.))." \
1038 "\n +/-N: file size is bigger/smaller than N") \
1039 "\n -print Print (default and assumed)" \
1040 USE_FEATURE_FIND_PRINT0( \
1041 "\n -print0 Delimit output with null characters rather than" \
1043 USE_FEATURE_FIND_CONTEXT ( \
1044 "\n -context File has specified security context") \
1045 USE_FEATURE_FIND_EXEC( \
1046 "\n -exec CMD ARG ; Execute CMD with all instances of {} replaced by the" \
1047 "\n matching files") \
1048 USE_FEATURE_FIND_PRUNE( \
1049 "\n -prune Stop traversing current subtree") \
1050 USE_FEATURE_FIND_DELETE( \
1051 "\n -delete Delete files, turns on -depth option") \
1052 USE_FEATURE_FIND_PAREN( \
1053 "\n (EXPR) Group an expression") \
1055 #define find_example_usage \
1056 "$ find / -name passwd\n" \
1059 #define fold_trivial_usage \
1060 "[-bs] [-w WIDTH] [FILE]"
1061 #define fold_full_usage \
1062 "Wrap input lines in each FILE (standard input by default), writing to\n" \
1065 " -b Count bytes rather than columns\n" \
1066 " -s Break at spaces\n" \
1067 " -w Use WIDTH columns instead of 80"
1069 #define free_trivial_usage \
1071 #define free_full_usage \
1072 "Display the amount of free and used system memory"
1073 #define free_example_usage \
1075 " total used free shared buffers\n" \
1076 " Mem: 257628 248724 8904 59644 93124\n" \
1077 " Swap: 128516 8404 120112\n" \
1078 "Total: 386144 257128 129016\n" \
1080 #define freeramdisk_trivial_usage \
1082 #define freeramdisk_full_usage \
1083 "Free all memory used by the specified ramdisk"
1084 #define freeramdisk_example_usage \
1085 "$ freeramdisk /dev/ram2\n"
1087 #define fsck_trivial_usage \
1088 "[-ANPRTV] [-C fd] [-t fstype] [fs-options] [filesys...]"
1089 #define fsck_full_usage \
1090 "Check and repair filesystems" \
1092 " -A Walk /etc/fstab and check all filesystems\n" \
1093 " -N Don't execute, just show what would be done\n" \
1094 " -P When using -A, check filesystems in parallel\n" \
1095 " -R When using -A, skip the root filesystem\n" \
1096 " -T Don't show title on startup\n" \
1098 " -C n Write status information to specified filedescriptor\n" \
1099 " -t type List of filesystem types to check"
1101 #define fsck_minix_trivial_usage \
1102 "[-larvsmf] /dev/name"
1103 #define fsck_minix_full_usage \
1104 "Perform a consistency check for MINIX filesystems" \
1106 " -l List all filenames\n" \
1107 " -r Perform interactive repairs\n" \
1108 " -a Perform automatic repairs\n" \
1110 " -s Output super-block information\n" \
1111 " -m Activate MINIX-like \"mode not cleared\" warnings\n" \
1112 " -f Force file system check"
1114 #define ftpget_trivial_usage \
1115 "[options] remote-host local-file remote-file"
1116 #define ftpget_full_usage \
1117 "Retrieve a remote file via FTP" \
1120 " -c,--continue Continue previous transfer\n" \
1121 " -v,--verbose Verbose\n" \
1122 " -u,--username Username\n" \
1123 " -p,--password Password\n" \
1124 " -P,--port Port number" \
1127 " -c Continue previous transfer\n" \
1134 #define ftpput_trivial_usage \
1135 "[options] remote-host remote-file local-file"
1136 #define ftpput_full_usage \
1137 "Store a local file on a remote machine via FTP" \
1140 " -v,--verbose Verbose\n" \
1141 " -u,--username Username\n" \
1142 " -p,--password Password\n" \
1143 " -P,--port Port number" \
1152 #define fuser_trivial_usage \
1153 "[options] file OR port/proto"
1154 #define fuser_full_usage \
1156 " -m Show all processes on the same mounted fs\n" \
1157 " -k Kill all processes that match\n" \
1158 " -s Don't print or kill anything\n" \
1159 " -4 When using port/proto only search IPv4 space\n" \
1160 " -6 When using port/proto only search IPv6 space\n" \
1161 " -SIGNAL When used with -k, this signal will be used to kill"
1163 #define getenforce_trivial_usage
1164 #define getenforce_full_usage
1166 #define getopt_trivial_usage \
1168 #define getopt_full_usage \
1169 "Parse command options\n" \
1171 " -a,--alternative Allow long options starting with single -\n" \
1172 " -l,--longoptions=longopts Long options to be recognized\n" \
1173 " -n,--name=progname The name under which errors are reported\n" \
1174 " -o,--options=optstring Short options to be recognized\n" \
1175 " -q,--quiet Disable error reporting by getopt(3)\n" \
1176 " -Q,--quiet-output No normal output\n" \
1177 " -s,--shell=shell Set shell quoting conventions\n" \
1178 " -T,--test Test for getopt(1) version\n" \
1179 " -u,--unquoted Don't quote the output" \
1182 " -a Allow long options starting with single -\n" \
1183 " -l longopts Long options to be recognized\n" \
1184 " -n progname The name under which errors are reported\n" \
1185 " -o optstring Short options to be recognized\n" \
1186 " -q Disable error reporting by getopt(3)\n" \
1187 " -Q No normal output\n" \
1188 " -s shell Set shell quoting conventions\n" \
1189 " -T Test for getopt(1) version\n" \
1190 " -u Don't quote the output" \
1192 #define getopt_example_usage \
1193 "$ cat getopt.test\n" \
1195 "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \
1196 " -n 'example.busybox' -- \"$@\"`\n" \
1197 "if [ $? != 0 ]; then exit 1; fi\n" \
1198 "eval set -- \"$GETOPT\"\n" \
1199 "while true; do\n" \
1201 " -a|--a-long) echo \"Option a\"; shift;;\n" \
1202 " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \
1204 " case \"$2\" in\n" \
1205 " \"\") echo \"Option c, no argument\"; shift 2;;\n" \
1206 " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \
1208 " --) shift; break;;\n" \
1209 " *) echo \"Internal error!\"; exit 1;;\n" \
1213 #define getsebool_trivial_usage \
1214 "-a or getsebool boolean..."
1215 #define getsebool_full_usage \
1216 " -a Show all SELinux booleans"
1218 #define getty_trivial_usage \
1219 "[OPTIONS]... baud_rate,... line [termtype]"
1220 #define getty_full_usage \
1221 "Open a tty, prompt for a login name, then invoke /bin/login" \
1223 " -h Enable hardware (RTS/CTS) flow control\n" \
1224 " -i Do not display /etc/issue before running login\n" \
1225 " -L Local line, so do not do carrier detect\n" \
1226 " -m Get baud rate from modem's CONNECT status message\n" \
1227 " -w Wait for a CR or LF before sending /etc/issue\n" \
1228 " -n Do not prompt the user for a login name\n" \
1229 " -f issue_file Display issue_file instead of /etc/issue\n" \
1230 " -l login_app Invoke login_app instead of /bin/login\n" \
1231 " -t timeout Terminate after timeout if no username is read\n" \
1232 " -I initstring Sets the init string to send before anything else\n" \
1233 " -H login_host Log login_host into the utmp file as the hostname"
1235 #define grep_trivial_usage \
1239 USE_FEATURE_GREP_EGREP_ALIAS("E") \
1240 USE_FEATURE_GREP_CONTEXT("ABC") \
1241 "] PATTERN [FILEs...]"
1242 #define grep_full_usage \
1243 "Search for PATTERN in each FILE or standard input" \
1245 "\n -H Prefix output lines with filename where match was found" \
1246 "\n -h Suppress the prefixing filename on output" \
1247 "\n -r Recurse subdirectories" \
1248 "\n -i Ignore case distinctions" \
1249 "\n -l List names of files that match" \
1250 "\n -L List names of files that do not match" \
1251 "\n -n Print line number with output lines" \
1252 "\n -q Quiet. Returns 0 if PATTERN was found, 1 otherwise" \
1253 "\n -v Select non-matching lines" \
1254 "\n -s Suppress file open/read error messages" \
1255 "\n -c Only print count of matching lines" \
1256 "\n -o Show only the part of a line that matches PATTERN" \
1257 "\n -m MAX Match up to MAX times per file" \
1259 "\n -w Match whole words only") \
1260 "\n -F PATTERN is a set of newline-separated strings" \
1261 USE_FEATURE_GREP_EGREP_ALIAS( \
1262 "\n -E PATTERN is an extended regular expression") \
1263 "\n -e PTRN Pattern to match" \
1264 "\n -f FILE Read pattern from file" \
1265 USE_FEATURE_GREP_CONTEXT( \
1266 "\n -A Print NUM lines of trailing context" \
1267 "\n -B Print NUM lines of leading context" \
1268 "\n -C Print NUM lines of output context") \
1270 #define grep_example_usage \
1271 "$ grep root /etc/passwd\n" \
1272 "root:x:0:0:root:/root:/bin/bash\n" \
1273 "$ grep ^[rR]oo. /etc/passwd\n" \
1274 "root:x:0:0:root:/root:/bin/bash\n"
1276 #define gunzip_trivial_usage \
1278 #define gunzip_full_usage \
1279 "Uncompress FILE (or standard input if FILE is '-')" \
1281 " -c Write output to standard output\n" \
1283 " -t Test compressed file integrity"
1284 #define gunzip_example_usage \
1285 "$ ls -la /tmp/BusyBox*\n" \
1286 "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \
1287 "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \
1288 "$ ls -la /tmp/BusyBox*\n" \
1289 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n"
1291 #define gzip_trivial_usage \
1292 "[OPTION]... [FILE]..."
1293 #define gzip_full_usage \
1294 "Compress FILE(s) with maximum compression.\n" \
1295 "When FILE is '-' or unspecified, reads standard input. Implies -c." \
1297 " -c Write output to standard output instead of FILE.gz\n" \
1298 " -d Decompress\n" \
1300 #define gzip_example_usage \
1301 "$ ls -la /tmp/busybox*\n" \
1302 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
1303 "$ gzip /tmp/busybox.tar\n" \
1304 "$ ls -la /tmp/busybox*\n" \
1305 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
1307 #define halt_trivial_usage \
1308 "[-d delay] [-n] [-f]"
1309 #define halt_full_usage \
1312 " -d Delay interval for halting\n" \
1313 " -n No call to sync()\n" \
1314 " -f Force halt (don't go through init)"
1316 #define hdparm_trivial_usage \
1317 "[options] [device] .."
1318 #define hdparm_full_usage \
1319 USE_FEATURE_HDPARM_GET_IDENTITY( \
1320 "If no device name is specified try to read from stdin.\n\n") \
1322 " -a Get/set fs readahead\n" \
1323 " -A Set drive read-lookahead flag (0/1)\n" \
1324 " -b Get/set bus state (0 == off, 1 == on, 2 == tristate)\n" \
1325 " -B Set Advanced Power Management setting (1-255)\n" \
1326 " -c Get/set IDE 32-bit IO setting\n" \
1327 " -C Check IDE power mode status\n" \
1328 USE_FEATURE_HDPARM_HDIO_GETSET_DMA( \
1329 " -d Get/set using_dma flag\n") \
1330 " -D Enable/disable drive defect-mgmt\n" \
1331 " -f Flush buffer cache for device on exit\n" \
1332 " -g Display drive geometry\n" \
1333 " -h Display terse usage information\n" \
1334 USE_FEATURE_HDPARM_GET_IDENTITY( \
1335 " -i Display drive identification\n") \
1336 USE_FEATURE_HDPARM_GET_IDENTITY( \
1337 " -I Detailed/current information directly from drive\n") \
1338 " -k Get/set keep_settings_over_reset flag (0/1)\n" \
1339 " -K Set drive keep_features_over_reset flag (0/1)\n" \
1340 " -L Set drive doorlock (0/1) (removable harddisks only)\n" \
1341 " -m Get/set multiple sector count\n" \
1342 " -n Get/set ignore-write-errors flag (0/1)\n" \
1343 " -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)\n" \
1344 " -P Set drive prefetch count\n" \
1345 " -q Change next setting quietly\n" \
1346 " -Q Get/set DMA tagged-queuing depth (if supported)\n" \
1347 " -r Get/set readonly flag (DANGEROUS to set)\n" \
1348 USE_FEATURE_HDPARM_HDIO_SCAN_HWIF( \
1349 " -R Register an IDE interface (DANGEROUS)\n") \
1350 " -S Set standby (spindown) timeout\n" \
1351 " -t Perform device read timings\n" \
1352 " -T Perform cache read timings\n" \
1353 " -u Get/set unmaskirq flag (0/1)\n" \
1354 USE_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \
1355 " -U Un-register an IDE interface (DANGEROUS)\n") \
1356 " -v Defaults; same as -mcudkrag for IDE drives\n" \
1357 " -V Display program version and exit immediately\n" \
1358 USE_FEATURE_HDPARM_HDIO_DRIVE_RESET( \
1359 " -w Perform device reset (DANGEROUS)\n") \
1360 " -W Set drive write-caching flag (0/1) (DANGEROUS)\n" \
1361 USE_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \
1362 " -x Tristate device for hotswap (0/1) (DANGEROUS)\n") \
1363 " -X Set IDE xfer mode (DANGEROUS)\n" \
1364 " -y Put IDE drive in standby mode\n" \
1365 " -Y Put IDE drive to sleep\n" \
1366 " -Z Disable Seagate auto-powersaving mode\n" \
1367 " -z Re-read partition table"
1369 #define head_trivial_usage \
1370 "[OPTION]... [FILE]..."
1371 #define head_full_usage \
1372 "Print first 10 lines of each FILE to standard output.\n" \
1373 "With more than one FILE, precede each with a header giving the\n" \
1374 "file name. With no FILE, or when FILE is -, read standard input." \
1376 "\n -n NUM Print first NUM lines instead of first 10" \
1377 USE_FEATURE_FANCY_HEAD( \
1378 "\n -c NUM Output the first NUM bytes" \
1379 "\n -q Never output headers giving file names" \
1380 "\n -v Always output headers giving file names")
1381 #define head_example_usage \
1382 "$ head -n 2 /etc/passwd\n" \
1383 "root:x:0:0:root:/root:/bin/bash\n" \
1384 "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n"
1386 #define hexdump_trivial_usage \
1387 "[-bcCdefnosvx" USE_FEATURE_HEXDUMP_REVERSE("R") "] FILE..."
1388 #define hexdump_full_usage \
1389 "Display file(s) or standard input in a user specified format" \
1391 "\n -b One-byte octal display" \
1392 "\n -c One-byte character display" \
1393 "\n -C Canonical hex+ASCII, 16 bytes per line" \
1394 "\n -d Two-byte decimal display" \
1395 "\n -e FORMAT STRING" \
1396 "\n -f FORMAT FILE" \
1397 "\n -n LENGTH Interpret only LENGTH bytes of input" \
1398 "\n -o Two-byte octal display" \
1399 "\n -s OFFSET Skip OFFSET bytes" \
1400 "\n -v Display all input data" \
1401 "\n -x Two-byte hexadecimal display" \
1402 USE_FEATURE_HEXDUMP_REVERSE( \
1403 "\n -R Reverse of 'hexdump -Cv'") \
1405 #define hd_trivial_usage \
1407 #define hd_full_usage \
1408 "hd is an alias for hexdump -C"
1410 #define hostid_trivial_usage \
1412 #define hostid_full_usage \
1413 "Print out a unique 32-bit identifier for the machine"
1415 #define hostname_trivial_usage \
1416 "[OPTION] {hostname | -F FILE}"
1417 #define hostname_full_usage \
1418 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
1419 "(or FILE with the -F parameter), the host name will be set." \
1422 " -i Addresses for the hostname\n" \
1423 " -d DNS domain name\n" \
1424 " -f Fully qualified domain name\n" \
1425 " -F FILE Use the contents of FILE to specify the hostname"
1426 #define hostname_example_usage \
1430 #define httpd_trivial_usage \
1433 " [-i] [-f] [-v[v]]" \
1434 USE_FEATURE_HTTPD_SETUID(" [-u user[:grp]]") \
1435 USE_FEATURE_HTTPD_BASIC_AUTH(" [-r realm]") \
1436 USE_FEATURE_HTTPD_AUTH_MD5(" [-m pass]") \
1439 #define httpd_full_usage \
1440 "Listen for incoming HTTP requests" \
1442 "\n -c FILE Configuration file (default httpd.conf)" \
1443 "\n -p [IP:]PORT Bind to ip:port (default *:80)" \
1444 "\n -i Inetd mode" \
1445 "\n -f Do not daemonize" \
1446 "\n -v[v] Verbose" \
1447 USE_FEATURE_HTTPD_SETUID( \
1448 "\n -u USER[:GRP] Set uid/gid after binding to port") \
1449 USE_FEATURE_HTTPD_BASIC_AUTH( \
1450 "\n -r REALM Authentication Realm for Basic Authentication") \
1451 USE_FEATURE_HTTPD_AUTH_MD5( \
1452 "\n -m PASS Crypt PASS with md5 algorithm") \
1453 "\n -h HOME Home directory (default .)" \
1454 "\n -e STRING HTML encode STRING" \
1455 "\n -d STRING URL decode STRING" \
1457 #define hwclock_trivial_usage \
1459 "[-r|--show] [-s|--hctosys] [-w|--systohc]" \
1460 " [-l|--localtime] [-u|--utc]" \
1464 "[-r] [-s] [-w] [-l] [-u] [-f FILE]" \
1466 #define hwclock_full_usage \
1467 "Query and set a hardware clock (RTC)" \
1469 " -r Read hardware clock and print result\n" \
1470 " -s Set the system time from the hardware clock\n" \
1471 " -w Set the hardware clock to the system time\n" \
1472 " -u The hardware clock is kept in coordinated universal time\n" \
1473 " -l The hardware clock is kept in local time\n" \
1474 " -f FILE Use the specified clock (e.g. /dev/rtc2)"
1476 #define id_trivial_usage \
1477 "[OPTIONS]... [USERNAME]"
1478 #define id_full_usage \
1479 "Print information for USERNAME or the current user" \
1482 " -Z Prints only the security context\n" \
1484 " -g Prints only the group ID\n" \
1485 " -u Prints only the user ID\n" \
1486 " -n Print a name instead of a number\n" \
1487 " -r Prints the real user ID instead of the effective ID"
1488 #define id_example_usage \
1490 "uid=1000(andersen) gid=1000(andersen)\n"
1492 #define ifconfig_trivial_usage \
1493 USE_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]"
1494 #define ifconfig_full_usage \
1495 "Configure a network interface" \
1498 " [add ADDRESS[/PREFIXLEN]]\n") \
1500 " [del ADDRESS[/PREFIXLEN]]\n") \
1501 " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \
1502 " [netmask ADDRESS] [dstaddr ADDRESS]\n" \
1503 USE_FEATURE_IFCONFIG_SLIP( \
1504 " [outfill NN] [keepalive NN]\n") \
1505 " " USE_FEATURE_IFCONFIG_HW("[hw ether ADDRESS] ") "[metric NN] [mtu NN]\n" \
1506 " [[-]trailers] [[-]arp] [[-]allmulti]\n" \
1507 " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \
1508 USE_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \
1509 " [mem_start NN] [io_addr NN] [irq NN]\n") \
1512 #define ifup_trivial_usage \
1513 "[-ahinv] ifaces..."
1514 #define ifup_full_usage \
1516 " -a De/configure all interfaces automatically\n" \
1517 " -i FILE Use FILE for interface definitions\n" \
1518 " -n Print out what would happen, but don't do it\n" \
1519 " (note that this option doesn't disable mappings)\n" \
1520 " -v Print out what would happen before doing it\n" \
1521 " -m Don't run any mappings\n" \
1522 " -f Force de/configuration"
1524 #define ifdown_trivial_usage \
1525 "[-ahinv] ifaces..."
1526 #define ifdown_full_usage \
1528 " -a De/configure all interfaces automatically\n" \
1529 " -i FILE Use FILE for interface definitions\n" \
1530 " -n Print out what would happen, but don't do it\n" \
1531 " (note that this option doesn't disable mappings)\n" \
1532 " -v Print out what would happen before doing it\n" \
1533 " -m Don't run any mappings\n" \
1534 " -f Force de/configuration"
1536 #define inetd_trivial_usage \
1537 "[-f] [-q len] [conf]"
1538 #define inetd_full_usage \
1539 "Listen for network connections and launch programs" \
1541 " -f Run in foreground\n" \
1542 " -q N Set the size of the socket listen queue to N\n" \
1545 #define init_trivial_usage \
1547 #define init_full_usage \
1548 "Init is the parent of all processes"
1549 #define init_notes_usage \
1550 "This version of init is designed to be run only by the kernel.\n" \
1552 "BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \
1553 "the /etc/inittab file is completely ignored by BusyBox init. If you want\n" \
1554 "runlevels, use sysvinit.\n" \
1556 "BusyBox init works just fine without an inittab. If no inittab is found,\n" \
1557 "it has the following default behavior:\n" \
1559 " ::sysinit:/etc/init.d/rcS\n" \
1560 " ::askfirst:/bin/sh\n" \
1561 " ::ctrlaltdel:/sbin/reboot\n" \
1562 " ::shutdown:/sbin/swapoff -a\n" \
1563 " ::shutdown:/bin/umount -a -r\n" \
1564 " ::restart:/sbin/init\n" \
1566 "if it detects that /dev/console is _not_ a serial console, it will also run:\n" \
1568 " tty2::askfirst:/bin/sh\n" \
1569 " tty3::askfirst:/bin/sh\n" \
1570 " tty4::askfirst:/bin/sh\n" \
1572 "If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \
1574 " <id>:<runlevels>:<action>:<process>\n" \
1578 " WARNING: This field has a non-traditional meaning for BusyBox init!\n" \
1579 " The id field is used by BusyBox init to specify the controlling tty for\n" \
1580 " the specified process to run on. The contents of this field are\n" \
1581 " appended to \"/dev/\" and used as-is. There is no need for this field to\n" \
1582 " be unique, although if it isn't you may have strange results. If this\n" \
1583 " field is left blank, the controlling tty is set to the console. Also\n" \
1584 " note that if BusyBox detects that a serial console is in use, then only\n" \
1585 " entries whose controlling tty is either the serial console or /dev/null\n" \
1586 " will be run. BusyBox init does nothing with utmp. We don't need no\n" \
1587 " stinkin' utmp.\n" \
1591 " The runlevels field is completely ignored.\n" \
1595 " Valid actions include: sysinit, respawn, askfirst, wait,\n" \
1596 " once, restart, ctrlaltdel, and shutdown.\n" \
1598 " The available actions can be classified into two groups: actions\n" \
1599 " that are run only once, and actions that are re-run when the specified\n" \
1600 " process exits.\n" \
1602 " Run only-once actions:\n" \
1604 " 'sysinit' is the first item run on boot. init waits until all\n" \
1605 " sysinit actions are completed before continuing. Following the\n" \
1606 " completion of all sysinit actions, all 'wait' actions are run.\n" \
1607 " 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \
1608 " the specified task completes. 'once' actions are asynchronous,\n" \
1609 " therefore, init does not wait for them to complete. 'restart' is\n" \
1610 " the action taken to restart the init process. By default this should\n" \
1611 " simply run /sbin/init, but can be a script which runs pivot_root or it\n" \
1612 " can do all sorts of other interesting things. The 'ctrlaltdel' init\n" \
1613 " actions are run when the system detects that someone on the system\n" \
1614 " console has pressed the CTRL-ALT-DEL key combination. Typically one\n" \
1615 " wants to run 'reboot' at this point to cause the system to reboot.\n" \
1616 " Finally the 'shutdown' action specifies the actions to taken when\n" \
1617 " init is told to reboot. Unmounting filesystems and disabling swap\n" \
1618 " is a very good here.\n" \
1620 " Run repeatedly actions:\n" \
1622 " 'respawn' actions are run after the 'once' actions. When a process\n" \
1623 " started with a 'respawn' action exits, init automatically restarts\n" \
1624 " it. Unlike sysvinit, BusyBox init does not stop processes from\n" \
1625 " respawning out of control. The 'askfirst' actions acts just like\n" \
1626 " respawn, except that before running the specified process it\n" \
1627 " displays the line \"Please press Enter to activate this console.\"\n" \
1628 " and then waits for the user to press enter before starting the\n" \
1629 " specified process.\n" \
1631 " Unrecognized actions (like initdefault) will cause init to emit an\n" \
1632 " error message, and then go along with its business. All actions are\n" \
1633 " run in the order they appear in /etc/inittab.\n" \
1637 " Specifies the process to be executed and its command line.\n" \
1639 "Example /etc/inittab file:\n" \
1641 " # This is run first except when booting in single-user mode\n" \
1643 " ::sysinit:/etc/init.d/rcS\n" \
1645 " # /bin/sh invocations on selected ttys\n" \
1647 " # Start an \"askfirst\" shell on the console (whatever that may be)\n" \
1648 " ::askfirst:-/bin/sh\n" \
1649 " # Start an \"askfirst\" shell on /dev/tty2-4\n" \
1650 " tty2::askfirst:-/bin/sh\n" \
1651 " tty3::askfirst:-/bin/sh\n" \
1652 " tty4::askfirst:-/bin/sh\n" \
1654 " # /sbin/getty invocations for selected ttys\n" \
1656 " tty4::respawn:/sbin/getty 38400 tty4\n" \
1657 " tty5::respawn:/sbin/getty 38400 tty5\n" \
1660 " # Example of how to put a getty on a serial line (for a terminal)\n" \
1662 " #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \
1663 " #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \
1665 " # Example how to put a getty on a modem line\n" \
1666 " #::respawn:/sbin/getty 57600 ttyS2\n" \
1668 " # Stuff to do when restarting the init process\n" \
1669 " ::restart:/sbin/init\n" \
1671 " # Stuff to do before rebooting\n" \
1672 " ::ctrlaltdel:/sbin/reboot\n" \
1673 " ::shutdown:/bin/umount -a -r\n" \
1674 " ::shutdown:/sbin/swapoff -a\n"
1676 #define insmod_trivial_usage \
1677 USE_FEATURE_2_4_MODULES("[OPTION]... ") "MODULE [symbol=value]..."
1678 #define insmod_full_usage \
1679 "Load the specified kernel modules into the kernel" \
1680 USE_FEATURE_2_4_MODULES( \
1682 " -f Force module to load into the wrong kernel version\n" \
1683 " -k Make module autoclean-able\n" \
1686 " -L Lock to prevent simultaneous loads of a module\n" \
1687 USE_FEATURE_INSMOD_LOAD_MAP( \
1688 " -m Output load map to stdout\n" \
1690 " -o NAME Set internal module name to NAME\n" \
1691 " -x Do not export externs" \
1694 #define install_trivial_usage \
1695 "[-cgmops] [sources] dest|directory"
1696 #define install_full_usage \
1697 "Copy files and set attributes" \
1699 " -c Copy the file, default\n" \
1700 " -d Create directories\n" \
1701 " -g Set group ownership\n" \
1702 " -m Set permissions\n" \
1703 " -o Set ownership\n" \
1704 " -p Preserve date\n" \
1705 " -s Strip symbol tables" \
1707 "\n -Z Set security context of copy" \
1709 /* would need to make the " | " optional depending on more than one selected */
1710 #define ip_trivial_usage \
1712 USE_FEATURE_IP_ADDRESS("address | ") \
1713 USE_FEATURE_IP_ROUTE("route | ") \
1714 USE_FEATURE_IP_LINK("link | ") \
1715 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1716 USE_FEATURE_IP_RULE("rule") \
1718 #define ip_full_usage \
1719 "ip [OPTIONS] OBJECT {COMMAND}\n" \
1720 "where OBJECT := {" \
1721 USE_FEATURE_IP_ADDRESS("address | ") \
1722 USE_FEATURE_IP_ROUTE("route | ") \
1723 USE_FEATURE_IP_LINK("link | ") \
1724 USE_FEATURE_IP_TUNNEL("tunnel | ") \
1725 USE_FEATURE_IP_RULE("rule") \
1727 "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }"
1729 #define ipaddr_trivial_usage \
1730 "{ {add|del} IFADDR dev STRING | {show|flush}\n" \
1731 " [dev STRING] [to PREFIX] }"
1732 #define ipaddr_full_usage \
1733 "ipaddr {add|delete} IFADDR dev STRING\n" \
1734 "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \
1735 " [to PREFIX] [label PATTERN]\n" \
1736 " IFADDR := PREFIX | ADDR peer PREFIX\n" \
1737 " [broadcast ADDR] [anycast ADDR]\n" \
1738 " [label STRING] [scope SCOPE-ID]\n" \
1739 " SCOPE-ID := [host | link | global | NUMBER]"
1741 #define ipcalc_trivial_usage \
1742 "[OPTION]... ADDRESS[[/]NETMASK] [NETMASK]"
1743 #define ipcalc_full_usage \
1744 "Calculate IP network settings from a IP address" \
1746 USE_FEATURE_IPCALC_LONG_OPTIONS( \
1747 "\n -b,--broadcast Display calculated broadcast address" \
1748 "\n -n,--network Display calculated network address" \
1749 "\n -m,--netmask Display default netmask for IP" \
1750 USE_FEATURE_IPCALC_FANCY( \
1751 "\n -p,--prefix Display the prefix for IP/NETMASK" \
1752 "\n -h,--hostname Display first resolved host name" \
1753 "\n -s,--silent Don't ever display error messages" \
1756 SKIP_FEATURE_IPCALC_LONG_OPTIONS( \
1757 "\n -b Display calculated broadcast address" \
1758 "\n -n Display calculated network address" \
1759 "\n -m Display default netmask for IP" \
1760 USE_FEATURE_IPCALC_FANCY( \
1761 "\n -p Display the prefix for IP/NETMASK" \
1762 "\n -h Display first resolved host name" \
1763 "\n -s Don't ever display error messages" \
1767 #define ipcrm_trivial_usage \
1768 "[-[MQS] key] [-[mqs] id]"
1769 #define ipcrm_full_usage \
1770 "The upper-case options MQS are used to remove a shared memory segment by a\n" \
1771 "segment by a shmkey value. The lower-case options mqs are used\n" \
1772 "to remove a segment by shmid value.\n" \
1774 " -[mM] Remove the memory segment after the last detach\n" \
1775 " -[qQ] Remove the message queue\n" \
1776 " -[sS] Remove the semaphore"
1778 #define ipcs_trivial_usage \
1779 "[[-smq] -i shmid] | [[-asmq] [-tcplu]]"
1780 #define ipcs_full_usage \
1781 " -i Show a specific resource\n" \
1782 "Resource specification:\n" \
1783 " -m Shared memory segments\n" \
1784 " -q Message queues\n" \
1785 " -s Semaphore arrays\n" \
1786 " -a All (default)\n" \
1787 "Output format:\n" \
1794 #define iplink_trivial_usage \
1795 "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }"
1796 #define iplink_full_usage \
1797 "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \
1798 " dynamic { on | off } |\n" \
1800 "iplink show [DEVICE]"
1802 #define iproute_trivial_usage \
1803 "{ list | flush | { add | del | change | append |\n" \
1804 " replace | monitor } ROUTE }"
1805 #define iproute_full_usage \
1806 "iproute { list | flush } SELECTOR\n" \
1807 "iproute get ADDRESS [from ADDRESS iif STRING]\n" \
1808 " [oif STRING] [tos TOS]\n" \
1809 "iproute { add | del | change | append | replace | monitor } ROUTE\n" \
1810 " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \
1811 " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]"
1813 #define iprule_trivial_usage \
1814 "{[list | add | del] RULE}"
1815 #define iprule_full_usage \
1816 "iprule [list | add | del] SELECTOR ACTION\n" \
1817 " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \
1818 " [dev STRING] [pref NUMBER]\n" \
1819 " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \
1820 " [prohibit | reject | unreachable]\n" \
1821 " [realms [SRCREALM/]DSTREALM]\n" \
1822 " TABLE_ID := [local | main | default | NUMBER]"
1824 #define iptunnel_trivial_usage \
1825 "{ add | change | del | show } [NAME]\n" \
1826 " [mode { ipip | gre | sit }]\n" \
1827 " [remote ADDR] [local ADDR] [ttl TTL]"
1828 #define iptunnel_full_usage \
1829 "iptunnel { add | change | del | show } [NAME]\n" \
1830 " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \
1831 " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
1832 " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]"
1834 #define kbd_mode_trivial_usage \
1836 #define kbd_mode_full_usage \
1837 "Report or set the keyboard mode" \
1838 "\n\nOptions set mode:\n" \
1839 " -a Default (ASCII)\n" \
1840 " -k Medium-raw (keyboard)\n" \
1841 " -s Raw (scancode)\n" \
1842 " -u Unicode (utf-8)"
1844 #define kill_trivial_usage \
1845 "[-l] [-signal] process-id [process-id...]"
1846 #define kill_full_usage \
1847 "Send a signal (default is TERM) to the specified process(es)" \
1849 " -l List all signal names and numbers"
1850 #define kill_example_usage \
1851 "$ ps | grep apache\n" \
1852 "252 root root S [apache]\n" \
1853 "263 www-data www-data S [apache]\n" \
1854 "264 www-data www-data S [apache]\n" \
1855 "265 www-data www-data S [apache]\n" \
1856 "266 www-data www-data S [apache]\n" \
1857 "267 www-data www-data S [apache]\n" \
1860 #define killall_trivial_usage \
1861 "[-l] [-q] [-signal] process-name [process-name...]"
1862 #define killall_full_usage \
1863 "Send a signal (default is TERM) to the specified process(es)" \
1865 " -l List all signal names and numbers\n" \
1866 " -q Do not complain if no processes were killed"
1867 #define killall_example_usage \
1868 "$ killall apache\n"
1870 #define killall5_trivial_usage \
1872 #define killall5_full_usage \
1873 "Send a signal (default is TERM) to all processes outside current session" \
1875 " -l List all signal names and numbers\n" \
1877 #define klogd_trivial_usage \
1879 #define klogd_full_usage \
1882 " -c n Sets the default log level of console messages to n\n" \
1883 " -n Run in foreground"
1885 #define length_trivial_usage \
1887 #define length_full_usage \
1888 "Print out the length of the specified STRING"
1889 #define length_example_usage \
1890 "$ length Hello\n" \
1893 #define less_trivial_usage \
1894 "[-EMNmh~?] FILE1 FILE2..."
1895 #define less_full_usage \
1896 "View a file or list of files. The position within files can be\n" \
1897 "changed, and files can be manipulated in various ways." \
1899 " -E Quit once the end of a file is reached\n" \
1900 " -M,-m Display a status line containing the current line numbers\n" \
1901 " and the percentage through the file\n" \
1902 " -N Prefix line numbers to each line\n" \
1903 " -~ Suppress ~s displayed when input past the end of the file is\n" \
1906 #define setarch_trivial_usage \
1907 "personality program [args...]"
1908 #define setarch_full_usage \
1909 "Personality may be:\n" \
1910 " linux32 Set 32bit uname emulation\n" \
1911 " linux64 Set 64bit uname emulation"
1913 #define ln_trivial_usage \
1914 "[OPTION] TARGET... LINK_NAME|DIRECTORY"
1915 #define ln_full_usage \
1916 "Create a link named LINK_NAME or DIRECTORY to the specified TARGET.\n" \
1917 "You may use '--' to indicate that all following arguments are non-options." \
1919 " -s Make symlinks instead of hardlinks\n" \
1920 " -f Remove existing destination files\n" \
1921 " -n Don't dereference symlinks - treat like normal file\n" \
1922 " -b Make a backup of the target (if exists) before link operation\n" \
1923 " -S suf Use suffix instead of ~ when making backup files"
1924 #define ln_example_usage \
1925 "$ ln -s BusyBox /tmp/ls\n" \
1926 "$ ls -l /tmp/ls\n" \
1927 "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n"
1929 #define load_policy_trivial_usage
1931 #define load_policy_full_usage
1933 #define loadfont_trivial_usage \
1935 #define loadfont_full_usage \
1936 "Load a console font from standard input"
1937 #define loadfont_example_usage \
1938 "$ loadfont < /etc/i18n/fontname\n"
1940 #define loadkmap_trivial_usage \
1942 #define loadkmap_full_usage \
1943 "Load a binary keyboard translation table from standard input"
1944 #define loadkmap_example_usage \
1945 "$ loadkmap < /etc/i18n/lang-keymap\n"
1947 #define logger_trivial_usage \
1948 "[OPTION]... [MESSAGE]"
1949 #define logger_full_usage \
1950 "Write MESSAGE to the system log. If MESSAGE is omitted, log stdin." \
1952 " -s Log to stderr as well as the system log\n" \
1953 " -t TAG Log using the specified tag (defaults to user name)\n" \
1954 " -p PRIO Enter the message with the specified priority.\n" \
1955 " This may be numerical or a 'facility.level' pair."
1956 #define logger_example_usage \
1957 "$ logger \"hello\"\n"
1959 #define login_trivial_usage \
1960 "[OPTION]... [username] [ENV=VAR...]"
1961 #define login_full_usage \
1962 "Begin a new session on the system" \
1964 " -f Do not authenticate (user already authenticated)\n" \
1965 " -h Name of the remote host for this login\n" \
1966 " -p Preserve environment"
1968 #define logname_trivial_usage \
1970 #define logname_full_usage \
1971 "Print the name of the current user"
1972 #define logname_example_usage \
1976 #define logread_trivial_usage \
1978 #define logread_full_usage \
1979 "Show the messages from syslogd (using circular buffer)" \
1981 " -f Output data as the log grows"
1983 #define losetup_trivial_usage \
1984 "[-o OFS] LOOPDEV FILE - associate loop devices\n" \
1985 " losetup -d LOOPDEV - disassociate\n" \
1986 " losetup [-f] - show"
1987 #define losetup_full_usage \
1989 " -o OFS Start OFS bytes into FILE\n" \
1990 " -f Show first free loop device"
1991 #define losetup_notes_usage \
1992 "No arguments will display all current associations.\n" \
1993 "One argument (losetup /dev/loop1) will display the current association\n" \
1994 "(if any), or disassociate it (with -d). The display shows the offset\n" \
1995 "and filename of the file the loop device is currently bound to.\n\n" \
1996 "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \
1997 "with an optional offset (-o 12345). Encryption is not yet supported.\n" \
1998 "losetup -f will show the first loop free loop device\n\n"
2000 #define ls_trivial_usage \
2001 "[-1Aa" USE_FEATURE_LS_TIMESTAMPS("c") "Cd" \
2002 USE_FEATURE_LS_TIMESTAMPS("e") USE_FEATURE_LS_FILETYPES("F") "iln" \
2003 USE_FEATURE_LS_FILETYPES("p") USE_FEATURE_LS_FOLLOWLINKS("L") \
2004 USE_FEATURE_LS_RECURSIVE("R") USE_FEATURE_LS_SORTFILES("rS") "s" \
2005 USE_FEATURE_AUTOWIDTH("T") USE_FEATURE_LS_TIMESTAMPS("tu") \
2006 USE_FEATURE_LS_SORTFILES("v") USE_FEATURE_AUTOWIDTH("w") "x" \
2007 USE_FEATURE_LS_SORTFILES("X") USE_FEATURE_HUMAN_READABLE("h") "k" \
2008 USE_SELINUX("K") "] [filenames...]"
2009 #define ls_full_usage \
2010 "List directory contents" \
2012 "\n -1 List files in a single column" \
2013 "\n -A Do not list implied . and .." \
2014 "\n -a Do not hide entries starting with ." \
2015 "\n -C List entries by columns" \
2016 USE_FEATURE_LS_TIMESTAMPS( \
2017 "\n -c With -l: show ctime") \
2018 USE_FEATURE_LS_COLOR( \
2019 "\n --color[={always,never,auto}] Control coloring") \
2020 "\n -d List directory entries instead of contents" \
2021 USE_FEATURE_LS_TIMESTAMPS( \
2022 "\n -e List both full date and full time") \
2023 USE_FEATURE_LS_FILETYPES( \
2024 "\n -F Append indicator (one of */=@|) to entries") \
2025 "\n -i List the i-node for each file" \
2026 "\n -l Use a long listing format" \
2027 "\n -n List numeric UIDs and GIDs instead of names" \
2028 USE_FEATURE_LS_FILETYPES( \
2029 "\n -p Append indicator (one of /=@|) to entries") \
2030 USE_FEATURE_LS_FOLLOWLINKS( \
2031 "\n -L List entries pointed to by symlinks") \
2032 USE_FEATURE_LS_RECURSIVE( \
2033 "\n -R List subdirectories recursively") \
2034 USE_FEATURE_LS_SORTFILES( \
2035 "\n -r Sort the listing in reverse order") \
2036 USE_FEATURE_LS_SORTFILES( \
2037 "\n -S Sort the listing by file size") \
2038 "\n -s List the size of each file, in blocks" \
2039 USE_FEATURE_AUTOWIDTH( \
2040 "\n -T NUM Assume Tabstop every NUM columns") \
2041 USE_FEATURE_LS_TIMESTAMPS( \
2042 "\n -t With -l: show modification time") \
2043 USE_FEATURE_LS_TIMESTAMPS( \
2044 "\n -u With -l: show access time") \
2045 USE_FEATURE_LS_SORTFILES( \
2046 "\n -v Sort the listing by version") \
2047 USE_FEATURE_AUTOWIDTH( \
2048 "\n -w NUM Assume the terminal is NUM columns wide") \
2049 "\n -x List entries by lines instead of by columns" \
2050 USE_FEATURE_LS_SORTFILES( \
2051 "\n -X Sort the listing by extension") \
2052 USE_FEATURE_HUMAN_READABLE( \
2053 "\n -h Print sizes in human readable format (e.g., 1K 243M 2G)") \
2055 "\n -k Print security context") \
2057 "\n -K Print security context in long format") \
2059 "\n -Z Print security context and permission")
2061 #define lsattr_trivial_usage \
2062 "[-Radlv] [files...]"
2063 #define lsattr_full_usage \
2064 "List file attributes on an ext2 fs" \
2066 " -R Recursively list subdirectories\n" \
2067 " -a Do not hide entries starting with .\n" \
2068 " -d List directory entries instead of contents\n" \
2069 " -l Print long flag names\n" \
2070 " -v List the file's version/generation number"
2072 #define lsmod_trivial_usage \
2074 #define lsmod_full_usage \
2075 "List the currently loaded kernel modules"
2077 #if ENABLE_FEATURE_MAKEDEVS_LEAF
2078 #define makedevs_trivial_usage \
2079 "NAME TYPE MAJOR MINOR FIRST LAST [s]"
2080 #define makedevs_full_usage \
2081 "Create a range of block or character special files\n\n" \
2082 "TYPEs include:\n" \
2083 " b: Make a block (buffered) device\n" \
2084 " c or u: Make a character (un-buffered) device\n" \
2085 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes\n" \
2087 "FIRST specifies the number appended to NAME to create the first device.\n" \
2088 "LAST specifies the number of the last item that should be created\n" \
2089 "If 's' is the last argument, the base device is created as well.\n\n" \
2091 " makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \
2092 " makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8"
2093 #define makedevs_example_usage \
2094 "# makedevs /dev/ttyS c 4 66 2 63\n" \
2095 "[creates ttyS2-ttyS63]\n" \
2096 "# makedevs /dev/hda b 3 0 0 8 s\n" \
2097 "[creates hda,hda1-hda8]\n"
2100 #if ENABLE_FEATURE_MAKEDEVS_TABLE
2101 #define makedevs_trivial_usage \
2102 "[-d device_table] rootdir"
2103 #define makedevs_full_usage \
2104 "Create a range of special files as specified in a device table.\n" \
2105 "Device table entries take the form of:\n" \
2106 "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \
2107 "Where name is the file name, type can be one of:\n" \
2108 " f A regular file\n" \
2110 " c Character special device file\n" \
2111 " b Block special device file\n" \
2112 " p Fifo (named pipe)\n" \
2113 "uid is the user id for the target file, gid is the group id for the\n" \
2114 "target file. The rest of the entries (major, minor, etc) apply to\n" \
2115 "to device special files. A '-' may be used for blank entries."
2116 #define makedevs_example_usage \
2118 "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \
2119 "/dev d 755 0 0 - - - - -\n" \
2120 "/dev/console c 666 0 0 5 1 - - -\n" \
2121 "/dev/null c 666 0 0 1 3 0 0 -\n" \
2122 "/dev/zero c 666 0 0 1 5 0 0 -\n" \
2123 "/dev/hda b 640 0 0 3 0 0 0 -\n" \
2124 "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \
2134 #define matchpathcon_trivial_usage \
2135 "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]"
2136 #define matchpathcon_full_usage \
2137 " -n Do not display path" \
2138 "\n -N Do not use translations" \
2139 "\n -f Use alternate file_context file" \
2140 "\n -p Use prefix to speed translations" \
2141 "\n -V Verify file context on disk matches defaults"
2143 #define md5sum_trivial_usage \
2144 "[OPTION] [FILEs...]" \
2145 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: md5sum [OPTION] -c [FILE]")
2146 #define md5sum_full_usage \
2147 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " MD5 checksums" \
2149 "With no FILE, or when FILE is -, read standard input." \
2150 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n\n" \
2151 " -c Check MD5 sums against given list\n" \
2152 "\nThe following two options are useful only when verifying checksums:\n" \
2153 " -s Don't output anything, status code shows success\n" \
2154 " -w Warn about improperly formatted MD5 checksum lines")
2155 #define md5sum_example_usage \
2156 "$ md5sum < busybox\n" \
2157 "6fd11e98b98a58f64ff3398d7b324003\n" \
2158 "$ md5sum busybox\n" \
2159 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2161 "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \
2165 #define mdev_trivial_usage \
2167 #define mdev_full_usage \
2168 " -s Scan /sys and populate /dev during system boot\n\n" \
2169 "Called with no options (via hotplug) it uses environment variables\n" \
2170 "to determine which device to add/remove."
2171 #define mdev_notes_usage "" \
2172 USE_FEATURE_MDEV_CONFIG( \
2173 "The mdev config file contains lines that look like:\n" \
2174 " hd[a-z][0-9]* 0:3 660\n\n" \
2175 "That's device name (with regex match), uid:gid, and permissions.\n\n" \
2176 USE_FEATURE_MDEV_EXEC( \
2177 "Optionally, that can be followed (on the same line) by a special character\n" \
2178 "and a command line to run after creating/before deleting the corresponding\n" \
2179 "device(s). The environment variable $MDEV indicates the active device node\n" \
2180 "(which is useful if it's a regex match). For example:\n\n" \
2181 " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \
2182 "The special characters are @ (run after creating), $ (run before deleting),\n" \
2183 "and * (run both after creating and before deleting). The commands run in\n" \
2184 "the /dev directory, and use system() which calls /bin/sh.\n\n" \
2186 "Config file parsing stops on the first matching line. If no config\n" \
2187 "entry is matched, devices are created with default 0:0 660. (Make\n" \
2188 "the last line match .* to override this.)\n\n" \
2191 #define mesg_trivial_usage \
2193 #define mesg_full_usage \
2194 "Control write access to your terminal\n" \
2195 " y Allow write access to your terminal\n" \
2196 " n Disallow write access to your terminal"
2198 #define microcom_trivial_usage \
2199 "[-s speed] tty-name"
2200 #define microcom_full_usage \
2203 #define mkdir_trivial_usage \
2204 "[OPTION] DIRECTORY..."
2205 #define mkdir_full_usage \
2206 "Create the DIRECTORY(ies) if they do not already exist" \
2208 " -m Set permission mode (as in chmod), not rwxrwxrwx - umask\n" \
2209 " -p No error if existing, make parent directories as needed" \
2211 "\n -Z Set security context" \
2214 #define mkdir_example_usage \
2215 "$ mkdir /tmp/foo\n" \
2216 "$ mkdir /tmp/foo\n" \
2217 "/tmp/foo: File exists\n" \
2218 "$ mkdir /tmp/foo/bar/baz\n" \
2219 "/tmp/foo/bar/baz: No such file or directory\n" \
2220 "$ mkdir -p /tmp/foo/bar/baz\n"
2222 #define mke2fs_trivial_usage \
2223 "[-c|-l filename] [-b block-size] [-f fragment-size] [-g blocks-per-group] " \
2224 "[-i bytes-per-inode] [-j] [-J journal-options] [-N number-of-inodes] [-n] " \
2225 "[-m reserved-blocks-percentage] [-o creator-os] [-O feature[,...]] [-q] " \
2226 "[r fs-revision-level] [-E extended-options] [-v] [-F] [-L volume-label] " \
2227 "[-M last-mounted-directory] [-S] [-T filesystem-type] " \
2228 "device [blocks-count]"
2229 #define mke2fs_full_usage \
2230 " -b size Block size in bytes\n" \
2231 " -c Check for bad blocks before creating\n" \
2232 " -E opts Set extended options\n" \
2233 " -f size Fragment size in bytes\n" \
2234 " -F Force (ignore sanity checks)\n" \
2235 " -g num Number of blocks in a block group\n" \
2236 " -i ratio The bytes/inode ratio\n" \
2237 " -j Create a journal (ext3)\n" \
2238 " -J opts Set journal options (size/device)\n" \
2239 " -l file Read bad blocks list from file\n" \
2240 " -L lbl Set the volume label\n" \
2241 " -m percent Percent of fs blocks to reserve for admin\n" \
2242 " -M dir Set last mounted directory\n" \
2243 " -n Do not actually create anything\n" \
2244 " -N num Number of inodes to create\n" \
2245 " -o os Set the 'creator os' field\n" \
2246 " -O features Dir_index/filetype/has_journal/journal_dev/sparse_super\n" \
2248 " -r rev Set filesystem revision\n" \
2249 " -S Write superblock and group descriptors only\n" \
2250 " -T fs-type Set usage type (news/largefile/largefile4)\n" \
2253 #define mkfifo_trivial_usage \
2255 #define mkfifo_full_usage \
2256 "Create a named pipe (identical to 'mknod name p')" \
2258 " -m Create the pipe using the specified mode (default a=rw)" \
2260 "\n -Z Set security context" \
2263 #define mkfs_minix_trivial_usage \
2264 "[-c | -l filename] [-nXX] [-iXX] /dev/name [blocks]"
2265 #define mkfs_minix_full_usage \
2266 "Make a MINIX filesystem" \
2268 " -c Check device for bad blocks\n" \
2269 " -n [14|30] Maximum length of filenames\n" \
2270 " -i INODES Number of inodes for the filesystem\n" \
2271 " -l FILENAME Read bad blocks list from FILENAME\n" \
2272 " -v Make a Minix version 2 filesystem"
2274 #define mknod_trivial_usage \
2275 "[OPTIONS] NAME TYPE MAJOR MINOR"
2276 #define mknod_full_usage \
2277 "Create a special file (block, character, or pipe)" \
2279 " -m Create the special file using the specified mode (default a=rw)" \
2280 "\n\nTYPEs include:\n" \
2281 " b: Make a block (buffered) device\n" \
2282 " c or u: Make a character (un-buffered) device\n" \
2283 " p: Make a named pipe. MAJOR and MINOR are ignored for named pipes" \
2285 "\n -Z Set security context" \
2288 #define mknod_example_usage \
2289 "$ mknod /dev/fd0 b 2 0\n" \
2290 "$ mknod -m 644 /tmp/pipe p\n"
2292 #define mkswap_trivial_usage \
2293 "[-c] [-v0|-v1] device [block-count]"
2294 #define mkswap_full_usage \
2295 "Prepare a disk partition to be used as swap partition" \
2297 " -c Check for read-ability\n" \
2298 " -v0 Make version 0 swap [max 128 Megs]\n" \
2299 " -v1 Make version 1 swap [big!] (default for kernels > 2.1.117)\n" \
2300 " block-count Number of block to use (default is entire partition)"
2302 #define mktemp_trivial_usage \
2304 #define mktemp_full_usage \
2305 "Create a temporary file with its name based on TEMPLATE.\n" \
2306 "TEMPLATE is any name with six 'Xs' (i.e., /tmp/temp.XXXXXX)." \
2308 " -d Make a directory instead of a file\n" \
2309 " -q Fail silently if an error occurs"
2310 #define mktemp_example_usage \
2311 "$ mktemp /tmp/temp.XXXXXX\n" \
2312 "/tmp/temp.mWiLjM\n" \
2313 "$ ls -la /tmp/temp.mWiLjM\n" \
2314 "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n"
2316 #define modprobe_trivial_usage \
2317 "[-knqrsv] MODULE [symbol=value...]"
2318 #define modprobe_full_usage \
2320 " -k Make module autoclean-able\n" \
2323 " -r Remove module (stacks) or do autoclean\n" \
2324 " -s Report via syslog instead of stderr\n" \
2326 #define modprobe_notes_usage \
2327 "modprobe can (un)load a stack of modules, passing each module options (when\n" \
2328 "loading). modprobe uses a configuration file to determine what option(s) to\n" \
2329 "pass each module it loads.\n" \
2331 "The configuration file is searched (in order) amongst:\n" \
2333 " /etc/modprobe.conf (2.6 only)\n" \
2334 " /etc/modules.conf\n" \
2335 " /etc/conf.modules (deprecated)\n" \
2337 "They all have the same syntax (see below). If none is present, it is\n" \
2338 "_not_ an error; each loaded module is then expected to load without\n" \
2339 "options. Once a file is found, the others are tested for.\n" \
2341 "/etc/modules.conf entry format:\n" \
2343 " alias <alias_name> <mod_name>\n" \
2344 " Makes it possible to modprobe alias_name, when there is no such module.\n" \
2345 " It makes sense if your mod_name is long, or you want a more representative\n" \
2346 " name for that module (eg. 'scsi' in place of 'aha7xxx').\n" \
2347 " This makes it also possible to use a different set of options (below) for\n" \
2348 " the module and the alias.\n" \
2349 " A module can be aliased more than once.\n" \
2351 " options <mod_name|alias_name> <symbol=value...>\n" \
2352 " When loading module mod_name (or the module aliased by alias_name), pass\n" \
2353 " the \"symbol=value\" pairs as option to that module.\n" \
2355 "Sample /etc/modules.conf file:\n" \
2357 " options tulip irq=3\n" \
2358 " alias tulip tulip2\n" \
2359 " options tulip2 irq=4 io=0x308\n" \
2361 "Other functionality offered by 'classic' modprobe is not available in\n" \
2362 "this implementation.\n" \
2364 "If module options are present both in the config file, and on the command line,\n" \
2365 "then the options from the command line will be passed to the module _after_\n" \
2366 "the options from the config file. That way, you can have defaults in the config\n" \
2367 "file, and override them for a specific usage from the command line.\n"
2368 #define modprobe_example_usage \
2369 "(with the above /etc/modules.conf):\n\n" \
2370 "$ modprobe tulip\n" \
2371 " will load the module 'tulip' with default option 'irq=3'\n\n" \
2372 "$ modprobe tulip irq=5\n" \
2373 " will load the module 'tulip' with option 'irq=5', thus overriding the default\n\n" \
2374 "$ modprobe tulip2\n" \
2375 " will load the module 'tulip' with default options 'irq=4 io=0x308',\n" \
2376 " which are the default for alias 'tulip2'\n\n" \
2377 "$ modprobe tulip2 irq=8\n" \
2378 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=8',\n" \
2379 " which are the default for alias 'tulip2' overridden by the option 'irq=8'\n\n" \
2380 " from the command line\n\n" \
2381 "$ modprobe tulip2 irq=2 io=0x210\n" \
2382 " will load the module 'tulip' with default options 'irq=4 io=0x308 irq=4 io=0x210',\n" \
2383 " which are the default for alias 'tulip2' overridden by the options 'irq=2 io=0x210'\n\n" \
2384 " from the command line\n"
2386 #define more_trivial_usage \
2388 #define more_full_usage \
2389 "View FILE or standard input one screenful at a time"
2390 #define more_example_usage \
2393 #define mount_trivial_usage \
2394 "[flags] DEVICE NODE [-o options,more-options]"
2395 #define mount_full_usage \
2396 "Mount a filesystem. Filesystem autodetection requires /proc be mounted." \
2398 " -a Mount all filesystems in fstab\n" \
2399 USE_FEATURE_MTAB_SUPPORT( \
2400 " -f Update /etc/mtab, but don't mount\n" \
2401 " -n Don't update /etc/mtab\n" \
2403 " -r Read-only mount\n" \
2404 " -t fs-type Filesystem type\n" \
2405 " -w Read-write mount (default)\n" \
2408 USE_FEATURE_MOUNT_LOOP( \
2409 " loop Ignored (loop devices are autodetected)\n" \
2411 USE_FEATURE_MOUNT_FLAGS( \
2412 " [a]sync Writes are asynchronous / synchronous\n" \
2413 " [no]atime Disable / enable updates to inode access times\n" \
2414 " [no]diratime Disable / enable atime updates to directories\n" \
2415 " [no]dev Allow use of special device files / disallow them\n" \
2416 " [no]exec Allow use of executable files / disallow them\n" \
2417 " [no]suid Allow set-user-id-root programs / disallow them\n" \
2418 " [r]shared Convert [recursively] to a shared subtree\n" \
2419 " [r]slave Convert [recursively] to a slave subtree\n" \
2420 " [r]private Convert [recursively] to a private subtree\n" \
2421 " [un]bindable Make mount point [un]able to be bind mounted\n" \
2422 " bind Bind a directory to an additional location\n" \
2423 " move Relocate an existing mount point\n" \
2425 " remount Remount a mounted filesystem, changing its flags\n" \
2426 " ro/rw Mount for read-only / read-write\n" \
2428 "There are EVEN MORE flags that are specific to each filesystem\n" \
2429 "You'll have to see the written documentation for those filesystems"
2430 #define mount_example_usage \
2432 "/dev/hda3 on / type minix (rw)\n" \
2433 "proc on /proc type proc (rw)\n" \
2434 "devpts on /dev/pts type devpts (rw)\n" \
2435 "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \
2436 "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \
2437 "$ mount cd_image.iso mydir\n"
2438 #define mount_notes_usage \
2439 "Returns 0 for success, number of failed mounts for -a, or errno for one mount."
2441 #define mountpoint_trivial_usage \
2442 "[-q] <[-d] DIR | -x DEVICE>"
2443 #define mountpoint_full_usage \
2444 "mountpoint checks if the directory is a mountpoint" \
2447 " -d Print major/minor device number of the filesystem\n" \
2448 " -x Print major/minor device number of the blockdevice"
2449 #define mountpoint_example_usage \
2450 "$ mountpoint /proc\n" \
2451 "/proc is not a mountpoint\n" \
2452 "$ mountpoint /sys\n" \
2453 "/sys is a mountpoint\n"
2455 #define mt_trivial_usage \
2456 "[-f device] opcode value"
2457 #define mt_full_usage \
2458 "Control magnetic tape drive operation\n" \
2459 "\nAvailable Opcodes:\n\n" \
2460 "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \
2461 "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \
2462 "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \
2463 "setpart tell unload unlock weof wset"
2465 #define mv_trivial_usage \
2466 "[OPTION]... SOURCE DEST\n" \
2467 "or: mv [OPTION]... SOURCE... DIRECTORY"
2468 #define mv_full_usage \
2469 "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY" \
2471 " -f Don't prompt before overwriting\n" \
2472 " -i Interactive, prompt before overwrite"
2473 #define mv_example_usage \
2474 "$ mv /tmp/foo /bin/bar\n"
2476 #define nameif_trivial_usage \
2477 "[-s] [-c FILE] [{IFNAME MACADDR}]"
2478 #define nameif_full_usage \
2479 "Rename network interface while it in the down state" \
2481 " -c FILE Use configuration file (default is /etc/mactab)\n" \
2482 " -s Use syslog (LOCAL0 facility)\n" \
2483 " IFNAME MACADDR new_interface_name interface_mac_address"
2484 #define nameif_example_usage \
2485 "$ nameif -s dmz0 00:A0:C9:8C:F6:3F\n" \
2487 "$ nameif -c /etc/my_mactab_file\n" \
2491 #if ENABLE_NC_SERVER || ENABLE_NC_EXTRA
2492 #define NC_OPTIONS_STR "\n\nOptions:"
2494 #define NC_OPTIONS_STR
2497 #define nc_trivial_usage \
2498 USE_NC_EXTRA("[-iN] [-wN] ")USE_NC_SERVER("[-l] [-p PORT] ") \
2499 "["USE_NC_EXTRA("-f FILENAME|")"IPADDR PORTNUM]"USE_NC_EXTRA(" [-e COMMAND]")
2500 #define nc_full_usage \
2501 "Open a pipe to IP:port" USE_NC_EXTRA(" or file") \
2504 "\n -e Exec rest of command line after connect" \
2505 "\n -i SECS Delay interval for lines sent" \
2506 "\n -w SECS Timeout for connect" \
2507 "\n -f FILE Use file (ala /dev/ttyS0) instead of network" \
2510 "\n -l Listen mode, for inbound connects" \
2512 "\n (use -l twice with -e for persistent server)") \
2513 "\n -p PORT Local port number" \
2516 #define nc_notes_usage "" \
2518 "To use netcat as a terminal emulator on a serial port:\n\n" \
2519 "$ stty 115200 -F /dev/ttyS0\n" \
2520 "$ stty raw -echo -ctlecho && nc -f /dev/ttyS0\n" \
2523 #define nc_example_usage \
2524 "$ nc foobar.somedomain.com 25\n" \
2525 "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \
2527 "214-Commands supported:\n" \
2528 "214- HELO EHLO MAIL RCPT DATA AUTH\n" \
2529 "214 NOOP QUIT RSET HELP\n" \
2531 "221 foobar closing connection\n"
2533 #else /* DESKTOP nc - much more compatible with nc 1.10 */
2535 #define nc_trivial_usage \
2536 "[-options] hostname port - connect" \
2537 USE_NC_SERVER("\nnc [-options] -l -p port [hostname] [port] - listen")
2538 #define nc_full_usage \
2540 "-l Listen mode, for inbound connects\n" \
2542 "-n Don't do DNS resolution" \
2543 "\n-s addr Local address" \
2544 "\n-p port Local port" \
2546 "\n-v Verbose (cumulative: -vv)" \
2547 "\n-w secs Timeout for connects and final net reads" \
2549 "\n-i sec Delay interval for lines sent" /* ", ports scanned" */ \
2550 "\n-o file Hex dump of traffic" \
2551 "\n-z Zero-I/O mode (scanning)" \
2553 "\n-e prog [args] Program to exec after connect (must be last)" \
2554 /* "\n-r Randomize local and remote ports" */
2555 /* "\n-g gateway Source-routing hop point[s], up to 8" */
2556 /* "\n-G num Source-routing pointer: 4, 8, 12, ..." */
2557 /* "\nport numbers can be individual or ranges: lo-hi [inclusive]" */
2561 #define netstat_trivial_usage \
2562 "[-laentuwxr"USE_FEATURE_NETSTAT_WIDE("W")"]"
2563 #define netstat_full_usage \
2564 "Display networking information" \
2566 "\n -l Display listening server sockets" \
2567 "\n -a Display all sockets (default: connected)" \
2568 "\n -e Display other/more information" \
2569 "\n -n Don't resolve names" \
2570 "\n -t Tcp sockets" \
2571 "\n -u Udp sockets" \
2572 "\n -w Raw sockets" \
2573 "\n -x Unix sockets" \
2574 "\n -r Display routing table" \
2575 USE_FEATURE_NETSTAT_WIDE( \
2576 "\n -W Display with no column truncation" \
2579 #define nice_trivial_usage \
2580 "[-n ADJUST] [COMMAND [ARG]...]"
2581 #define nice_full_usage \
2582 "Run a program with modified scheduling priority" \
2584 " -n ADJUST Adjust the scheduling priority by ADJUST"
2586 #define nmeter_trivial_usage \
2588 #define nmeter_full_usage \
2589 "Monitor system in real time\n\n" \
2590 "Format specifiers:\n" \
2591 "%Nc or %[cN] Monitor CPU. N - bar size, default 10\n" \
2592 " (displays: S:system U:user N:niced D:iowait I:irq i:softirq)\n" \
2593 "%[niface] Monitor network interface 'iface'\n" \
2594 "%m Monitor allocated memory\n" \
2595 "%[mf] Monitor free memory\n" \
2596 "%[mt] Monitor total memory\n" \
2597 "%s Monitor allocated swap\n" \
2598 "%f Monitor number of used file descriptors\n" \
2599 "%Ni Monitor total/specific IRQ rate\n" \
2600 "%x Monitor context switch rate\n" \
2601 "%p Monitor forks\n" \
2602 "%[pn] Monitor # of processes\n" \
2603 "%b Monitor block io\n" \
2604 "%Nt Show time (with N decimal points)\n" \
2605 "%Nd Milliseconds between updates (default=1000)\n" \
2606 "%r Print <cr> instead of <lf> at EOL"
2607 #define nmeter_example_usage \
2608 "nmeter '%250d%t %20c int %i bio %b mem %m forks%p'"
2610 #define nohup_trivial_usage \
2612 #define nohup_full_usage \
2613 "Run a command immune to hangups, with output to a non-tty"
2614 #define nohup_example_usage \
2617 #define nslookup_trivial_usage \
2619 #define nslookup_full_usage \
2620 "Query the nameserver for the IP address of the given HOST\n" \
2621 "optionally using a specified DNS server"
2622 #define nslookup_example_usage \
2623 "$ nslookup localhost\n" \
2624 "Server: default\n" \
2625 "Address: default\n" \
2628 "Address: 127.0.0.1\n"
2630 #define od_trivial_usage \
2631 "[-aBbcDdeFfHhIiLlOovXx] [FILE]"
2632 #define od_full_usage \
2633 "Write an unambiguous representation, octal bytes by default, of FILE\n" \
2634 "to standard output. With no FILE, or when FILE is -, read standard input."
2636 #define openvt_trivial_usage \
2637 "VTNUM COMMAND [ARGS...]"
2638 #define openvt_full_usage \
2639 "Start a command on a new virtual terminal"
2640 #define openvt_example_usage \
2641 "openvt 2 /bin/ash\n"
2643 #define passwd_trivial_usage \
2645 #define passwd_full_usage \
2646 "Change a user password. If no name is specified,\n" \
2647 "changes the password for the current user." \
2649 " -a Define which algorithm shall be used for the password\n" \
2650 " (choices: des, md5)\n" /* ", sha1)" */ \
2651 " -d Delete the password for the specified user account\n" \
2652 " -l Locks (disables) the specified user account\n" \
2653 " -u Unlocks (re-enables) the specified user account"
2655 #define chpasswd_trivial_usage \
2656 USE_GETOPT_LONG("[--md5|--encrypt]") SKIP_GETOPT_LONG("[-m|-e]")
2657 #define chpasswd_full_usage \
2658 "Read user:password information from stdin\n" \
2659 "and update /etc/passwd accordingly." \
2662 "\n -e,--encrypt Supplied passwords are in encrypted form" \
2663 "\n -m,--md5 Use MD5 encryption instead of DES" \
2666 "\n -e Supplied passwords are in encrypted form" \
2667 "\n -m Use MD5 encryption instead of DES" \
2670 #define patch_trivial_usage \
2671 "[-p num] [-i diff]"
2672 #define patch_full_usage \
2673 " -p NUM Strip NUM leading components from file names\n" \
2674 " -i DIFF Read DIFF instead of stdin"
2675 #define patch_example_usage \
2676 "$ patch -p1 < example.diff\n" \
2677 "$ patch -p0 -i example.diff"
2679 #define pgrep_trivial_usage \
2681 #define pgrep_full_usage \
2682 "Display process(es) selected by regex pattern" \
2684 " -l Show command name too\n" \
2685 " -f Match against entire command line\n" \
2686 " -n Signal the newest process only\n" \
2687 " -o Signal the oldest process only\n" \
2688 " -v Negate the matching\n" \
2689 " -x Match whole name (not substring)"
2691 #if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT)
2692 #define USAGE_PIDOF "Options:"
2694 #define USAGE_PIDOF "\nThis version of pidof accepts no options."
2697 #define pidof_trivial_usage \
2698 "process-name [OPTION] [process-name...]"
2700 #define pidof_full_usage \
2701 "List the PIDs of all processes with names that match the\n" \
2702 "names on the command line\n" \
2704 USE_FEATURE_PIDOF_SINGLE( \
2705 "\n -s Display only a single PID") \
2706 USE_FEATURE_PIDOF_OMIT( \
2707 "\n -o PID Omit given pid") \
2708 USE_FEATURE_PIDOF_OMIT( \
2709 "\n Use %PPID to omit the parent pid of pidof itself")
2710 #define pidof_example_usage \
2713 USE_FEATURE_PIDOF_OMIT( \
2714 "$ pidof /bin/sh\n20351 5973 5950\n") \
2715 USE_FEATURE_PIDOF_OMIT( \
2716 "$ pidof /bin/sh -o %PPID\n20351 5950")
2718 #if !ENABLE_FEATURE_FANCY_PING
2719 #define ping_trivial_usage \
2721 #define ping_full_usage \
2722 "Send ICMP ECHO_REQUEST packets to network hosts"
2723 #define ping6_trivial_usage \
2725 #define ping6_full_usage \
2726 "Send ICMP ECHO_REQUEST packets to network hosts"
2728 #define ping_trivial_usage \
2730 #define ping_full_usage \
2731 "Send ICMP ECHO_REQUEST packets to network hosts" \
2733 " -4, -6 Force IPv4 or IPv6 hostname resolution\n" \
2734 " -c CNT Send only CNT pings\n" \
2735 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2736 " -I iface/IP Use interface or IP address as source\n" \
2737 " -q Quiet, only displays output at start\n" \
2738 " and when finished"
2739 #define ping6_trivial_usage \
2741 #define ping6_full_usage \
2742 "Send ICMP ECHO_REQUEST packets to network hosts" \
2744 " -c CNT Send only CNT pings\n" \
2745 " -s SIZE Send SIZE data bytes in packets (default=56)\n" \
2746 " -I iface/IP Use interface or IP address as source\n" \
2747 " -q Quiet, only displays output at start\n" \
2748 " and when finished"
2750 #define ping_example_usage \
2751 "$ ping localhost\n" \
2752 "PING slag (127.0.0.1): 56 data bytes\n" \
2753 "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \
2755 "--- debian ping statistics ---\n" \
2756 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2757 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
2758 #define ping6_example_usage \
2759 "$ ping6 ip6-localhost\n" \
2760 "PING ip6-localhost (::1): 56 data bytes\n" \
2761 "64 bytes from ::1: icmp6_seq=0 ttl=64 time=20.1 ms\n" \
2763 "--- ip6-localhost ping statistics ---\n" \
2764 "1 packets transmitted, 1 packets received, 0% packet loss\n" \
2765 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
2767 #define pivot_root_trivial_usage \
2769 #define pivot_root_full_usage \
2770 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
2771 "the new root file system"
2773 #define pkill_trivial_usage \
2774 "[-l] | [-fnovx] [-signal] pattern"
2775 #define pkill_full_usage \
2776 "Send a signal to process(es) selected by regex pattern" \
2778 " -l List all signals\n" \
2779 " -f Match against entire command line\n" \
2780 " -n Signal the newest process only\n" \
2781 " -o Signal the oldest process only\n" \
2782 " -v Negate the matching\n" \
2783 " -x Match whole name (not substring)"
2785 #define poweroff_trivial_usage \
2786 "[-d delay] [-n] [-f]"
2787 #define poweroff_full_usage \
2788 "Halt and shut off power" \
2790 " -d Delay interval for halting\n" \
2791 " -n No call to sync()\n" \
2792 " -f Force power off (don't go through init)"
2794 #define printenv_trivial_usage \
2796 #define printenv_full_usage \
2797 "Print all or part of environment.\n" \
2798 "If no environment VARIABLE specified, print them all."
2800 #define printf_trivial_usage \
2801 "FORMAT [ARGUMENT...]"
2802 #define printf_full_usage \
2803 "Format and print ARGUMENT(s) according to FORMAT,\n" \
2804 "where FORMAT controls the output exactly as in C printf"
2805 #define printf_example_usage \
2806 "$ printf \"Val=%d\\n\" 5\n" \
2812 #define ps_trivial_usage \
2814 #define ps_full_usage \
2815 "Report process status" \
2817 "\n -o col1,col2=header Select columns for display" \
2819 #else /* !ENABLE_DESKTOP */
2821 #if !defined CONFIG_SELINUX && !ENABLE_FEATURE_PS_WIDE
2822 #define USAGE_PS "\nThis version of ps accepts no options"
2824 #define USAGE_PS "\nOptions:"
2827 #define ps_trivial_usage \
2829 #define ps_full_usage \
2830 "Report process status\n" \
2833 "\n -Z Show SE Linux context") \
2834 USE_FEATURE_PS_WIDE( \
2837 #endif /* ENABLE_DESKTOP */
2839 #define ps_example_usage \
2841 " PID Uid Gid State Command\n" \
2842 " 1 root root S init\n" \
2843 " 2 root root S [kflushd]\n" \
2844 " 3 root root S [kupdate]\n" \
2845 " 4 root root S [kpiod]\n" \
2846 " 5 root root S [kswapd]\n" \
2847 " 742 andersen andersen S [bash]\n" \
2848 " 743 andersen andersen S -bash\n" \
2849 " 745 root root S [getty]\n" \
2850 " 2990 andersen andersen R ps\n"
2852 #define pscan_trivial_usage \
2853 "[-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST"
2854 #define pscan_full_usage \
2855 "Scan a host, print all open ports" \
2857 "\n -p Scan from this port (default 1)" \
2858 "\n -P Scan up to this port (default 1024)" \
2859 "\n -t Timeout (default 5000 ms)" \
2860 "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \
2862 #define pwd_trivial_usage \
2864 #define pwd_full_usage \
2865 "Print the full filename of the current working directory"
2866 #define pwd_example_usage \
2870 #define raidautorun_trivial_usage \
2872 #define raidautorun_full_usage \
2873 "Tell the kernel to automatically search and start RAID arrays"
2874 #define raidautorun_example_usage \
2875 "$ raidautorun /dev/md0"
2877 #define rdate_trivial_usage \
2879 #define rdate_full_usage \
2880 "Get and possibly set the system date and time from a remote HOST" \
2882 " -s Set the system date and time (default)\n" \
2883 " -p Print the date and time"
2885 #define readahead_trivial_usage \
2887 #define readahead_full_usage \
2888 "Preload FILE(s) in RAM cache so that subsequent reads for those" \
2889 "files do not block on disk I/O"
2891 #define readlink_trivial_usage \
2892 USE_FEATURE_READLINK_FOLLOW("[-f] ") "FILE"
2893 #define readlink_full_usage \
2894 "Display the value of a symlink" \
2895 USE_FEATURE_READLINK_FOLLOW( \
2897 " -f Canonicalize by following all symlinks")
2899 #define readprofile_trivial_usage \
2901 #define readprofile_full_usage \
2903 " -m mapfile (Default: /boot/System.map)\n" \
2904 " -p profile (Default: /proc/profile)\n" \
2905 " -M mult Set the profiling multiplier to mult\n" \
2906 " -i Print only info about the sampling step\n" \
2908 " -a Print all symbols, even if count is 0\n" \
2909 " -b Print individual histogram-bin counts\n" \
2910 " -s Print individual counters within functions\n" \
2911 " -r Reset all the counters (root only)\n" \
2912 " -n Disable byte order auto-detection"
2914 #define realpath_trivial_usage \
2916 #define realpath_full_usage \
2917 "Return the absolute pathnames of given argument"
2919 #define reboot_trivial_usage \
2920 "[-d delay] [-n] [-f]"
2921 #define reboot_full_usage \
2922 "Reboot the system" \
2924 " -d Delay interval for rebooting\n" \
2925 " -n No call to sync()\n" \
2926 " -f Force reboot (don't go through init)"
2928 #define renice_trivial_usage \
2929 "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]"
2930 #define renice_full_usage \
2931 "Change priority of running processes" \
2933 " -n Adjust current nice value (smaller is faster)\n" \
2934 " -p Process id(s) (default)\n" \
2935 " -g Process group id(s)\n" \
2936 " -u Process user name(s) and/or id(s)"
2938 #define reset_trivial_usage \
2940 #define reset_full_usage \
2943 #define resize_trivial_usage \
2945 #define resize_full_usage \
2948 #define restorecon_trivial_usage \
2949 "[-iFnrRv] [-e excludedir]... [-o filename] [-f filename | pathname]"
2950 #define restorecon_full_usage \
2951 "Reset security contexts of files in pathname\n" \
2952 "\n -i Ignore files that do not exist" \
2953 "\n -f file File with list of files to process. Use - for stdin" \
2954 "\n -e directory Directory to exclude" \
2955 "\n -R,-r Recurse directories" \
2956 "\n -n Don't change any file labels" \
2957 "\n -o file Save list of files with incorrect context" \
2959 "\n -vv Show changed labels" \
2960 "\n -F Force reset of context to match file_context" \
2961 "\n for customizable files, or the user section," \
2962 "\n if it has changed"
2964 #define rm_trivial_usage \
2965 "[OPTION]... FILE..."
2966 #define rm_full_usage \
2967 "Remove (unlink) the FILE(s). You may use '--' to\n" \
2968 "indicate that all following arguments are non-options." \
2970 " -i Always prompt before removing each destination\n" \
2971 " -f Remove existing destinations, never prompt\n" \
2972 " -r,-R Remove the contents of directories recursively"
2973 #define rm_example_usage \
2974 "$ rm -rf /tmp/foo\n"
2976 #define rmdir_trivial_usage \
2977 "[OPTION]... DIRECTORY..."
2978 #define rmdir_full_usage \
2979 "Remove the DIRECTORY, if it is empty"
2980 #define rmdir_example_usage \
2981 "# rmdir /tmp/foo\n"
2983 #define rmmod_trivial_usage \
2984 "[OPTION]... [MODULE]..."
2985 #define rmmod_full_usage \
2986 "Unload the specified kernel modules from the kernel" \
2988 " -a Remove all unused modules (recursively)"
2989 #define rmmod_example_usage \
2992 #define route_trivial_usage \
2993 "[{add|del|delete}]"
2994 #define route_full_usage \
2995 "Edit the kernel's routing tables" \
2997 " -n Dont resolve names\n" \
2998 " -e Display other/more information\n" \
2999 " -A inet" USE_FEATURE_IPV6("{6}") " Select address family"
3001 #define rpm_trivial_usage \
3002 "-i -q[ildc]p package.rpm"
3003 #define rpm_full_usage \
3004 "Manipulate RPM packages" \
3006 "\n -i Install package" \
3007 "\n -q Query package" \
3008 "\n -p Query uninstalled package" \
3009 "\n -i Show information" \
3010 "\n -l List contents" \
3011 "\n -d List documents" \
3012 "\n -c List config files"
3014 #define rpm2cpio_trivial_usage \
3016 #define rpm2cpio_full_usage \
3017 "Output a cpio archive of the rpm file"
3019 #define runcon_trivial_usage \
3020 "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] COMMAND [args]\n" \
3021 " runcon CONTEXT COMMAND [args]"
3022 #define runcon_full_usage \
3023 "Run a program in a different security context\n\n" \
3024 " CONTEXT Complete security context\n" \
3026 " -c,--compute Compute process transition context before modifying\n" \
3027 " -t,--type=TYPE Type (for same role as parent)\n" \
3028 " -u,--user=USER User identity\n" \
3029 " -r,--role=ROLE Role\n" \
3030 " -l,--range=RNG Levelrange" \
3033 " -c Compute process transition context before modifying\n" \
3034 " -t TYPE Type (for same role as parent)\n" \
3035 " -u USER User identity\n" \
3037 " -l RNG Levelrange" \
3040 #define run_parts_trivial_usage \
3041 "[-t] "USE_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
3042 #define run_parts_full_usage \
3043 "Run a bunch of scripts in a directory" \
3045 " -t Prints what would be run, but does not actually run anything\n" \
3046 " -a ARG Pass ARG as an argument for every program invoked\n" \
3047 " -u MASK Set the umask to MASK before executing every program" \
3048 USE_FEATURE_RUN_PARTS_FANCY("\n -l Prints names of all matching files even when they are not executable")
3050 #define run_parts_example_usage \
3051 "$ run-parts -a start /etc/init.d\n" \
3052 "$ run-parts -a stop=now /etc/init.d\n\n" \
3053 "Let's assume you have a script foo/dosomething:\n" \
3055 "for i in $*; do eval $i; done; unset i\n" \
3056 "case \"$1\" in\n" \
3057 "start*) echo starting something;;\n" \
3058 "stop*) set -x; shutdown -h $stop;;\n" \
3060 "Running this yields:\n" \
3061 "$run-parts -a stop=+4m foo/\n" \
3064 #define runlevel_trivial_usage \
3066 #define runlevel_full_usage \
3067 "Find the current and previous system runlevel.\n\n" \
3068 "If no utmp file exists or if no runlevel record can be found,\n" \
3070 #define runlevel_example_usage \
3071 "$ runlevel /var/run/utmp\n" \
3074 #define runsv_trivial_usage \
3076 #define runsv_full_usage \
3077 "Start and monitor a service and optionally an appendant log service"
3079 #define runsvdir_trivial_usage \
3081 #define runsvdir_full_usage \
3082 "Start a runsv process for each subdirectory"
3084 #define rx_trivial_usage \
3086 #define rx_full_usage \
3087 "Receive a file using the xmodem protocol"
3088 #define rx_example_usage \
3091 #define sed_trivial_usage \
3092 "[-efinr] pattern [files...]"
3093 #define sed_full_usage \
3095 " -e script Add the script to the commands to be executed\n" \
3096 " -f scriptfile Add script-file contents to the\n" \
3097 " commands to be executed\n" \
3098 " -i Edit files in-place\n" \
3099 " -n Suppress automatic printing of pattern space\n" \
3100 " -r Use extended regular expression syntax\n" \
3102 "If no -e or -f is given, the first non-option argument is taken as the sed\n" \
3103 "script to interpret. All remaining arguments are names of input files; if no\n" \
3104 "input files are specified, then the standard input is read. Source files\n" \
3105 "will not be modified unless -i option is given."
3107 #define sed_example_usage \
3108 "$ echo \"foo\" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \
3111 #define selinuxenabled_trivial_usage
3112 #define selinuxenabled_full_usage
3114 #define seq_trivial_usage \
3115 "[first [increment]] last"
3116 #define seq_full_usage \
3117 "Print numbers from FIRST to LAST, in steps of INCREMENT.\n" \
3118 "FIRST, INCREMENT default to 1" \
3119 "\n\nArguments:\n" \
3122 " FIRST INCREMENT LAST"
3124 #define sestatus_trivial_usage \
3126 #define sestatus_full_usage \
3128 "-b Display current state of booleans"
3130 #define setconsole_trivial_usage \
3131 "[-r" USE_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
3132 #define setconsole_full_usage \
3133 "Redirect system console output to DEVICE (default: /dev/tty)" \
3135 " -r Reset output to /dev/console"
3137 #define setenforce_trivial_usage \
3138 "[Enforcing | Permissive | 1 | 0]"
3139 #define setenforce_full_usage
3141 #define setfiles_trivial_usage \
3142 "[-dnpqsvW] [-e dir]... [-o file] [-r alt_root_path]" \
3143 USE_FEATURE_SETFILES_CHECK_OPTION( \
3144 " [-c policyfile] spec_file" \
3148 #define setfiles_full_usage \
3149 "Reset file contexts under pathname according to spec_file" \
3150 USE_FEATURE_SETFILES_CHECK_OPTION( \
3151 "\n -c file Check the validity of the contexts against the specified binary policy" \
3153 "\n -d Show which specification matched each file" \
3154 "\n -l Log changes in file labels to syslog" \
3155 "\n -n Don't change any file labels" \
3156 "\n -q Suppress warnings" \
3157 "\n -r dir Use an altenate root path" \
3158 "\n -e dir Exclude directory" \
3159 "\n -F Force reset of context to match file_context for customizable files" \
3160 "\n -o file Save list of files with incorrect context" \
3161 "\n -s Take a list of files from standard input (instead of command line)" \
3162 "\n -v Show changes in file labels, if type or role are changing" \
3163 "\n -vv Show changes in file labels, if type, role, or user are changing" \
3164 "\n -W Display warnings about entries that had no matching files"
3166 #define setkeycodes_trivial_usage \
3167 "SCANCODE KEYCODE..."
3168 #define setkeycodes_full_usage \
3169 "Set entries into the kernel's scancode-to-keycode map,\n" \
3170 "allowing unusual keyboards to generate usable keycodes.\n\n" \
3171 "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
3172 "and KEYCODE is given in decimal"
3173 #define setkeycodes_example_usage \
3174 "$ setkeycodes e030 127\n"
3176 #define setlogcons_trivial_usage \
3178 #define setlogcons_full_usage \
3179 "Redirect the kernel output to console N (0 for current)"
3181 #define setsebool_trivial_usage \
3184 #define setsebool_full_usage \
3185 "Change boolean setting"
3187 #define setsid_trivial_usage \
3189 #define setsid_full_usage \
3190 "Run any program in a new session by calling setsid() before\n" \
3191 "exec'ing the rest of its arguments. See setsid(2) for details."
3193 #define lash_trivial_usage \
3195 "or: sh -c command [args]..."
3196 #define lash_full_usage \
3197 "The BusyBox LAme SHell (command interpreter)"
3198 #define lash_notes_usage \
3199 "This command does not yet have proper documentation.\n\n" \
3200 "Use lash just as you would use any other shell. It properly handles pipes,\n" \
3201 "redirects, job control, can be used as the shell for scripts, and has a\n" \
3202 "sufficient set of builtins to do what is needed. It does not (yet) support\n" \
3203 "Bourne Shell syntax. If you need things like \"if-then-else\", \"while\", and such\n" \
3204 "use ash or bash. If you just need a very simple and extremely small shell,\n" \
3205 "this will do the job."
3207 #define last_trivial_usage \
3209 #define last_full_usage \
3210 "Show listing of the last users that logged into the system"
3212 #define sha1sum_trivial_usage \
3213 "[OPTION] [FILEs...]" \
3214 USE_FEATURE_MD5_SHA1_SUM_CHECK("\n or: sha1sum [OPTION] -c [FILE]")
3215 #define sha1sum_full_usage \
3216 "Print" USE_FEATURE_MD5_SHA1_SUM_CHECK(" or check") " SHA1 checksums.\n" \
3217 "With no FILE, or when FILE is -, read standard input." \
3219 USE_FEATURE_MD5_SHA1_SUM_CHECK( \
3220 " -c Check SHA1 sums against given list\n" \
3221 "\nThe following two options are useful only when verifying checksums:\n" \
3222 " -s Don't output anything, status code shows success\n" \
3223 " -w Warn about improperly formatted SHA1 checksum lines")
3225 #define slattach_trivial_usage \
3226 "[-cehmLF] [-s speed] [-p protocol] DEVICEs"
3227 #define slattach_full_usage \
3228 "Attach network interface(s) to serial line(s)\n" \
3230 "\n -p Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \
3231 "\n -s Set line speed" \
3232 "\n -e Exit after initializing device" \
3233 "\n -h Exit when the carrier is lost" \
3234 "\n -c Execute a command when the line is hung up" \
3235 "\n -m Do NOT initialize the line in raw 8 bits mode" \
3236 "\n -L Enable 3-wire operation" \
3237 "\n -F Disable RTS/CTS flow control" \
3239 #define sleep_trivial_usage \
3240 USE_FEATURE_FANCY_SLEEP("[") "N" USE_FEATURE_FANCY_SLEEP("]...")
3241 #define sleep_full_usage \
3242 SKIP_FEATURE_FANCY_SLEEP("Pause for N seconds") \
3243 USE_FEATURE_FANCY_SLEEP( \
3244 "Pause for a time equal to the total of the args given, where each arg can\n" \
3245 "have an optional suffix of (s)econds, (m)inutes, (h)ours, or (d)ays")
3246 #define sleep_example_usage \
3248 "[2 second delay results]\n" \
3249 USE_FEATURE_FANCY_SLEEP( \
3250 "$ sleep 1d 3h 22m 8s\n" \
3251 "[98528 second delay results]\n")
3253 #define sort_trivial_usage \
3255 USE_FEATURE_SORT_BIG("gMcszbdfimSTokt] [-o outfile] [-k start[.offset][opts][,end[.offset][opts]] [-t char") \
3257 #define sort_full_usage \
3258 "Sort lines of text in the specified files" \
3260 USE_FEATURE_SORT_BIG( \
3261 " -b Ignore leading blanks\n" \
3262 " -c Check whether input is sorted\n" \
3263 " -d Dictionary order (blank or alphanumeric only)\n" \
3264 " -f Ignore case\n" \
3265 " -g General numerical sort\n" \
3266 " -i Ignore unprintable characters\n" \
3268 " -M Sort month\n") \
3269 " -n Sort numbers\n" \
3270 USE_FEATURE_SORT_BIG( \
3271 " -o Output to file\n" \
3272 " -k Sort by key\n" \
3273 " -t Use key separator other than whitespace\n") \
3274 " -r Reverse sort order\n" \
3275 USE_FEATURE_SORT_BIG( \
3276 " -s Stable (don't sort ties alphabetically)\n") \
3277 " -u Suppress duplicate lines" \
3278 USE_FEATURE_SORT_BIG( \
3279 "\n -z Input terminated by nulls, not newlines\n") \
3280 USE_FEATURE_SORT_BIG( \
3281 " -mST Ignored for GNU compatibility") \
3283 #define sort_example_usage \
3284 "$ echo -e \"e\\nf\\nb\\nd\\nc\\na\" | sort\n" \
3291 USE_FEATURE_SORT_BIG( \
3292 "$ echo -e \"c 3\\nb 2\\nd 2\" | $SORT -k 2,2n -k 1,1r\n" \
3299 #define split_trivial_usage \
3300 "[OPTION] [INPUT [PREFIX]]"
3301 #define split_full_usage \
3303 "\n -b n[k|m] Split by bytes" \
3304 "\n -l n Split by lines" \
3305 "\n -a n Use n letters as suffix"
3306 #define split_example_usage \
3307 "$ split TODO foo\n" \
3308 "$ cat TODO | split -a 2 -l 2 TODO_\n"
3310 #define start_stop_daemon_trivial_usage \
3312 USE_GETOPT_LONG("--start|--stop") SKIP_GETOPT_LONG("-S|-K") \
3313 "] ... [-- arguments...]"
3314 #define start_stop_daemon_full_usage \
3315 "Start and stop services" \
3318 "\n -S,--start Start" \
3319 "\n -K,--stop Stop" \
3320 "\n -a,--startas pathname Starts process specified by pathname" \
3321 "\n -b,--background Put process into background" \
3322 "\n -u,--user username|uid Stop this user's processes" \
3323 "\n -x,--exec executable Program to either start or check" \
3324 "\n -n,--name process-name Stop processes with this name" \
3325 "\n -p,--pidfile pid-file Save or load pid using a pid-file" \
3326 "\n -m,--make-pidfile Create the -p file and enter pid in it" \
3327 "\n -q,--quiet Quiet" \
3328 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3329 "\n -o,--oknodo Exit status 0 if nothing done" \
3330 "\n -v,--verbose Verbose" \
3331 "\n -N,--nicelevel N Add N to process's nice level" \
3333 "\n -s,--signal signal Signal to send (default TERM)" \
3334 "\n -c,--chuid user[:[grp]] Change to specified user/group" \
3339 "\n -a pathname Starts process specified by pathname" \
3340 "\n -b Put process into background" \
3341 "\n -u username|uid Stop this user's processes" \
3342 "\n -x executable Program to either start or check" \
3343 "\n -n process-name Stop processes with this name" \
3344 "\n -p pid-file Save or load pid using a pid-file" \
3345 "\n -m Create the -p file and enter pid in it" \
3347 USE_FEATURE_START_STOP_DAEMON_FANCY( \
3348 "\n -o Exit status 0 if nothing done" \
3350 "\n -N N Add N to process's nice level" \
3352 "\n -s signal Signal to send (default TERM)" \
3353 "\n -c user[:[grp]] Change to specified user/group" \
3356 #define stat_trivial_usage \
3358 #define stat_full_usage \
3359 "Display file (default) or filesystem status" \
3361 USE_FEATURE_STAT_FORMAT( \
3362 " -c fmt Use the specified format\n") \
3363 " -f Display filesystem status\n" \
3364 " -L,-l Dereference links\n" \
3365 " -t Display info in terse form" \
3367 "\n -Z Print security context" \
3369 USE_FEATURE_STAT_FORMAT( \
3370 "\n\nValid format sequences for files:\n" \
3371 " %a Access rights in octal\n" \
3372 " %A Access rights in human readable form\n" \
3373 " %b Number of blocks allocated (see %B)\n" \
3374 " %B The size in bytes of each block reported by %b\n" \
3375 " %d Device number in decimal\n" \
3376 " %D Device number in hex\n" \
3377 " %f Raw mode in hex\n" \
3379 " %g Group ID of owner\n" \
3380 " %G Group name of owner\n" \
3381 " %h Number of hard links\n" \
3382 " %i Inode number\n" \
3384 " %N Quoted file name with dereference if symlink\n" \
3385 " %o I/O block size\n" \
3386 " %s Total size, in bytes\n" \
3387 " %t Major device type in hex\n" \
3388 " %T Minor device type in hex\n" \
3389 " %u User ID of owner\n" \
3390 " %U User name of owner\n" \
3391 " %x Time of last access\n" \
3392 " %X Time of last access as seconds since Epoch\n" \
3393 " %y Time of last modification\n" \
3394 " %Y Time of last modification as seconds since Epoch\n" \
3395 " %z Time of last change\n" \
3396 " %Z Time of last change as seconds since Epoch\n" \
3397 "\nValid format sequences for file systems:\n" \
3398 " %a Free blocks available to non-superuser\n" \
3399 " %b Total data blocks in file system\n" \
3400 " %c Total file nodes in file system\n" \
3401 " %d Free file nodes in file system\n" \
3402 " %f Free blocks in file system\n" \
3404 " %C Security context in SELinux\n" \
3406 " %i File System ID in hex\n" \
3407 " %l Maximum length of filenames\n" \
3409 " %s Block size (for faster transfer)\n" \
3410 " %S Fundamental block size (for block counts)\n" \
3411 " %t Type in hex\n" \
3412 " %T Type in human readable form" \
3415 #define strings_trivial_usage \
3416 "[-afo] [-n length] [file...]"
3417 #define strings_full_usage \
3418 "Display printable strings in a binary file" \
3420 "\n -a Scan whole file (default)" \
3421 "\n -f Precede strings with filenames" \
3422 "\n -n N At least N characters form a string (default 4)" \
3423 "\n -o Precede strings with decimal offsets"
3425 #define stty_trivial_usage \
3426 "[-a|g] [-F DEVICE] [SETTING]..."
3427 #define stty_full_usage \
3428 "Without arguments, prints baud rate, line discipline,\n" \
3429 "and deviations from stty sane" \
3431 "\n -F DEVICE Open device instead of stdin" \
3432 "\n -a Print all current settings in human-readable form" \
3433 "\n -g Print in stty-readable form" \
3434 "\n [SETTING] See manpage"
3436 #define su_trivial_usage \
3437 "[OPTION]... [-] [username]"
3438 #define su_full_usage \
3439 "Change user id or become root" \
3441 "\n -p, -m Preserve environment" \
3442 "\n -c Command to pass to 'sh -c'" \
3443 "\n -s Shell to use instead of default shell"
3445 #define sulogin_trivial_usage \
3446 "[OPTION]... [tty-device]"
3447 #define sulogin_full_usage \
3448 "Single user login" \
3452 #define sum_trivial_usage \
3454 #define sum_full_usage \
3455 "Checksum and count the blocks in a file" \
3457 " -r Use BSD sum algorithm (1K blocks)\n" \
3458 " -s Use System V sum algorithm (512byte blocks)"
3460 #define sv_trivial_usage \
3461 "[-v] [-w sec] command service..."
3462 #define sv_full_usage \
3463 "Control services monitored by runsv supervisor.\n" \
3464 "Commands (only first character is enough):\n" \
3466 "status: query service status\n" \
3467 "up: if service isn't running, start it. If service stops, restart it\n" \
3468 "once: like 'up', but if service stops, don't restart it\n" \
3469 "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \
3470 " if it exists. After it stops, do not restart service\n" \
3471 "exit: send TERM and CONT signals to service and log service. If they exit,\n" \
3472 " runsv exits too\n" \
3473 "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \
3474 "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service"
3476 #define svlogd_trivial_usage \
3477 "[-ttv] [-r c] [-R abc] [-l len] [-b buflen] dir..."
3478 #define svlogd_full_usage \
3479 "Continuously read log data from standard input, optionally " \
3480 "filter log messages, and write the data to one or more automatically " \
3483 #define swapoff_trivial_usage \
3485 #define swapoff_full_usage \
3486 "Stop swapping virtual memory pages on DEVICE" \
3488 " -a Stop swapping on all swap devices"
3490 #define swapon_trivial_usage \
3492 #define swapon_full_usage \
3493 "Start swapping virtual memory pages on DEVICE" \
3495 " -a Start swapping on all swap devices"
3497 #define switch_root_trivial_usage \
3498 "[-c /dev/console] NEW_ROOT NEW_INIT [ARGUMENTS_TO_INIT]"
3499 #define switch_root_full_usage \
3500 "Use from PID 1 under initramfs to free initramfs, chroot to NEW_ROOT,\n" \
3501 "and exec NEW_INIT" \
3503 " -c Redirect console to device on new root"
3505 #define sync_trivial_usage \
3507 #define sync_full_usage \
3508 "Write all buffered filesystem blocks to disk"
3510 #define sysctl_trivial_usage \
3511 "[OPTIONS]... [VALUE]..."
3512 #define sysctl_full_usage \
3513 "Configure kernel parameters at runtime" \
3515 " -n Disable printing of key names\n" \
3516 " -w Change sysctl setting\n" \
3517 " -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)\n" \
3518 " -a Display all values\n" \
3519 " -A Display all values in table form"
3520 #define sysctl_example_usage \
3521 "sysctl [-n] variable...\n" \
3522 "sysctl [-n] -w variable=value...\n" \
3523 "sysctl [-n] -a\n" \
3524 "sysctl [-n] -p file (default /etc/sysctl.conf)\n" \
3527 #define syslogd_trivial_usage \
3529 #define syslogd_full_usage \
3530 "System logging utility.\n" \
3531 "Note that this version of syslogd ignores /etc/syslog.conf." \
3533 "\n -n Run in foreground" \
3534 "\n -O FILE Log to given file (default=/var/log/messages)" \
3535 "\n -l n Set local log level" \
3536 "\n -S Smaller logging output" \
3537 USE_FEATURE_ROTATE_LOGFILE( \
3538 "\n -s SIZE Max size (KB) before rotate (default=200KB, 0=off)" \
3539 "\n -b NUM Number of rotated logs to keep (default=1, max=99, 0=purge)") \
3540 USE_FEATURE_REMOTE_LOG( \
3541 "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \
3542 "\n -L Log locally and via network (default is network only if -R)") \
3543 USE_FEATURE_IPC_SYSLOG( \
3544 "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)")
3545 /* NB: -Csize shouldn't have space (because size is optional) */
3546 /* "\n -m MIN Minutes between MARK lines (default=20, 0=off)" */
3547 #define syslogd_example_usage \
3548 "$ syslogd -R masterlog:514\n" \
3549 "$ syslogd -R 192.168.1.1:601\n"
3551 #define tail_trivial_usage \
3552 "[OPTION]... [FILE]..."
3553 #define tail_full_usage \
3554 "Print last 10 lines of each FILE to standard output.\n" \
3555 "With more than one FILE, precede each with a header giving the\n" \
3556 "file name. With no FILE, or when FILE is -, read standard input." \
3558 USE_FEATURE_FANCY_TAIL( \
3559 "\n -c N[kbm] Output the last N bytes") \
3560 "\n -n N[kbm] Print last N lines instead of last 10" \
3561 "\n -f Output data as the file grows" \
3562 USE_FEATURE_FANCY_TAIL( \
3563 "\n -q Never output headers giving file names" \
3564 "\n -s SEC Wait SEC seconds between reads with -f" \
3565 "\n -v Always output headers giving file names" \
3567 "If the first character of N (bytes or lines) is a '+', output begins with\n" \
3568 "the Nth item from the start of each file, otherwise, print the last N items\n" \
3569 "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." )
3570 #define tail_example_usage \
3571 "$ tail -n 1 /etc/resolv.conf\n" \
3572 "nameserver 10.0.0.1\n"
3574 #define tar_trivial_usage \
3575 "-[" USE_FEATURE_TAR_CREATE("c") USE_FEATURE_TAR_GZIP("z") \
3576 USE_FEATURE_TAR_BZIP2("j") USE_FEATURE_TAR_LZMA("a") \
3577 USE_FEATURE_TAR_COMPRESS("Z") "xtvO] " \
3578 USE_FEATURE_TAR_FROM("[-X FILE] ") \
3579 "[-f TARFILE] [-C DIR] [FILE(s)]..."
3580 #define tar_full_usage \
3581 "Create, extract, or list files from a tar file" \
3583 USE_FEATURE_TAR_CREATE( \
3587 "\nArchive format selection:\n" \
3588 USE_FEATURE_TAR_GZIP( \
3589 " z Filter the archive through gzip\n") \
3590 USE_FEATURE_TAR_BZIP2( \
3591 " j Filter the archive through bzip2\n") \
3592 USE_FEATURE_TAR_LZMA( \
3593 " a Filter the archive through lzma\n") \
3594 USE_FEATURE_TAR_COMPRESS( \
3595 " Z Filter the archive through compress\n") \
3596 "\nFile selection:\n" \
3597 " f Name of TARFILE or \"-\" for stdin\n" \
3598 " O Extract to stdout\n" \
3599 USE_FEATURE_TAR_FROM( \
3600 " exclude File to exclude\n" \
3601 " X File with names to exclude\n") \
3602 " C Change to directory DIR before operation\n" \
3604 #define tar_example_usage \
3605 "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \
3606 "$ tar -cf /tmp/tarball.tar /usr/local\n"
3608 #define taskset_trivial_usage \
3609 "[OPTIONS] [mask] [pid | command [arg]...]"
3610 #define taskset_full_usage \
3611 "Set or get CPU affinity" \
3613 " -p Operate on an existing PID"
3614 #define taskset_example_usage \
3615 "$ taskset 0x7 ./dgemm_test&\n" \
3616 "$ taskset -p 0x1 $!\n" \
3617 "pid 4790's current affinity mask: 7\n" \
3618 "pid 4790's new affinity mask: 1\n" \
3619 "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \
3620 "pid 6671's current affinity mask: 1\n" \
3621 "pid 6671's new affinity mask: 1\n" \
3622 "$ taskset -p 1\n" \
3623 "pid 1's current affinity mask: 3\n"
3625 #define tee_trivial_usage \
3626 "[OPTION]... [FILE]..."
3627 #define tee_full_usage \
3628 "Copy standard input to each FILE, and also to standard output" \
3630 " -a Append to the given FILEs, do not overwrite\n" \
3631 " -i Ignore interrupt signals (SIGINT)"
3632 #define tee_example_usage \
3633 "$ echo \"Hello\" | tee /tmp/foo\n" \
3634 "$ cat /tmp/foo\n" \
3637 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
3638 #define telnet_trivial_usage \
3639 "[-a] [-l USER] HOST [PORT]"
3640 #define telnet_full_usage \
3641 "Connect to remote telnet server" \
3643 " -a Attempt an automatic login with the USER variable\n" \
3644 " -l USER Attempt an automatic login with the USER argument\n" \
3645 " HOST The official name, alias or the IP address of the\n" \
3647 " PORT The remote port number to connect to. If it is not\n" \
3648 " specified, the default telnet (23) port is used."
3650 #define telnet_trivial_usage \
3652 #define telnet_full_usage \
3653 "Connect to remote telnet server"
3656 #define telnetd_trivial_usage \
3658 #define telnetd_full_usage \
3659 "Handle incoming telnet connections" \
3660 SKIP_FEATURE_TELNETD_STANDALONE(" via inetd") \
3662 "\n -l LOGIN Exec LOGIN on connect" \
3663 "\n -f issue_file Display issue_file instead of /etc/issue" \
3664 "\n -K Close connection as soon as login exits" \
3665 "\n (normally wait until all programs close slave pty)" \
3666 USE_FEATURE_TELNETD_STANDALONE( \
3667 "\n -p PORT Port to listen to" \
3668 "\n -b ADDR Address to bind to" \
3669 "\n -F Run in foreground" \
3670 "\n -i Run as inetd subservice" \
3673 #define test_trivial_usage \
3674 "EXPRESSION\n or [ EXPRESSION ]"
3675 #define test_full_usage \
3676 "Check file types and compares values returning an exit code\n" \
3677 "determined by the value of EXPRESSION"
3678 #define test_example_usage \
3679 "$ test 1 -eq 2\n" \
3682 "$ test 1 -eq 1\n" \
3688 "$ [ -d /junk ]\n" \
3692 #define tcpsvd_trivial_usage \
3693 "[-hEv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] ip port prog..."
3694 /* with not-implemented options: */
3695 /* "[-hpEvv] [-c n] [-C n:msg] [-b n] [-u user] [-l name] [-i dir|-x cdb] [-t sec] ip port prog..." */
3696 #define tcpsvd_full_usage \
3697 "Creates TCP socket, binds it to ip:port and listens on it\n" \
3698 "for incoming connections. For each connection it runs prog." \
3700 "\nip IP to listen on. '0' = all" \
3701 "\nport Port to listen on" \
3702 "\nprog [arg] Program to run" \
3703 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3704 "\n-u user[:group] Change to user/group after bind" \
3705 "\n-c n Handle up to n connections simultaneously" \
3706 "\n-b n Allow a backlog of approximately n TCP SYNs" \
3707 "\n-C n[:msg] Allow only up to n connections from the same IP" \
3708 "\n New connections from this IP address are closed" \
3709 "\n immediately. 'msg' is written to the peer before close" \
3710 "\n-h Look up peer's hostname" \
3711 "\n-E Do not set up environment variables" \
3714 #define udpsvd_trivial_usage \
3715 "[-hEv] [-c n] [-u user] [-l name] ip port prog"
3716 #define udpsvd_full_usage \
3717 "Creates UDP socket, binds it to ip:port and listens on it\n" \
3718 "for incoming packets. For each packet it runs prog\n" \
3719 "(redirecting all further packets with same peer ip:port to it)." \
3721 "\nip IP to listen on. '0' = all" \
3722 "\nport Port to listen on" \
3723 "\nprog [arg] Program to run" \
3724 "\n-l name Local hostname (else looks up local hostname in DNS)" \
3725 "\n-u user[:group] Change to user/group after bind" \
3726 "\n-c n Handle up to n connections simultaneously" \
3727 "\n-h Look up peer's hostname" \
3728 "\n-E Do not set up environment variables" \
3731 #define tftp_trivial_usage \
3732 "[OPTION]... HOST [PORT]"
3733 #define tftp_full_usage \
3734 "Transfer a file from/to tftp server using \"octet\" mode" \
3736 "\n -l FILE Local FILE" \
3737 "\n -r FILE Remote FILE" \
3738 USE_FEATURE_TFTP_GET( \
3741 USE_FEATURE_TFTP_PUT( \
3744 USE_FEATURE_TFTP_BLOCKSIZE( \
3745 "\n -b SIZE Transfer blocks of SIZE octets" \
3747 #define time_trivial_usage \
3748 "[OPTION]... COMMAND [ARGS...]"
3749 #define time_full_usage \
3750 "Run the program COMMAND with arguments ARGS. When COMMAND finishes,\n" \
3751 "COMMAND's resource usage information is displayed." \
3755 #define top_trivial_usage \
3756 "[-b] [-n count] [-d seconds]"
3757 #define top_full_usage \
3758 "Provide a view of process activity in real time.\n" \
3759 "Read the status of all processes from /proc each <seconds>\n" \
3760 "and show the status for however many processes will fit on the screen."
3762 #define touch_trivial_usage \
3763 "[-c] FILE [FILE...]"
3764 #define touch_full_usage \
3765 "Update the last-modified date on the given FILE[s]" \
3767 " -c Do not create any files"
3768 #define touch_example_usage \
3769 "$ ls -l /tmp/foo\n" \
3770 "/bin/ls: /tmp/foo: No such file or directory\n" \
3771 "$ touch /tmp/foo\n" \
3772 "$ ls -l /tmp/foo\n" \
3773 "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n"
3775 #define tr_trivial_usage \
3776 "[-cds] STRING1 [STRING2]"
3777 #define tr_full_usage \
3778 "Translate, squeeze, and/or delete characters from\n" \
3779 "standard input, writing to standard output" \
3781 " -c Take complement of STRING1\n" \
3782 " -d Delete input characters coded STRING1\n" \
3783 " -s Squeeze multiple output characters of STRING2 into one character"
3784 #define tr_example_usage \
3785 "$ echo \"gdkkn vnqkc\" | tr [a-y] [b-z]\n" \
3788 #define traceroute_trivial_usage \
3789 "[-FIldnrv] [-f 1st_ttl] [-m max_ttl] [-p port#] [-q nqueries]\n" \
3790 " [-s src_addr] [-t tos] [-w wait] [-g gateway] [-i iface]\n" \
3791 " [-z pausemsecs] host [data size]"
3792 #define traceroute_full_usage \
3793 "Trace the route to \"host\"" \
3795 " -F Set the don't fragment bit\n" \
3796 " -I Use ICMP ECHO instead of UDP datagrams\n" \
3797 " -l Display the ttl value of the returned packet\n" \
3798 " -d Set SO_DEBUG options to socket\n" \
3799 " -n Print hop addresses numerically rather than symbolically\n" \
3800 " -r Bypass the normal routing tables and send directly to a host\n" \
3802 " -m max_ttl Max time-to-live (max number of hops)\n" \
3803 " -p port# Base UDP port number used in probes\n" \
3804 " (default is 33434)\n" \
3805 " -q nqueries Number of probes per 'ttl' (default 3)\n" \
3806 " -s src_addr IP address to use as the source address\n" \
3807 " -t tos Type-of-service in probe packets (default 0)\n" \
3808 " -w wait Time in seconds to wait for a response\n" \
3809 " (default 3 sec)\n" \
3810 " -g Loose source route gateway (8 max)"
3812 #define true_trivial_usage \
3814 #define true_full_usage \
3815 "Return an exit code of TRUE (0)"
3816 #define true_example_usage \
3821 #define tty_trivial_usage \
3823 #define tty_full_usage \
3824 "Print file name of standard input's terminal" \
3825 USE_INCLUDE_SUSv2( \
3827 " -s Print nothing, only return exit status")
3828 #define tty_example_usage \
3832 #define ttysize_trivial_usage \
3834 #define ttysize_full_usage \
3835 "Print dimension(s) of standard input's terminal, on error return 80x25"
3837 #define tune2fs_trivial_usage \
3838 "[-c max-mounts-count] [-e errors-behavior] [-g group] " \
3839 "[-i interval[d|m|w]] [-j] [-J journal-options] [-l] [-s sparse-flag] " \
3840 "[-m reserved-blocks-percent] [-o [^]mount-options[,...]] " \
3841 "[-r reserved-blocks-count] [-u user] [-C mount-count] " \
3842 "[-L volume-label] [-M last-mounted-dir] [-O [^]feature[,...]] " \
3843 "[-T last-check-time] [-U UUID] device"
3844 #define tune2fs_full_usage \
3845 "Adjust filesystem options on ext[23] filesystems"
3847 #define udhcpc_trivial_usage \
3848 "[-Cfbnqtv] [-c CID] [-V VCLS] [-H HOSTNAME] [-i INTERFACE]\n" \
3849 " [-p pidfile] [-r IP] [-s script]"
3850 #define udhcpc_full_usage \
3852 " -V,--vendorclass=CLASSID Vendor class identifier" \
3853 "\n -i,--interface=INTERFACE Interface to use (default eth0)" \
3854 "\n -H,-h,--hostname=HOSTNAME Client hostname" \
3855 "\n -c,--clientid=CLIENTID Client identifier" \
3856 "\n -C,--clientid-none Suppress default client identifier" \
3857 "\n -p,--pidfile=file Create pidfile" \
3858 "\n -r,--request=IP IP address to request" \
3859 "\n -s,--script=file Run file at dhcp events (default: /usr/share/udhcpc/default.script)" \
3860 "\n -t,--retries=N Send up to N request packets" \
3861 "\n -T,--timeout=N Try to get a lease for N seconds (default 3)" \
3862 "\n -A,--tryagain=N Wait N seconds (default 60) after failure" \
3863 "\n -f,--foreground Run in foreground" \
3864 "\n -b,--background Background if lease is not immediately obtained" \
3865 "\n -S,--syslog Log to syslog too" \
3866 "\n -n,--now Exit with failure if lease is not immediately obtained" \
3867 "\n -q,--quit Quit after obtaining lease" \
3868 "\n -R,--release Release IP on quit" \
3869 USE_FEATURE_UDHCPC_ARPING( \
3870 "\n -a,--arping Use arping to validate offered address" \
3871 "\n -W,--wait=N Wait N seconds after declining (default 10)" \
3875 " -V CLASSID Vendor class identifier" \
3876 "\n -i INTERFACE Interface to use (default: eth0)" \
3877 "\n -H,-h HOSTNAME Client hostname" \
3878 "\n -c CLIENTID Client identifier" \
3879 "\n -C Suppress default client identifier" \
3880 "\n -p file Create pidfile" \
3881 "\n -r IP IP address to request" \
3882 "\n -s file Run file at dhcp events (default: /usr/share/udhcpc/default.script)" \
3883 "\n -t N Send up to N request packets" \
3884 "\n -T N Try to get a lease for N seconds (default 3)" \
3885 "\n -A N Wait N seconds (default 60) after failure" \
3886 "\n -f Run in foreground" \
3887 "\n -b Background if lease is not immediately obtained" \
3888 "\n -S Log to syslog too" \
3889 "\n -n Exit with failure if lease is not immediately obtained" \
3890 "\n -q Quit after obtaining lease" \
3891 "\n -R Release IP on quit" \
3892 USE_FEATURE_UDHCPC_ARPING( \
3893 "\n -a Use arping to validate offered address" \
3894 "\n -W N Wait N seconds after declining (default 10)" \
3898 #define udhcpd_trivial_usage \
3899 "[-fS] [configfile]" \
3901 #define udhcpd_full_usage \
3903 "\n -f Run in foreground" \
3904 "\n -S Log to syslog too"
3906 #define umount_trivial_usage \
3907 "[flags] FILESYSTEM|DIRECTORY"
3908 #define umount_full_usage \
3909 "Unmount file systems" \
3911 USE_FEATURE_UMOUNT_ALL( \
3912 "\n -a Unmount all file systems" USE_FEATURE_MTAB_SUPPORT(" in /etc/mtab")) \
3913 USE_FEATURE_MTAB_SUPPORT( \
3914 "\n -n Don't erase /etc/mtab entries") \
3915 "\n -r Try to remount devices as read-only if mount is busy" \
3916 "\n -l Lazy umount (detach filesystem)" \
3917 "\n -f Force umount (i.e., unreachable NFS server)" \
3918 USE_FEATURE_MOUNT_LOOP( \
3919 "\n -D Do not free loop device (if a loop device has been used)")
3920 #define umount_example_usage \
3921 "$ umount /dev/hdc1\n"
3923 #define uname_trivial_usage \
3925 #define uname_full_usage \
3926 "Print certain system information. With no OPTION, same as -s." \
3928 " -a Print all information\n" \
3929 " -m The machine (hardware) type\n" \
3930 " -n Print machine's hostname\n" \
3931 " -r Print OS release\n" \
3932 " -s Print OS name\n" \
3933 " -p Print host processor type\n" \
3934 " -v Print OS version"
3935 #define uname_example_usage \
3937 "Linux debian 2.4.23 #2 Tue Dec 23 17:09:10 MST 2003 i686 GNU/Linux\n"
3939 #define uncompress_trivial_usage \
3940 "[-c] [-f] [name...]"
3941 #define uncompress_full_usage \
3942 "Uncompress .Z file[s]" \
3944 " -c Extract to stdout\n" \
3945 " -f Force overwrite an existing file"
3947 #define unexpand_trivial_usage \
3948 "[-f][-a][-t NUM] [FILE|-]"
3949 #define unexpand_full_usage \
3950 "Convert spaces to tabs, writing to standard output." \
3952 USE_FEATURE_UNEXPAND_LONG_OPTIONS( \
3953 "\n -a,--all Convert all blanks" \
3954 "\n -f,--first-only Convert only leading blanks" \
3955 "\n -t,--tabs=N Tabstops every N chars" \
3957 SKIP_FEATURE_UNEXPAND_LONG_OPTIONS( \
3958 "\n -a Convert all blanks" \
3959 "\n -f Convert only leading blanks" \
3960 "\n -t N Tabstops every N chars" \
3963 #define uniq_trivial_usage \
3964 "[-fscdu]... [INPUT [OUTPUT]]"
3965 #define uniq_full_usage \
3966 "Discard all but one of successive identical lines from INPUT\n" \
3967 "(or standard input), writing to OUTPUT (or standard output)" \
3969 " -c Prefix lines by the number of occurrences\n" \
3970 " -d Only print duplicate lines\n" \
3971 " -u Only print unique lines\n" \
3972 " -f N Skip the first N fields\n" \
3973 " -s N Skip the first N chars (after any skipped fields)"
3974 #define uniq_example_usage \
3975 "$ echo -e \"a\\na\\nb\\nc\\nc\\na\" | sort | uniq\n" \
3980 #define unix2dos_trivial_usage \
3982 #define unix2dos_full_usage \
3983 "Convert FILE from unix format to dos format. When no option\n" \
3984 "is given, the input is converted to the opposite output format.\n" \
3985 "When no file is given, use stdin/stdout." \
3987 " -u Output will be in UNIX format\n" \
3988 " -d Output will be in DOS format"
3990 #define unzip_trivial_usage \
3991 "[-opts[modifiers]] file[.zip] [list] [-x xlist] [-d exdir]"
3992 #define unzip_full_usage \
3993 "Extract files from ZIP archives" \
3995 " -l List archive contents (with -q for short form)\n" \
3996 " -n Never overwrite existing files (default)\n" \
3997 " -o Overwrite files without prompting\n" \
3998 " -p Send output to stdout\n" \
4000 " -x Exclude these files\n" \
4001 " -d Extract files into this directory"
4003 #define uptime_trivial_usage \
4005 #define uptime_full_usage \
4006 "Display the time since the last boot"
4007 #define uptime_example_usage \
4009 " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n"
4011 #define usleep_trivial_usage \
4013 #define usleep_full_usage \
4014 "Pause for N microseconds"
4015 #define usleep_example_usage \
4016 "$ usleep 1000000\n" \
4017 "[pauses for 1 second]\n"
4019 #define uudecode_trivial_usage \
4020 "[-o outfile] [infile]"
4021 #define uudecode_full_usage \
4022 "Uudecode a file\n" \
4023 "NB: finds outfile name in uuencoded source unless -o is given"
4024 #define uudecode_example_usage \
4025 "$ uudecode -o busybox busybox.uu\n" \
4026 "$ ls -l busybox\n" \
4027 "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n"
4029 #define uuencode_trivial_usage \
4030 "[-m] [infile] stored_filename"
4031 #define uuencode_full_usage \
4032 "Uuencode a file to stdout" \
4034 " -m Use base64 encoding per RFC1521"
4035 #define uuencode_example_usage \
4036 "$ uuencode busybox busybox\n" \
4037 "begin 755 busybox\n" \
4038 "<encoded file snipped>\n" \
4039 "$ uudecode busybox busybox > busybox.uu\n" \
4042 #define vconfig_trivial_usage \
4043 "COMMAND [OPTIONS]..."
4044 #define vconfig_full_usage \
4045 "Create and remove virtual ethernet devices" \
4047 " add [interface-name] [vlan_id]\n" \
4048 " rem [vlan-name]\n" \
4049 " set_flag [interface-name] [flag-num] [0 | 1]\n" \
4050 " set_egress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4051 " set_ingress_map [vlan-name] [skb_priority] [vlan_qos]\n" \
4052 " set_name_type [name-type]"
4054 #define vi_trivial_usage \
4055 "[OPTION] [FILE]..."
4056 #define vi_full_usage \
4059 " -R Read-only - do not write to the file"
4061 #define vlock_trivial_usage \
4063 #define vlock_full_usage \
4064 "Lock a virtual terminal. A password is required to unlock." \
4068 #define watch_trivial_usage \
4069 "[-n seconds] [-t] COMMAND..."
4070 #define watch_full_usage \
4071 "Execute a program periodically" \
4073 " -n Loop period in seconds (default 2)\n" \
4074 " -t Don't print header"
4075 #define watch_example_usage \
4077 "Mon Dec 17 10:31:40 GMT 2000\n" \
4078 "Mon Dec 17 10:31:42 GMT 2000\n" \
4079 "Mon Dec 17 10:31:44 GMT 2000"
4081 #define watchdog_trivial_usage \
4082 "[-t N[ms]] [-F] DEV"
4083 #define watchdog_full_usage \
4084 "Periodically write to watchdog device DEV" \
4086 "\n -t N Timer period (default 30)" \
4087 "\n -F Run in foreground" \
4089 "\nUse -t 500ms to specify period in milliseconds"
4091 #define wc_trivial_usage \
4092 "[OPTION]... [FILE]..."
4093 #define wc_full_usage \
4094 "Print line, word, and byte counts for each FILE, and a total line if\n" \
4095 "more than one FILE is specified. With no FILE, read standard input." \
4097 " -c Print the byte counts\n" \
4098 " -l Print the newline counts\n" \
4099 " -L Print the length of the longest line\n" \
4100 " -w Print the word counts"
4101 #define wc_example_usage \
4102 "$ wc /etc/passwd\n" \
4103 " 31 46 1365 /etc/passwd\n"
4105 #define wget_trivial_usage \
4107 "[-c|--continue] [-s|--spider] [-q|--quiet] [-O|--output-document file]\n" \
4108 " [--header 'header: value'] [-Y|--proxy on/off] [-P DIR]\n" \
4109 " [-U|--user-agent agent] url" \
4112 "[-csq] [-O file] [-Y on/off] [-P DIR] [-U agent] url" \
4114 #define wget_full_usage \
4115 "Retrieve files via HTTP or FTP" \
4117 " -s Spider mode - only check file existence\n" \
4118 " -c Continue retrieval of aborted transfer\n" \
4120 " -P Set directory prefix to DIR\n" \
4121 " -O Save to filename ('-' for stdout)\n" \
4122 " -U Adjust 'User-Agent' field\n" \
4123 " -Y Use proxy ('on' or 'off')"
4125 #define which_trivial_usage \
4127 #define which_full_usage \
4129 #define which_example_usage \
4133 #define who_trivial_usage \
4135 #define who_full_usage \
4136 "Show who is logged on" \
4140 #define whoami_trivial_usage \
4142 #define whoami_full_usage \
4143 "Print the user name associated with the current effective user id"
4145 #define xargs_trivial_usage \
4146 "[OPTIONS] [COMMAND] [ARGS...]"
4147 #define xargs_full_usage \
4148 "Execute COMMAND on every item given by standard input" \
4150 USE_FEATURE_XARGS_SUPPORT_CONFIRMATION( \
4151 " -p Prompt the user about whether to run each command\n") \
4152 " -r Do not run command for empty read lines\n" \
4153 USE_FEATURE_XARGS_SUPPORT_TERMOPT( \
4154 " -x Exit if the size is exceeded\n") \
4155 USE_FEATURE_XARGS_SUPPORT_ZERO_TERM( \
4156 " -0 Input filenames are terminated by a null character\n") \
4157 " -t Print the command line on stderr before executing it"
4158 #define xargs_example_usage \
4159 "$ ls | xargs gzip\n" \
4160 "$ find . -name '*.c' -print | xargs rm\n"
4162 #define yes_trivial_usage \
4163 "[OPTION]... [STRING]..."
4164 #define yes_full_usage \
4165 "Repeatedly output a line with all specified STRING(s), or 'y'"
4167 #define zcat_trivial_usage \
4169 #define zcat_full_usage \
4170 "Uncompress to stdout"
4172 #define zcip_trivial_usage \
4173 "[OPTIONS] ifname script"
4174 #define zcip_full_usage \
4175 "Manage a ZeroConf IPv4 link-local address" \
4177 " -f Run in foreground\n" \
4178 " -q Quit after address (no daemon)\n" \
4179 " -r 169.254.x.x Request this address first\n" \
4182 #endif /* __BB_USAGE_H__ */
projects / oweals / busybox.git / blob