4f806a0bff883abea3b34bbbfc3d933c17ddce17
[people/mcb30/busybox.git] / README
1 Please see the LICENSE file for copyright information.
2     
3 BusyBox combines tiny versions of many common UNIX utilities into a single
4 small executable. It provides minimalist replacements for most of the utilities
5 you usually find in fileutils, shellutils, findutils, textutils, grep, gzip,
6 tar, etc. BusyBox provides a fairly complete POSIX environment for any small or
7 embedded system. The utilities in BusyBox generally have fewer options than
8 their full featured GNU cousins; however, the options that are included provide
9 the expected functionality and behave very much like their GNU counterparts.
10
11 BusyBox has been written with size-optimization and limited resources in mind.
12 It is also extremely modular so you can easily include or exclude commands (or
13 features) at compile time. This makes it easy to customize your embedded
14 systems. To create a working system, just add /dev, a shell, and a kernel.  For
15 a really minimal system, you can even use the busybox shell (not Bourne
16 compatible, but very small and quite usable) and the busybox vi editor.
17
18 BusyBox was originally written to support the Debian Rescue/Install disks, but
19 it also makes an excellent environment for any small or embedded system.
20
21 As of version 0.20 there is now a version number. : ) Also as of version 0.20,
22 BusyBox is now modularized to easily allow you to build only the components you
23 need, thereby reducing binary size. To turn off unwanted BusyBox components,
24 simply edit the file "Config.h" and comment out the components you do not need
25 using C++ style (//) comments.
26
27 After the build is complete, a busybox.links file is generated.  This is
28 used by 'make install' to create symlinks to the busybox binary for all
29 compiled in functions.  By default, 'make install' will place the symlink
30 forest into `pwd`/_install unless you have defined the PREFIX environment
31 variable (i.e., 'make PREFIX=/tmp/foo install')
32
33 ----------------
34     
35 Supported architectures:
36
37    Busybox in general will build on any architecture supported by gcc.  It has
38    a few specialized features added for __sparc__ and __alpha__.  insmod
39    functionality is currently limited to x86, ARM, SH3/4, powerpc, m68k, 
40    and MIPS.
41
42 Supported libcs:
43
44    glibc-2.0.x, glibc-2.1.x, Linux-libc5, uClibc.  People are looking at
45    newlib and diet-libc, but consider them unsupported, untested, or worse.
46
47 Supported kernels:
48
49    Full functionality requires Linux 2.0.x, 2.2.x, or 2.4.x.  A large fraction
50    of the code should run on just about anything.
51
52 ----------------
53
54 Shells:
55
56 lash is the very smallest shell (adds just 10k) and it is quite usable as 
57 a command prompt, but it is not suitable for any but the most trivial
58 scripting (such as an initrd that calls insmod a few times) since it does
59 not understand Bourne shell grammer.  It does handle pipes, redirects, and
60 job control though.  Adding in command editing makes it very nice
61 lightweight command prompt.
62
63 hush is also quite small (just 18k) and it has very complete Bourne shell
64 grammer.  It handles if/then/else/fi just fine, but doesn't handle loops
65 like for/do/done or case/esac and such.  It also currently has a problem
66 with job control.
67
68 msh: The minix shell (adds just 30k) is quite complete and handles things
69 like for/do/done, case/esac and all the things you expect a Bourne shell to
70 do.  It is not always pedantically correct about Bourne shell grammer (try
71 running the shell testscript "tests/sh.testcases" on it and compare vs bash)
72 but for most things it works quite well.  It also uses only vfork, so it can
73 be used on uClinux systems.  This was only recently added, so there is still
74 room to shrink it further...
75
76 ash: This adds about 60k in the default configuration and is the most
77 complete and most pedantically correct shell included with busybox.  This
78 shell was also recently added, and several people (mainly Vladimir and Erik)
79 have been working on it.  There are a number of configurable things at the
80 top of ash.c as well, so check those out if you want to tweak things.  The
81 Posix math support is currently disabled (that bit of code was horrible) but
82 will be restored for the next BusyBox release.
83
84 ----------------
85
86 Getting help:
87
88 When you find you need help, you can check out the BusyBox mailing list
89 archives at http://opensource.lineo.com/lists/busybox/ or even join
90 the mailing list if you are interested.
91
92 ----------------
93
94 Bugs:
95
96 If you find bugs, please submit a bug report.  Full instructions on how to
97 report a bug are found at http://bugs.lineo.com/Reporting.html.
98
99 For the impatient: To submit a bug, simply send an email describing the problem
100 to submit@bugs.lineo.com.  Bug reports should look something like this:
101
102     To: submit@bugs.lineo.com
103     From: diligent@testing.linux.org
104     Subject: /bin/true doesn't work
105
106     Package: busybox
107     Version: 0.51
108
109     When I invoke '/bin/true' it doesn't work.  I expected it to return 
110     a "0" but it returned a "1" instead.  Here is the transcript:
111         $ /bin/true ; echo $?
112         1
113     With GNU /bin/true, I get the following output:
114         $ /bin/true ; echo $?
115         0
116     I am using Debian 2.2r2, kernel version 2.2.18, and the latest
117     uClibc from CVS.  Thanks for the wonderful program!
118         -Diligent
119
120 Note the careful description and use of examples showing not only what BusyBox
121 does, but also a counter example showing what an equivalent GNU app does.  Bug
122 reports lacking such detail may take a _long_ time to be fixed...  Thanks for
123 understanding.
124
125 ----------------
126
127 FTP:
128
129 Source for the latest released version can always be downloaded from 
130     ftp://ftp.lineo.com/pub/busybox. 
131
132 ----------------
133
134 CVS:
135
136 BusyBox now has its own publicly browsable CVS tree at:
137     http://opensource.lineo.com/cgi-bin/cvsweb/busybox/
138
139 Anonymous CVS access is available.  For instructions, check out:
140     http://opensource.lineo.com/cvs_anon.html
141
142 For those that are actively contributing there is even CVS write access:
143     http://opensource.lineo.com/cvs_write.html
144
145 ----------------
146
147 Please feed suggestions, bug reports, insults, and bribes back to:
148         Erik Andersen 
149         <andersen@lineo.com>
150         <andersee@debian.org>
151         <andersee@codepoet.org>
152
153 <blatant plug>
154 Many thanks to go to Lineo for paying me to work on busybox. 
155 </blatant plug>
156