emo/busybox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
-Erik
This commit is contained in:
Eric Andersen
2000-07-06 16:58:45 +00:00
parent b2731b11ef
commit 6f5e281479
1 changed files with 476 additions and 644 deletions
Download Patch File Download Diff File Expand all files Collapse all files

414
docs/busybox.sgml
View File

@@ -57,7 +57,6 @@
</para> </para>
</chapter> </chapter>
<chapter id="Syntax"> <chapter id="Syntax">
<title>How to use BusyBox</title> <title>How to use BusyBox</title>
<sect1 id="How to use BusyBox"> <sect1 id="How to use BusyBox">
@@ -76,7 +75,6 @@
</para> </para>
</sect1> </sect1>
<sect1 id="Invoking BusyBox"> <sect1 id="Invoking BusyBox">
<para> <para>
When you create a link to BusyBox for the function you wish to use, when When you create a link to BusyBox for the function you wish to use, when
@@ -147,12 +145,11 @@
</para> </para>
</sect1> </sect1>
<sect1 id="ar"> <sect1 id="ar">
<title>ar</title> <title>ar</title>
<para> <para>
Usage: ar [optxvV] archive [filenames] Usage: ar [OPTION] archive [FILENAME]...
</para> </para>
<para> <para>
@@ -165,18 +162,15 @@
<para> <para>
<screen> <screen>
o preserve original dates o Preserve original dates
p extract to stdout p Extract to stdout
t list t List
x extract x Extract
v verbosely list files processed v Verbosely list files processed
</screen> </screen>
</para> </para>
</sect1> </sect1>
<sect1 id="basename"> <sect1 id="basename">
<title>basename</title> <title>basename</title>
<para> <para>
@@ -184,7 +178,7 @@
</para> </para>
<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. any trailing SUFFIX.
</para> </para>
@@ -204,16 +198,15 @@
</para> </para>
</sect1> </sect1>
<sect1 id="cat"> <sect1 id="cat">
<title>cat</title> <title>cat</title>
<para> <para>
Usage: cat [FILE ...] Usage: cat [FILE]...
</para> </para>
<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. output.
</para> </para>
@@ -227,11 +220,8 @@
110716.72 17.67 110716.72 17.67
</screen> </screen>
</para> </para>
</sect1> </sect1>
<sect1 id="chgrp"> <sect1 id="chgrp">
<title>chgrp</title> <title>chgrp</title>
@@ -249,7 +239,7 @@
<para> <para>
<screen> <screen>
-R change files and directories recursively -R Change files and directories recursively
</screen> </screen>
</para> </para>
@@ -268,8 +258,6 @@
</para> </para>
</sect1> </sect1>
<sect1 id="chmod"> <sect1 id="chmod">
<title>chmod</title> <title>chmod</title>
@@ -278,7 +266,7 @@
</para> </para>
<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 <literal>FILE(s)</literal> (or directories). Each MODE is defined by
combining the letters for WHO has access to the file, an OPERATOR for combining the letters for WHO has access to the file, an OPERATOR for
selecting how the permissions should be changed, and a PERMISSION for selecting how the permissions should be changed, and a PERMISSION for
@@ -377,8 +365,6 @@
</para> </para>
</sect1> </sect1>
<sect1 id="chown"> <sect1 id="chown">
<title>chown</title> <title>chown</title>
<para> <para>
@@ -386,7 +372,7 @@
</para> </para>
<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>
<para> <para>
@@ -395,7 +381,7 @@
<para> <para>
<screen> <screen>
-R Changes files and directories recursively -R Change files and directories recursively
</screen> </screen>
</para> </para>
@@ -417,8 +403,6 @@
</para> </para>
</sect1> </sect1>
<sect1 id="chroot"> <sect1 id="chroot">
<title>chroot</title> <title>chroot</title>
<para> <para>
@@ -445,7 +429,6 @@
</para> </para>
</sect1> </sect1>
<sect1 id="chvt"> <sect1 id="chvt">
<title>chvt</title> <title>chvt</title>
<para> <para>
@@ -453,13 +436,10 @@
</para> </para>
<para> <para>
Changes the foreground virtual terminal to /dev/ttyN Change the foreground virtual terminal to /dev/ttyN
</para> </para>
</sect1> </sect1>
<sect1 id="clear"> <sect1 id="clear">
<title>clear</title> <title>clear</title>
@@ -468,11 +448,10 @@
</para> </para>
<para> <para>
Clears the screen. Clear the screen.
</para> </para>
</sect1> </sect1>
<sect1 id="cp"> <sect1 id="cp">
<title>cp</title> <title>cp</title>
@@ -487,7 +466,7 @@
</para> </para>
<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. DIRECTORY.
</para> </para>
@@ -498,14 +477,13 @@
<para> <para>
<screen> <screen>
-a Same as -dpR -a Same as -dpR
-d Preserves links -d Preserve links
-p Preserves file attributes if possible -p Preserve file attributes if possible
-R Copies directories recursively -R Copy directories recursively
</screen> </screen>
</para> </para>
</sect1> </sect1>
<sect1 id="cut"> <sect1 id="cut">
<title>cut</title> <title>cut</title>
@@ -514,7 +492,7 @@
</para> </para>
<para> <para>
Prints selected fields from each input FILE to standard output. Print selected fields from each input FILE to standard output.
</para> </para>
<para> <para>
@@ -546,8 +524,6 @@
</para> </para>
</sect1> </sect1>
<sect1 id="date"> <sect1 id="date">
<title>date</title> <title>date</title>
@@ -562,7 +538,7 @@
</para> </para>
<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>
<para> <para>
@@ -571,9 +547,9 @@
<para> <para>
<screen> <screen>
-R Outputs RFC-822 compliant date string -R Output RFC-822 compliant date string
-s Sets time described by STRING -s Set time described by STRING
-u Prints or sets Coordinated Universal Time -u Print or set Coordinated Universal Time
</screen> </screen>
</para> </para>
@@ -589,42 +565,27 @@
</para> </para>
</sect1> </sect1>
<sect1 id="dc">
<title>dc</title>
<!-- This is where I have stopped formatting stuff -->
</listitem></varlistentry>
<varlistentry><term><emphasis>dc
</emphasis></term>
<listitem><para></para>
<para> <para>
Usage: dc expression ... Usage: dc [EXPRESSION]
</para> </para>
<para> <para>
This is a Tiny RPN calculator that understands the following operations: +, This is a Tiny RPN calculator that understands the
-, /, *, and, or, not, eor. If no arguments are given, dc will process following operations: +, -, /, *, and, or, not, eor. If
input from STDIN. no arguments are given, dc will process input from
stdin.
</para> </para>
<para> <para>
The behaviour of BusyBox/dc deviates (just a little ;-) from GNU/dc, but The behaviour of BusyBox/dc deviates (just a little ;-)
this will be remedied in the future. from GNU/dc, but this will be remedied in the future.
</para> </para>
<para> <para>
Example: Example:
</para> </para>
<para> <para>
@@ -640,57 +601,43 @@ Example:
$ echo 72 9 div 8 mul | dc $ echo 72 9 div 8 mul | dc
64 64
</screen> </screen>
</para>
</sect1>
<sect1 id="dd">
<title>dd</title>
<para>
Usage: dd [OPTION]...
</para> </para>
<para> <para>
------------------------------- Copy a file, converting and formatting according to
options.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>dd
</emphasis></term>
<listitem><para></para>
<para>
Usage: dd [if=name] [of=name] [bs=n] [count=n] [skip=n] [seek=n]
</para> </para>
<para> <para>
Copy a file, converting and formatting according to options Options:
</para> </para>
<para> <para>
<screen> <screen>
if=FILE read from FILE instead of stdin if=FILE Read from FILE instead of stdin
of=FILE write to FILE instead of stdout of=FILE Write to FILE instead of stdout
bs=n read and write n bytes at a time bs=N Read and write N bytes at a time
count=n copy only n input blocks count=N Copy only N input blocks
skip=n skip n input blocks skip=N Skip N input blocks
seek=n skip n output blocks seek=N Skip N output blocks
</screen> </screen>
</para> </para>
<para> <para>
Numbers may be suffixed by w (x2), k (x1024), b (x512), or M (x1024^2) Numbers may be suffixed by w (x2), k (x1024), b (x512),
or M (x1024^2).
</para> </para>
<para> <para>
Example: Example:
</para> </para>
<para> <para>
@@ -699,62 +646,34 @@ Example:
4+0 records in 4+0 records in
4+0 records out 4+0 records out
</screen> </screen>
</para> </para>
</sect1>
<para> <sect1 id="deallocvt">
------------------------------- <title>deallocvt</title>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>deallocvt
</emphasis></term>
<listitem><para></para>
<para> <para>
Usage: deallocvt N Usage: deallocvt N
</para> </para>
<para> <para>
Deallocates unused virtual terminal /dev/ttyN Deallocate unused virtual terminal /dev/ttyN.
</para>
</sect1>
<sect1 id="df">
<title>df</title>
<para>
Usage: df [FILE]...
</para> </para>
<para> <para>
------------------------------- Print the filesystem space used and space available.
</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>
<para> <para>
Example: Example:
</para> </para>
<para> <para>
@@ -767,38 +686,22 @@ Example:
Filesystem 1k-blocks Used Available Use% Mounted on Filesystem 1k-blocks Used Available Use% Mounted on
/dev/sda3 8690864 8553540 137324 98% / /dev/sda3 8690864 8553540 137324 98% /
</screen> </screen>
</para> </para>
</sect1>
<para> <sect1 id="dirname">
------------------------------- <title>dirname</title>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>dirname
</emphasis></term>
<listitem><para></para>
<para> <para>
Usage: dirname NAME Usage: dirname NAME
</para> </para>
<para> <para>
Strip non-directory suffix from file name Strip non-directory suffix from NAME.
</para> </para>
<para> <para>
Example: Example:
</para> </para>
<para> <para>
@@ -808,83 +711,64 @@ Example:
$ dirname /tmp/foo/ $ dirname /tmp/foo/
/tmp /tmp
</screen> </screen>
</para>
</sect1>
<sect1 id="dmesg">
<title>dmesg</title>
<para>
Usage: dmesg [OPTION]...
</para> </para>
<para> <para>
------------------------------- Print or control the kernel ring buffer.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>dmesg
</emphasis></term>
<listitem><para></para>
<para>
Usage: dmesg [<emphasis>-c</emphasis>] [<emphasis>-n</emphasis> level] [<emphasis>-s</emphasis> bufsize]
</para>
<para>
Print or controls the kernel ring buffer.
</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>
<para> <para>
Options: Options:
</para> </para>
<para> <para>
<screen> <screen>
-l count sizes many times if hard linked -c Clear the ring buffer after printing
-s display only a total for each argument -n LEVEL Set the console logging level to LEVEL
-s BUFSIZE Query ring buffer using a buffer of BUFSIZE
</screen> </screen>
</para>
</sect1>
<sect1 id="du">
<title>du</title>
<para>
Usage: du [OPTION]... [FILE]...
</para>
<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>
<screen>
-l Count sizes many times if hard linked
-s Display only a total for each argument
</screen>
</para> </para>
<para> <para>
Example: Example:
</para> </para>
<para> <para>
<screen> <screen>
$ ./BusyBox du $ du
16 ./CVS 16 ./CVS
12 ./kernel-patches/CVS 12 ./kernel-patches/CVS
80 ./kernel-patches 80 ./kernel-patches
@@ -896,38 +780,23 @@ Example:
104 ./docs 104 ./docs
2417 . 2417 .
</screen> </screen>
</para> </para>
</sect1>
<para> <sect1 id="dutmp">
------------------------------- <title>dutmp</title>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>dutmp
</emphasis></term>
<listitem><para></para>
<para> <para>
Usage: dutmp [FILE] Usage: dutmp [FILE]
</para> </para>
<para> <para>
Dump utmp file format (pipe delimited) from FILE or stdin to stdout. Dump utmp file format (pipe delimited) from FILE or
stdin to stdout.
</para> </para>
<para> <para>
Example: Example:
</para> </para>
<para> <para>
@@ -941,54 +810,34 @@ Example:
6|246|tty2|2|LOGIN||0|0|0|955637630|999498|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 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>
Usage: echo [OPTION]... [ARG]...
</para> </para>
<para> <para>
------------------------------- Print ARGs to stdout.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>echo
</emphasis></term>
<listitem><para></para>
<para>
Usage: echo [-neE] [ARG ...]
</para>
<para>
Prints the specified ARGs to stdout
</para> </para>
<para> <para>
Options: Options:
</para> </para>
<para> <para>
<screen> <screen>
-n suppress trailing newline -n Suppress trailing newline
-e interpret backslash-escaped characters (i.e. \t=tab etc) -e Enable interpretation of escaped characters
-E disable interpretation of backslash-escaped characters -E Disable interpretation of escaped characters
</screen> </screen>
</para> </para>
<para> <para>
Example: Example:
</para> </para>
<para> <para>
@@ -1002,32 +851,22 @@ Example:
$ echo "Erik\nis\ncool" $ echo "Erik\nis\ncool"
Erik\nis\ncool Erik\nis\ncool
</screen> </screen>
</para>
</sect1>
<sect1 id="false">
<title>false</title>
<para>
Usage: false
</para> </para>
<para> <para>
------------------------------- Returns an exit code of FALSE (1).
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>false
</emphasis></term>
<listitem><para></para>
<para>
Returns an exit code of FALSE (1)
</para> </para>
<para> <para>
Example: Example:
</para> </para>
<para> <para>
@@ -1036,17 +875,10 @@ Example:
$ echo $? $ echo $?
1 1
</screen> </screen>
</para> </para>
</sect1>
<para> <!-- This is where I have stopped formatting stuff -->
-------------------------------
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis>fbset <varlistentry><term><emphasis>fbset
</emphasis></term> </emphasis></term>