Added dos2unix, unix2dos, and unrpm.c thanks to robotti@metconnect.com.

[oweals/busybox.git] / docs / busybox.sgml

diff --git a/docs/busybox.sgml b/docs/busybox.sgml
index 61b08adbd0309e70217786b20425cebbce356531..e8a91fa05eab33d129da53e61d1e6da920582097 100644 (file)
--- a/docs/busybox.sgml
+++ b/docs/busybox.sgml
@@ -1,4 +1,4 @@
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [...]>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ ]>
 <book id="BusyBoxDocumentation">
  <bookinfo>
   <title>BusyBox - The Swiss Army Knife of Embedded Linux</title>
@@ -59,8 +59,8 @@
 
   <chapter id="Syntax">
      <title>How to use BusyBox</title>
-       <sect1 id="How to use BusyBox">
-           <title>Syntax</title
+       <sect1 id="How-to-use-BusyBox">
+           <title>Syntax</title>
 
            <para>
            <screen>
@@ -75,7 +75,9 @@
            </para>
        </sect1>
 
-       <sect1 id="Invoking BusyBox">
+       <sect1 id="Invoking-BusyBox">
+           <title>Invoking BusyBox</title>
+
            <para>
            When you create a link to BusyBox for the function you wish to use, when
            BusyBox is called using that link it will behave as if the command itself
@@ -115,7 +117,9 @@
 
        </sect1>
 
-       <sect1 id="Common options">
+       <sect1 id="Common-options">
+           <title>Common options</title>
+
            <para>
            Most BusyBox commands support the <emphasis>--help</emphasis> option to provide 
            a terse runtime description of their behavior. 
@@ -125,7 +129,7 @@
 
   <chapter id="Commands">
      <title>BusyBox Commands</title>
-       <sect1 id="Available BusyBox Commands">
+       <sect1 id="Available-BusyBox-Commands">
            <title>Available BusyBox Commands</title>
                <para>
                Currently defined functions include:
@@ -741,6 +745,19 @@
                </para>
        </sect1>
 
+       <sect1 id="dos2unix">
+           <title>dos2unix</title>
+
+               <para>
+               Usage: dos2unix < dosfile > unixfile
+               </para>
+
+               <para>
+               Converts a text file from dos format to unix format.
+               </para>
+
+       </sect1>
+
        <sect1 id="du">
            <title>du</title>
 
@@ -1261,7 +1278,7 @@
                </para>
        </sect1>
 
-<      <sect1 id="gzip">
+       <sect1 id="gzip">
            <title>gzip</title>
 
                <para>
@@ -1489,7 +1506,7 @@
                <screen>
                        &lt;id&gt;:&lt;runlevels&gt;:&lt;action&gt;:&lt;process&gt;
                </screen>
-               <para>
+               </para>
 
                <sect2>
                    <title>id</title>
@@ -1550,9 +1567,8 @@
                        </para>
                </sect2>
 
-               <para>
-               Example /etc/inittab file:
-               </para>
+               <sect2>
+                   <title>Example /etc/inittab file</title>
 
                <para>
                <screen>
@@ -1563,14 +1579,16 @@
                        # /bin/sh invocations on selected ttys
                        #
                        # Start an "askfirst" shell on the console (whatever that may be)
-                       ::askfirst:/bin/sh
-                       # Start an "askfirst" shell on /dev/tty2
-                       tty2::askfirst:/bin/sh
+                       ::askfirst:-/bin/sh
+                       # Start an "askfirst" shell on /dev/tty2-4
+                       tty2::askfirst:-/bin/sh
+                       tty2::askfirst:-/bin/sh
+                       tty2::askfirst:-/bin/sh
 
                        # /sbin/getty invocations for selected ttys
                        #
-                       tty4::respawn:/sbin/getty 38400 tty4
-                       tty5::respawn:/sbin/getty 38400 tty5
+                       tty4::respawn:/sbin/getty 38400 tty5
+                       tty5::respawn:/sbin/getty 38400 tty6
 
                        # Example of how to put a getty on a serial line (for a terminal)
                        #
@@ -1581,10 +1599,11 @@
                        #ttyS2::respawn:/sbin/getty -x0 -s 57600 ttyS2
 
                        # Stuff to do before rebooting
-                       ::ctrlaltdel:/bin/umount -a -r &gt; /dev/null 2&gt;&amp;1
-                       ::ctrlaltdel:/sbin/swapoff -a &gt; /dev/null 2&gt;&amp;1
+                       ::ctrlaltdel:/bin/umount -a -r
+                       ::ctrlaltdel:/sbin/swapoff
                </screen>
                </para>
+               </sect2>
        </sect1>
 
        <sect1 id="insmod">
@@ -3128,8 +3147,8 @@
                </para>
 
                <para>
-               <screen>
                   or: [ EXPRESSION ]
+               </para>
 
                <para>
                Check file types and compare values returning an exit
@@ -3387,6 +3406,32 @@
                </screen>
                </para>
        </sect1>
+       
+       <sect1 id="unix2dos">
+           <title>unix2dos</title>
+
+               <para>
+               Usage: unix2dos < unixfile > dosfile
+               </para>
+
+               <para>
+               Converts a text file from unix format to dos format.
+               </para>
+
+       </sect1>
+
+       <sect1 id="unrpm">
+           <titleunrpmuniq</title>
+
+               <para>
+               Usage: unrpm < package.rpm | gzip -d | cpio -idmuv
+               </para>
+
+               <para>
+               Extracts an rpm archive.
+               </para>
+
+       </sect1>
 
        <sect1 id="update">
            <title>update</title>