- constify some read-only members and remove superfluous casts
[oweals/busybox.git] / docs / busybox_header.pod
index c531bad8882494687a1a6e5b890edd41e73f1052..ab1ebd5012126c4a559634b0bcd19e1a44d6cb36 100644 (file)
@@ -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 PREFIX. 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 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 PREFIX.
 
 =head1 USAGE
 
@@ -81,31 +80,3 @@ 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,
-       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 COMMAND DESCRIPTIONS
-
-=over 4
-
-