Doug Swarin pointed out a security bug in the -i option of sed.

[oweals/busybox.git] / README

diff --git a/README b/README
index 631d4c15bc931fc2f4afc3f7d3f53b8278a08323..bf2ae6f3f2a11503e93909b59399a8f2fc726f5c 100644 (file)
--- a/README
+++ b/README
@@ -5,17 +5,18 @@ small executable. It provides minimalist replacements for most of the utilities
 you usually find in GNU coreutils, util-linux, etc. The utilities in BusyBox
 generally have fewer options than their full-featured GNU cousins; however, the
 options that are included provide the expected functionality and behave very
-much like their GNU counterparts. BusyBox provides a fairly complete POSIX
-environment for any small or embedded system.
+much like their GNU counterparts.
 
 BusyBox has been written with size-optimization and limited resources in mind.
 It is also extremely modular so you can easily include or exclude commands (or
 features) at compile time. This makes it easy to customize your embedded
 systems. To create a working system, just add /dev, /etc, and a Linux kernel.
+BusyBox provides a fairly complete POSIX environment for any small or embedded
+system.
 
 BusyBox is extremely configurable.  This allows you to include only the
 components you need, thereby reducing binary size. Run 'make config' or
-'make menuconfig' for select the functionality that you wish to enable.
+'make menuconfig' to select the functionality that you wish to enable.
 
 After the build is complete, a busybox.links file is generated.  This is
 used by 'make install' to create symlinks to the BusyBox binary for all
@@ -30,25 +31,27 @@ If you wish to install hard links, rather than symlinks, you can use
 
 Supported architectures:
 
-   BusyBox in general will build on any architecture supported by gcc.  It has
-   a few specialized features added for __sparc__ and __alpha__.  insmod
-   functionality is currently limited to x86, ARM, SH3/4, powerpc, m68k,
-   MIPS, cris, and v850e.
+   BusyBox in general will build on any architecture supported by gcc.
+   Kernel module loading for 2.2 and 2.4 Linux kernels is currently
+   limited to ARM, CRIS, H8/300, x86, ia64, x86_64, m68k, MIPS, PowerPC,
+   S390, SH3/4/5, Sparc, v850e, and x86_64 for 2.4.x kernels.  For 2.6.x
+   kernels, kernel module loading support should work on all architectures.
+
 
 Supported C Libraries:
 
-   glibc-2.0.x, glibc-2.1.x, glibc-2.2.x, glibc-2.3.x, uClibc.  People
-   are looking at newlib and diet-libc, but consider them unsupported,
-   untested, or worse.  Linux-libc5 is no longer supported -- you
-   should probably use uClibc instead if you want a small C library.
+   uClibc and glibc are supported.  People have been looking at newlib and
+   dietlibc, but they are currently considered unsupported, untested, or
+   worse.  Linux-libc5 is no longer supported -- you should probably use uClibc
+   instead if you want a small C library.
 
 Supported kernels:
 
    Full functionality requires Linux 2.2.x or better.  A large fraction of the
    code should run on just about anything.  While the current code is fairly
    Linux specific, it should be fairly easy to port the majority of the code
-   to, say, FreeBSD or Solaris, or MacOsX, or even Windows (if you are into that
-   sortof thing).
+   to support, say, FreeBSD or Solaris, or Mac OS X, or even Windows (if you
+   are into that sort of thing).
 
 ----------------
 
@@ -79,7 +82,7 @@ an example:
     With GNU date I get the following output:
 
        $ date
-       Sat Mar 27 14:19:41 MST 2004
+       Fri Oct  8 14:19:41 MDT 2004
 
     But when I use BusyBox date I get this instead: