Oops. Forgot these....
[oweals/busybox.git] / docs / busybox.sgml
index 184814125184c2f35c94aa64d439d0a43207b36e..2d372506b190a3ccd2591b3c00e22b87f845c0ac 100644 (file)
 
                <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,
+               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,
 
        </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>
 
                <para>
                <screen>
                        -c      Write output to standard output
+                       -d      decompress
                </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>
 
                <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>
                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>
                        -n      Run as a foreground process
                        -K      Do not start up the klogd process
                        -O FILE Use an alternate log file (default=/var/log/messages)
-                       -R HOST[:PORT] Log messages to HOST on PORT (default=514) over UDP.
-                       -N      Do not log anything locally -- network logging only
+                       -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)
                </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>
                INPUT (or stdin), writing to OUTPUT (or stdout).
                </para>
 
+               <para>
+               Options:
+               </para>
+
+               <para>
+               <screen>
+               -c              prefix lines by the number of occurrences
+               -d              only print duplicate lines
+               -u              only print unique lines
+               </screen>
+               </para>
+
                <para>
                Example:
                </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>