applyinf fix for:
[people/mcb30/busybox.git] / docs / busybox_header.pod
1 # vi: set sw=4 ts=4:
2
3 =head1 NAME
4
5 BusyBox - The Swiss Army Knife of Embedded Linux
6
7 =head1 SYNTAX
8
9  BusyBox <function> [arguments...]  # or
10
11  <function> [arguments...]          # if symlinked
12
13 =head1 DESCRIPTION
14
15 BusyBox combines tiny versions of many common UNIX utilities into a single
16 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
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
20 much like their GNU counterparts.
21
22 BusyBox has been written with size-optimization and limited resources in mind.
23 It is also extremely modular so you can easily include or exclude commands (or
24 features) at compile time. This makes it easy to customize your embedded
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.
28
29 BusyBox is extremely configurable.  This allows you to include only the
30 components you need, thereby reducing binary size. Run 'make config' or 'make
31 menuconfig' to select the functionality that you wish to enable.  The run
32 'make' to compile BusyBox using your configuration.
33
34 After the compile has finished, you should use 'make install' to install
35 BusyBox.  This will install the '/bin/busybox' binary, and will also create
36 symlinks pointing to the '/bin/busybox' binary for each utility that you
37 compile into BusyBox.  By default, 'make install' will place these symlinks
38 into the './_install' directory, unless you have defined 'PREFIX', thereby
39 specifying some alternative location (i.e., 'make PREFIX=/tmp/foo install').
40 If you wish to install using hardlinks, rather than the default of using
41 symlinks, you can use 'make PREFIX=/tmp/foo install-hardlinks' instead.
42
43 =head1 USAGE
44
45 BusyBox is a multi-call binary.  A multi-call binary is an executable program
46 that performs the same job as more than one utility program.  That means there
47 is just a single BusyBox binary, but that single binary acts like a large
48 number of utilities.  This allows BusyBox to be smaller since all the built-in
49 utility programs (we call them applets) can share code for many common operations.
50
51 You can also invoke BusyBox by issuing a command as an argument on the
52 command line.  For example, entering
53
54         /bin/busybox ls
55
56 will also cause BusyBox to behave as 'ls'.
57
58 Of course, adding '/bin/busybox' into every command would be painful.  So most
59 people will invoke BusyBox using links to the BusyBox binary.
60
61 For example, entering
62
63         ln -s /bin/busybox ls
64         ./ls
65
66 will cause BusyBox to behave as 'ls' (if the 'ls' command has been compiled
67 into BusyBox).  Generally speaking, you should never need to make all these
68 links yourself, as the BusyBox build system will do this for you when you run
69 the 'make install' command.
70
71 If you invoke BusyBox with no arguments, it will provide you with a list of the
72 applets that have been compiled into your BusyBox binary.
73
74 =head1 COMMON OPTIONS
75
76 Most BusyBox commands support the B<--help> argument to provide a terse runtime
77 description of their behavior.  If the CONFIG_FEATURE_VERBOSE_USAGE option has
78 been enabled, more detailed usage information will also be available.
79
80 =head1 COMMANDS
81
82 Currently defined functions include:
83
84         addgroup, adduser, adjtimex, ar, arping, ash, awk, basename, bunzip2,
85         busybox, bzcat, cal, cat, chgrp, chmod, chown, chroot, chvt, clear, cmp,
86         cp, cpio, crond, crontab, cut, date, dc, dd, deallocvt, delgroup, deluser,
87         devfsd, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, dumpkmap,
88         dumpleases, echo, egrep, env, expr, false, fbset, fdflush, fdformat, fdisk,
89         fgrep, find, fold, free, freeramdisk, fsck.minix, ftpget, ftpput, getopt,
90         getty, grep, gunzip, gzip, halt, hdparm, head, hexdump, hostid, hostname,
91         httpd, hush, hwclock, id, ifconfig, ifdown, ifup, inetd, init, insmod,
92         install, ip, ipaddr, ipcalc, ipcrm, ipcs, iplink, iproute, iptunnel, kill, 
93         killall, klogd, lash, last, length, linuxrc, ln, loadfont, loadkmap, 
94         logger, login, logname, logread, losetup, ls, lsmod, makedevs, md5sum, 
95         mesg, mkdir, mkfifo, mkfs.minix, mknod, mkswap, mktemp, modprobe, more, 
96         mount, msh, mt, mv, nameif, nc, netstat, nslookup, od, openvt, passwd, 
97         patch, pidof, ping, ping6, pipe_progress, pivot_root, poweroff, printf, ps,
98         pwd, rdate, readlink, realpath, reboot, renice, reset, rm, rmdir, rmmod, 
99         route, rpm, rpm2cpio, run-parts, rx, sed, seq, setkeycodes, sha1sum, sleep,
100         sort, start-stop-daemon, strings, stty, su, sulogin, swapoff, swapon, sync,
101         sysctl, syslogd, tail, tar, tee, telnet, telnetd, test, tftp, time, top,
102         touch, tr, traceroute, true, tty, udhcpc, udhcpd, umount, uname,
103         uncompress, uniq, unix2dos, unzip, uptime, usleep, uudecode, uuencode,
104         vconfig, vi, vlock, watch, watchdog, wc, wget, which, who, whoami, xargs,
105         yes, zcat
106
107 =head1 COMMAND DESCRIPTIONS
108
109 =over 4
110
111