eliminate mixed declaration, to support older compilers a little longer.
[people/mcb30/busybox.git] / README
1 Please see the LICENSE file for details on copying and usage.
2 Please refer to the INSTALL file for instructions on how to build.
3
4 What is busybox:
5
6   BusyBox combines tiny versions of many common UNIX utilities into a single
7   small executable.  It provides minimalist replacements for most of the
8   utilities you usually find in bzip2, coreutils, file, findutils, gawk, grep,
9   inetutils, modutils, net-tools, procps, sed, shadow, sysklogd, sysvinit, tar,
10   util-linux, and vim.  The utilities in BusyBox often have fewer options than
11   their full-featured cousins; however, the options that are included provide
12   the expected functionality and behave very much like their larger
13   counterparts.
14
15   BusyBox has been written with size-optimization and limited resources in
16   mind, both to produce small binaries and to reduce run-time memory usage.
17   Busybox is also extremely modular so you can easily include or exclude
18   commands (or features) at compile time.  This makes it easy to customize
19   embedded systems; to create a working system, just add /dev, /etc, and a
20   Linux kernel.  Busybox (usually together with uClibc) has also been used as
21   a component of "thin client" desktop systems, live-CD distributions, rescue
22   disks, installers, and so on.
23
24   BusyBox provides a fairly complete POSIX environment for any small system,
25   both embedded environments and more full featured systems concerned about
26   space.  Busybox is slowly working towards implementing the full Single Unix
27   Specification V3 (http://www.opengroup.org/onlinepubs/009695399/), but isn't
28   there yet (and for size reasons will probably support at most UTF-8 for
29   internationalization).  We are also interested in passing the Linux Test
30   Project (http://ltp.sourceforge.net).
31
32 ----------------
33
34 Using busybox:
35
36   BusyBox is extremely configurable.  This allows you to include only the
37   components and options you need, thereby reducing binary size.  Run 'make
38   config' or 'make menuconfig' to select the functionality that you wish to
39   enable.  (See 'make help' for more commands.)
40
41   The behavior of busybox is determined by the name it's called under: as
42   "cp" it behaves like cp, as "sed" it behaves like sed, and so on.  Called
43   as "busybox" it takes the second argument as the name of the applet to
44   run (I.E. "./busybox ls -l /proc"). 
45
46   The "standalone shell" mode is an easy way to try out busybox; this is a
47   command shell that calls the builtin applets without needing them to be
48   installed in the path.  (Note that this requires /proc to be mounted, if
49   testing from a boot floppy or in a chroot environment.)
50
51   The build automatically generates a file "busybox.links", which is used by
52   'make install' to create symlinks to the BusyBox binary for all compiled in
53   commands.  Use the PREFIX environment variable to specify where to install
54   the busybox binary and symlink forest.  (i.e., 'make PREFIX=/tmp/foo install',
55   or 'make PREFIX=/tmp/foo install-hardlinks' if you prefer hard links.)
56
57 ----------------
58
59 Downloading the current source code:
60
61   Source for the latest released version, as well as daily snapshots, can always
62   be downloaded from
63
64     http://busybox.net/downloads/
65
66   You can browse the up to the minute source code and change history online.
67   The "stable" series is at:
68
69     http://www.busybox.net/cgi-bin/viewcvs.cgi/branches/busybox_1_00_stable/busybox/
70
71   And the development series is at:
72
73     http://www.busybox.net/cgi-bin/viewcvs.cgi/trunk/busybox/
74
75   Anonymous SVN access is available.  For instructions, check out:
76
77     http://busybox.net/subversion.html
78
79   For those that are actively contributing and would like to check files in,
80   see:
81
82     http://busybox.net/developer.html
83
84   The developers also have a bug and patch tracking system
85   (http://bugs.busybox.net) although posting a bug/patch to the mailing list
86   is generally a faster way of getting it fixed, and the complete archive of
87   what happened is the subversion changelog.
88
89 ----------------
90
91 getting help:
92
93   when you find you need help, you can check out the busybox mailing list
94   archives at http://busybox.net/lists/busybox/ or even join
95   the mailing list if you are interested.
96
97 ----------------
98
99 bugs:
100
101   if you find bugs, please submit a detailed bug report to the busybox mailing
102   list at busybox@busybox.net.  a well-written bug report should include a
103   transcript of a shell session that demonstrates the bad behavior and enables
104   anyone else to duplicate the bug on their own machine. the following is such
105   an example:
106
107     to: busybox@busybox.net
108     from: diligent@testing.linux.org
109     subject: /bin/date doesn't work
110
111     package: busybox
112     version: 1.00
113
114     when i execute busybox 'date' it produces unexpected results.
115     with gnu date i get the following output:
116
117         $ date
118         fri oct  8 14:19:41 mdt 2004
119
120     but when i use busybox date i get this instead:
121
122         $ date
123         illegal instruction
124
125     i am using debian unstable, kernel version 2.4.25-vrs2 on a netwinder,
126     and the latest uclibc from cvs.  thanks for the wonderful program!
127
128         -diligent
129
130   note the careful description and use of examples showing not only what
131   busybox does, but also a counter example showing what an equivalent app
132   does (or pointing to the text of a relevant standard).  Bug reports lacking
133   such detail may never be fixed...  Thanks for understanding.
134
135 ----------------
136
137 Portability:
138
139   Busybox is developed and tested on Linux 2.4 and 2.6 kernels, compiled
140   with gcc (the unit-at-a-time optimizations in version 3.4 and later are
141   worth upgrading to get, but older versions should work), and linked against
142   uClibc (0.9.27 or greater) or glibc (2.2 or greater).  In such an
143   environment, the full set of busybox features should work, and if
144   anything doesn't we want to know about it so we can fix it.
145
146   There are many other environments out there, in which busybox may build
147   and run just fine.  We just don't test them.  Since busybox consists of a
148   large number of more or less independent applets, portability is a question
149   of which features work where.  Some busybox applets (such as cat and rm) are
150   highly portable and likely to work just about anywhere, while others (such as
151   insmod and losetup) require recent Linux kernels with recent C libraries.
152
153   Earlier versions of Linux and glibc may or may not work, for any given
154   configuration.  Linux 2.2 or earlier should mostly work (there's still
155   some support code in things like mount.c) but this is no longer regularly
156   tested, and inherently won't support certain features (such as long files
157   and --bind mounts).  The same is true for glibc 2.0 and 2.1: expect a higher
158   testing and debugging burden using such old infrastructure.  (The busybox
159   developers are not very interested in supporting these older versions, but
160   will probably accept small self-contained patches to fix simple problems.)
161
162   Some environments are not recommended.  Early versions of uClibc were buggy
163   and missing many features: upgrade.  Linking against libc5 or dietlibc is
164   not supported and not interesting to the busybox developers.  (The first is
165   obsolete and has no known size or feature advantages over uClibc, the second
166   has known bugs that its developers have actively refused to fix.)  Ancient
167   Linux kernels (2.0.x and earlier) are similarly uninteresting.
168
169   In theory it's possible to use Busybox under other operating systems (such as
170   MacOS X, Solaris, Cygwin, or the BSD Fork Du Jour).  This generally involves
171   a different kernel and a different C library at the same time.  While it
172   should be possible to port the majority of the code to work in one of
173   these environments, don't be suprised if it doesn't work out of the box.  If
174   you're into that sort of thing, start small (selecting just a few applets)
175   and work your way up.
176
177   Shaun Jackman has recently (2005) ported busybox to a combination of newlib
178   and libgloss, and some of his patches have been integrated.  This platform
179   may join glibc/uclibc and Linux as a supported combination with the 1.1
180   release, but is not supported in 1.0.
181
182 Supported hardware:
183
184   BusyBox in general will build on any architecture supported by gcc.  We
185   support both 32 and 64 bit platforms, and both big and little endian
186   systems.
187
188   Under 2.4 Linux kernels, kernel module loading was implemented in a
189   platform-specific manner.  Busybox's insmod utility has been reported to
190   work under ARM, CRIS, H8/300, x86, ia64, x86_64, m68k, MIPS, PowerPC, S390,
191   SH3/4/5, Sparc, v850e, and x86_64.  Anything else probably won't work.
192
193   The module loading mechanism for the 2.6 kernel is much more generic, and
194   we believe 2.6.x kernel module loading support should work on all
195   architectures supported by the kernel.
196
197 ----------------
198
199 Please feed suggestions, bug reports, insults, and bribes back to the busybox
200 maintainer:
201         Erik Andersen
202         <andersen@codepoet.org>