aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README64
1 files changed, 37 insertions, 27 deletions
diff --git a/README b/README
index 503799210..231fddece 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
1Please see the LICENSE file for copyright information. 1Please see the LICENSE file for details on copying and usage.
2 2
3BusyBox combines tiny versions of many common UNIX utilities into a single 3BusyBox combines tiny versions of many common UNIX utilities into a single
4small executable. It provides minimalist replacements for most of the utilities 4small executable. It provides minimalist replacements for most of the utilities
@@ -8,14 +8,14 @@ embedded system. The utilities in BusyBox generally have fewer options than
8their full featured GNU cousins; however, the options that are included provide 8their full featured GNU cousins; however, the options that are included provide
9the expected functionality and behave very much like their GNU counterparts. 9the expected functionality and behave very much like their GNU counterparts.
10 10
11BusyBox was originally written to support the Debian Rescue/Install disks, but
12it also makes an excellent environment for any small or embedded system.
13
11BusyBox has been written with size-optimization and limited resources in mind. 14BusyBox has been written with size-optimization and limited resources in mind.
12It is also extremely modular so you can easily include or exclude commands (or 15It is also extremely modular so you can easily include or exclude commands (or
13features) at compile time. This makes it easy to customize your embedded 16features) at compile time. This makes it easy to customize your embedded
14systems. To create a working system, just add /dev, /etc, and a kernel. 17systems. To create a working system, just add /dev, /etc, and a kernel.
15 18
16BusyBox was originally written to support the Debian Rescue/Install disks, but
17it also makes an excellent environment for any small or embedded system.
18
19As of version 0.20 there is now a version number. : ) Also as of version 0.20, 19As of version 0.20 there is now a version number. : ) Also as of version 0.20,
20BusyBox is now modularized to easily allow you to build only the components you 20BusyBox is now modularized to easily allow you to build only the components you
21need, thereby reducing binary size. Run 'make config' or 'make menuconfig' 21need, thereby reducing binary size. Run 'make config' or 'make menuconfig'
@@ -27,6 +27,9 @@ compiled in functions. By default, 'make install' will place the symlink
27forest into `pwd`/_install unless you have defined the PREFIX environment 27forest into `pwd`/_install unless you have defined the PREFIX environment
28variable (i.e., 'make PREFIX=/tmp/foo install') 28variable (i.e., 'make PREFIX=/tmp/foo install')
29 29
30If you wish to install hardlinks, rather than symlinks, you can use
31'make install-hardlinks' instead.
32
30---------------- 33----------------
31 34
32Supported architectures: 35Supported architectures:
@@ -44,8 +47,11 @@ Supported libcs:
44 47
45Supported kernels: 48Supported kernels:
46 49
47 Full functionality requires Linux 2.0.x, 2.2.x, or 2.4.x. A large fraction 50 Full functionality requires Linux 2.0.x or better. A large fraction of the
48 of the code should run on just about anything. 51 code should run on just about anything. While the current code is fairly
52 Linux specific, it should be fairly easy to port the majority of the code
53 to, say, FreeBSD or Solaris, or MacOsX, or even Windows (if you are into that
54 sortof thing).
49 55
50---------------- 56----------------
51 57
@@ -89,34 +95,38 @@ the mailing list if you are interested.
89 95
90Bugs: 96Bugs:
91 97
92If you find bugs, please submit a bug report. Full instructions on how to 98If you find bugs, please submit a detailed bug report to the busybox mailing
93report a bug are found at http://bugs.busybox.net/Reporting.html. 99list at busybox@busybox.net. A well-written bug report should include a
94 100transcript of a shell session that demonstrates the bad behavior and enables
95For the impatient: To submit a bug, simply send an email describing the problem 101anyone else to duplicate the bug on their own machine. The following is such
96to submit@bugs.busybox.net. Bug reports should look something like this: 102an example:
97 103
98 To: submit@bugs.busybox.net 104 To: busybox@busybox.net
99 From: diligent@testing.linux.org 105 From: diligent@testing.linux.org
100 Subject: /bin/true doesn't work 106 Subject: /bin/date doesn't work
101 107
102 Package: busybox 108 Package: busybox
103 Version: 0.51 109 Version: 1.00
104 110
105 When I invoke '/bin/true' it doesn't work. I expected it to return 111 When I execute Busybox 'date' it produces unexpected results.
106 a "0" but it returned a "1" instead. Here is the transcript: 112 With GNU date I get the following output:
107 $ /bin/true ; echo $? 113
108 1 114 $ date
109 With GNU /bin/true, I get the following output: 115 Wed Mar 21 14:19:41 MST 2001
110 $ /bin/true ; echo $? 116
111 0 117 But when I use BusyBox date I get this instead:
112 I am using Debian 2.2r2, kernel version 2.2.18, and the latest 118
113 uClibc from CVS. Thanks for the wonderful program! 119 $ date
120 llegal instruction
121
122 I am using Debian unstable, kernel version 2.4.19-rmk1 on an Netwinder,
123 and the latest uClibc from CVS. Thanks for the wonderful program!
124
114 -Diligent 125 -Diligent
115 126
116Note the careful description and use of examples showing not only what BusyBox 127Note the careful description and use of examples showing not only what BusyBox
117does, but also a counter example showing what an equivalent GNU app does. Bug 128does, but also a counter example showing what an equivalent GNU app does. Bug
118reports lacking such detail may take a _long_ time to be fixed... Thanks for 129reports lacking such detail may never be fixed... Thanks for understanding.
119understanding.
120 130
121---------------- 131----------------
122 132
@@ -144,5 +154,5 @@ For those that are actively contributing there is even CVS write access:
144Please feed suggestions, bug reports, insults, and bribes back to: 154Please feed suggestions, bug reports, insults, and bribes back to:
145 Erik Andersen 155 Erik Andersen
146 <andersen@codepoet.org> 156 <andersen@codepoet.org>
147 <andersee@debian.org> 157 <andersen@codepoet.org>
148 158