Fix a bug of mine where extracting files to stdout would extract to
[oweals/busybox.git] / docs / busybox.sgml
index fda66a619e7a4d77fd0ba2f098ebdaa99c17c279..b54d68ee58e01a469c842fa177156c92fc60e631 100644 (file)
                </para>
 
                <para>
-               ar, basename, cat, chgrp, chmod, chown, chroot, chvt, clear,
-               cp, cut, date, dc, dd, deallocvt, df, dirname, dmesg, du,
-               dumpkmap, dutmp, echo, false, fbset, fdflush, find, free,
-               freeramdisk, fsck.minix, grep, gunzip, gzip, halt, head,
-               hostid, hostname, id, init, insmod, kill, killall, length, ln,
-               loadacm, loadfont, loadkmap, logger, logname, ls, lsmod,
-               makedevs, mkdir, mkfifo, mkfs.minix, mknod, mkswap, mktemp,
-               more, mount, mt, mv, nc, nslookup, ping, poweroff, printf, ps,
-               pwd, reboot, renice, reset, rm, rmdir, rmmod, sed, setkeycodes, sh, sleep,
-               sort, swapoff, swapon, sync, syslogd, tail, tar, tee, telnet,
-               test, touch, tr, true, tty, umount, uname, uniq, update,
-               uptime, usleep, uudecode, uuencode, wc, which, whoami, yes,
-               zcat, [
+               addgroup, adduser, adjtimex, ar, arping, ash, awk, basename,
+               bunzip2, busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot,
+               chvt, clear, cmp, cp, cpio, crond, crontab, cut, date, dc, dd,
+               deallocvt, delgroup, deluser, df, dirname, dmesg, dos2unix, dpkg,
+               dpkg-deb, du, dumpkmap, dumpleases, dutmp, echo, egrep, env, expr,
+               false, fbset, fdflush, fdformat, fgrep, find, fold, free, freeramdisk,
+               fsck.minix, ftpget, ftpput, getopt, getty, grep, gunzip, gzip,
+               halt, hdparm, head, hexdump, hostid, hostname, httpd, hush, hwclock, 
+               id, ifconfig, ifdown, ifup, inetd, init, insmod, ip, ipcalc, iplink,
+               iproute, iptunnel, kill, killall, klogd, lash, length, linuxrc,
+               ln, loadfont, loadkmap, logger, login, logname, logread,
+               losetup, ls, lsmod, makedevs, md5sum, mesg, minit, mkdir, mkfifo,
+               mkfs.minix, mknod, mkswap, mktemp, modprobe, more, mount, msh,
+               msvc, mt, mv, nameif, nc, netstat, nslookup, od, openvt, passwd,
+               patch, pidfilehack, pidof, ping, ping6, pivot_root, poweroff,
+               printf, ps, pwd, rdate, readlink, realpath, reboot, renice, reset,
+               rm, rmdir, rmmod, route, rpm, rpm2cpio, run-parts, sed, setkeycodes,
+               sha1sum, sleep, sort, start-stop-daemon, strings, stty, su, sulogin,
+               swapoff, swapon, sync, syslogd, tail, tar, tee, telnet, telnetd,
+               test, tftp, time, top, touch, tr, traceroute, true, tty, udhcpc,
+               udhcpd, umount, uname, uncompress, uniq, unix2dos, unzip, 
+               uptime, usleep, uudecode, uuencode, vconfig, vi, vlock, watch,
+               watchdog, wc, wget, which, who, whoami, xargs, yes, zcat, [
+
                </para>
        </sect1>
 
 
        </sect1>
 
+       <sect1 id="dpkg-deb">
+           <title>dpkg-deb</title>
+
+               <para>
+               Usage: dpkg-deb [OPTION] archive [directory] 
+               </para>
+
+               <para>
+               Debian package archive (.deb) manipulation tool 
+               </para>
+
+               <para>
+               Options:
+               </para>
+               
+               <para>
+               <screen>
+                       -c      List the contents of the filesystem tree archive portion of the package 
+                       -e      Extracts the control information files from a package archive into the specified directory.
+                               If  no  directory  is specified then a subdirectory DEBIAN in the current directory is used.
+                       -x      Silently extracts the filesystem tree from a package archive into the specified directory.
+                       -X      Extracts the filesystem tree from a package archive into the specified directory, listing the files as it goes. 
+                       If required the specified directory (but not its parents) will be created.
+               </screen>
+               <para>
+
+               <para>
+               Example:
+               </para>
+
+               <para>
+               <screen>
+                       dpkg-deb -e ./busybox_0.48-1_i386.deb
+                       dpkg-deb -x ./busybox_0.48-1_i386.deb ./unpack_dir
+               </screen>
+               </para>
+       </sect1>
+
        <sect1 id="du">
            <title>du</title>
 
 
                <para>
                Summarize the disk space used for each FILE or current
-               directory.  Disk space printed in units of 1k (i.e.
+               directory.  Disk space printed in units of 1k (i.e.,
                1024 bytes).
                </para>
 
                <screen>
                        -follow         Dereference symbolic links
                        -name PATTERN   File name (leading directories removed) matches PATTERN
-                       -print          Print the full file name followed by a newline to stdout
+                       -type X         Filetype matches X (where X is one of: f,d,l,b,c,...)
+                       -perm PERMS     Permissions match any of (+NNN); all of (-NNN); or exactly (NNN)
+                       -mtime TIME     Modified time is greater than (+N); less than (-N); or exactly (N) days
                </screen>
                </para>
 
                <screen>
                        -g      Print only the group ID
                        -u      Print only the user ID
+                       -n      print a name instead of a number (with for -ug)
                        -r      Print the real user ID instead of the effective ID (with -ug)
                </screen>
                </para>
                <sect2>
                    <title>id</title>
                        <para>
-                       WARNING: This field has a non-traditional
-                       meaning for BusyBox init!  The id field is used
-                       by BusyBox init to specify the controlling tty
-                       for the specified process to run on.  The
-                       contents of this field are appended to "/dev/"
-                       and used as-is.  There is no need for this field
-                       to be unique, although if it isn't you may have
-                       strange results.  If this field is left blank,
-                       it is completely ignored.  Also note that if
-                       BusyBox detects that a serial console is in use,
-                       then all entries containing non-empty id fields
-                       will _not_ be run.  BusyBox init does nothing
-                       with utmp.  We don't need no stinkin' utmp.
+
+                       WARNING: This field has a non-traditional meaning for BusyBox init!
+                       The id field is used by BusyBox init to specify the controlling tty
+                       for the specified process to run on.  The contents of this field
+                       are appended to "/dev/" and used as-is.  There is no need for this
+                       field to be unique, although if it isn't you may have strange
+                       results.  If this field is left blank, the controlling tty is set
+                       to the console.  Also note that if BusyBox detects that a serial
+                       console is in use, then only entries whose controlling tty is
+                       either the serial console or /dev/null will be run.  BusyBox init
+                       does nothing with utmp.  We don't need no stinkin' utmp.
+
                        </para>
                </sect2>
 
                        -k      Make module autoclean-able.
                        -v      Verbose output
                        -x      Do not export externs
+                       -L      Prevent simultaneous loads of the same module
                </screen>
                </para>
        </sect1>
                </para>
        </sect1>
 
-       <sect1 id="loadacm">
-           <title>loadacm</title>
-
-               <para>
-               Usage: loadacm
-               </para>
-
-               <para>
-               Load an acm from stdin.
-               </para>
-
-               <para>
-               Example:
-               </para>
-
-               <para>
-               <screen>
-                       $ loadacm &lt; /etc/i18n/acmname
-               </screen>
-               </para>
-       </sect1>
-
        <sect1 id="loadfont">
            <title>loadfont</title>
 
                </para>
 
                <para>
-               Write MESSAGE to the system log.  If MESSAGE is '-', log
+               Write MESSAGE to the system log.  If MESSAGE is omitted, log
                stdin.
                </para>
 
                </para>
        </sect1>
 
+       <sect1 id="logread">
+           <title>logread</title>
+
+               <para>
+               Usage: logread [OPTION]...
+               </para>
+
+               <para>
+               Shows the messages from syslogd (using circular buffer).
+               </para>
+
+               <para>
+               Options:
+               </para>
+
+               <para>
+               <screen>
+                       -f      Output data as the log grows.
+               </screen>
+               </para>
+
+               <para>
+               Example:
+               </para>
+
+               <para>
+               <screen>
+                       $ logread
+               </screen>
+               </para>
+       </sect1>
+
        <sect1 id="ls">
            <title>ls</title>
 
 
                <para>
                Creates a temporary file with its name based on
-               TEMPLATE.  TEMPLATE is any name with six `Xs' (i.e.
+               TEMPLATE.  TEMPLATE is any name with six `Xs' (i.e.,
                /tmp/temp.XXXXXX).
                </para>
 
                </para>
 
                <para>
-               Open a pipe to HOST:PORT.
+                  or: nc -p PORT -l
+               </para>
+
+
+               <para>
+               Open a pipe to HOST:PORT or listen for a connection on PORT.
                </para>
 
                <para>
 
                <para>
                <screen>
+                       -i              Always prompt before removing each destinations
                        -f              Remove existing destinations, never prompt
                        -r or -R        Remove the contents of directories recursively
                </screen>
 
                <para>
                <screen>
-                       -a      Try to remove all unused kernel modules
+                       -a      Remove all unused modules (recursively)
                </screen>
                </para>
 
                </para>
        </sect1>
 
+    <sect1 id="run-parts">
+       <title>run-parts</title>
+       
+               <para>
+               Usage: run-parts [-t] [-a ARG] [-u MASK] DIRECTORY
+               </para>
+       
+               <para>
+               Run a bunch of scripts in a directory.
+               </para>
+       
+               <para>
+               Options:
+               </para>
+       
+               <para>
+               <screen>
+                       -t       Test only. It only print the file to be executed,
+                       without execute them.
+                       -a ARG   Pass ARG as an a argument to the programs executed.
+                       -u MASK  Set the umask to MASK before executing the programs.
+               </screen>
+               </para>
+       </sect1>
+       
+
+       
        <sect1 id="sed">
            <title>sed</title>
 
                        -O FILE Use an alternate log file (default=/var/log/messages)
                        -R HOST[:PORT] Log remotely to IP or hostname on PORT (default PORT=514/UDP)
                        -L      Log locally as well as network logging (default is network only)
+                       -C [size(KiB)] Log to a circular buffer. Read this buffer using 'logread'
                </screen>
                </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)
+                       -f      Force filesystem umount (i.e., unreachable NFS server)
                        -l      Do not free loop device (if a loop device has been used)
                </screen>
                </para>
                </para>
        </sect1>
 
+       <sect1 id="watchdog">
+           <title>watchdog</title>
+
+               <para>
+               Usage: watchdog device
+               </para>
+
+               <para>
+               Periodically writes to watchdog device B<device>.
+               </para>
+       </sect1>
+
        <sect1 id="wc">
            <title>wc</title>
 
     <title>MAINTAINER</title>
 
        <para>
-       Erik Andersen &lt;andersee@debian.org&gt; &lt;andersen@lineo.com&gt;
+       Erik Andersen &lt;andersen@codepoet.org&gt;
        </para>
   </chapter>
 
        </para>
 
        <para>
-       Erik Andersen &lt;andersee@debian.org&gt;
+       Erik Andersen &lt;andersen@codepoet.org&gt;
        </para>
 
        <para>
        </para>
 
        <para>
-       John Beppu &lt;beppu@lineo.com&gt;
+       John Beppu &lt;beppu@codepoet.org&gt;
        </para>
 
        <para>
        </para>
 
         <para>
-        Mark Whitley &lt;markw@lineo.com&gt;
+        Mark Whitley &lt;markw@codepoet.org&gt;
         </para>
 
        <para>
        Enrique Zanardi &lt;ezanardi@ull.es&gt;
        </para>
 
+       <para>
+       Vladimir Oleynik &lt;dzo@simtreas.ru&gt;
+       </para>
+
 
   </chapter>
 </book>    <!-- End of the book -->