summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEric Andersen2000-07-04 20:07:13 +0000
committerEric Andersen2000-07-04 20:07:13 +0000
commit028fb625f53208a4d835f4a5ae034c3edc1ad051 (patch)
tree770e4c60d1c5fc2d465e6bbfd236049b37c95b24 /docs
parent5331025f796d1defe90c8dda1fe1481de95850e5 (diff)
downloadbusybox-028fb625f53208a4d835f4a5ae034c3edc1ad051.zip
busybox-028fb625f53208a4d835f4a5ae034c3edc1ad051.tar.gz
More doc updates
-Erik
Diffstat (limited to 'docs')
-rw-r--r--docs/busybox.pod274
-rw-r--r--docs/busybox.sgml1265
2 files changed, 688 insertions, 851 deletions
diff --git a/docs/busybox.pod b/docs/busybox.pod
index 5c2c590..d1d6f7e 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 <ezanardi@ull.es>
=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 $
diff --git a/docs/busybox.sgml b/docs/busybox.sgml
index ac3e7e7..49b82c3 100644
--- a/docs/busybox.sgml
+++ b/docs/busybox.sgml
@@ -231,531 +231,368 @@
</sect1>
-<para>
--------------------------------
-
-
-</para>
-
-</listitem></varlistentry>
-<varlistentry><term><emphasis>chgrp
-
-</emphasis></term>
-<listitem><para></para>
-
-<para>
-Usage: chgrp [OPTION]... GROUP FILE...
-
-
-</para>
-
-<para>
-Change the group membership of each FILE to GROUP.
-
-
-</para>
-
-<para>
-Options:
-
-
-</para>
-
-<para>
-<screen>
- -R change files and directories recursively
-</screen>
-
-
-</para>
-
-<para>
-Example:
-
-
-</para>
-
-<para>
-<screen>
- $ 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
-</screen>
-
-
-</para>
-
-<para>
--------------------------------
-
-
-</para>
-
-</listitem></varlistentry>
-<varlistentry><term><emphasis>chmod
-
-</emphasis></term>
-<listitem><para></para>
-
-<para>
-Usage: chmod [<emphasis>-R</emphasis>] MODE[,MODE]... FILE...
-
-
-</para>
-
-<para>
-Changes file access permissions for the specified
-<literal>FILE(s)</literal> (or directories). Each MODE is defined by
-combining the letters for WHO has access to the file, an OPERATOR for
-selecting how the permissions should be changed, and a PERMISSION for
-<literal>FILE(s)</literal> (or directories).
-
-
-</para>
-
-<para>
-WHO may be chosen from
-
-
-</para>
-
-<para>
-<screen>
- u User who owns the file
- g Users in the file's Group
- o Other users not in the file's group
- a All users
-</screen>
-
-
-</para>
-
-<para>
-OPERATOR may be chosen from
-
-
-</para>
-
-<para>
-<screen>
- + Add a permission
- - Remove a permission
- = Assign a permission
-</screen>
-
-
-</para>
-
-<para>
-PERMISSION may be chosen from
-
-
-</para>
-
-<para>
-<screen>
- r Read
- w Write
- x Execute (or access for directories)
- s Set user (or group) ID bit
- t Sticky bit (for directories prevents removing files by non-owners)
-</screen>
-
-
-</para>
-
-<para>
-Alternately, permissions can be set numerically where the first three
-numbers are calculated by adding the octal values, such as
-
-
-</para>
-
-<para>
-<screen>
- 4 Read
- 2 Write
- 1 Execute
-</screen>
-
-
-</para>
-
-<para>
-An optional fourth digit can also be used to specify
-
-
-</para>
-
-<para>
-<screen>
- 4 Set user ID
- 2 Set group ID
- 1 Sticky bit
-</screen>
-
-
-</para>
-
-<para>
-Options:
-
-
-</para>
-
-<para>
-<screen>
- -R Change files and directories recursively.
-</screen>
-
-
-</para>
-
-<para>
-Example:
-
-
-</para>
-
-<para>
-<screen>
- $ 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
-</screen>
-
-
-</para>
-
-<para>
--------------------------------
-
-
-</para>
-</listitem></varlistentry>
-<varlistentry><term><emphasis>chown
-
-</emphasis></term>
-<listitem><para></para>
-
-<para>
-Usage: chown [OPTION]... OWNER[&lt;.|:&gt;[GROUP] FILE...
-
-
-</para>
-
-<para>
-Changes the owner and/or group of each FILE to OWNER and/or GROUP.
-
-
-</para>
-
-<para>
-Options:
-
-
-</para>
-
-<para>
-<screen>
- -R Changes files and directories recursively
-</screen>
-
-
-</para>
-
-<para>
-Example:
-
-
-</para>
-
-<para>
-<screen>
- $ 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
-</screen>
-
-
-</para>
-
-<para>
--------------------------------
-
-
-</para>
-
-</listitem></varlistentry>
-<varlistentry><term><emphasis>chroot
-
-</emphasis></term>
-<listitem><para></para>
-
-<para>
-Usage: chroot NEWROOT [COMMAND...]
-
-
-</para>
-
-<para>
-Run COMMAND with root directory set to NEWROOT.
-
-
-</para>
-
-<para>
-Example:
-
-
-</para>
-
-<para>
-<screen>
- $ ls -l /bin/ls
- lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -&gt; /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*
-</screen>
-
-
-</para>
-
-<para>
--------------------------------
-
-
-</para>
-
-</listitem></varlistentry>
-<varlistentry><term><emphasis>clear
-
-</emphasis></term>
-<listitem><para></para>
-
-<para>
-Clears the screen.
-
-
-</para>
-
-<para>
--------------------------------
-
-
-</para>
+ <sect1 id="chgrp">
+ <title>chgrp</title>
-</listitem></varlistentry>
-<varlistentry><term><emphasis>chvt
-
-</emphasis></term>
-<listitem><para></para>
-
-<para>
-Usage: chvt N
-
-
-</para>
+ <para>
+ Usage: chgrp [OPTION]... GROUP FILE...
+ </para>
-<para>
-Changes the foreground virtual terminal to /dev/ttyN
+ <para>
+ Change the group membership of each FILE to GROUP.
+ </para>
+ <para>
+ Options:
+ </para>
-</para>
+ <para>
+ <screen>
+ -R change files and directories recursively
+ </screen>
+ </para>
-<para>
--------------------------------
+ <para>
+ Example:
+ </para>
+ <para>
+ <screen>
+ $ 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
+ </screen>
+ </para>
+ </sect1>
-</para>
-</listitem></varlistentry>
-<varlistentry><term><emphasis>cp
-</emphasis></term>
-<listitem><para></para>
+ <sect1 id="chmod">
+ <title>chmod</title>
-<para>
-Usage: cp [OPTION]... SOURCE DEST
+ <para>
+ Usage: chmod [<emphasis>-R</emphasis>] MODE[,MODE]... FILE...
+ </para>
+ <para>
+ Changes file access permissions for the specified
+ <literal>FILE(s)</literal> (or directories). Each MODE is defined by
+ combining the letters for WHO has access to the file, an OPERATOR for
+ selecting how the permissions should be changed, and a PERMISSION for
+ <literal>FILE(s)</literal> (or directories).
+ </para>
-</para>
+ <para>
+ WHO may be chosen from
+ </para>
-<para>
-<screen>
- or: cp [OPTION]... SOURCE... DIRECTORY
-</screen>
+ <para>
+ <screen>
+ u User who owns the file
+ g Users in the file's Group
+ o Other users not in the file's group
+ a All users
+ </screen>
+ </para>
+ <para>
+ OPERATOR may be chosen from
+ </para>
-</para>
+ <para>
+ <screen>
+ + Add a permission
+ - Remove a permission
+ = Assign a permission
+ </screen>
+ </para>
-<para>
-Copies SOURCE to DEST, or multiple <literal>SOURCE(s)</literal> to
-DIRECTORY.
+ <para>
+ PERMISSION may be chosen from
+ </para>
+ <para>
+ <screen>
+ r Read
+ w Write
+ x Execute (or access for directories)
+ s Set user (or group) ID bit
+ t Sticky bit (for directories prevents removing files by non-owners)
+ </screen>
+ </para>
-</para>
+ <para>
+ Alternately, permissions can be set numerically where the first three
+ numbers are calculated by adding the octal values, such as
+ </para>
-<para>
-Options:
+ <para>
+ <screen>
+ 4 Read
+ 2 Write
+ 1 Execute
+ </screen>
+ </para>
+ <para>
+ An optional fourth digit can also be used to specify
+ </para>
-</para>
+ <para>
+ <screen>
+ 4 Set user ID
+ 2 Set group ID
+ 1 Sticky bit
+ </screen>
+ </para>
-<para>
-<screen>
- -a Same as -dpR
- -d Preserves links
- -p Preserves file attributes if possible
- -R Copies directories recursively
-</screen>
+ <para>
+ Options:
+ </para>
+ <para>
+ <screen>
+ -R Change files and directories recursively.
+ </screen>
+ </para>
-</para>
+ <para>
+ Example:
+ </para>
-<para>
--------------------------------
+ <para>
+ <screen>
+ $ 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
+ </screen>
+ </para>
+ </sect1>
-</para>
+
+ <sect1 id="chown">
+ <title>chown</title>
+ <para>
+ Usage: chown [OPTION]... OWNER[&lt;.|:&gt;[GROUP] FILE...
+ </para>
-</listitem></varlistentry>
-<varlistentry><term><emphasis>cut
+ <para>
+ Changes the owner and/or group of each FILE to OWNER and/or GROUP.
+ </para>
-</emphasis></term>
-<listitem><para></para>
+ <para>
+ Options:
+ </para>
-<para>
-Usage: cut [OPTION]... [FILE]...
+ <para>
+ <screen>
+ -R Changes files and directories recursively
+ </screen>
+ </para>
+ <para>
+ Example:
+ </para>
-</para>
+ <para>
+ <screen>
+ $ 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
+ </screen>
+ </para>
+ </sect1>
-<para>
-Prints selected fields from each input FILE to standard output.
-</para>
+ <sect1 id="chroot">
+ <title>chroot</title>
+ <para>
+ Usage: chroot NEWROOT [COMMAND...]
+ </para>
-<para>
-Options:
+ <para>
+ Run COMMAND with root directory set to NEWROOT.
+ </para>
+ <para>
+ Example:
+ </para>
-</para>
+ <para>
+ <screen>
+ $ ls -l /bin/ls
+ lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -&gt; /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*
+ </screen>
+ </para>
+ </sect1>
-<para>
-<screen>
- -b LIST Output only bytes from LIST
- -c LIST Output only characters from LIST
- -d CHAR Use CHAR instead of tab as the field delimiter
- -s Only output Lines if the include DELIM
- -f N Print only these fields
- -n Ignored
-</screen>
+ <sect1 id="chvt">
+ <title>chvt</title>
+ <para>
+ Usage: chvt N
+ </para>
-</para>
+ <para>
+ Changes the foreground virtual terminal to /dev/ttyN
+ </para>
+ </sect1>
-<para>
-Example:
-</para>
-<para>
-<screen>
- $ echo "Hello world" | cut -f 1 -d ' '
- Hello
- $ echo "Hello world" | cut -f 2 -d ' '
- world
-</screen>
+ <sect1 id="clear">
+ <title>clear</title>
+ <para>
+ Usage: clear
+ </para>
-</para>
+ <para>
+ Clears the screen.
+ </para>
+ </sect1>
-<para>
--------------------------------
+ <sect1 id="cp">
+ <title>cp</title>
-</para>
+ <para>
+ Usage: cp [OPTION]... SOURCE DEST
+ </para>
-</listitem></varlistentry>
-<varlistentry><term><emphasis>date
+ <para>
+ <screen>
+ or: cp [OPTION]... SOURCE... DIRECTORY
+ </screen>
+ </para>
-</emphasis></term>
-<listitem><para></para>
+ <para>
+ Copies SOURCE to DEST, or multiple <literal>SOURCE(s)</literal> to
+ DIRECTORY.
+ </para>
-<para>
-Usage: date [OPTION]... [+FORMAT]
+ <para>
+ Options:
+ </para>
+ <para>
+ <screen>
+ -a Same as -dpR
+ -d Preserves links
+ -p Preserves file attributes if possible
+ -R Copies directories recursively
+ </screen>
+ </para>
+ </sect1>
-</para>
-<para>
-<screen>
- or: date [OPTION] [MMDDhhmm[[CC]YY][.ss]]
-</screen>
+ <sect1 id="cut">
+ <title>cut</title>
+ <para>
+ Usage: cut [OPTION]... [FILE]...
+ </para>
-</para>
+ <para>
+ Prints selected fields from each input FILE to standard output.
+ </para>
-<para>
-Displays the current time in the given FORMAT, or sets the system date.
+ <para>
+ Options:
+ </para>
+ <para>
+ <screen>
+ -b LIST Output only bytes from LIST
+ -c LIST Output only characters from LIST
+ -d CHAR Use CHAR instead of tab as the field delimiter
+ -s Only output Lines if the include DELIM
+ -f N Print only these fields
+ -n Ignored
+ </screen>
+ </para>
-</para>
+ <para>
+ Example:
+ </para>
-<para>
-Options:
+ <para>
+ <screen>
+ $ echo "Hello world" | cut -f 1 -d ' '
+ Hello
+ $ echo "Hello world" | cut -f 2 -d ' '
+ world
+ </screen>
+ </para>
+ </sect1>
-</para>
-<para>
-<screen>
- -R Outputs RFC-822 compliant date string
- -s Sets time described by STRING
- -u Prints or sets Coordinated Universal Time
-</screen>
+ <sect1 id="date">
+ <title>date</title>
+ <para>
+ Usage: date [OPTION]... [+FORMAT]
+ </para>
-</para>
+ <para>
+ <screen>
+ or: date [OPTION] [MMDDhhmm[[CC]YY][.ss]]
+ </screen>
+ </para>
-<para>
-Example:
+ <para>
+ Displays the current time in the given FORMAT, or sets the system date.
+ </para>
+ <para>
+ Options:
+ </para>
-</para>
+ <para>
+ <screen>
+ -R Outputs RFC-822 compliant date string
+ -s Sets time described by STRING
+ -u Prints or sets Coordinated Universal Time
+ </screen>
+ </para>
-<para>
-<screen>
- $ date
- Wed Apr 12 18:52:41 MDT 2000
-</screen>
+ <para>
+ Example:
+ </para>
+ <para>
+ <screen>
+ $ date
+ Wed Apr 12 18:52:41 MDT 2000
+ </screen>
+ </para>
+ </sect1>
-</para>
-<para>
--------------------------------
+<!-- This is where I have stopped formatting stuff -->
-</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>dc
@@ -869,6 +706,30 @@ Example:
<para>
-------------------------------
+</para>
+
+</listitem></varlistentry>
+<varlistentry><term><emphasis>deallocvt
+
+</emphasis></term>
+<listitem><para></para>
+
+<para>
+Usage: deallocvt N
+
+
+</para>
+
+<para>
+Deallocates unused virtual terminal /dev/ttyN
+
+
+</para>
+
+<para>
+-------------------------------
+
+
</para>
@@ -1416,30 +1277,6 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>deallocvt
-
-</emphasis></term>
-<listitem><para></para>
-
-<para>
-Usage: deallocvt N
-
-
-</para>
-
-<para>
-Deallocates unused virtual terminal /dev/ttyN
-
-
-</para>
-
-<para>
--------------------------------
-
-
-</para>
-
-</listitem></varlistentry>
<varlistentry><term><emphasis>fsck.minix
</emphasis></term>
@@ -3064,51 +2901,6 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>nc
-
-</emphasis></term>
-<listitem><para></para>
-
-<para>
-Usage: nc [IP] [port]
-
-
-</para>
-
-<para>
-Netcat opens a pipe to IP:port
-
-
-</para>
-
-<para>
-Example:
-
-
-</para>
-
-<para>
-<screen>
- $ 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
-</screen>
-
-
-</para>
-
-<para>
--------------------------------
-
-
-</para>
-
-</listitem></varlistentry>
<varlistentry><term><emphasis>more
</emphasis></term>
@@ -3295,6 +3087,51 @@ Example:
</para>
</listitem></varlistentry>
+<varlistentry><term><emphasis>nc
+
+</emphasis></term>
+<listitem><para></para>
+
+<para>
+Usage: nc [IP] [port]
+
+
+</para>
+
+<para>
+Netcat opens a pipe to IP:port
+
+
+</para>
+
+<para>
+Example:
+
+
+</para>
+
+<para>
+<screen>
+ $ 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
+</screen>
+
+
+</para>
+
+<para>
+-------------------------------
+
+
+</para>
+
+</listitem></varlistentry>
<varlistentry><term><emphasis>nslookup
</emphasis></term>
@@ -3860,47 +3697,6 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>sh
-
-</emphasis></term>
-<listitem><para></para>
-
-<para>
-Usage: sh
-
-
-</para>
-
-<para>
-lash -- the BusyBox LAme SHell (command interpreter)
-
-
-</para>
-
-<para>
-This command does not yet have proper documentation.
-
-
-</para>
-
-<para>
-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.
-
-
-</para>
-
-<para>
--------------------------------
-
-
-</para>
-
-</listitem></varlistentry>
<varlistentry><term><emphasis>sfdisk
</emphasis></term>
@@ -3996,6 +3792,47 @@ You can disable all consistency checking with:
</para>
</listitem></varlistentry>
+<varlistentry><term><emphasis>sh
+
+</emphasis></term>
+<listitem><para></para>
+
+<para>
+Usage: sh
+
+
+</para>
+
+<para>
+lash -- the BusyBox LAme SHell (command interpreter)
+
+
+</para>
+
+<para>
+This command does not yet have proper documentation.
+
+
+</para>
+
+<para>
+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.
+
+
+</para>
+
+<para>
+-------------------------------
+
+
+</para>
+
+</listitem></varlistentry>
<varlistentry><term><emphasis>sleep
</emphasis></term>
@@ -4079,19 +3916,33 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>sync
+<varlistentry><term><emphasis>swapoff
</emphasis></term>
<listitem><para></para>
<para>
-Usage: sync
+Usage: swapoff [OPTION] [device]
</para>
<para>
-Write all buffered filesystem blocks to disk.
+Stop swapping virtual memory pages on the given device.
+
+
+</para>
+
+<para>
+Options:
+
+
+</para>
+
+<para>
+<screen>
+ -a Stop swapping on all swap devices
+</screen>
</para>
@@ -4103,20 +3954,19 @@ Write all buffered filesystem blocks to disk.
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>syslogd
+<varlistentry><term><emphasis>swapon
</emphasis></term>
<listitem><para></para>
<para>
-Usage: syslogd [OPTION]...
+Usage: swapon [OPTION] [device]
</para>
<para>
-Linux system and kernel (provides klogd) logging utility. Note that this
-version of syslogd/klogd ignores /etc/syslog.conf.
+Start swapping virtual memory pages on the given device.
</para>
@@ -4129,10 +3979,7 @@ Options:
<para>
<screen>
- -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 Start swapping on all swap devices
</screen>
@@ -4145,33 +3992,19 @@ Options:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>swapon
+<varlistentry><term><emphasis>sync
</emphasis></term>
<listitem><para></para>
<para>
-Usage: swapon [OPTION] [device]
-
-
-</para>
-
-<para>
-Start swapping virtual memory pages on the given device.
-
-
-</para>
-
-<para>
-Options:
+Usage: sync
</para>
<para>
-<screen>
- -a Start swapping on all swap devices
-</screen>
+Write all buffered filesystem blocks to disk.
</para>
@@ -4183,19 +4016,20 @@ Options:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>swapoff
+<varlistentry><term><emphasis>syslogd
</emphasis></term>
<listitem><para></para>
<para>
-Usage: swapoff [OPTION] [device]
+Usage: syslogd [OPTION]...
</para>
<para>
-Stop swapping virtual memory pages on the given device.
+Linux system and kernel (provides klogd) logging utility. Note that this
+version of syslogd/klogd ignores /etc/syslog.conf.
</para>
@@ -4208,7 +4042,10 @@ Options:
<para>
<screen>
- -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)
</screen>
@@ -4364,20 +4201,33 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>test, [
+<varlistentry><term><emphasis>tee
</emphasis></term>
<listitem><para></para>
<para>
-Usage: test EXPRESSION or [ EXPRESSION ]
+Usage: tee [OPTION]... [FILE]...
</para>
<para>
-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.
+
+
+</para>
+
+<para>
+Options:
+
+
+</para>
+
+<para>
+<screen>
+ -a append to the given FILEs, do not overwrite
+</screen>
</para>
@@ -4390,18 +4240,9 @@ Example:
<para>
<screen>
- $ 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
</screen>
@@ -4439,33 +4280,20 @@ over a network using the TELNET protocol.
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>tee
+<varlistentry><term><emphasis>test, [
</emphasis></term>
<listitem><para></para>
<para>
-Usage: tee [OPTION]... [FILE]...
-
-
-</para>
-
-<para>
-Copy standard input to each FILE, and also to standard output.
-
-
-</para>
-
-<para>
-Options:
+Usage: test EXPRESSION or [ EXPRESSION ]
</para>
<para>
-<screen>
- -a append to the given FILEs, do not overwrite
-</screen>
+Checks file types and compares values returning an exit code determined by
+the value of EXPRESSION.
</para>
@@ -4478,9 +4306,18 @@ Example:
<para>
<screen>
- $ 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
</screen>
@@ -4678,32 +4515,29 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>uuencode
+<varlistentry><term><emphasis>umount
</emphasis></term>
<listitem><para></para>
<para>
-Usage: uuencode [OPTION] [INFILE] REMOTEFILE
-
-
-</para>
-
-<para>
-Uuencode a file.
+Usage: umount [flags] filesystem|directory
</para>
<para>
-Options:
+Flags:
</para>
<para>
<screen>
- -m use base64 encoding as of RFC1521
+ -a: Unmount all file systems
+ -r: Try to remount devices as read-only if mount is busy
+ -f: Force filesystem umount (i.e. unreachable NFS server)
+ -l: Do not free loop device (if a loop device has been used)
</screen>
@@ -4717,12 +4551,7 @@ Example:
<para>
<screen>
- $ uuencode busybox busybox
- begin 755 busybox
- M?T5,1@$!`0````````````(``P`!````L+@$"#0```!0N@,``````#0`(``&amp;
- .....
- $ uudecode busybox busybox &gt; busybox.uu
- $
+ $ umount /dev/hdc1
</screen>
@@ -4735,19 +4564,19 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>uudecode
+<varlistentry><term><emphasis>uname
</emphasis></term>
<listitem><para></para>
<para>
-Usage: uudecode [OPTION] [FILE]
+Usage: uname [OPTION]...
</para>
<para>
-Uudecode a uuencoded file
+Print certain system information. With no OPTION, same as <emphasis>-s</emphasis>.
</para>
@@ -4760,7 +4589,13 @@ Options:
<para>
<screen>
- -o FILE direct output to FILE
+ -a print all information
+ -m the machine (hardware) type
+ -n print the machine's network node hostname
+ -r print the operating system release
+ -s print the operating system name
+ -p print the host processor type
+ -v print the operating system version
</screen>
@@ -4774,9 +4609,8 @@ Example:
<para>
<screen>
- $ uudecode -o busybox busybox.uu
- $ ls -l busybox
- -rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox
+ $ uname -a
+ Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown
</screen>
@@ -4789,30 +4623,20 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>umount
+<varlistentry><term><emphasis>uniq
</emphasis></term>
<listitem><para></para>
<para>
-Usage: umount [flags] filesystem|directory
-
-
-</para>
-
-<para>
-Flags:
+Usage: uniq [OPTION]... [INPUT [OUTPUT]]
</para>
<para>
-<screen>
- -a: Unmount all file systems
- -r: Try to remount devices as read-only if mount is busy
- -f: Force filesystem umount (i.e. unreachable NFS server)
- -l: Do not free loop device (if a loop device has been used)
-</screen>
+Discard all but one of successive identical lines from INPUT (or standard
+input), writing to OUTPUT (or standard output).
</para>
@@ -4825,7 +4649,10 @@ Example:
<para>
<screen>
- $ umount /dev/hdc1
+ $ echo -e "a\na\nb\nc\nc\na" | sort | uniq
+ a
+ b
+ c
</screen>
@@ -4838,19 +4665,19 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>uname
+<varlistentry><term><emphasis>update
</emphasis></term>
<listitem><para></para>
<para>
-Usage: uname [OPTION]...
+Usage: update [options]
</para>
<para>
-Print certain system information. With no OPTION, same as <emphasis>-s</emphasis>.
+Periodically flushes filesystem buffers.
</para>
@@ -4863,28 +4690,9 @@ Options:
<para>
<screen>
- -a print all information
- -m the machine (hardware) type
- -n print the machine's network node hostname
- -r print the operating system release
- -s print the operating system name
- -p print the host processor type
- -v print the operating system version
-</screen>
-
-
-</para>
-
-<para>
-Example:
-
-
-</para>
-
-<para>
-<screen>
- $ uname -a
- Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown
+ -S force use of sync(2) instead of flushing
+ -s SECS call sync this often (default 30)
+ -f SECS flush some buffers this often (default 5)
</screen>
@@ -4897,20 +4705,19 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>uniq
+<varlistentry><term><emphasis>uptime
</emphasis></term>
<listitem><para></para>
<para>
-Usage: uniq [OPTION]... [INPUT [OUTPUT]]
+Usage: uptime
</para>
<para>
-Discard all but one of successive identical lines from INPUT (or standard
-input), writing to OUTPUT (or standard output).
+Tells how long the system has been running since boot.
</para>
@@ -4923,10 +4730,8 @@ Example:
<para>
<screen>
- $ echo -e "a\na\nb\nc\nc\na" | sort | uniq
- a
- b
- c
+ $ uptime
+ 1:55pm up 2:30, load average: 0.09, 0.04, 0.00
</screen>
@@ -4939,34 +4744,33 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>update
+<varlistentry><term><emphasis>usleep
</emphasis></term>
<listitem><para></para>
<para>
-Usage: update [options]
+Usage: usleep N
</para>
<para>
-Periodically flushes filesystem buffers.
+Pauses for N microseconds.
</para>
<para>
-Options:
+Example:
</para>
<para>
<screen>
- -S force use of sync(2) instead of flushing
- -s SECS call sync this often (default 30)
- -f SECS flush some buffers this often (default 5)
+ $ usleep 1000000
+ [pauses for 1 second]
</screen>
@@ -4979,19 +4783,33 @@ Options:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>uptime
+<varlistentry><term><emphasis>uudecode
</emphasis></term>
<listitem><para></para>
<para>
-Usage: uptime
+Usage: uudecode [OPTION] [FILE]
</para>
<para>
-Tells how long the system has been running since boot.
+Uudecode a uuencoded file
+
+
+</para>
+
+<para>
+Options:
+
+
+</para>
+
+<para>
+<screen>
+ -o FILE direct output to FILE
+</screen>
</para>
@@ -5004,8 +4822,9 @@ Example:
<para>
<screen>
- $ uptime
- 1:55pm up 2:30, load average: 0.09, 0.04, 0.00
+ $ uudecode -o busybox busybox.uu
+ $ ls -l busybox
+ -rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox
</screen>
@@ -5018,19 +4837,33 @@ Example:
</para>
</listitem></varlistentry>
-<varlistentry><term><emphasis>usleep
+<varlistentry><term><emphasis>uuencode
</emphasis></term>
<listitem><para></para>
<para>
-Usage: usleep N
+Usage: uuencode [OPTION] [INFILE] REMOTEFILE
</para>
<para>
-Pauses for N microseconds.
+Uuencode a file.
+
+
+</para>
+
+<para>
+Options:
+
+
+</para>
+
+<para>
+<screen>
+ -m use base64 encoding as of RFC1521
+</screen>
</para>
@@ -5043,8 +4876,12 @@ Example:
<para>
<screen>
- $ usleep 1000000
- [pauses for 1 second]
+ $ uuencode busybox busybox
+ begin 755 busybox
+ M?T5,1@$!`0````````````(``P`!````L+@$"#0```!0N@,``````#0`(``&amp;
+ .....
+ $ uudecode busybox busybox &gt; busybox.uu
+ $
</screen>