summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJohn Beppu2001-03-15 21:08:01 +0000
committerJohn Beppu2001-03-15 21:08:01 +0000
commite708cb5f9a74d8243ba3a223395466951255badc (patch)
treebab7fbe2ba6c217c838e88df0ef1d51becd71018 /docs
parenta4edd0e946f47dfca4fe0d5ed410743bdcda131c (diff)
downloadbusybox-e708cb5f9a74d8243ba3a223395466951255badc.zip
busybox-e708cb5f9a74d8243ba3a223395466951255badc.tar.gz
- generated middle section of busybox.pod w/ autodocifier.pl
- updated autodocifier.pl to use tab to indent example section
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/autodocifier.pl13
-rw-r--r--docs/busybox.pod762
2 files changed, 357 insertions, 418 deletions
diff --git a/docs/autodocifier.pl b/docs/autodocifier.pl
index 7c3aa50..567b103 100755
--- a/docs/autodocifier.pl
+++ b/docs/autodocifier.pl
@@ -69,13 +69,12 @@ sub pod_for_usage {
# prepare example if one exists
my $example = (defined $usage->{example})
- ? $usage->{example}
+ ?
+ "Example:\n\n" .
+ join ("\n",
+ map { "\t$_" }
+ split("\n", $usage->{example})) . "\n\n"
: "";
- $example =
- "Example:\n\n" .
- join ("\n",
- map { " $_" }
- split("\n", $example)) . "\n\n";
return
"=item I<$name>".
@@ -227,4 +226,4 @@ John BEPPU <beppu@lineo.com>
=cut
-# $Id: autodocifier.pl,v 1.16 2001/03/15 20:49:25 beppu Exp $
+# $Id: autodocifier.pl,v 1.17 2001/03/15 21:08:01 beppu Exp $
diff --git a/docs/busybox.pod b/docs/busybox.pod
index d7786dd..c5d7396 100644
--- a/docs/busybox.pod
+++ b/docs/busybox.pod
@@ -68,11 +68,8 @@ swapoff, swapon, sync, syslogd, tail, tar, tee, telnet, test, tftp, touch, tr,
true, tty, umount, uname, uniq, unix2dos, update, uptime, usleep, uudecode,
uuencode, watchdog, wc, wget, which, whoami, xargs, yes, zcat, [
--------------------------------
-
=over 4
-
=item I<ar>
ar -[ovR]{ptx} archive filenames
@@ -99,12 +96,12 @@ If specified, also removes any trailing SUFFIX.
Example:
-$ basename /usr/local/bin/foo
-foo
-$ basename /usr/local/bin/
-bin
-$ basename /foo/bar.txt .txt
-bar
+ $ basename /usr/local/bin/foo
+ foo
+ $ basename /usr/local/bin/
+ bin
+ $ basename /foo/bar.txt .txt
+ bar
-------------------------------
@@ -116,8 +113,8 @@ Concatenates FILE(s) and prints them to stdout.
Example:
-$ cat /proc/uptime
-110716.72 17.67
+ $ cat /proc/uptime
+ 110716.72 17.67
-------------------------------
@@ -133,12 +130,11 @@ Options:
Example:
-$ ls -l /tmp/foo
--r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo
-$ chgrp root /tmp/foo
-$ ls -l /tmp/foo
--r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo
-
+ $ ls -l /tmp/foo
+ -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo
+ $ chgrp root /tmp/foo
+ $ ls -l /tmp/foo
+ -r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo
-------------------------------
@@ -155,15 +151,14 @@ Options:
Example:
-$ ls -l /tmp/foo
--rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo
-$ chmod u+x /tmp/foo
-$ ls -l /tmp/foo
--rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*
-$ chmod 444 /tmp/foo
-$ ls -l /tmp/foo
--r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo
-
+ $ ls -l /tmp/foo
+ -rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo
+ $ chmod u+x /tmp/foo
+ $ ls -l /tmp/foo
+ -rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*
+ $ chmod 444 /tmp/foo
+ $ ls -l /tmp/foo
+ -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo
-------------------------------
@@ -179,15 +174,14 @@ Options:
Example:
-$ ls -l /tmp/foo
--r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo
-$ chown root /tmp/foo
-$ ls -l /tmp/foo
--r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo
-$ chown root.root /tmp/foo
-ls -l /tmp/foo
--r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo
-
+ $ ls -l /tmp/foo
+ -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo
+ $ chown root /tmp/foo
+ $ ls -l /tmp/foo
+ -r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo
+ $ chown root.root /tmp/foo
+ ls -l /tmp/foo
+ -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo
-------------------------------
@@ -199,13 +193,12 @@ Run COMMAND with root directory set to NEWROOT.
Example:
-$ ls -l /bin/ls
-lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox
-$ mount /dev/hdc1 /mnt -t minix
-$ chroot /mnt
-$ ls -l /bin/ls
--rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*
-
+ $ ls -l /bin/ls
+ lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox
+ $ mount /dev/hdc1 /mnt -t minix
+ $ chroot /mnt
+ $ ls -l /bin/ls
+ -rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*
-------------------------------
@@ -264,11 +257,10 @@ Options:
Example:
-$ echo Hello world | cut -f 1 -d ' '
-Hello
-$ echo Hello world | cut -f 2 -d ' '
-world
-
+ $ echo Hello world | cut -f 1 -d ' '
+ Hello
+ $ echo Hello world | cut -f 2 -d ' '
+ world
-------------------------------
@@ -287,9 +279,8 @@ Options:
Example:
-$ date
-Wed Apr 12 18:52:41 MDT 2000
-
+ $ date
+ Wed Apr 12 18:52:41 MDT 2000
-------------------------------
@@ -303,17 +294,16 @@ i.e. 'dc 2 2 add' -> 4, and 'dc 8 8 \* 2 2 + /' -> 16
Example:
-$ dc 2 2 +
-4
-$ dc 8 8 * 2 2 + /
-16
-$ dc 0 1 and
-0
-$ dc 0 1 or
-1
-$ echo 72 9 div 8 mul | dc
-64
-
+ $ dc 2 2 +
+ 4
+ $ dc 8 8 * 2 2 + /
+ 16
+ $ dc 0 1 and
+ 0
+ $ dc 0 1 or
+ 1
+ $ echo 72 9 div 8 mul | dc
+ 64
-------------------------------
@@ -338,10 +328,9 @@ MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824).
Example:
-$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4
-4+0 records in
-4+0 records out
-
+ $ dd if=/dev/zero of=/dev/ram1 bs=1M count=4
+ 4+0 records in
+ 4+0 records out
-------------------------------
@@ -367,14 +356,13 @@ Options:
Example:
-$ df
-Filesystem 1k-blocks Used Available Use% Mounted on
-/dev/sda3 8690864 8553540 137324 98% /
-/dev/sda1 64216 36364 27852 57% /boot
-$ df /dev/sda3
-Filesystem 1k-blocks Used Available Use% Mounted on
-/dev/sda3 8690864 8553540 137324 98% /
-
+ $ df
+ Filesystem 1k-blocks Used Available Use% Mounted on
+ /dev/sda3 8690864 8553540 137324 98% /
+ /dev/sda1 64216 36364 27852 57% /boot
+ $ df /dev/sda3
+ Filesystem 1k-blocks Used Available Use% Mounted on
+ /dev/sda3 8690864 8553540 137324 98% /
-------------------------------
@@ -386,11 +374,10 @@ Strips non-directory suffix from FILENAME
Example:
-$ dirname /tmp/foo
-/tmp
-$ dirname /tmp/foo/
-/tmp
-
+ $ dirname /tmp/foo
+ /tmp
+ $ dirname /tmp/foo/
+ /tmp
-------------------------------
@@ -450,8 +437,7 @@ Options:
Example:
-$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp
-
+ $ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp
-------------------------------
@@ -472,18 +458,17 @@ Options:
Example:
-$ du
-16 ./CVS
-12 ./kernel-patches/CVS
-80 ./kernel-patches
-12 ./tests/CVS
-36 ./tests
-12 ./scripts/CVS
-16 ./scripts
-12 ./docs/CVS
-104 ./docs
-2417 .
-
+ $ du
+ 16 ./CVS
+ 12 ./kernel-patches/CVS
+ 80 ./kernel-patches
+ 12 ./tests/CVS
+ 36 ./tests
+ 12 ./scripts/CVS
+ 16 ./scripts
+ 12 ./docs/CVS
+ 104 ./docs
+ 2417 .
-------------------------------
@@ -495,8 +480,7 @@ Prints out a binary keyboard translation table to standard output.
Example:
-$ dumpkmap > keymap
-
+ $ dumpkmap > keymap
-------------------------------
@@ -509,15 +493,14 @@ or stdin to stdout. (i.e. 'dutmp /var/run/utmp')
Example:
-$ dutmp /var/run/utmp
-8|7||si|||0|0|0|955637625|760097|0
-2|0|~|~~|reboot||0|0|0|955637625|782235|0
-1|20020|~|~~|runlevel||0|0|0|955637625|800089|0
-8|125||l4|||0|0|0|955637629|998367|0
-6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0
-6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0
-7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0
-
+ $ dutmp /var/run/utmp
+ 8|7||si|||0|0|0|955637625|760097|0
+ 2|0|~|~~|reboot||0|0|0|955637625|782235|0
+ 1|20020|~|~~|runlevel||0|0|0|955637625|800089|0
+ 8|125||l4|||0|0|0|955637629|998367|0
+ 6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0
+ 6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0
+ 7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0
-------------------------------
@@ -535,29 +518,20 @@ Options:
Example:
-$ echo Erik is cool
-Erik is cool
-$ echo -e Erik
-is
-cool
-Erik
-is
-cool
-$ echo Erik
-is
-cool
-Erik
-is
-cool
-
-
--------------------------------
-
-=item I<egrep>
-
-egrep
-
-
+ $ echo Erik is cool
+ Erik is cool
+ $ echo -e Erik
+ is
+ cool
+ Erik
+ is
+ cool
+ $ echo Erik
+ is
+ cool
+ Erik
+ is
+ cool
-------------------------------
@@ -609,10 +583,9 @@ Return an exit code of FALSE (1).
Example:
-$ false
-$ echo $?
-1
-
+ $ false
+ $ echo $?
+ 1
-------------------------------
@@ -624,14 +597,13 @@ Show and modify frame buffer settings
Example:
-$ fbset
-mode 1024x768-76
- geometry 1024 768 1024 768 16
- timings 12714 128 32 16 4 128 4
- accel false
- rgba 5/11,6/5,5/0,0/0
-endmode
-
+ $ fbset
+ mode 1024x768-76
+ geometry 1024 768 1024 768 16
+ timings 12714 128 32 16 4 128 4
+ accel false
+ rgba 5/11,6/5,5/0,0/0
+ endmode
-------------------------------
@@ -662,9 +634,8 @@ EXPRESSION may consist of:
Example:
-$ find / -name /etc/passwd
-/etc/passwd
-
+ $ find / -name /etc/passwd
+ /etc/passwd
-------------------------------
@@ -676,12 +647,12 @@ Displays the amount of free and used system memory
Example:
-$ free
- total used free shared buffers
- Mem: 257628 248724 8904 59644 93124
- Swap: 128516 8404 120112
-Total: 386144 257128 129016
-
+ $ free
+ total used free shared buffers
+ Mem: 257628 248724 8904 59644 93124
+ Swap: 128516 8404 120112
+ Total: 386144 257128 129016
+
-------------------------------
@@ -693,8 +664,7 @@ Frees all memory used by the specified ramdisk.
Example:
-$ freeramdisk /dev/ram2
-
+ $ freeramdisk /dev/ram2
-------------------------------
@@ -734,25 +704,24 @@ Parse command options
Example:
-$ cat getopt.test
-GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \
- -n 'example.busybox' -- $@`
-if [ $? != 0 ] ; then exit 1 ; fi
-eval set -- $GETOPT
-while true ; do
- case $1 in
- -a|--a-long) echo Option a ; shift ;;
- -b|--b-long) echo Option b, argument `$2' ; shift 2 ;;
- -c|--c-long)
- case $2 in
- \) echo Option c, no argument; shift 2 ;;
- *) echo Option c, argument `$2' ; shift 2 ;;
- esac ;;
- --) shift ; break ;;
- *) echo Internal error! ; exit 1 ;;
- esac
-done
-
+ $ cat getopt.test
+ GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \
+ -n 'example.busybox' -- $@`
+ if [ $? != 0 ] ; then exit 1 ; fi
+ eval set -- $GETOPT
+ while true ; do
+ case $1 in
+ -a|--a-long) echo Option a ; shift ;;
+ -b|--b-long) echo Option b, argument `$2' ; shift 2 ;;
+ -c|--c-long)
+ case $2 in
+ \) echo Option c, no argument; shift 2 ;;
+ *) echo Option c, argument `$2' ; shift 2 ;;
+ esac ;;
+ --) shift ; break ;;
+ *) echo Internal error! ; exit 1 ;;
+ esac
+ done
-------------------------------
@@ -774,11 +743,10 @@ Options:
Example:
-$ grep root /etc/passwd
-root:x:0:0:root:/root:/bin/bash
-$ grep ^[rR]oo. /etc/passwd
-root:x:0:0:root:/root:/bin/bash
-
+ $ grep root /etc/passwd
+ root:x:0:0:root:/root:/bin/bash
+ $ grep ^[rR]oo. /etc/passwd
+ root:x:0:0:root:/root:/bin/bash
-------------------------------
@@ -795,12 +763,11 @@ Options:
Example:
-$ ls -la /tmp/BusyBox*
--rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz
-$ gunzip /tmp/BusyBox-0.43.tar.gz
-$ ls -la /tmp/BusyBox*
--rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar
-
+ $ ls -la /tmp/BusyBox*
+ -rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz
+ $ gunzip /tmp/BusyBox-0.43.tar.gz
+ $ ls -la /tmp/BusyBox*
+ -rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar
-------------------------------
@@ -818,12 +785,11 @@ Options:
Example:
-$ ls -la /tmp/BusyBox*
--rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar
-$ gzip /tmp/BusyBox-0.43.tar
-$ ls -la /tmp/BusyBox*
--rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz
-
+ $ ls -la /tmp/BusyBox*
+ -rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar
+ $ gzip /tmp/BusyBox-0.43.tar
+ $ ls -la /tmp/BusyBox*
+ -rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz
-------------------------------
@@ -849,10 +815,9 @@ Options:
Example:
-$ head -n 2 /etc/passwd
-root:x:0:0:root:/root:/bin/bash
-daemon:x:1:1:daemon:/usr/sbin:/bin/sh
-
+ $ head -n 2 /etc/passwd
+ root:x:0:0:root:/root:/bin/bash
+ daemon:x:1:1:daemon:/usr/sbin:/bin/sh
-------------------------------
@@ -880,9 +845,8 @@ Options:
Example:
-$ hostname
-slag
-
+ $ hostname
+ slag
-------------------------------
@@ -901,9 +865,8 @@ Options:
Example:
-$ id
-uid=1000(andersen) gid=1000(andersen)
-
+ $ id
+ uid=1000(andersen) gid=1000(andersen)
-------------------------------
@@ -1056,15 +1019,14 @@ Options:
Example:
-$ ps | grep apache
-252 root root S [apache]
-263 www-data www-data S [apache]
-264 www-data www-data S [apache]
-265 www-data www-data S [apache]
-266 www-data www-data S [apache]
-267 www-data www-data S [apache]
-$ kill 252
-
+ $ ps | grep apache
+ 252 root root S [apache]
+ 263 www-data www-data S [apache]
+ 264 www-data www-data S [apache]
+ 265 www-data www-data S [apache]
+ 266 www-data www-data S [apache]
+ 267 www-data www-data S [apache]
+ $ kill 252
-------------------------------
@@ -1080,8 +1042,8 @@ Options:
Example:
-$ killall apache
-
+ $ killall apache
+
-------------------------------
@@ -1104,9 +1066,8 @@ Prints out the length of the specified STRING.
Example:
-$ length Hello
-5
-
+ $ length Hello
+ 5
-------------------------------
@@ -1126,10 +1087,10 @@ Options:
Example:
-$ ln -s BusyBox /tmp/ls
-$ ls -l /tmp/ls
-lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*
-
+ $ ln -s BusyBox /tmp/ls
+ $ ls -l /tmp/ls
+ lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*
+
-------------------------------
@@ -1141,8 +1102,8 @@ Loads an acm from standard input.
Example:
-$ loadacm < /etc/i18n/acmname
-
+ $ loadacm < /etc/i18n/acmname
+
-------------------------------
@@ -1154,8 +1115,8 @@ Loads a console font from standard input.
Example:
-$ loadfont < /etc/i18n/fontname
-
+ $ loadfont < /etc/i18n/fontname
+
-------------------------------
@@ -1167,8 +1128,8 @@ Loads a binary keyboard translation table from standard input.
Example:
-$ loadkmap < /etc/i18n/lang-keymap
-
+ $ loadkmap < /etc/i18n/lang-keymap
+
-------------------------------
@@ -1187,8 +1148,8 @@ Options:
Example:
-$ logger hello
-
+ $ logger hello
+
-------------------------------
@@ -1200,9 +1161,9 @@ Print the name of the current user.
Example:
-$ logname
-root
-
+ $ logname
+ root
+
-------------------------------
@@ -1282,11 +1243,11 @@ For example:
Example:
-$ makedevs /dev/ttyS c 4 66 2 63
-[creates ttyS2-ttyS63]
-$ makedevs /dev/hda b 3 0 0 8 s
-[creates hda,hda1-hda8]
-
+ $ makedevs /dev/ttyS c 4 66 2 63
+ [creates ttyS2-ttyS63]
+ $ makedevs /dev/hda b 3 0 0 8 s
+ [creates hda,hda1-hda8]
+
-------------------------------
@@ -1312,15 +1273,14 @@ The following two options are useful only when verifying checksums:
Example:
-$ md5sum < busybox
-6fd11e98b98a58f64ff3398d7b324003
-$ md5sum busybox
-6fd11e98b98a58f64ff3398d7b324003 busybox
-$ md5sum -c -
-6fd11e98b98a58f64ff3398d7b324003 busybox
-busybox: OK
-^D
-
+ $ md5sum < busybox
+ 6fd11e98b98a58f64ff3398d7b324003
+ $ md5sum busybox
+ 6fd11e98b98a58f64ff3398d7b324003 busybox
+ $ md5sum -c -
+ 6fd11e98b98a58f64ff3398d7b324003 busybox
+ busybox: OK
+ ^D
-------------------------------
@@ -1337,13 +1297,13 @@ Options:
Example:
-$ mkdir /tmp/foo
-$ mkdir /tmp/foo
-/tmp/foo: File exists
-$ mkdir /tmp/foo/bar/baz
-/tmp/foo/bar/baz: No such file or directory
-$ mkdir -p /tmp/foo/bar/baz
-
+ $ mkdir /tmp/foo
+ $ mkdir /tmp/foo
+ /tmp/foo: File exists
+ $ mkdir /tmp/foo/bar/baz
+ /tmp/foo/bar/baz: No such file or directory
+ $ mkdir -p /tmp/foo/bar/baz
+
-------------------------------
@@ -1393,9 +1353,9 @@ TYPEs include:
Example:
-$ mknod /dev/fd0 b 2 0
-$ mknod -m 644 /tmp/pipe p
-
+ $ mknod /dev/fd0 b 2 0
+ $ mknod -m 644 /tmp/pipe p
+
-------------------------------
@@ -1424,11 +1384,11 @@ TEMPLATE is any name with six `Xs' (i.e. /tmp/temp.XXXXXX).
Example:
-$ mktemp /tmp/temp.XXXXXX
-/tmp/temp.mWiLjM
-$ ls -la /tmp/temp.mWiLjM
--rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM
-
+ $ mktemp /tmp/temp.XXXXXX
+ /tmp/temp.mWiLjM
+ $ ls -la /tmp/temp.mWiLjM
+ -rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM
+
-------------------------------
@@ -1440,8 +1400,8 @@ More is a filter for viewing FILE one screenful at a time.
Example:
-$ dmesg | more
-
+ $ dmesg | more
+
-------------------------------
@@ -1477,13 +1437,13 @@ You'll have to see the written documentation for those.
Example:
-$ mount
-/dev/hda3 on / type minix (rw)
-proc on /proc type proc (rw)
-devpts on /dev/pts type devpts (rw)
-$ mount /dev/fd0 /mnt -t msdos -o ro
-$ mount /tmp/diskimage /opt -t ext2 -o loop
-
+ $ mount
+ /dev/hda3 on / type minix (rw)
+ proc on /proc type proc (rw)
+ devpts on /dev/pts type devpts (rw)
+ $ mount /dev/fd0 /mnt -t msdos -o ro
+ $ mount /tmp/diskimage /opt -t ext2 -o loop
+
-------------------------------
@@ -1511,8 +1471,8 @@ Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.
Example:
-$ mv /tmp/foo /bin/bar
-
+ $ mv /tmp/foo /bin/bar
+
-------------------------------
@@ -1524,14 +1484,14 @@ Netcat opens a pipe to IP:port
Example:
-$ nc foobar.somedomain.com 25
-220 foobar ESMTP Exim 3.12 help
-214-Commands supported:
-214- HELO EHLO MAIL RCPT DATA AUTH
-214 NOOP QUIT RSET HELP
-quit
-221 foobar closing connection
-
+ $ nc foobar.somedomain.com 25
+ 220 foobar ESMTP Exim 3.12 help
+ 214-Commands supported:
+ 214- HELO EHLO MAIL RCPT DATA AUTH
+ 214 NOOP QUIT RSET HELP
+ quit
+ 221 foobar closing connection
+
-------------------------------
@@ -1543,13 +1503,13 @@ Queries the nameserver for the IP address of the given HOST
Example:
-$ nslookup localhost
-Server: default
-Address: default
-
-Name: debian
-Address: 127.0.0.1
-
+ $ nslookup localhost
+ Server: default
+ Address: default
+
+ Name: debian
+ Address: 127.0.0.1
+
-------------------------------
@@ -1568,14 +1528,14 @@ Options:
Example:
-$ ping localhost
-PING slag (127.0.0.1): 56 data bytes
-64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms
-
---- debian ping statistics ---
-1 packets transmitted, 1 packets received, 0% packet loss
-round-trip min/avg/max = 20.1/20.1/20.1 ms
-
+ $ ping localhost
+ PING slag (127.0.0.1): 56 data bytes
+ 64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms
+
+ --- debian ping statistics ---
+ 1 packets transmitted, 1 packets received, 0% packet loss
+ round-trip min/avg/max = 20.1/20.1/20.1 ms
+
-------------------------------
@@ -1605,10 +1565,10 @@ Where FORMAT controls the output exactly as in C printf.
Example:
-$ printf Val=%d
- 5
-Val=5
-
+ $ printf Val=%d
+ 5
+ Val=5
+
-------------------------------
@@ -1622,18 +1582,17 @@ This version of ps accepts no options.
Example:
-$ ps
- PID Uid Gid State Command
- 1 root root S init
- 2 root root S [kflushd]
- 3 root root S [kupdate]
- 4 root root S [kpiod]
- 5 root root S [kswapd]
- 742 andersen andersen S [bash]
- 743 andersen andersen S -bash
- 745 root root S [getty]
- 2990 andersen andersen R ps
-
+ $ ps
+ PID Uid Gid State Command
+ 1 root root S init
+ 2 root root S [kflushd]
+ 3 root root S [kupdate]
+ 4 root root S [kpiod]
+ 5 root root S [kswapd]
+ 742 andersen andersen S [bash]
+ 743 andersen andersen S -bash
+ 745 root root S [getty]
+ 2990 andersen andersen R ps
-------------------------------
@@ -1645,9 +1604,8 @@ Print the full filename of the current working directory.
Example:
-$ pwd
-/root
-
+ $ pwd
+ /root
-------------------------------
@@ -1713,8 +1671,7 @@ Options:
Example:
-$ rm -rf /tmp/foo
-
+ $ rm -rf /tmp/foo
-------------------------------
@@ -1742,8 +1699,7 @@ Options:
Example:
-$ rmmod tulip
-
+ $ rmmod tulip
-------------------------------
@@ -1780,9 +1736,8 @@ files; if no input files are specified, then the standard input is read.
Example:
-$ echo foo | sed -e 's/f[a-zA-Z]o/bar/g'
-bar
-
+ $ echo foo | sed -e 's/f[a-zA-Z]o/bar/g'
+ bar
-------------------------------
@@ -1798,8 +1753,7 @@ and KEYCODE is given in decimal
Example:
-$ setkeycodes e030 127
-
+ $ setkeycodes e030 127
-------------------------------
@@ -1829,9 +1783,8 @@ Pause for N seconds.
Example:
-$ sleep 2
-[2 second delay results]
-
+ $ sleep 2
+ [2 second delay results]
-------------------------------
@@ -1843,19 +1796,18 @@ Sorts lines of text in the specified files
Example:
-$ echo -e e
-f
-b
-d
-c
-a | sort
-a
-b
-c
-d
-e
-f
-
+ $ echo -e e
+ f
+ b
+ d
+ c
+ a | sort
+ a
+ b
+ c
+ d
+ e
+ f
-------------------------------
@@ -1924,9 +1876,8 @@ Options:
Example:
-$ syslogd -R masterlog:514
-$ syslogd -R 192.168.1.1:601
-
+ $ syslogd -R masterlog:514
+ $ syslogd -R 192.168.1.1:601
-------------------------------
@@ -1947,15 +1898,14 @@ Options:
-s SEC wait SEC seconds between reads with -f
-v always output headers giving file names
-If the first character of N (bytes or lines) is a `+', output begins with
+If the first character of N (bytes or lines) is a '+', output begins with
the Nth item from the start of each file, otherwise, print the last N items
in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2).
Example:
-$ tail -n 1 /etc/resolv.conf
-nameserver 10.0.0.1
-
+ $ tail -n 1 /etc/resolv.conf
+ nameserver 10.0.0.1
-------------------------------
@@ -1984,9 +1934,8 @@ Informative output:
Example:
-$ zcat /tmp/tarball.tar.gz | tar -xf -
-$ tar -cf /tmp/tarball.tar /usr/local
-
+ $ zcat /tmp/tarball.tar.gz | tar -xf -
+ $ tar -cf /tmp/tarball.tar /usr/local
-------------------------------
@@ -2002,10 +1951,9 @@ Options:
Example:
-$ echo Hello | tee /tmp/foo
-$ cat /tmp/foo
-Hello
-
+ $ echo Hello | tee /tmp/foo
+ $ cat /tmp/foo
+ Hello
-------------------------------
@@ -2028,19 +1976,18 @@ code determined by the value of EXPRESSION.
Example:
-$ test 1 -eq 2
-$ echo $?
-1
-$ test 1 -eq 1
-$ echo $?
-0
-$ [ -d /etc ]
-$ echo $?
-0
-$ [ -d /junk ]
-$ echo $?
-1
-
+ $ test 1 -eq 2
+ $ echo $?
+ 1
+ $ test 1 -eq 1
+ $ echo $?
+ 0
+ $ [ -d /etc ]
+ $ echo $?
+ 0
+ $ [ -d /junk ]
+ $ echo $?
+ 1
-------------------------------
@@ -2071,12 +2018,12 @@ Options:
Example:
-$ ls -l /tmp/foo
-/bin/ls: /tmp/foo: No such file or directory
-$ touch /tmp/foo
-$ ls -l /tmp/foo
--rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo
-
+ $ ls -l /tmp/foo
+ /bin/ls: /tmp/foo: No such file or directory
+ $ touch /tmp/foo
+ $ ls -l /tmp/foo
+ -rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo
+
-------------------------------
@@ -2095,9 +2042,9 @@ Options:
Example:
-$ echo gdkkn vnqkc | tr [a-y] [b-z]
-hello world
-
+ $ echo gdkkn vnqkc | tr [a-y] [b-z]
+ hello world
+
-------------------------------
@@ -2109,10 +2056,9 @@ Return an exit code of TRUE (0).
Example:
-$ true
-$ echo $?
-0
-
+ $ true
+ $ echo $?
+ 0
-------------------------------
@@ -2128,9 +2074,8 @@ Options:
Example:
-$ tty
-/dev/tty2
-
+ $ tty
+ /dev/tty2
-------------------------------
@@ -2150,8 +2095,7 @@ Flags:
Example:
-$ umount /dev/hdc1
-
+ $ umount /dev/hdc1
-------------------------------
@@ -2173,8 +2117,8 @@ Options:
Example:
-$ uname -a
-Linux debian 2.2.15pre13
+ $ uname -a
+ Linux debian 2.2.15pre13
-------------------------------
@@ -2193,16 +2137,15 @@ Options:
Example:
-$ echo -e a
-a
-b
-c
-c
-a | sort | uniq
-a
-b
-c
-
+ $ echo -e a
+ a
+ b
+ c
+ c
+ a | sort | uniq
+ a
+ b
+ c
-------------------------------
@@ -2236,9 +2179,9 @@ Display the time since the last boot.
Example:
-$ uptime
- 1:55pm up 2:30, load average: 0.09, 0.04, 0.00
-
+ $ uptime
+ 1:55pm up 2:30, load average: 0.09, 0.04, 0.00
+
-------------------------------
@@ -2250,9 +2193,8 @@ Pause for N microseconds.
Example:
-$ usleep 1000000
-[pauses for 1 second]
-
+ $ usleep 1000000
+ [pauses for 1 second]
-------------------------------
@@ -2283,12 +2225,11 @@ Options:
Example:
-$ uuencode busybox busybox
-begin 755 busybox
-M?T5,1@$!`0````````````(``P`!````L+@$.....
-$ uudecode busybox busybox > busybox.uu
-$
-
+ $ uuencode busybox busybox
+ begin 755 busybox
+ <encoded file snipped>
+ $ uudecode busybox busybox > busybox.uu
+ $
-------------------------------
@@ -2316,9 +2257,9 @@ Options:
Example:
-$ wc /etc/passwd
- 31 46 1365 /etc/passwd
-
+ $ wc /etc/passwd
+ 31 46 1365 /etc/passwd
+
-------------------------------
@@ -2343,9 +2284,8 @@ Locates a COMMAND.
Example:
-$ which login
-/bin/login
-
+ $ which login
+ /bin/login
-------------------------------
@@ -2365,9 +2305,9 @@ Executes COMMAND on every item given by standard input.
Example:
-$ ls | xargs gzip
-$ find . -name '*.c' -print | xargs rm
-
+ $ ls | xargs gzip
+ $ find . -name '*.c' -print | xargs rm
+
-------------------------------
@@ -2375,7 +2315,7 @@ $ find . -name '*.c' -print | xargs rm
yes [OPTION]... [STRING]...
-Repeatedly outputs a line with all specified STRING(s), or `y'.
+Repeatedly outputs a line with all specified STRING(s), or 'y'.
-------------------------------
@@ -2535,4 +2475,4 @@ Enrique Zanardi <ezanardi@ull.es>
=cut
-# $Id: busybox.pod,v 1.90 2001/03/15 18:14:25 andersen Exp $
+# $Id: busybox.pod,v 1.91 2001/03/15 21:08:01 beppu Exp $