diff options
author | John Beppu <beppu@lbox.org> | 2000-04-13 03:16:01 +0000 |
---|---|---|
committer | John Beppu <beppu@lbox.org> | 2000-04-13 03:16:01 +0000 |
commit | f17792ca9b7cf659e3187a0f37380ca9384d8fbf (patch) | |
tree | 16a6052874fb14731f2c3e7332e17b441ba7df1f | |
parent | 61677feff7f549a48267c2c0c50a7420de6e2599 (diff) | |
download | busybox-w32-f17792ca9b7cf659e3187a0f37380ca9384d8fbf.tar.gz busybox-w32-f17792ca9b7cf659e3187a0f37380ca9384d8fbf.tar.bz2 busybox-w32-f17792ca9b7cf659e3187a0f37380ca9384d8fbf.zip |
+ formatting modifications to make pod2man(1p) happy.
-rw-r--r-- | docs/busybox.pod | 71 |
1 files changed, 41 insertions, 30 deletions
diff --git a/docs/busybox.pod b/docs/busybox.pod index 655e07bca..38e490115 100644 --- a/docs/busybox.pod +++ b/docs/busybox.pod | |||
@@ -34,23 +34,23 @@ tries to make itself useful to small systems with limited resources. | |||
34 | 34 | ||
35 | Currently defined functions include: | 35 | Currently defined functions include: |
36 | 36 | ||
37 | basename, cat, chmod, chown, chgrp, chroot, clear, chvt, cp, mv, date, | 37 | basename, cat, chmod, chown, chgrp, chroot, clear, chvt, cp, mv, date, |
38 | dd, df, dirname, dmesg, du, dutmp, echo, fbset, fdflush, find, free, | 38 | dd, df, dirname, dmesg, du, dutmp, echo, fbset, fdflush, find, free, |
39 | freeramdisk, deallocvt, fsck.minix, mkfs.minix, grep, gunzip, gzip, | 39 | freeramdisk, deallocvt, fsck.minix, mkfs.minix, grep, gunzip, gzip, |
40 | halt, head, hostid, hostname, init, kill, killall, length, ln, loadacm, | 40 | halt, head, hostid, hostname, init, kill, killall, length, ln, loadacm, |
41 | loadfont, loadkmap, ls, lsmod, makedevs, math, mkdir, mkfifo, mknod, | 41 | loadfont, loadkmap, ls, lsmod, makedevs, math, mkdir, mkfifo, mknod, |
42 | mkswap, mnc, more, mount, mt, nslookup, poweroff, ping, printf, ps, | 42 | mkswap, mnc, more, mount, mt, nslookup, poweroff, ping, printf, ps, |
43 | pwd, reboot, rm, rmdir, rmmod, sed, sh, fdisk, sfdisk, sleep, sort, | 43 | pwd, reboot, rm, rmdir, rmmod, sed, sh, fdisk, sfdisk, sleep, sort, |
44 | sync, syslogd, logger, logname, swapon, swapoff, tail, tar, [, test, | 44 | sync, syslogd, logger, logname, swapon, swapoff, tail, tar, [, test, |
45 | tee, touch, tr, true, false, tty, umount, uname, uptime, uniq, update, | 45 | tee, touch, tr, true, false, tty, umount, uname, uptime, uniq, update, |
46 | usleep, wc, whoami, yes, zcat | 46 | usleep, wc, whoami, yes, zcat |
47 | 47 | ||
48 | =head1 OPTIONS | 48 | =head1 OPTIONS |
49 | 49 | ||
50 | Common Options: | 50 | Common Options: |
51 | 51 | ||
52 | Most BusyBox commands support the "--help" option to provide a | 52 | Most BusyBox commands support the B<--help> option to provide a |
53 | terse runtime description of their behavior. | 53 | terse runtime description of their behavior. |
54 | 54 | ||
55 | =over 4 | 55 | =over 4 |
56 | 56 | ||
@@ -80,7 +80,7 @@ Example: | |||
80 | 80 | ||
81 | =item chmod | 81 | =item chmod |
82 | 82 | ||
83 | Usage: chmod [-R] MODE[,MODE]... FILE... | 83 | Usage: chmod [B<-R>] MODE[,MODE]... FILE... |
84 | 84 | ||
85 | Changes file access permissions for the specified file(s) or directory(s). | 85 | Changes file access permissions for the specified file(s) or directory(s). |
86 | Each MODE is defined by combining the letters for WHO has access to the file, | 86 | Each MODE is defined by combining the letters for WHO has access to the file, |
@@ -223,12 +223,13 @@ Usage: date [OPTION]... [+FORMAT] | |||
223 | Display the current time in the given FORMAT, or set the system date. | 223 | Display the current time in the given FORMAT, or set the system date. |
224 | 224 | ||
225 | Options: | 225 | Options: |
226 | |||
226 | -R output RFC-822 compliant date string | 227 | -R output RFC-822 compliant date string |
227 | -s set time described by STRING | 228 | -s set time described by STRING |
228 | -u print or set Coordinated Universal Time | 229 | -u print or set Coordinated Universal Time |
229 | 230 | ||
230 | Example: | 231 | Example: |
231 | 232 | ||
232 | $ date | 233 | $ date |
233 | Wed Apr 12 18:52:41 MDT 2000 | 234 | Wed Apr 12 18:52:41 MDT 2000 |
234 | 235 | ||
@@ -272,7 +273,7 @@ Exmaple: | |||
272 | 273 | ||
273 | =item dmesg | 274 | =item dmesg |
274 | 275 | ||
275 | Usage: dmesg [-c] [-n level] [-s bufsize] | 276 | Usage: dmesg [B<-c>] [B<-n> level] [B<-s> bufsize] |
276 | 277 | ||
277 | Print or controls the kernel ring buffer. | 278 | Print or controls the kernel ring buffer. |
278 | 279 | ||
@@ -284,6 +285,7 @@ Summarize disk space used for each FILE and/or directory. | |||
284 | Disk space is printed in units of 1k (i.e. 1024 bytes). | 285 | Disk space is printed in units of 1k (i.e. 1024 bytes). |
285 | 286 | ||
286 | Options: | 287 | Options: |
288 | |||
287 | -l count sizes many times if hard linked | 289 | -l count sizes many times if hard linked |
288 | -s display only a total for each argument | 290 | -s display only a total for each argument |
289 | 291 | ||
@@ -369,11 +371,12 @@ Deallocates unused virtual terminal /dev/ttyN | |||
369 | 371 | ||
370 | =item fsck.minix | 372 | =item fsck.minix |
371 | 373 | ||
372 | Usage: fsck.minix [-larvsmf] /dev/name | 374 | Usage: fsck.minix [B<-larvsmf>] /dev/name |
373 | 375 | ||
374 | Performs a consistency check for MINIX filesystems. | 376 | Performs a consistency check for MINIX filesystems. |
375 | 377 | ||
376 | OPTIONS: | 378 | OPTIONS: |
379 | |||
377 | -l Lists all filenames | 380 | -l Lists all filenames |
378 | -r Perform interactive repairs | 381 | -r Perform interactive repairs |
379 | -a Perform automatic repairs | 382 | -a Perform automatic repairs |
@@ -385,11 +388,12 @@ OPTIONS: | |||
385 | 388 | ||
386 | =item mkfs.minix | 389 | =item mkfs.minix |
387 | 390 | ||
388 | Usage: mkfs.minix [-c | -l filename] [-nXX] [-iXX] /dev/name [blocks] | 391 | Usage: mkfs.minix [B<-c> | B<-l> filename] [B<-nXX>] [B<-iXX>] /dev/name [blocks] |
389 | 392 | ||
390 | Make a MINIX filesystem. | 393 | Make a MINIX filesystem. |
391 | 394 | ||
392 | OPTIONS: | 395 | OPTIONS: |
396 | |||
393 | -c Check the device for bad blocks | 397 | -c Check the device for bad blocks |
394 | -n [14|30] Specify the maximum length of filenames | 398 | -n [14|30] Specify the maximum length of filenames |
395 | -i Specify the number of inodes for the filesystem | 399 | -i Specify the number of inodes for the filesystem |
@@ -404,6 +408,7 @@ Usage: grep [OPTIONS]... PATTERN [FILE]... | |||
404 | Search for PATTERN in each FILE or standard input. | 408 | Search for PATTERN in each FILE or standard input. |
405 | 409 | ||
406 | OPTIONS: | 410 | OPTIONS: |
411 | |||
407 | -h suppress the prefixing filename on output | 412 | -h suppress the prefixing filename on output |
408 | -i ignore case distinctions | 413 | -i ignore case distinctions |
409 | -n print line number with output lines | 414 | -n print line number with output lines |
@@ -428,6 +433,7 @@ With more than one FILE, precede each with a header giving the | |||
428 | file name. With no FILE, or when FILE is -, read standard input. | 433 | file name. With no FILE, or when FILE is -, read standard input. |
429 | 434 | ||
430 | Options: | 435 | Options: |
436 | |||
431 | -n NUM Print first NUM lines instead of first 10 | 437 | -n NUM Print first NUM lines instead of first 10 |
432 | 438 | ||
433 | Example: | 439 | Example: |
@@ -438,12 +444,13 @@ Example: | |||
438 | 444 | ||
439 | =item hostname | 445 | =item hostname |
440 | 446 | ||
441 | Usage: hostname [OPTION] {hostname | -F file} | 447 | Usage: hostname [OPTION] {hostname | B<-F> file} |
442 | 448 | ||
443 | Get or set the hostname or DNS domain name. If a hostname is given | 449 | Get or set the hostname or DNS domain name. If a hostname is given |
444 | (or a file with the -F parameter), the host name will be set. | 450 | (or a file with the B<-F> parameter), the host name will be set. |
445 | 451 | ||
446 | Options: | 452 | Options: |
453 | |||
447 | -s Short | 454 | -s Short |
448 | -i Addresses for the hostname | 455 | -i Addresses for the hostname |
449 | -d DNS domain name | 456 | -d DNS domain name |
@@ -456,11 +463,12 @@ Example: | |||
456 | 463 | ||
457 | =item kill | 464 | =item kill |
458 | 465 | ||
459 | Usage: kill [-signal] process-id [process-id ...] | 466 | Usage: kill [B<-signal>] process-id [process-id ...] |
460 | 467 | ||
461 | Send a signal (default is SIGTERM) to the specified process(es). | 468 | Send a signal (default is SIGTERM) to the specified process(es). |
462 | 469 | ||
463 | Options: | 470 | Options: |
471 | |||
464 | -l List all signal names and numbers. | 472 | -l List all signal names and numbers. |
465 | 473 | ||
466 | Example: | 474 | Example: |
@@ -487,7 +495,7 @@ Options: | |||
487 | 495 | ||
488 | =item ls | 496 | =item ls |
489 | 497 | ||
490 | Usage: ls [-1acdelnpuxACF] [filenames...] | 498 | Usage: ls [B<-1acdelnpuxACF>] [filenames...] |
491 | 499 | ||
492 | 500 | ||
493 | =item lsmod | 501 | =item lsmod |
@@ -519,7 +527,7 @@ TYPEs include: | |||
519 | 527 | ||
520 | =item mkswap | 528 | =item mkswap |
521 | 529 | ||
522 | Usage: mkswap [-c] [-v0|-v1] device [block-count] | 530 | Usage: mkswap [B<-c>] [-v0|-v1] device [block-count] |
523 | Prepare a disk partition to be used as a swap partition. | 531 | Prepare a disk partition to be used as a swap partition. |
524 | 532 | ||
525 | Options: | 533 | Options: |
@@ -539,7 +547,7 @@ Usage: more [file ...] | |||
539 | 547 | ||
540 | Usage: mount [flags] | 548 | Usage: mount [flags] |
541 | 549 | ||
542 | mount [flags] device directory [-o options,more-options] | 550 | mount [flags] device directory [B<-o> options,more-options] |
543 | 551 | ||
544 | Flags: | 552 | Flags: |
545 | -a: Mount all file systems in fstab. | 553 | -a: Mount all file systems in fstab. |
@@ -612,7 +620,7 @@ Remove the DIRECTORY(ies), if they are empty. | |||
612 | 620 | ||
613 | =item sed | 621 | =item sed |
614 | 622 | ||
615 | Usage: sed [-n] -e script [file...] | 623 | Usage: sed [B<-n>] B<-e> script [file...] |
616 | Allowed sed scripts come in the following form: | 624 | Allowed sed scripts come in the following form: |
617 | 625 | ||
618 | 'ADDR [!] COMMAND' | 626 | 'ADDR [!] COMMAND' |
@@ -630,8 +638,8 @@ Allowed sed scripts come in the following form: | |||
630 | 638 | ||
631 | Options: | 639 | Options: |
632 | 640 | ||
633 | -e add the script to the commands to be executed | 641 | -e add the script to the commands to be executed |
634 | -n suppress automatic printing of pattern space | 642 | -n suppress automatic printing of pattern space |
635 | 643 | ||
636 | This version of sed matches full regular expresions. | 644 | This version of sed matches full regular expresions. |
637 | 645 | ||
@@ -720,7 +728,7 @@ Options: | |||
720 | 728 | ||
721 | =item touch | 729 | =item touch |
722 | 730 | ||
723 | Usage: touch [-c] file [file ...] | 731 | Usage: touch [B<-c>] file [file ...] |
724 | Update the last-modified date on the given file[s]. | 732 | Update the last-modified date on the given file[s]. |
725 | 733 | ||
726 | 734 | ||
@@ -735,7 +743,8 @@ Usage: touch [-c] file [file ...] | |||
735 | =item uname | 743 | =item uname |
736 | 744 | ||
737 | Usage: uname [OPTION]... | 745 | Usage: uname [OPTION]... |
738 | Print certain system information. With no OPTION, same as -s. | 746 | |
747 | Print certain system information. With no OPTION, same as B<-s>. | ||
739 | 748 | ||
740 | Options: | 749 | Options: |
741 | 750 | ||
@@ -751,7 +760,9 @@ Options: | |||
751 | =item umount | 760 | =item umount |
752 | 761 | ||
753 | Usage: Usage: umount [flags] filesystem|directory | 762 | Usage: Usage: umount [flags] filesystem|directory |
754 | Flags: | 763 | |
764 | Flags: | ||
765 | |||
755 | -a: Unmount all file systems | 766 | -a: Unmount all file systems |
756 | 767 | ||
757 | 768 | ||
@@ -797,7 +808,7 @@ Options: | |||
797 | Usage: gzip [OPTION]... FILE | 808 | Usage: gzip [OPTION]... FILE |
798 | 809 | ||
799 | Compress FILE with maximum compression. | 810 | Compress FILE with maximum compression. |
800 | When FILE is -, reads standard input. Implies -c. | 811 | When FILE is -, reads standard input. Implies B<-c>. |
801 | 812 | ||
802 | Options: | 813 | Options: |
803 | 814 | ||