- split busybox.pod into a header and footer.

the body will be generated by docs/autodocifier.pl
This commit is contained in:
John Beppu 2001-04-05 19:41:23 +00:00
parent 9a1395b9fd
commit 5bca0afb31
3 changed files with 399 additions and 152 deletions

File diff suppressed because it is too large Load Diff

147
docs/busybox_footer.pod Normal file
View File

@ -0,0 +1,147 @@
=head1 LIBC NSS
GNU Libc uses the Name Service Switch (NSS) to configure the behavior of the C
library for the local environment, and to configure how it reads system data,
such as passwords and group information. BusyBox has made it Policy that it
will never use NSS, and will never use and libc calls that make use of NSS.
This allows you to run an embedded system without the need for installing an
/etc/nsswitch.conf file and without and /lib/libnss_* libraries installed.
If you are using a system that is using a remote LDAP server for authentication
via GNU libc NSS, and you want to use BusyBox, then you will need to adjust the
BusyBox source. Chances are though, that if you have enough space to install
of that stuff on your system, then you probably want the full GNU utilities.
=head1 SEE ALSO
textutils(1), shellutils(1), etc...
=head1 MAINTAINER
Erik Andersen <andersee@debian.org> <andersen@lineo.com>
=head1 AUTHORS
The following people have contributed code to BusyBox whether
they know it or not.
=for html <br>
Erik Andersen <andersen@lineo.com>, <andersee@debian.org>
Tons of new stuff, major rewrite of most of the
core apps, tons of new apps as noted in header files.
=for html <br>
Edward Betts <edward@debian.org>
expr, hostid, logname, tty, wc, whoami, yes
=for html <br>
John Beppu <beppu@lineo.com>
du, head, nslookup, sort, tee, uniq
=for html <br>
Brian Candler <B.Candler@pobox.com>
tiny-ls(ls)
=for html <br>
Randolph Chung <tausq@debian.org>
fbset, ping, hostname, and mkfifo
=for html <br>
Dave Cinege <dcinege@psychosis.com>
more(v2), makedevs, dutmp, modularization, auto links file,
various fixes, Linux Router Project maintenance
=for html <br>
Karl M. Hegbloom <karlheg@debian.org>
cp_mv.c, the test suite, various fixes to utility.c, &c.
=for html <br>
Daniel Jacobowitz <dan@debian.org>
mktemp.c
=for html <br>
Matt Kraai <kraai@alumni.carnegiemellon.edu>
documentation, bugfixes
=for html <br>
John Lombardo <john@deltanet.com>
dirname, tr
=for html <br>
Glenn McGrath <bug1@netconnect.com.au>
ar.c
=for html <br>
Bruce Perens <bruce@pixar.com>
Original author of BusyBox. His code is still in many apps.
=for html <br>
Chip Rosenthal <chip@unicom.com>, <crosenth@covad.com>
wget - Contributed by permission of Covad Communications
=for html <br>
Pavel Roskin <proski@gnu.org>
Lots of bugs fixes and patches.
=for html <br>
Gyepi Sam <gyepi@praxis-sw.com>
Remote logging feature for syslogd
=for html <br>
Linus Torvalds <torvalds@transmeta.com>
mkswap, fsck.minix, mkfs.minix
=for html <br>
Mark Whitley <markw@lineo.com>
sed remix, bug fixes, style-guide, etc.
=for html <br>
Charles P. Wright <cpwright@villagenet.com>
gzip, mini-netcat(nc)
=for html <br>
Enrique Zanardi <ezanardi@ull.es>
tarcat (since removed), loadkmap, various fixes, Debian maintenance
=cut
# $Id: busybox_footer.pod,v 1.1 2001/04/05 19:41:23 beppu Exp $

72
docs/busybox_header.pod Normal file
View File

@ -0,0 +1,72 @@
# vi: set sw=4 ts=4:
=head1 NAME
BusyBox - The Swiss Army Knife of Embedded Linux
=head1 SYNTAX
BusyBox <function> [arguments...] # or
<function> [arguments...] # if symlinked
=head1 DESCRIPTION
BusyBox combines tiny versions of many common UNIX utilities into a single
small executable. It provides minimalist replacements for most of the utilities
you usually find in fileutils, shellutils, findutils, textutils, grep, gzip,
tar, etc. BusyBox provides a fairly complete POSIX environment for any small
or embedded system. The utilities in BusyBox generally have fewer options than
their full-featured GNU cousins; however, the options that are included provide
the expected functionality and behave very much like their GNU counterparts.
BusyBox has been written with size-optimization and limited resources in mind.
It is also extremely modular so you can easily include or exclude commands (or
features) at compile time. This makes it easy to customize your embedded
systems. To create a working system, just add a kernel, a shell (such as ash),
and an editor (such as elvis-tiny or ae).
=head1 USAGE
When you create a link to BusyBox for the function you wish to use, when BusyBox
is called using that link it will behave as if the command itself has been invoked.
For example, entering
ln -s ./BusyBox ls
./ls
will cause BusyBox to behave as 'ls' (if the 'ls' command has been compiled
into BusyBox).
You can also invoke BusyBox by issuing the command as an argument on the
command line. For example, entering
./BusyBox ls
will also cause BusyBox to behave as 'ls'.
=head1 COMMON OPTIONS
Most BusyBox commands support the B<--help> option to provide a
terse runtime description of their behavior.
=head1 COMMANDS
Currently defined functions include:
ar, basename, busybox, cat, chgrp, chmod, chown, chroot, chvt, clear, cmp, cp,
cut, date, dc, dd, deallocvt, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du,
dumpkmap, dutmp, echo, expr, false, fbset, fdflush, find, free, freeramdisk,
fsck.minix, getopt, grep, gunzip, gzip, halt, head, hostid, hostname, id,
ifconfig, init, insmod, kill, killall, klogd, length, ln, loadacm, loadfont,
loadkmap, logger, logname, ls, lsmod, makedevs, md5sum, mkdir, mkfifo,
mkfs.minix, mknod, mkswap, mktemp, more, mount, mt, mv, nc, nslookup, ping,
pivot_root, poweroff, printf, ps, pwd, rdate, readlink, reboot, renice, reset,
rm, rmdir, rmmod, route, rpmunpack, sed, setkeycodes, sh, sleep, sort, stty,
swapoff, swapon, sync, syslogd, tail, tar, tee, telnet, test, tftp, touch, tr,
true, tty, umount, uname, uniq, unix2dos, update, uptime, usleep, uudecode,
uuencode, watchdog, wc, wget, which, whoami, xargs, yes, zcat, [
=over 4