Yet more doc updates

author: Eric Andersen <andersen@codepoet.org> 2004-04-06 15:39:20 +0000
committer: Eric Andersen <andersen@codepoet.org> 2004-04-06 15:39:20 +0000
commit: 69bd0d1e8926f06ac4a741607f02ae9cd0d16bed (patch)
tree: e29766ef81f7be12741d8d5f2a8dc673984c1e9f /docs/busybox_header.pod
parent: f730088bbcb7e0270a590a7161b0f8d8d50386d7 (diff)
download: busybox-w32-69bd0d1e8926f06ac4a741607f02ae9cd0d16bed.tar.gz
busybox-w32-69bd0d1e8926f06ac4a741607f02ae9cd0d16bed.tar.bz2
busybox-w32-69bd0d1e8926f06ac4a741607f02ae9cd0d16bed.zip
1 files changed, 31 insertions, 30 deletions
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
+much like their GNU counterparts.
-environment for any small or embedded system.
 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,
+        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
@@ -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
+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
 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
+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
author	Eric Andersen <andersen@codepoet.org>	2004-04-06 15:39:20 +0000
committer	Eric Andersen <andersen@codepoet.org>	2004-04-06 15:39:20 +0000
commit	69bd0d1e8926f06ac4a741607f02ae9cd0d16bed (patch)
tree	e29766ef81f7be12741d8d5f2a8dc673984c1e9f /docs/busybox_header.pod
parent	f730088bbcb7e0270a590a7161b0f8d8d50386d7 (diff)
download	busybox-w32-69bd0d1e8926f06ac4a741607f02ae9cd0d16bed.tar.gz busybox-w32-69bd0d1e8926f06ac4a741607f02ae9cd0d16bed.tar.bz2 busybox-w32-69bd0d1e8926f06ac4a741607f02ae9cd0d16bed.zip

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