DocBook documentation update from Matt Kraai <kraai@alumni.carnegiemellon.edu>

-Erik
1_00_stable_10817
Eric Andersen 2000-07-06 16:58:45 +00:00
parent b2731b11ef
commit 6f5e281479
1 changed files with 476 additions and 644 deletions

View File

@ -57,7 +57,6 @@
</para>
</chapter>
<chapter id="Syntax">
<title>How to use BusyBox</title>
<sect1 id="How to use BusyBox">
@ -76,7 +75,6 @@
</para>
</sect1>
<sect1 id="Invoking BusyBox">
<para>
When you create a link to BusyBox for the function you wish to use, when
@ -147,12 +145,11 @@
</para>
</sect1>
<sect1 id="ar">
<title>ar</title>
<para>
Usage: ar [optxvV] archive [filenames]
Usage: ar [OPTION] archive [FILENAME]...
</para>
<para>
@ -165,18 +162,15 @@
<para>
<screen>
o preserve original dates
p extract to stdout
t list
x extract
v verbosely list files processed
o Preserve original dates
p Extract to stdout
t List
x Extract
v Verbosely list files processed
</screen>
</para>
</sect1>
<sect1 id="basename">
<title>basename</title>
<para>
@ -184,7 +178,7 @@
</para>
<para>
Strips directory path and suffixes from FILE. If specified, also removes
Strip directory path and suffixes from FILE. If specified, also removes
any trailing SUFFIX.
</para>
@ -204,16 +198,15 @@
</para>
</sect1>
<sect1 id="cat">
<title>cat</title>
<para>
Usage: cat [FILE ...]
Usage: cat [FILE]...
</para>
<para>
Concatenates <literal>FILE(s)</literal> and prints them to the standard
Concatenate <literal>FILE(s)</literal> and prints them to the standard
output.
</para>
@ -227,11 +220,8 @@
110716.72 17.67
</screen>
</para>
</sect1>
<sect1 id="chgrp">
<title>chgrp</title>
@ -249,7 +239,7 @@
<para>
<screen>
-R change files and directories recursively
-R Change files and directories recursively
</screen>
</para>
@ -268,8 +258,6 @@
</para>
</sect1>
<sect1 id="chmod">
<title>chmod</title>
@ -278,7 +266,7 @@
</para>
<para>
Changes file access permissions for the specified
Change 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
@ -377,8 +365,6 @@
</para>
</sect1>
<sect1 id="chown">
<title>chown</title>
<para>
@ -386,7 +372,7 @@
</para>
<para>
Changes the owner and/or group of each FILE to OWNER and/or GROUP.
Change the owner and/or group of each FILE to OWNER and/or GROUP.
</para>
<para>
@ -395,7 +381,7 @@
<para>
<screen>
-R Changes files and directories recursively
-R Change files and directories recursively
</screen>
</para>
@ -417,8 +403,6 @@
</para>
</sect1>
<sect1 id="chroot">
<title>chroot</title>
<para>
@ -445,7 +429,6 @@
</para>
</sect1>
<sect1 id="chvt">
<title>chvt</title>
<para>
@ -453,13 +436,10 @@
</para>
<para>
Changes the foreground virtual terminal to /dev/ttyN
Change the foreground virtual terminal to /dev/ttyN
</para>
</sect1>
<sect1 id="clear">
<title>clear</title>
@ -468,11 +448,10 @@
</para>
<para>
Clears the screen.
Clear the screen.
</para>
</sect1>
<sect1 id="cp">
<title>cp</title>
@ -487,7 +466,7 @@
</para>
<para>
Copies SOURCE to DEST, or multiple <literal>SOURCE(s)</literal> to
Copy SOURCE to DEST, or multiple <literal>SOURCE(s)</literal> to
DIRECTORY.
</para>
@ -498,14 +477,13 @@
<para>
<screen>
-a Same as -dpR
-d Preserves links
-p Preserves file attributes if possible
-R Copies directories recursively
-d Preserve links
-p Preserve file attributes if possible
-R Copy directories recursively
</screen>
</para>
</sect1>
<sect1 id="cut">
<title>cut</title>
@ -514,7 +492,7 @@
</para>
<para>
Prints selected fields from each input FILE to standard output.
Print selected fields from each input FILE to standard output.
</para>
<para>
@ -546,8 +524,6 @@
</para>
</sect1>
<sect1 id="date">
<title>date</title>
@ -562,7 +538,7 @@
</para>
<para>
Displays the current time in the given FORMAT, or sets the system date.
Display the current time in the given FORMAT, or set the system date.
</para>
<para>
@ -571,9 +547,9 @@
<para>
<screen>
-R Outputs RFC-822 compliant date string
-s Sets time described by STRING
-u Prints or sets Coordinated Universal Time
-R Output RFC-822 compliant date string
-s Set time described by STRING
-u Print or set Coordinated Universal Time
</screen>
</para>
@ -589,46 +565,31 @@
</para>
</sect1>
<sect1 id="dc">
<title>dc</title>
<para>
Usage: dc [EXPRESSION]
</para>
<!-- This is where I have stopped formatting stuff -->
<para>
This is a Tiny RPN calculator that understands the
following operations: +, -, /, *, and, or, not, eor. If
no arguments are given, dc will process input from
stdin.
</para>
<para>
The behaviour of BusyBox/dc deviates (just a little ;-)
from GNU/dc, but this will be remedied in the future.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>dc
<para>
Example:
</para>
</emphasis></term>
<listitem><para></para>
<para>
Usage: dc expression ...
</para>
<para>
This is a Tiny RPN calculator that understands the following operations: +,
-, /, *, and, or, not, eor. If no arguments are given, dc will process
input from STDIN.
</para>
<para>
The behaviour of BusyBox/dc deviates (just a little ;-) from GNU/dc, but
this will be remedied in the future.
</para>
<para>
Example:
</para>
<para>
<screen>
<para>
<screen>
$ dc 2 2 +
4
$ dc 8 8 \* 2 2 + /
@ -639,126 +600,84 @@ Example:
1
$ echo 72 9 div 8 mul | dc
64
</screen>
</screen>
</para>
</sect1>
<sect1 id="dd">
<title>dd</title>
</para>
<para>
Usage: dd [OPTION]...
</para>
<para>
-------------------------------
<para>
Copy a file, converting and formatting according to
options.
</para>
<para>
Options:
</para>
</para>
<para>
<screen>
if=FILE Read from FILE instead of stdin
of=FILE Write to FILE instead of stdout
bs=N Read and write N bytes at a time
count=N Copy only N input blocks
skip=N Skip N input blocks
seek=N Skip N output blocks
</screen>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>dd
<para>
Numbers may be suffixed by w (x2), k (x1024), b (x512),
or M (x1024^2).
</para>
</emphasis></term>
<listitem><para></para>
<para>
Example:
</para>
<para>
Usage: dd [if=name] [of=name] [bs=n] [count=n] [skip=n] [seek=n]
</para>
<para>
Copy a file, converting and formatting according to options
</para>
<para>
<screen>
if=FILE read from FILE instead of stdin
of=FILE write to FILE instead of stdout
bs=n read and write n bytes at a time
count=n copy only n input blocks
skip=n skip n input blocks
seek=n skip n output blocks
</screen>
</para>
<para>
Numbers may be suffixed by w (x2), k (x1024), b (x512), or M (x1024^2)
</para>
<para>
Example:
</para>
<para>
<screen>
<para>
<screen>
$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4
4+0 records in
4+0 records out
</screen>
</screen>
</para>
</sect1>
<sect1 id="deallocvt">
<title>deallocvt</title>
</para>
<para>
Usage: deallocvt N
</para>
<para>
-------------------------------
<para>
Deallocate unused virtual terminal /dev/ttyN.
</para>
</sect1>
</para>
<sect1 id="df">
<title>df</title>
</listitem></varlistentry>
<varlistentry><term><emphasis>deallocvt
<para>
Usage: df [FILE]...
</para>
</emphasis></term>
<listitem><para></para>
<para>
Print the filesystem space used and space available.
</para>
<para>
Usage: deallocvt N
<para>
Example:
</para>
</para>
<para>
Deallocates unused virtual terminal /dev/ttyN
</para>
<para>
-------------------------------
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>df
</emphasis></term>
<listitem><para></para>
<para>
Usage: df [filesystem ...]
</para>
<para>
Prints the filesystem space used and space available.
</para>
<para>
Example:
</para>
<para>
<screen>
<para>
<screen>
$ df
Filesystem 1k-blocks Used Available Use% Mounted on
/dev/sda3 8690864 8553540 137324 98% /
@ -766,125 +685,90 @@ Example:
$ df /dev/sda3
Filesystem 1k-blocks Used Available Use% Mounted on
/dev/sda3 8690864 8553540 137324 98% /
</screen>
</screen>
</para>
</sect1>
<sect1 id="dirname">
<title>dirname</title>
</para>
<para>
Usage: dirname NAME
</para>
<para>
-------------------------------
<para>
Strip non-directory suffix from NAME.
</para>
<para>
Example:
</para>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>dirname
</emphasis></term>
<listitem><para></para>
<para>
Usage: dirname NAME
</para>
<para>
Strip non-directory suffix from file name
</para>
<para>
Example:
</para>
<para>
<screen>
<para>
<screen>
$ dirname /tmp/foo
/tmp
$ dirname /tmp/foo/
/tmp
</screen>
</screen>
</para>
</sect1>
<sect1 id="dmesg">
<title>dmesg</title>
</para>
<para>
Usage: dmesg [OPTION]...
</para>
<para>
-------------------------------
<para>
Print or control the kernel ring buffer.
</para>
<para>
Options:
</para>
</para>
<para>
<screen>
-c Clear the ring buffer after printing
-n LEVEL Set the console logging level to LEVEL
-s BUFSIZE Query ring buffer using a buffer of BUFSIZE
</screen>
</para>
</sect1>
</listitem></varlistentry>
<varlistentry><term><emphasis>dmesg
<sect1 id="du">
<title>du</title>
</emphasis></term>
<listitem><para></para>
<para>
Usage: du [OPTION]... [FILE]...
</para>
<para>
Usage: dmesg [<emphasis>-c</emphasis>] [<emphasis>-n</emphasis> level] [<emphasis>-s</emphasis> bufsize]
<para>
Summarize the disk space used for each FILE or current
directory. Disk space printed in units of 1k (i.e.
1024 bytes).
</para>
<para>
Options:
</para>
</para>
<para>
<screen>
-l Count sizes many times if hard linked
-s Display only a total for each argument
</screen>
</para>
<para>
Print or controls the kernel ring buffer.
<para>
Example:
</para>
</para>
<para>
-------------------------------
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>du
</emphasis></term>
<listitem><para></para>
<para>
Usage: du [OPTION]... [FILE]...
</para>
<para>
Summarize disk space used for each FILE and/or directory. Disk space is
printed in units of 1k (i.e. 1024 bytes).
</para>
<para>
Options:
</para>
<para>
<screen>
-l count sizes many times if hard linked
-s display only a total for each argument
</screen>
</para>
<para>
Example:
</para>
<para>
<screen>
$ ./BusyBox du
<para>
<screen>
$ du
16 ./CVS
12 ./kernel-patches/CVS
80 ./kernel-patches
@ -895,43 +779,28 @@ Example:
12 ./docs/CVS
104 ./docs
2417 .
</screen>
</screen>
</para>
</sect1>
<sect1 id="dutmp">
<title>dutmp</title>
</para>
<para>
Usage: dutmp [FILE]
</para>
<para>
-------------------------------
<para>
Dump utmp file format (pipe delimited) from FILE or
stdin to stdout.
</para>
<para>
Example:
</para>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>dutmp
</emphasis></term>
<listitem><para></para>
<para>
Usage: dutmp [FILE]
</para>
<para>
Dump utmp file format (pipe delimited) from FILE or stdin to stdout.
</para>
<para>
Example:
</para>
<para>
<screen>
<para>
<screen>
$ dutmp /var/run/utmp
8|7||si|||0|0|0|955637625|760097|0
2|0|~|~~|reboot||0|0|0|955637625|782235|0
@ -940,59 +809,39 @@ Example:
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
</screen>
</screen>
</para>
</sect1>
<sect1 id="echo">
<title>echo</title>
</para>
<para>
Usage: echo [OPTION]... [ARG]...
</para>
<para>
-------------------------------
<para>
Print ARGs to stdout.
</para>
<para>
Options:
</para>
</para>
<para>
<screen>
-n Suppress trailing newline
-e Enable interpretation of escaped characters
-E Disable interpretation of escaped characters
</screen>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>echo
<para>
Example:
</para>
</emphasis></term>
<listitem><para></para>
<para>
Usage: echo [-neE] [ARG ...]
</para>
<para>
Prints the specified ARGs to stdout
</para>
<para>
Options:
</para>
<para>
<screen>
-n suppress trailing newline
-e interpret backslash-escaped characters (i.e. \t=tab etc)
-E disable interpretation of backslash-escaped characters
</screen>
</para>
<para>
Example:
</para>
<para>
<screen>
<para>
<screen>
$ echo "Erik is cool"
Erik is cool
$ echo -e "Erik\nis\ncool"
@ -1001,52 +850,35 @@ Example:
cool
$ echo "Erik\nis\ncool"
Erik\nis\ncool
</screen>
</screen>
</para>
</sect1>
<sect1 id="false">
<title>false</title>
</para>
<para>
Usage: false
</para>
<para>
-------------------------------
<para>
Returns an exit code of FALSE (1).
</para>
<para>
Example:
</para>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>false
</emphasis></term>
<listitem><para></para>
<para>
Returns an exit code of FALSE (1)
</para>
<para>
Example:
</para>
<para>
<screen>
<para>
<screen>
$ false
$ echo $?
1
</screen>
</screen>
</para>
</sect1>
</para>
<para>
-------------------------------
</para>
</listitem></varlistentry>
<!-- This is where I have stopped formatting stuff -->
<varlistentry><term><emphasis>fbset
</emphasis></term>