emo/busybox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Yet more doc updates

Browse Source
This commit is contained in:
Eric Andersen 2004-04-06 15:39:20 +00:00
parent f730088bbc
commit 69bd0d1e89
3 changed files with 58 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README
View File

@ -5,17 +5,18 @@ small executable. It provides minimalist replacements for most of the utilities
you usually find in GNU coreutils, util-linux, etc. The utilities in BusyBox you usually find in GNU coreutils, util-linux, etc. The utilities in BusyBox
generally have fewer options than their full-featured GNU cousins; however, the generally have fewer options than their full-featured GNU cousins; however, the
options that are included provide the expected functionality and behave very options that are included provide the expected functionality and behave very
much like their GNU counterparts. BusyBox provides a fairly complete POSIX much like their GNU counterparts.
environment for any small or embedded system.
BusyBox has been written with size-optimization and limited resources in mind. 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 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 features) at compile time. This makes it easy to customize your embedded
systems. To create a working system, just add /dev, /etc, and a Linux kernel. systems. To create a working system, just add /dev, /etc, and a Linux kernel.
BusyBox provides a fairly complete POSIX environment for any small or embedded
system.
BusyBox is extremely configurable. This allows you to include only the BusyBox is extremely configurable. This allows you to include only the
components you need, thereby reducing binary size. Run 'make config' or components you need, thereby reducing binary size. Run 'make config' or
'make menuconfig' for select the functionality that you wish to enable. 'make menuconfig' to select the functionality that you wish to enable.
After the build is complete, a busybox.links file is generated. This is After the build is complete, a busybox.links file is generated. This is
used by 'make install' to create symlinks to the BusyBox binary for all used by 'make install' to create symlinks to the BusyBox binary for all

46
docs/busybox.net/screenshot.html
View File

@ -13,7 +13,7 @@ font-family: monospace; font-size: smaller;" width="100">
$ ./busybox $ ./busybox
BusyBox v1.00-pre3 (2003.09.12-05:48+0000) multi-call binary BusyBox v1.00 (2004.04.06-14:56+0000) multi-call binary
Usage: busybox [function] [arguments]... Usage: busybox [function] [arguments]...
or: [function] [arguments]... or: [function] [arguments]...
@ -25,28 +25,28 @@ Usage: busybox [function] [arguments]...
Currently defined functions: Currently defined functions:
[, addgroup, adduser, adjtimex, ar, arping, ash, awk, basename, [, addgroup, adduser, adjtimex, ar, arping, ash, awk, basename, bunzip2,
bunzip2, busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot, chvt, busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot, chvt, clear, cmp,
clear, cmp, cp, cpio, crond, crontab, cut, date, dc, dd, deallocvt, cp, cpio, crond, crontab, cut, date, dc, dd, deallocvt, delgroup, deluser,
delgroup, deluser, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, devfsd, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, dumpkmap,
dumpkmap, dumpleases, echo, egrep, env, expr, false, fbset, fdflush, dumpleases, echo, egrep, env, expr, false, fbset, fdflush, fdformat, fdisk,
fdformat, fgrep, find, fold, free, freeramdisk, fsck.minix, ftpget, fgrep, find, fold, free, freeramdisk, fsck.minix, ftpget, ftpput, getopt,
ftpput, getopt, getty, grep, gunzip, gzip, halt, head, hexdump, hostid, getty, grep, gunzip, gzip, halt, hdparm, head, hexdump, hostid, hostname,
hostname, httpd, hush, hwclock, id, ifconfig, ifdown, ifup, inetd, httpd, hush, hwclock, id, ifconfig, ifdown, ifup, inetd, init, insmod,
init, insmod, ip, ipcalc, iplink, iproute, iptunnel, kill, killall, install, ip, ipcalc, iplink, iproute, iptunnel, kill, killall, klogd, lash,
klogd, lash, last, length, linuxrc, ln, loadfont, loadkmap, logger, last, length, linuxrc, ln, loadfont, loadkmap, logger, login, logname,
login, logname, logread, losetup, ls, lsmod, makedevs, md5sum, mesg, logread, losetup, ls, lsmod, makedevs, md5sum, mesg, mkdir, mkfifo,
minit, mkdir, mkfifo, mkfs.minix, mknod, mkswap, mktemp, modprobe, mkfs.minix, mknod, mkswap, mktemp, modprobe, more, mount, msh, mt, mv,
more, mount, msh, msvc, mt, mv, nameif, nc, netstat, nslookup, od, nameif, nc, netstat, nslookup, od, openvt, passwd, patch, pidof, ping,
openvt, passwd, patch, pidfilehack, pidof, ping, ping6, pivot_root, ping6, pipe_progress, pivot_root, poweroff, printf, ps, pwd, rdate,
poweroff, printf, ps, pwd, rdate, readlink, realpath, reboot, renice, readlink, realpath, reboot, renice, reset, rm, rmdir, rmmod, route, rpm,
reset, rm, rmdir, rmmod, route, rpm, rpm2cpio, run-parts, sed, rpm2cpio, run-parts, rx, sed, seq, setkeycodes, sha1sum, sleep, sort,
setkeycodes, sha1sum, sleep, sort, start-stop-daemon, strings, stty, start-stop-daemon, strings, stty, su, sulogin, swapoff, swapon, sync,
su, sulogin, swapoff, swapon, sync, syslogd, tail, tar, tee, telnet, sysctl, syslogd, tail, tar, tee, telnet, telnetd, test, tftp, time, top,
telnetd, test, tftp, time, top, touch, tr, traceroute, true, tty, touch, tr, traceroute, true, tty, udhcpc, udhcpd, umount, uname,
udhcpc, udhcpd, umount, uname, uncompress, uniq, unix2dos, unzip, uncompress, uniq, unix2dos, unzip, uptime, usleep, uudecode, uuencode,
update, uptime, usleep, uudecode, uuencode, vconfig, vi, vlock, watch, vconfig, vi, vlock, watch, watchdog, wc, wget, which, who, whoami, xargs,
watchdog, wc, wget, which, who, whoami, xargs, yes, zcat yes, zcat
$ <blink>_</blink> $ <blink>_</blink>

61
docs/busybox_header.pod
View File

@ -17,17 +17,18 @@ small executable. It provides minimalist replacements for most of the utilities
you usually find in GNU coreutils, util-linux, etc. The utilities in BusyBox you usually find in GNU coreutils, util-linux, etc. The utilities in BusyBox
generally have fewer options than their full-featured GNU cousins; however, the generally have fewer options than their full-featured GNU cousins; however, the
options that are included provide the expected functionality and behave very options that are included provide the expected functionality and behave very
much like their GNU counterparts. BusyBox provides a fairly complete POSIX much like their GNU counterparts.
environment for any small or embedded system.
BusyBox has been written with size-optimization and limited resources in mind. 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 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 features) at compile time. This makes it easy to customize your embedded
systems. To create a working system, just add /dev, /etc, and a Linux kernel. systems. To create a working system, just add /dev, /etc, and a Linux kernel.
BusyBox provides a fairly complete POSIX environment for any small or embedded
system.
BusyBox is extremely configurable. This allows you to include only the BusyBox is extremely configurable. This allows you to include only the
components you need, thereby reducing binary size. Run 'make config' or 'make components you need, thereby reducing binary size. Run 'make config' or 'make
menuconfig' for select the functionality that you wish to enable. The run menuconfig' to select the functionality that you wish to enable. The run
'make' to compile BusyBox using your configuration. 'make' to compile BusyBox using your configuration.
After the compile has finished, you should use 'make install' to install After the compile has finished, you should use 'make install' to install
@ -47,7 +48,7 @@ is just a single BusyBox binary, but that single binary acts like a large
number of utilities. This allows BusyBox to be smaller since all the built-in number of utilities. This allows BusyBox to be smaller since all the built-in
utility programs (we call them applets) can share code for many common operations. utility programs (we call them applets) can share code for many common operations.
You can also invoke BusyBox by issuing the command as an argument on the You can also invoke BusyBox by issuing a command as an argument on the
command line. For example, entering command line. For example, entering
/bin/busybox ls /bin/busybox ls
@ -81,27 +82,27 @@ been enabled, more detailed usage information will also be available.
Currently defined functions include: Currently defined functions include:
addgroup, adduser, adjtimex, ar, arping, ash, awk, basename, bunzip2, addgroup, adduser, adjtimex, ar, arping, ash, awk, basename, bunzip2,
busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot, chvt, clear, busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot, chvt, clear, cmp,
cmp, cp, cpio, crond, crontab, cut, date, dc, dd, deallocvt, delgroup, cp, cpio, crond, crontab, cut, date, dc, dd, deallocvt, delgroup, deluser,
deluser, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, dumpkmap, devfsd, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, dumpkmap,
dumpleases, dutmp, echo, egrep, env, expr, false, fbset, fdflush, dumpleases, echo, egrep, env, expr, false, fbset, fdflush, fdformat, fdisk,
fdformat, fgrep, find, fold, free, freeramdisk, fsck.minix, ftpget, fgrep, find, fold, free, freeramdisk, fsck.minix, ftpget, ftpput, getopt,
ftpput, getopt, getty, grep, gunzip, gzip, halt, hdparm, head, hexdump, getty, grep, gunzip, gzip, halt, hdparm, head, hexdump, hostid, hostname,
hostid, hostname, httpd, hush, hwclock, id, ifconfig, ifdown, ifup, httpd, hush, hwclock, id, ifconfig, ifdown, ifup, inetd, init, insmod,
inetd, init, insmod, ip, ipcalc, iplink, iproute, iptunnel, kill, install, ip, ipcalc, iplink, iproute, iptunnel, kill, killall, klogd, lash,
killall, klogd, lash, length, linuxrc, ln, loadfont, loadkmap, logger, last, length, linuxrc, ln, loadfont, loadkmap, logger, login, logname,
login, logname, logread, losetup, ls, lsmod, makedevs, md5sum, mesg, logread, losetup, ls, lsmod, makedevs, md5sum, mesg, mkdir, mkfifo,
minit, mkdir, mkfifo, mkfs.minix, mknod, mkswap, mktemp, modprobe, mkfs.minix, mknod, mkswap, mktemp, modprobe, more, mount, msh, mt, mv,
more, mount, msh, msvc, mt, mv, nameif, nc, netstat, nslookup, od, nameif, nc, netstat, nslookup, od, openvt, passwd, patch, pidof, ping,
openvt, passwd, patch, pidfilehack, pidof, ping, ping6, pivot_root, ping6, pipe_progress, pivot_root, poweroff, printf, ps, pwd, rdate,
poweroff, printf, ps, pwd, rdate, readlink, realpath, reboot, renice, readlink, realpath, reboot, renice, reset, rm, rmdir, rmmod, route, rpm,
reset, rm, rmdir, rmmod, route, rpm, rpm2cpio, run-parts, sed, rpm2cpio, run-parts, rx, sed, seq, setkeycodes, sha1sum, sleep, sort,
setkeycodes, sha1sum, sleep, sort, start-stop-daemon, strings, stty, start-stop-daemon, strings, stty, su, sulogin, swapoff, swapon, sync,
su, sulogin, swapoff, swapon, sync, syslogd, tail, tar, tee, telnet, sysctl, syslogd, tail, tar, tee, telnet, telnetd, test, tftp, time, top,
telnetd, test, tftp, time, top, touch, tr, traceroute, true, tty, touch, tr, traceroute, true, tty, udhcpc, udhcpd, umount, uname,
udhcpc, udhcpd, umount, uname, uncompress, uniq, unix2dos, unzip, uncompress, uniq, unix2dos, unzip, uptime, usleep, uudecode, uuencode,
uptime, usleep, uudecode, uuencode, vconfig, vi, vlock, watch, vconfig, vi, vlock, watch, watchdog, wc, wget, which, who, whoami, xargs,
watchdog, wc, wget, which, who, whoami, xargs, yes, zcat, [ yes, zcat
=head1 LIBC NSS =head1 LIBC NSS
@ -110,8 +111,8 @@ of the C library for the local environment, and to configure how it reads
system data, such as passwords and group information. This is implemented system data, such as passwords and group information. This is implemented
using an /etc/nsswitch.conf configuration file, and using one or more of the using an /etc/nsswitch.conf configuration file, and using one or more of the
/lib/libnss_* libraries. BusyBox tries to avoid using any libc calls that make /lib/libnss_* libraries. BusyBox tries to avoid using any libc calls that make
use of NSS. Some applets, such as login and su, will use libc functions that use of NSS. Some applets however, such as login and su, will use libc functions
usually require NSS. that require NSS.
If you enable CONFIG_USE_BB_PWD_GRP, BusyBox will use internal functions to If you enable CONFIG_USE_BB_PWD_GRP, BusyBox will use internal functions to
directly access the /etc/passwd, /etc/group, and /etc/shadow files without directly access the /etc/passwd, /etc/group, and /etc/shadow files without
@ -122,9 +123,9 @@ When used with glibc, the BusyBox 'networking' applets will similarly require
that you install at least some of the glibc NSS stuff (in particular, that you install at least some of the glibc NSS stuff (in particular,
/etc/nsswitch.conf, /lib/libnss_dns*, /lib/libnss_files*, and /lib/libresolv*). /etc/nsswitch.conf, /lib/libnss_dns*, /lib/libnss_files*, and /lib/libresolv*).
Shameless Plug: As an alternative one could use a C library such as uClibc. In Shameless Plug: As an alternative, one could use a C library such as uClibc. In
addition to making your system significantly smaller, uClibc does not need or addition to making your system significantly smaller, uClibc does not require the
use any NSS support files or libraries. use of any NSS support files or libraries.
=over 4 =over 4