README

   1 Please see the LICENSE file for copyright information.
   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 fileutils, shellutils, findutils, textutils, grep, gzip,
   6 tar, etc. BusyBox provides a fairly complete POSIX environment for any small or
   7 embedded system. The utilities in BusyBox generally have fewer options than
   8 their full featured GNU cousins; however, the options that are included provide
   9 the expected functionality and behave very 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 a kernel and an editor (such as
  15 e3 (http://www.sax.de/~adlibiti) or elvis-tiny).
  16
  17 BusyBox was originally written to support the Debian Rescue/Install disks, but
  18 it also makes an excellent environment for any small or embedded system.
  19
  20 As of version 0.20 there is now a version number. : ) Also as of version 0.20,
  21 BusyBox is now modularized to easily allow you to build only the components you
  22 need, thereby reducing binary size. To turn off unwanted BusyBox components,
  23 simply edit the file "Config.h" and comment out the components you do not need
  24 using C++ style (//) comments.
  25
  26 After the build is complete, a busybox.links file is generated.  This is
  27 used by 'make install' to create symlinks to the busybox binary for all
  28 compiled in functions.  By default, 'make install' will place the symlink
  29 forest into `pwd`/_install unless you have defined the PREFIX environment
  30 variable (i.e., make PREFIX="/tmp/foo" install)
  31
  32 ----------------
  33
  34 Supported architectures:
  35
  36    Busybox in general will build on any architecture supported by gcc.  It has
  37    a few specialized features added for __sparc__ and __alpha__.  insmod
  38    functionality is currently limited to x86, ARM, and SH3/4.
  39
  40 Supported libcs:
  41
  42    glibc-2.0.x, glibc-2.1.x, Linux-libc5, uClibc.  People are looking at
  43    newlib and diet-libc, but consider them unsupported, untested, or worse.
  44
  45 Supported kernels:
  46
  47    Full functionality requires Linux 2.0.x, 2.2.x, or 2.4.x.  A large fraction
  48    of the code should run on just about anything.
  49
  50 ----------------
  51
  52 Getting help:
  53
  54 When you find you need help, you can check out the BusyBox mailing list
  55 archives at http://opensource.lineo.com/lists/busybox/ or even join
  56 the mailing list if you are interested.
  57
  58 ----------------
  59
  60 Bugs:
  61
  62 If you find bugs, please submit a bug report.  Full instructions on how to
  63 report a bug are found at http://bugs.lineo.com/Reporting.html.
  64
  65 For the impatient: To submit a bug, simply send an email describing the problem
  66 to submit@bugs.lineo.com.  Bug reports should look something like this:
  67
  68     To: submit@bugs.lineo.com
  69     From: diligent@testing.linux.org
  70     Subject: /bin/true doesn't work
  71
  72     Package: busybox
  73     Version: 0.48
  74
  75     When I invoke '/bin/true' it doesn't work.  I expected it to return
  76     a "0" but it returned a "1" instead.  Here is the transcript:
  77         $ /bin/true ; echo $?
  78         1
  79     With GNU /bin/true, I get the following output:
  80         $ /bin/true ; echo $?
  81         0
  82     I am using Debian 2.2r2, kernel version 2.2.18, and the latest
  83     uClibc from CVS.  Thanks for the wonderful program!
  84         -Diligent
  85
  86 Note the careful description and use of examples showing not only what BusyBox
  87 does, but also a counter example showing what an equivalent GNU app does.  Bug
  88 reports lacking such detail may take a _long_ time to be fixed...  Thanks for
  89 understanding.
  90
  91 ----------------
  92
  93 FTP:
  94
  95 Source for the latest released version can always be downloaded from
  96     ftp://ftp.lineo.com/pub/busybox.
  97
  98 ----------------
  99
 100 CVS:
 101
 102 BusyBox now has its own publicly browsable CVS tree at:
 103     http://opensource.lineo.com/cgi-bin/cvsweb/busybox/
 104
 105 Anonymous CVS access is available.  For instructions, check out:
 106     http://opensource.lineo.com/cvs_anon.html
 107
 108 For those that are actively contributing there is even CVS write access:
 109     http://opensource.lineo.com/cvs_write.html
 110
 111 ----------------
 112
 113 Please feed suggestions, bug reports, insults, and bribes back to:
 114         Erik Andersen
 115         <andersen@lineo.com>
 116         <andersee@debian.org>
 117
 118 <blatant plug>
 119 Many thanks to go to Lineo for paying me to work on busybox.
 120 </blatant plug>
 121