More minor updates to docs (and making apps behave as the docs
[oweals/busybox.git] / docs / busybox.pod
index 144c62719075f9665eef585d0030f6f0bb137716..0a61839e4e5e4bf8ac835b4add6fc34281f74aa3 100644 (file)
@@ -68,7 +68,7 @@ Example:
 
 -------------------------------
 
-=item cat
+=item cat  
 
 Usage: cat [file ...]
 
@@ -86,11 +86,11 @@ Example:
 Usage: chgrp [OPTION]... GROUP FILE...
 
 Change the group membership of each FILE to GROUP.
+
 Options:
 
        -R      change files and directories recursively
+
 Example:
 
        $ ls -l /tmp/foo
@@ -166,7 +166,7 @@ Example:
 Usage: chown [OPTION]...  OWNER[.[GROUP] FILE...
 
 Changes the owner and/or group of each FILE to OWNER and/or GROUP.
+
 Options:
 
        -R      change files and directories recursively
@@ -807,19 +807,37 @@ Example:
 
 =item loadacm
 
-FIXME
+Usage: loadacm
+
+Loads an acm from standard input.
+
+Example:
+
+       $ loadacm < /etc/i18n/acmname
 
 -------------------------------
 
 =item loadfont
 
-FIXME
+Usage: loadfont
+
+Loads a console font from standard input.
+
+Example:
+
+       $ loadfont < /etc/i18n/fontname
 
 -------------------------------
 
 =item loadkmap
 
-FIXME
+Usage: loadkmap
+
+Loads a binary keyboard translation table from standard input.
+
+Example:
+
+       $ loadkmap < /etc/i18n/lang-keymap
 
 -------------------------------
 
@@ -1290,7 +1308,18 @@ Example:
 
 =item sh
 
-FIXME
+Usage: sh
+
+lash -- the BusyBox LAme SHell (command interpreter)
+
+This command does not yet have proper documentation.  
+
+Use lash just as you would use any other shell.  It properly handles pipes,
+redirects, job control, can be used as the shell for scripts (#!/bin/sh), and
+has a sufficient set of builtins to do what is needed.  It does not (yet)
+support Bourne Shell syntax.  If you need things like "if-then-else", "while",
+and such, use ash or bash.  If you just need a very simple and extremely small
+shell, this will do the job.
 
 -------------------------------
 
@@ -1528,12 +1557,7 @@ Example:
 
 =item tr
 
-Usage:  
-
-  tr [-csu] string1 string2
-  tr [-cu] -d string1
-  tr [-cu] -s string1
-  tr [-cu] -ds string1 string2
+Usage:  tr [B<-cdsu>] string1 [string2]
 
 Translate, squeeze, and/or delete characters from standard
 input, writing to standard output.
@@ -1559,67 +1583,162 @@ Example:
 
 =item tty
 
-FIXME
+Usage: tty
+
+Print the file name of the terminal connected to standard input.
+
+Options:
+
+        -s      print nothing, only return an exit status
+
+Example:
+
+       $ tty
+       /dev/tty2
 
 -------------------------------
 
 =item umount
 
-FIXME
+Usage: umount [flags] filesystem|directory
+
+Flags:
+
+        -a:     Unmount all file systems
+        -r:     Try to remount devices as read-only if mount is busy
+        -f:     Do not free loop device (if a loop device has been used)
+
+Example:
+
+       $ umount /dev/hdc1 
 
 -------------------------------
 
 =item uname
 
-FIXME
+Usage: uname [OPTION]...
+
+Print certain system information.  With no OPTION, same as B<-s>.
+
+Options:
+
+        -a      print all information
+        -m      the machine (hardware) type
+        -n      print the machine's network node hostname
+        -r      print the operating system release
+        -s      print the operating system name
+        -p      print the host processor type
+        -v      print the operating system version
+
+Example:
+
+       $ uname -a
+       Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown
 
 -------------------------------
 
 =item uniq
 
-FIXME
+Usage: uniq [OPTION]... [INPUT [OUTPUT]]
+
+Discard all but one of successive identical lines from INPUT
+(or standard input), writing to OUTPUT (or standard output).
+
+Example:
+
+       $ echo -e "a\na\nb\nc\nc\na" | sort | uniq
+       a
+       b
+       c
 
 -------------------------------
 
 =item update
 
-FIXME
+Usage: update [options]
+
+Periodically flushes filesystem buffers.
+
+Options:
+
+        -S      force use of sync(2) instead of flushing
+        -s SECS call sync this often (default 30)
+        -f SECS flush some buffers this often (default 5)
 
 -------------------------------
 
 =item uptime
 
-FIXME
+Usage: uptime
+
+Tells how long the system has been running since boot.
+
+Example:
+
+       $ uptime
+         1:55pm  up  2:30, load average: 0.09, 0.04, 0.00
 
 -------------------------------
 
 =item usleep
 
-FIXME
+Usage: usleep N
+
+Pauses for N microseconds.
+
+Example:
+
+       $ usleep 1000000
+       [pauses for 1 second]
 
 -------------------------------
 
 =item wc
 
-FIXME
+Usage: wc [OPTION]... [FILE]...
+
+Print line, word, and byte counts for each FILE, and a total line if
+more than one FILE is specified.  With no FILE, read standard input.
+
+Options:
+
+        -c      print the byte counts
+        -l      print the newline counts
+        -L      print the length of the longest line
+        -w      print the word counts
+
+Example:
+
+       $ wc /etc/passwd
+            31      46    1365 /etc/passwd
 
 -------------------------------
 
 =item whoami
 
-FIXME
+Usage: whoami
+
+Prints the user name associated with the current effective user id.
+
+Example:
+
+       $ whoami
+       andersen
 
 -------------------------------
 
 =item yes
 
-FIXME
+Usage: yes [OPTION]... [STRING]...
+
+Repeatedly outputs a line with all specified STRING(s), or `y'.
 
 -------------------------------
 
 =item zcat
 
-FIXME
+This is essentially an alias for invoking "gunzip B<-c>", where 
+it decompresses the file inquestion and send the output to stdout. 
 
 -------------------------------
 
@@ -1662,6 +1781,10 @@ Karl M. Hegbloom <karlheg@debian.org>
 
 =for html <br>
 
+John Lombardo <john@deltanet.com>      
+
+=for html <br>
+
 Bruce Perens <bruce@perens.com>
 
 =for html <br>
@@ -1680,4 +1803,4 @@ Enrique Zanardi <ezanardi@ull.es>
 
 =cut
 
-# $Id: busybox.pod,v 1.11 2000/04/16 10:22:28 beppu Exp $
+# $Id: busybox.pod,v 1.17 2000/04/19 03:59:10 erik Exp $