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