ash: use bbox wrappers for malloc etc instead of homegrown ones

[oweals/busybox.git] / docs / busybox_header.pod

diff --git a/docs/busybox_header.pod b/docs/busybox_header.pod
index 5af92401c7d68d0521202aeb76c06f9e43d1a498..2a99636b1761a0e3357cb04bbcd9352f670a5f06 100644 (file)
--- a/docs/busybox_header.pod
+++ b/docs/busybox_header.pod
@@ -6,9 +6,9 @@ BusyBox - The Swiss Army Knife of Embedded Linux
 
 =head1 SYNTAX
 
- BusyBox <function> [arguments...]  # or
+ busybox <applet> [arguments...]  # or
 
- <function> [arguments...]         # if symlinked
+ <applet> [arguments...]         # if symlinked
 
 =head1 DESCRIPTION
 
@@ -28,17 +28,16 @@ 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' to select the functionality that you wish to enable.  The run
+menuconfig' to select the functionality that you wish to enable.  Then run
 'make' to compile BusyBox using your configuration.
 
 After the compile has finished, you should use 'make install' to install
-BusyBox.  This will install the '/bin/busybox' binary, and will also create
-symlinks pointing to the '/bin/busybox' binary for each utility that you
-compile into BusyBox.  By default, 'make install' will place these symlinks
-into the './_install' directory, unless you have defined 'PREFIX', thereby
-specifying some alternative location (i.e., 'make PREFIX=/tmp/foo install').
-If you wish to install using hardlinks, rather than the default of using
-symlinks, you can use 'make PREFIX=/tmp/foo install-hardlinks' instead.
+BusyBox. This will install the 'bin/busybox' binary, in the target directory
+specified by CONFIG_PREFIX. CONFIG_PREFIX can be set when configuring BusyBox,
+or you can specify an alternative location at install time (i.e., with a
+command line like 'make CONFIG_PREFIX=/tmp/foo install'). If you enabled
+any applet installation scheme (either as symlinks or hardlinks), these will
+also be installed in the location pointed to by CONFIG_PREFIX.
 
 =head1 USAGE
 
@@ -46,7 +45,8 @@ BusyBox is a multi-call binary.  A multi-call binary is an executable program
 that performs the same job as more than one utility program.  That means there
 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.
+utility programs (we call them applets) can share code for many common
+operations.
 
 You can also invoke BusyBox by issuing a command as an argument on the
 command line.  For example, entering
@@ -73,39 +73,11 @@ applets that have been compiled into your BusyBox binary.
 
 =head1 COMMON OPTIONS
 
-Most BusyBox commands support the B<--help> argument to provide a terse runtime
+Most BusyBox applets support the B<--help> argument to provide a terse runtime
 description of their behavior.  If the CONFIG_FEATURE_VERBOSE_USAGE option has
 been enabled, more detailed usage information will also be available.
 
 =head1 COMMANDS
 
-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,
-       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, ipaddr, ipcalc, ipcrm, ipcs, 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 COMMAND DESCRIPTIONS
-
-=over 4
-
+Currently available applets include: