From 69bd0d1e8926f06ac4a741607f02ae9cd0d16bed Mon Sep 17 00:00:00 2001 From: Eric Andersen Date: Tue, 6 Apr 2004 15:39:20 +0000 Subject: [PATCH] Yet more doc updates --- README | 7 ++-- docs/busybox.net/screenshot.html | 46 ++++++++++++------------ docs/busybox_header.pod | 61 ++++++++++++++++---------------- 3 files changed, 58 insertions(+), 56 deletions(-) diff --git a/README b/README index 631d4c15b..b31036bcc 100644 --- a/README +++ b/README @@ -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 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 provides a fairly complete POSIX -environment for any small or embedded system. +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 /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 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 used by 'make install' to create symlinks to the BusyBox binary for all diff --git a/docs/busybox.net/screenshot.html b/docs/busybox.net/screenshot.html index 1f8e8c81b..7d4f25cf8 100644 --- a/docs/busybox.net/screenshot.html +++ b/docs/busybox.net/screenshot.html @@ -13,7 +13,7 @@ font-family: monospace; font-size: smaller;" width="100"> $ ./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]... or: [function] [arguments]... @@ -25,28 +25,28 @@ Usage: busybox [function] [arguments]... Currently defined functions: - [, addgroup, adduser, adjtimex, ar, arping, ash, awk, basename, - bunzip2, busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot, chvt, - clear, cmp, cp, cpio, crond, crontab, cut, date, dc, dd, deallocvt, - delgroup, deluser, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, - dumpkmap, dumpleases, echo, egrep, env, expr, false, fbset, fdflush, - fdformat, fgrep, find, fold, free, freeramdisk, fsck.minix, ftpget, - ftpput, getopt, getty, grep, gunzip, gzip, halt, head, hexdump, hostid, - hostname, httpd, hush, hwclock, id, ifconfig, ifdown, ifup, inetd, - init, insmod, ip, ipcalc, iplink, iproute, iptunnel, kill, killall, - klogd, lash, last, length, linuxrc, ln, loadfont, loadkmap, logger, - login, logname, logread, losetup, ls, lsmod, makedevs, md5sum, mesg, - minit, mkdir, mkfifo, mkfs.minix, mknod, mkswap, mktemp, modprobe, - more, mount, msh, msvc, mt, mv, nameif, nc, netstat, nslookup, od, - openvt, passwd, patch, pidfilehack, pidof, ping, ping6, pivot_root, - poweroff, printf, ps, pwd, rdate, readlink, realpath, reboot, renice, - reset, rm, rmdir, rmmod, route, rpm, rpm2cpio, run-parts, sed, - setkeycodes, sha1sum, sleep, sort, start-stop-daemon, strings, stty, - su, sulogin, swapoff, swapon, sync, syslogd, tail, tar, tee, telnet, - telnetd, test, tftp, time, top, touch, tr, traceroute, true, tty, - udhcpc, udhcpd, umount, uname, uncompress, uniq, unix2dos, unzip, - update, uptime, usleep, uudecode, uuencode, vconfig, vi, vlock, watch, - watchdog, wc, wget, which, who, whoami, xargs, yes, zcat + [, addgroup, adduser, adjtimex, ar, arping, ash, awk, basename, bunzip2, + busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot, chvt, clear, cmp, + cp, cpio, crond, crontab, cut, date, dc, dd, deallocvt, delgroup, deluser, + devfsd, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, dumpkmap, + dumpleases, echo, egrep, env, expr, false, fbset, fdflush, fdformat, fdisk, + fgrep, find, fold, free, freeramdisk, fsck.minix, ftpget, ftpput, getopt, + getty, grep, gunzip, gzip, halt, hdparm, head, hexdump, hostid, hostname, + httpd, hush, hwclock, id, ifconfig, ifdown, ifup, inetd, init, insmod, + install, ip, ipcalc, iplink, iproute, iptunnel, kill, killall, klogd, lash, + last, length, linuxrc, ln, loadfont, loadkmap, logger, login, logname, + logread, losetup, ls, lsmod, makedevs, md5sum, mesg, mkdir, mkfifo, + mkfs.minix, mknod, mkswap, mktemp, modprobe, more, mount, msh, mt, mv, + nameif, nc, netstat, nslookup, od, openvt, passwd, patch, pidof, ping, + ping6, pipe_progress, pivot_root, poweroff, printf, ps, pwd, rdate, + readlink, realpath, reboot, renice, reset, rm, rmdir, rmmod, route, rpm, + rpm2cpio, run-parts, rx, sed, seq, setkeycodes, sha1sum, sleep, sort, + start-stop-daemon, strings, stty, su, sulogin, swapoff, swapon, sync, + sysctl, syslogd, tail, tar, tee, telnet, telnetd, test, tftp, time, top, + touch, tr, traceroute, true, tty, udhcpc, udhcpd, umount, uname, + uncompress, uniq, unix2dos, unzip, uptime, usleep, uudecode, uuencode, + vconfig, vi, vlock, watch, watchdog, wc, wget, which, who, whoami, xargs, + yes, zcat $ _ diff --git a/docs/busybox_header.pod b/docs/busybox_header.pod index c8ca66693..daf5df4f2 100644 --- a/docs/busybox_header.pod +++ b/docs/busybox_header.pod @@ -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 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 provides a fairly complete POSIX -environment for any small or embedded system. +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 /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 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. 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 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 /bin/busybox ls @@ -81,27 +82,27 @@ been enabled, more detailed usage information will also be available. Currently defined functions include: addgroup, adduser, adjtimex, ar, arping, ash, awk, basename, bunzip2, - busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot, chvt, clear, - cmp, cp, cpio, crond, crontab, cut, date, dc, dd, deallocvt, delgroup, - deluser, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, dumpkmap, - dumpleases, dutmp, echo, egrep, env, expr, false, fbset, fdflush, - fdformat, fgrep, find, fold, free, freeramdisk, fsck.minix, ftpget, - ftpput, getopt, getty, grep, gunzip, gzip, halt, hdparm, head, hexdump, - hostid, hostname, httpd, hush, hwclock, id, ifconfig, ifdown, ifup, - inetd, init, insmod, ip, ipcalc, iplink, iproute, iptunnel, kill, - killall, klogd, lash, length, linuxrc, ln, loadfont, loadkmap, logger, - login, logname, logread, losetup, ls, lsmod, makedevs, md5sum, mesg, - minit, mkdir, mkfifo, mkfs.minix, mknod, mkswap, mktemp, modprobe, - more, mount, msh, msvc, mt, mv, nameif, nc, netstat, nslookup, od, - openvt, passwd, patch, pidfilehack, pidof, ping, ping6, pivot_root, - poweroff, printf, ps, pwd, rdate, readlink, realpath, reboot, renice, - reset, rm, rmdir, rmmod, route, rpm, rpm2cpio, run-parts, sed, - setkeycodes, sha1sum, sleep, sort, start-stop-daemon, strings, stty, - su, sulogin, swapoff, swapon, sync, syslogd, tail, tar, tee, telnet, - telnetd, test, tftp, time, top, touch, tr, traceroute, true, tty, - udhcpc, udhcpd, umount, uname, uncompress, uniq, unix2dos, unzip, - uptime, usleep, uudecode, uuencode, vconfig, vi, vlock, watch, - watchdog, wc, wget, which, who, whoami, xargs, yes, zcat, [ + busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot, chvt, clear, cmp, + cp, cpio, crond, crontab, cut, date, dc, dd, deallocvt, delgroup, deluser, + devfsd, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, dumpkmap, + dumpleases, echo, egrep, env, expr, false, fbset, fdflush, fdformat, fdisk, + fgrep, find, fold, free, freeramdisk, fsck.minix, ftpget, ftpput, getopt, + getty, grep, gunzip, gzip, halt, hdparm, head, hexdump, hostid, hostname, + httpd, hush, hwclock, id, ifconfig, ifdown, ifup, inetd, init, insmod, + install, ip, ipcalc, iplink, iproute, iptunnel, kill, killall, klogd, lash, + last, length, linuxrc, ln, loadfont, loadkmap, logger, login, logname, + logread, losetup, ls, lsmod, makedevs, md5sum, mesg, mkdir, mkfifo, + mkfs.minix, mknod, mkswap, mktemp, modprobe, more, mount, msh, mt, mv, + nameif, nc, netstat, nslookup, od, openvt, passwd, patch, pidof, ping, + ping6, pipe_progress, pivot_root, poweroff, printf, ps, pwd, rdate, + readlink, realpath, reboot, renice, reset, rm, rmdir, rmmod, route, rpm, + rpm2cpio, run-parts, rx, sed, seq, setkeycodes, sha1sum, sleep, sort, + start-stop-daemon, strings, stty, su, sulogin, swapoff, swapon, sync, + sysctl, syslogd, tail, tar, tee, telnet, telnetd, test, tftp, time, top, + touch, tr, traceroute, true, tty, udhcpc, udhcpd, umount, uname, + uncompress, uniq, unix2dos, unzip, uptime, usleep, uudecode, uuencode, + vconfig, vi, vlock, watch, watchdog, wc, wget, which, who, whoami, xargs, + yes, zcat =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 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 -use of NSS. Some applets, such as login and su, will use libc functions that -usually require NSS. +use of NSS. Some applets however, such as login and su, will use libc functions +that require NSS. 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 @@ -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, /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 -addition to making your system significantly smaller, uClibc does not need or -use any NSS support files or libraries. +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 require the +use of any NSS support files or libraries. =over 4