aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README47
1 files changed, 21 insertions, 26 deletions
diff --git a/README b/README
index 14cc845f7..631d4c15b 100644
--- a/README
+++ b/README
@@ -2,44 +2,40 @@ Please 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
5you usually find in fileutils, shellutils, findutils, textutils, grep, gzip, 5you usually find in GNU coreutils, util-linux, etc. The utilities in BusyBox
6tar, etc. BusyBox provides a fairly complete POSIX environment for any small or 6generally have fewer options than their full-featured GNU cousins; however, the
7embedded system. The utilities in BusyBox generally have fewer options than 7options that are included provide the expected functionality and behave very
8their full featured GNU cousins; however, the options that are included provide 8much like their GNU counterparts. BusyBox provides a fairly complete POSIX
9the expected functionality and behave very much like their GNU counterparts. 9environment for any small or embedded system.
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 10
14BusyBox has been written with size-optimization and limited resources in mind. 11BusyBox has been written with size-optimization and limited resources in mind.
15It is also extremely modular so you can easily include or exclude commands (or 12It is also extremely modular so you can easily include or exclude commands (or
16features) at compile time. This makes it easy to customize your embedded 13features) at compile time. This makes it easy to customize your embedded
17systems. To create a working system, just add /dev, /etc, and a kernel. 14systems. To create a working system, just add /dev, /etc, and a Linux kernel.
18 15
19As of version 0.20 there is now a version number. : ) Also as of version 0.20, 16BusyBox is extremely configurable. This allows you to include only the
20BusyBox is now modularized to easily allow you to build only the components you 17components you need, thereby reducing binary size. Run 'make config' or
21need, thereby reducing binary size. Run 'make config' or 'make menuconfig' 18'make menuconfig' for select the functionality that you wish to enable.
22for select the functionality that you wish to enable.
23 19
24After the build is complete, a busybox.links file is generated. This is 20After the build is complete, a busybox.links file is generated. This is
25used by 'make install' to create symlinks to the busybox binary for all 21used by 'make install' to create symlinks to the BusyBox binary for all
26compiled in functions. By default, 'make install' will place the symlink 22compiled in functions. By default, 'make install' will place the symlink
27forest into `pwd`/_install unless you have defined the PREFIX environment 23forest into `pwd`/_install unless you have defined the PREFIX environment
28variable (i.e., 'make PREFIX=/tmp/foo install') 24variable (i.e., 'make PREFIX=/tmp/foo install')
29 25
30If you wish to install hardlinks, rather than symlinks, you can use 26If you wish to install hard links, rather than symlinks, you can use
31'make install-hardlinks' instead. 27'make PREFIX=/tmp/foo install-hardlinks' instead.
32 28
33---------------- 29----------------
34 30
35Supported architectures: 31Supported architectures:
36 32
37 Busybox in general will build on any architecture supported by gcc. It has 33 BusyBox in general will build on any architecture supported by gcc. It has
38 a few specialized features added for __sparc__ and __alpha__. insmod 34 a few specialized features added for __sparc__ and __alpha__. insmod
39 functionality is currently limited to x86, ARM, SH3/4, powerpc, m68k, 35 functionality is currently limited to x86, ARM, SH3/4, powerpc, m68k,
40 MIPS, cris, and v850e. 36 MIPS, cris, and v850e.
41 37
42Supported libcs: 38Supported C Libraries:
43 39
44 glibc-2.0.x, glibc-2.1.x, glibc-2.2.x, glibc-2.3.x, uClibc. People 40 glibc-2.0.x, glibc-2.1.x, glibc-2.2.x, glibc-2.3.x, uClibc. People
45 are looking at newlib and diet-libc, but consider them unsupported, 41 are looking at newlib and diet-libc, but consider them unsupported,
@@ -66,7 +62,7 @@ the mailing list if you are interested.
66 62
67Bugs: 63Bugs:
68 64
69If you find bugs, please submit a detailed bug report to the busybox mailing 65If you find bugs, please submit a detailed bug report to the BusyBox mailing
70list at busybox@mail.busybox.net. A well-written bug report should include a 66list at busybox@mail.busybox.net. A well-written bug report should include a
71transcript of a shell session that demonstrates the bad behavior and enables 67transcript of a shell session that demonstrates the bad behavior and enables
72anyone else to duplicate the bug on their own machine. The following is such 68anyone else to duplicate the bug on their own machine. The following is such
@@ -76,21 +72,21 @@ an example:
76 From: diligent@testing.linux.org 72 From: diligent@testing.linux.org
77 Subject: /bin/date doesn't work 73 Subject: /bin/date doesn't work
78 74
79 Package: busybox 75 Package: BusyBox
80 Version: 1.00 76 Version: 1.00
81 77
82 When I execute Busybox 'date' it produces unexpected results. 78 When I execute BusyBox 'date' it produces unexpected results.
83 With GNU date I get the following output: 79 With GNU date I get the following output:
84 80
85 $ date 81 $ date
86 Wed Mar 21 14:19:41 MST 2001 82 Sat Mar 27 14:19:41 MST 2004
87 83
88 But when I use BusyBox date I get this instead: 84 But when I use BusyBox date I get this instead:
89 85
90 $ date 86 $ date
91 llegal instruction 87 illegal instruction
92 88
93 I am using Debian unstable, kernel version 2.4.19-rmk1 on an Netwinder, 89 I am using Debian unstable, kernel version 2.4.25-vrs2 on a Netwinder,
94 and the latest uClibc from CVS. Thanks for the wonderful program! 90 and the latest uClibc from CVS. Thanks for the wonderful program!
95 91
96 -Diligent 92 -Diligent
@@ -101,7 +97,7 @@ reports lacking such detail may never be fixed... Thanks for understanding.
101 97
102---------------- 98----------------
103 99
104FTP: 100Downloads:
105 101
106Source for the latest released version, as well as daily snapshots, can always 102Source for the latest released version, as well as daily snapshots, can always
107be downloaded from 103be downloaded from
@@ -125,5 +121,4 @@ For those that are actively contributing there is even CVS write access:
125Please feed suggestions, bug reports, insults, and bribes back to: 121Please feed suggestions, bug reports, insults, and bribes back to:
126 Erik Andersen 122 Erik Andersen
127 <andersen@codepoet.org> 123 <andersen@codepoet.org>
128 <andersen@codepoet.org>
129 124