aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Beppu <beppu@lbox.org>2000-01-18 22:33:11 +0000
committerJohn Beppu <beppu@lbox.org>2000-01-18 22:33:11 +0000
commit46a4e762439eb519345703311ad314827bcd74c1 (patch)
treef788ea1038c00b14ede24541be5b23b605557cb9
parent3a1b6be7d809ab947967f114b1a52a0e3097b8e7 (diff)
downloadbusybox-46a4e762439eb519345703311ad314827bcd74c1.tar.gz
fleshed out a bit more... just wanted to put the current
changes under version control.
-rw-r--r--docs/busybox.pod159
1 files changed, 156 insertions, 3 deletions
diff --git a/docs/busybox.pod b/docs/busybox.pod
index d189ce577..2116e4622 100644
--- a/docs/busybox.pod
+++ b/docs/busybox.pod
@@ -1,15 +1,160 @@
=head1 NAME
-busybox - I am BusyBox of borg. Unix will be assimilated.
+busybox - I am BusyBox of Borg. Unix will be assimilated.
=head1 SYNOPSIS
-busybox <command> [options...]
+ busybox <function> [arguments...] # or
+
+ <function> [arguments...] # if symlinked
=head1 DESCRIPTION
BusyBox is a multi-call binary that combines many common Unix utilities into
-a single executable. This is a size optimization.
+a single executable. This is a size optimization. Most people will create
+a symlink to busybox for each function name, and BusyBox will act like
+whatever you invoke it as.
+
+=head1 COMMANDS
+
+Currently defined functions:
+busybox, cat, chmod, chown, chgrp, chroot, clear, chvt, cp, date,
+dd, df, dmesg, du, fbset, find, free, deallocvt, fsck.minix, mkfs.minix,
+grep, head, hostname, init, linuxrc, kill, ln, ls, lsmod, mkdir,
+mknod, mkswap, more, mount, mv, ping, poweroff, ps, pwd, reboot,
+rm, rmdir, sed, sleep, sort, sync, syslogd, swapon, swapoff, tail,
+tar, tee, touch, true, false, uname, umount, uniq, update, zcat,
+gunzip, gzip
+
+Oh yes. Unix will be mine.
+
+=over 4
+
+=item busybox
+
+=item cat
+
+=item chmod
+
+=item chown
+
+=item chgrp
+
+=item chroot
+
+=item clear
+
+=item chvt
+
+=item cp
+
+=item date
+
+=item dd
+
+=item df
+
+=item dmesg
+
+=item du
+
+=item fbset
+
+=item find
+
+=item free
+
+=item deallocvt
+
+=item fsck.minix
+
+=item mkfs.minix
+
+=item grep
+
+=item head
+
+=item hostname
+
+=item init
+
+=item linuxrc
+
+=item kill
+
+=item ln
+
+=item ls
+
+=item lsmod
+
+=item mkdir
+
+=item mknod
+
+=item mkswap
+
+=item more
+
+=item mount
+
+=item mv
+
+=item ping
+
+=item poweroff
+
+=item ps
+
+=item pwd
+
+=item reboot
+
+=item rm
+
+=item rmdir
+
+=item sed
+
+=item sleep
+
+=item sort
+
+=item sync
+
+=item syslogd
+
+=item swapon
+
+=item swapoff
+
+=item tail
+
+=item tar
+
+=item tee
+
+=item touch
+
+=item true
+
+=item false
+
+=item uname
+
+=item umount
+
+=item uniq
+
+=item update
+
+=item zcat
+
+=item gunzip
+
+=item gzip
+
+=back
=head1 SEE ALSO
@@ -25,12 +170,20 @@ Erik Andersen <erik@lineo.com>
=item Bruce Perens <perens@technocrat.net>
+The original author.
+
=item Erik Andersen <erik@lineo.com>
+He's thrashed around in the code enough to be considered the maintainer.
+
=item Randolph Chung <rchung@debian.org>
+ping, fbset, mkfifo, etc.
+
=item John Beppu <beppu@lineo.com>
+sort, head, du, uniq, tee.
+
=back
=cut