README

   1 Please see the LICENSE file for details on copying and usage.
   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 GNU coreutils, util-linux, etc. The utilities in BusyBox
   6 generally have fewer options than their full-featured GNU cousins; however, the
   7 options that are included provide the expected functionality and behave very
   8 much like their GNU counterparts.
   9
  10 BusyBox has been written with size-optimization and limited resources in mind.
  11 It is also extremely modular so you can easily include or exclude commands (or
  12 features) at compile time. This makes it easy to customize your embedded
  13 systems. To create a working system, just add /dev, /etc, and a Linux kernel.
  14 BusyBox provides a fairly complete POSIX environment for any small or embedded
  15 system.
  16
  17 BusyBox is extremely configurable.  This allows you to include only the
  18 components you need, thereby reducing binary size. Run 'make config' or
  19 'make menuconfig' to select the functionality that you wish to enable.
  20
  21 After the build is complete, a busybox.links file is generated.  This is
  22 used by 'make install' to create symlinks to the BusyBox binary for all
  23 compiled in functions.  By default, 'make install' will place the symlink
  24 forest into `pwd`/_install unless you have defined the PREFIX environment
  25 variable (i.e., 'make PREFIX=/tmp/foo install')
  26
  27 If you wish to install hard links, rather than symlinks, you can use
  28 'make PREFIX=/tmp/foo install-hardlinks' instead.
  29
  30 ----------------
  31
  32 Supported architectures:
  33
  34    BusyBox in general will build on any architecture supported by gcc.  It has
  35    a few specialized features added for __sparc__ and __alpha__.  insmod
  36    functionality is currently limited to x86, ARM, SH3/4, powerpc, m68k,
  37    MIPS, cris, and v850e.
  38
  39 Supported C Libraries:
  40
  41    glibc-2.0.x, glibc-2.1.x, glibc-2.2.x, glibc-2.3.x, uClibc.  People
  42    are looking at newlib and diet-libc, but consider them unsupported,
  43    untested, or worse.  Linux-libc5 is no longer supported -- you
  44    should probably use uClibc instead if you want a small C library.
  45
  46 Supported kernels:
  47
  48    Full functionality requires Linux 2.2.x or better.  A large fraction of the
  49    code should run on just about anything.  While the current code is fairly
  50    Linux specific, it should be fairly easy to port the majority of the code
  51    to, say, FreeBSD or Solaris, or MacOsX, or even Windows (if you are into that
  52    sortof thing).
  53
  54 ----------------
  55
  56 Getting help:
  57
  58 When you find you need help, you can check out the BusyBox mailing list
  59 archives at http://busybox.net/lists/busybox/ or even join
  60 the mailing list if you are interested.
  61
  62 ----------------
  63
  64 Bugs:
  65
  66 If you find bugs, please submit a detailed bug report to the BusyBox mailing
  67 list at busybox@mail.busybox.net.  A well-written bug report should include a
  68 transcript of a shell session that demonstrates the bad behavior and enables
  69 anyone else to duplicate the bug on their own machine. The following is such
  70 an example:
  71
  72     To: busybox@mail.busybox.net
  73     From: diligent@testing.linux.org
  74     Subject: /bin/date doesn't work
  75
  76     Package: BusyBox
  77     Version: 1.00
  78
  79     When I execute BusyBox 'date' it produces unexpected results.
  80     With GNU date I get the following output:
  81
  82         $ date
  83         Sat Mar 27 14:19:41 MST 2004
  84
  85     But when I use BusyBox date I get this instead:
  86
  87         $ date
  88         illegal instruction
  89
  90     I am using Debian unstable, kernel version 2.4.25-vrs2 on a Netwinder,
  91     and the latest uClibc from CVS.  Thanks for the wonderful program!
  92
  93         -Diligent
  94
  95 Note the careful description and use of examples showing not only what BusyBox
  96 does, but also a counter example showing what an equivalent GNU app does.  Bug
  97 reports lacking such detail may never be fixed...  Thanks for understanding.
  98
  99 ----------------
 100
 101 Downloads:
 102
 103 Source for the latest released version, as well as daily snapshots, can always
 104 be downloaded from
 105     http://busybox.net/downloads/
 106
 107 ----------------
 108
 109 CVS:
 110
 111 BusyBox now has its own publicly browsable CVS tree at:
 112     http://busybox.net/cgi-bin/cvsweb/busybox/
 113
 114 Anonymous CVS access is available.  For instructions, check out:
 115     http://busybox.net/cvs_anon.html
 116
 117 For those that are actively contributing there is even CVS write access:
 118     http://busybox.net/cvs_write.html
 119
 120 ----------------
 121
 122 Please feed suggestions, bug reports, insults, and bribes back to:
 123         Erik Andersen
 124         <andersen@codepoet.org>
 125