From 028fb625f53208a4d835f4a5ae034c3edc1ad051 Mon Sep 17 00:00:00 2001 From: Eric Andersen Date: Tue, 4 Jul 2000 20:07:13 +0000 Subject: More doc updates -Erik --- docs/busybox.pod | 274 +++++++++++++++++++++++++++---------------------------- 1 file changed, 137 insertions(+), 137 deletions(-) (limited to 'docs/busybox.pod') diff --git a/docs/busybox.pod b/docs/busybox.pod index 5c2c59054..d1d6f7efd 100644 --- a/docs/busybox.pod +++ b/docs/busybox.pod @@ -237,12 +237,6 @@ Example: ------------------------------- -=item clear - -Clears the screen. - -------------------------------- - =item chvt Usage: chvt N @@ -251,6 +245,12 @@ Changes the foreground virtual terminal to /dev/ttyN ------------------------------- +=item clear + +Clears the screen. + +------------------------------- + =item cp Usage: cp [OPTION]... SOURCE DEST @@ -363,6 +363,14 @@ Example: ------------------------------- +=item deallocvt + +Usage: deallocvt N + +Deallocates unused virtual terminal /dev/ttyN + +------------------------------- + =item df Usage: df [filesystem ...] @@ -580,14 +588,6 @@ Example: ------------------------------- -=item deallocvt - -Usage: deallocvt N - -Deallocates unused virtual terminal /dev/ttyN - -------------------------------- - =item fsck.minix Usage: fsck.minix [B<-larvsmf>] /dev/name @@ -1187,25 +1187,6 @@ Example: ------------------------------- -=item nc - -Usage: nc [IP] [port] - -Netcat opens a pipe to IP:port - -Example: - - $ nc foobar.somedomain.com 25 - 220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600 - help - 214-Commands supported: - 214- HELO EHLO MAIL RCPT DATA AUTH - 214 NOOP QUIT RSET HELP - quit - 221 foobar closing connection - -------------------------------- - =item more Usage: more [file ...] @@ -1277,6 +1258,25 @@ Example: ------------------------------- +=item nc + +Usage: nc [IP] [port] + +Netcat opens a pipe to IP:port + +Example: + + $ nc foobar.somedomain.com 25 + 220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600 + help + 214-Commands supported: + 214- HELO EHLO MAIL RCPT DATA AUTH + 214 NOOP QUIT RSET HELP + quit + 221 foobar closing connection + +------------------------------- + =item nslookup Usage: nslookup [HOST] @@ -1476,23 +1476,6 @@ Example: ------------------------------- -=item sh - -Usage: sh - -lash -- the BusyBox LAme SHell (command interpreter) - -This command does not yet have proper documentation. - -Use lash just as you would use any other shell. It properly handles pipes, -redirects, job control, can be used as the shell for scripts (#!/bin/sh), and -has a sufficient set of builtins to do what is needed. It does not (yet) -support Bourne Shell syntax. If you need things like "if-then-else", "while", -and such, use ash or bash. If you just need a very simple and extremely small -shell, this will do the job. - -------------------------------- - =item sfdisk Usage: sfdisk [options] device ... @@ -1536,6 +1519,23 @@ You can disable all consistency checking with: ------------------------------- +=item sh + +Usage: sh + +lash -- the BusyBox LAme SHell (command interpreter) + +This command does not yet have proper documentation. + +Use lash just as you would use any other shell. It properly handles pipes, +redirects, job control, can be used as the shell for scripts (#!/bin/sh), and +has a sufficient set of builtins to do what is needed. It does not (yet) +support Bourne Shell syntax. If you need things like "if-then-else", "while", +and such, use ash or bash. If you just need a very simple and extremely small +shell, this will do the job. + +------------------------------- + =item sleep Usage: sleep N @@ -1567,27 +1567,15 @@ Example: ------------------------------- -=item sync - -Usage: sync - -Write all buffered filesystem blocks to disk. - -------------------------------- - -=item syslogd +=item swapoff -Usage: syslogd [OPTION]... +Usage: swapoff [OPTION] [device] -Linux system and kernel (provides klogd) logging utility. -Note that this version of syslogd/klogd ignores /etc/syslog.conf. +Stop swapping virtual memory pages on the given device. Options: - -m NUM Interval between MARK lines (default=20min, 0=off) - -n Run as a foreground process - -K Do not start up the klogd process - -O FILE Use an alternate log file (default=/var/log/messages) + -a Stop swapping on all swap devices ------------------------------- @@ -1603,15 +1591,27 @@ Options: ------------------------------- -=item swapoff +=item sync -Usage: swapoff [OPTION] [device] +Usage: sync -Stop swapping virtual memory pages on the given device. +Write all buffered filesystem blocks to disk. + +------------------------------- + +=item syslogd + +Usage: syslogd [OPTION]... + +Linux system and kernel (provides klogd) logging utility. +Note that this version of syslogd/klogd ignores /etc/syslog.conf. Options: - -a Stop swapping on all swap devices + -m NUM Interval between MARK lines (default=20min, 0=off) + -n Run as a foreground process + -K Do not start up the klogd process + -O FILE Use an alternate log file (default=/var/log/messages) ------------------------------- @@ -1666,28 +1666,21 @@ Example: ------------------------------- -=item test, [ +=item tee -Usage: test EXPRESSION -or [ EXPRESSION ] +Usage: tee [OPTION]... [FILE]... -Checks file types and compares values returning an exit -code determined by the value of EXPRESSION. +Copy standard input to each FILE, and also to standard output. + +Options: + + -a append to the given FILEs, do not overwrite Example: - $ test 1 -eq 2 - $ echo $? - 1 - $ test 1 -eq 1 - $ echo $? - 0 - $ [ -d /etc ] - $ echo $? - 0 - $ [ -d /junk ] - $ echo $? - 1 + $ echo "Hello" | tee /tmp/foo + $ cat /tmp/foo + Hello ------------------------------- @@ -1700,21 +1693,28 @@ computer over a network using the TELNET protocol. ------------------------------- -=item tee - -Usage: tee [OPTION]... [FILE]... - -Copy standard input to each FILE, and also to standard output. +=item test, [ -Options: +Usage: test EXPRESSION +or [ EXPRESSION ] - -a append to the given FILEs, do not overwrite +Checks file types and compares values returning an exit +code determined by the value of EXPRESSION. Example: - $ echo "Hello" | tee /tmp/foo - $ cat /tmp/foo - Hello + $ test 1 -eq 2 + $ echo $? + 1 + $ test 1 -eq 1 + $ echo $? + 0 + $ [ -d /etc ] + $ echo $? + 0 + $ [ -d /junk ] + $ echo $? + 1 ------------------------------- @@ -1783,45 +1783,6 @@ Example: ------------------------------- -=item uuencode - -Usage: uuencode [OPTION] [INFILE] REMOTEFILE - -Uuencode a file. - -Options: - - -m use base64 encoding as of RFC1521 - -Example: - - $ uuencode busybox busybox - begin 755 busybox - M?T5,1@$!`0````````````(``P`!````L+@$"#0```!0N@,``````#0`(``& - ..... - $ uudecode busybox busybox > busybox.uu - $ - -------------------------------- - -=item uudecode - -Usage: uudecode [OPTION] [FILE] - -Uudecode a uuencoded file - -Options: - - -o FILE direct output to FILE - -Example: - - $ uudecode -o busybox busybox.uu - $ ls -l busybox - -rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox - -------------------------------- - =item umount Usage: umount [flags] filesystem|directory @@ -1918,6 +1879,45 @@ Example: ------------------------------- +=item uuencode + +Usage: uuencode [OPTION] [INFILE] REMOTEFILE + +Uuencode a file. + +Options: + + -m use base64 encoding as of RFC1521 + +Example: + + $ uuencode busybox busybox + begin 755 busybox + M?T5,1@$!`0````````````(``P`!````L+@$"#0```!0N@,``````#0`(``& + ..... + $ uudecode busybox busybox > busybox.uu + $ + +------------------------------- + +=item uudecode + +Usage: uudecode [OPTION] [FILE] + +Uudecode a uuencoded file + +Options: + + -o FILE direct output to FILE + +Example: + + $ uudecode -o busybox busybox.uu + $ ls -l busybox + -rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox + +------------------------------- + =item wc Usage: wc [OPTION]... [FILE]... @@ -2063,4 +2063,4 @@ Enrique Zanardi =cut -# $Id: busybox.pod,v 1.52 2000/06/26 12:14:30 andersen Exp $ +# $Id: busybox.pod,v 1.53 2000/07/04 20:07:13 andersen Exp $ -- cgit v1.2.3