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 BusyBox combines tiny versions of many common UNIX utilities into a single
   5 small executable. It provides minimalist replacements for most of the utilities
   6 you usually find in GNU coreutils, util-linux, etc. The utilities in BusyBox
   7 generally have fewer options than their full-featured GNU cousins; however, the
   8 options that are included provide the expected functionality and behave very
   9 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, /etc, and a Linux kernel.
  15 BusyBox provides a fairly complete POSIX environment for any small or embedded
  16 system.
  17
  18 BusyBox is extremely configurable.  This allows you to include only the
  19 components you need, thereby reducing binary size. See the file INSTALL
  20 for details.
  21
  22 ----------------
  23
  24 Supported architectures:
  25
  26    BusyBox in general will build on any architecture supported by gcc.
  27    Kernel module loading for 2.2 and 2.4 Linux kernels is currently
  28    limited to ARM, CRIS, H8/300, x86, ia64, x86_64, m68k, MIPS, PowerPC,
  29    S390, SH3/4/5, Sparc, v850e, and x86_64 for 2.4.x kernels.  For 2.6.x
  30    kernels, kernel module loading support should work on all architectures.
  31
  32
  33 Supported C Libraries:
  34
  35    uClibc and glibc are supported.  People have been looking at newlib and
  36    dietlibc, but they are currently considered unsupported, untested, or
  37    worse.  Linux-libc5 is no longer supported -- you should probably use uClibc
  38    instead if you want a small C library.
  39
  40 Supported kernels:
  41
  42    Full functionality requires Linux 2.2.x or better.  A large fraction of the
  43    code should run on just about anything.  While the current code is fairly
  44    Linux specific, it should be fairly easy to port the majority of the code
  45    to support, say, FreeBSD or Solaris, or Mac OS X, or even Windows (if you
  46    are into that sort of thing).
  47
  48 ----------------
  49
  50 Getting help:
  51
  52 When you find you need help, you can check out the BusyBox mailing list
  53 archives at http://busybox.net/lists/busybox/ or even join
  54 the mailing list if you are interested.
  55
  56 ----------------
  57
  58 Bugs:
  59
  60 If you find bugs, please submit a detailed bug report to the BusyBox mailing
  61 list at busybox@mail.busybox.net.  A well-written bug report should include a
  62 transcript of a shell session that demonstrates the bad behavior and enables
  63 anyone else to duplicate the bug on their own machine. The following is such
  64 an example:
  65
  66     To: busybox@mail.busybox.net
  67     From: diligent@testing.linux.org
  68     Subject: /bin/date doesn't work
  69
  70     Package: BusyBox
  71     Version: 1.00
  72
  73     When I execute BusyBox 'date' it produces unexpected results.
  74     With GNU date I get the following output:
  75
  76         $ date
  77         Fri Oct  8 14:19:41 MDT 2004
  78
  79     But when I use BusyBox date I get this instead:
  80
  81         $ date
  82         illegal instruction
  83
  84     I am using Debian unstable, kernel version 2.4.25-vrs2 on a Netwinder,
  85     and the latest uClibc from CVS.  Thanks for the wonderful program!
  86
  87         -Diligent
  88
  89 Note the careful description and use of examples showing not only what BusyBox
  90 does, but also a counter example showing what an equivalent GNU app does.  Bug
  91 reports lacking such detail may never be fixed...  Thanks for understanding.
  92
  93 ----------------
  94
  95 Downloads:
  96
  97 Source for the latest released version, as well as daily snapshots, can always
  98 be downloaded from
  99     http://busybox.net/downloads/
 100
 101 ----------------
 102
 103 CVS:
 104
 105 BusyBox now has its own publicly browsable SVN tree at:
 106     http://busybox.net/cgi-bin/viewcvs.cgi/trunk/busybox/
 107
 108 Anonymous SVN access is available.  For instructions, check out:
 109     http://busybox.net/subversion.html
 110
 111 For those that are actively contributing there is even SVN write access:
 112     http://busybox.net/developer.html
 113
 114 ----------------
 115
 116 Please feed suggestions, bug reports, insults, and bribes back to:
 117         Erik Andersen
 118         <andersen@codepoet.org>
 119