Fix a bug of mine where extracting files to stdout would extract to
[oweals/busybox.git] / docs / busybox.sgml
index f794f896cc66880d7e209ca682f232f659b2296f..b54d68ee58e01a469c842fa177156c92fc60e631 100644 (file)
                </para>
 
                <para>
-               ar, basename, cat, chgrp, chmod, chown, chroot, chvt, clear,
-               cp, cut, date, dc, dd, deallocvt, df, dirname, dmesg, dpkg-deb,
-               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>
 
 
                <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>
 
                </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>
        </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>
                <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>
     <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 -->