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, /etc, and a kernel.
  15
  16 BusyBox was originally written to support the Debian Rescue/Install disks, but
  17 it also makes an excellent environment for any small or embedded system.
  18
  19 As of version 0.20 there is now a version number. : ) Also as of version 0.20,
  20 BusyBox is now modularized to easily allow you to build only the components you
  21 need, thereby reducing binary size. To turn off unwanted BusyBox components,
  22 simply edit the file "Config.h" and comment out the components you do not need
  23 using C++ style (//) comments.
  24
  25 After the build is complete, a busybox.links file is generated.  This is
  26 used by 'make install' to create symlinks to the busybox binary for all
  27 compiled in functions.  By default, 'make install' will place the symlink
  28 forest into `pwd`/_install unless you have defined the PREFIX environment
  29 variable (i.e., 'make PREFIX=/tmp/foo install')
  30
  31 ----------------
  32
  33 Supported architectures:
  34
  35    Busybox in general will build on any architecture supported by gcc.  It has
  36    a few specialized features added for __sparc__ and __alpha__.  insmod
  37    functionality is currently limited to x86, ARM, SH3/4, powerpc, m68k,
  38    and MIPS.
  39
  40 Supported libcs:
  41
  42    glibc-2.0.x, glibc-2.1.x, glibc-2.2.x, Linux-libc5, uClibc.  People
  43    are looking at newlib and diet-libc, but consider them unsupported,
  44    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 Shells:
  54
  55 lash is the very smallest shell (adds just 10k) and it is quite usable as
  56 a command prompt, but it is not suitable for any but the most trivial
  57 scripting (such as an initrd that calls insmod a few times) since it does
  58 not understand Bourne shell grammer.  It does handle pipes, redirects, and
  59 job control though.  Adding in command editing makes it a very nice
  60 lightweight command prompt.
  61
  62 hush is also quite small (just 18k) and it has very complete Bourne shell
  63 grammer.  It handles if/then/else/fi just fine, but doesn't handle loops
  64 like for/do/done or case/esac and such.  It also currently has a problem
  65 with job control.  Using hush is not yet recommended.
  66
  67 msh: The minix shell (adds just 30k) is quite complete and handles things
  68 like for/do/done, case/esac and all the things you expect a Bourne shell to
  69 do.  It is not always pedantically correct about Bourne shell grammer (try
  70 running the shell testscript "tests/sh.testcases" on it and compare vs bash)
  71 but for most things it works quite well.  It also uses only vfork, so it can
  72 be used on uClinux systems.  This was only recently added, so there is still
  73 room to shrink it further...
  74
  75 ash: This adds about 60k in the default configuration and is the most
  76 complete and most pedantically correct shell included with busybox.  This
  77 shell was also recently added, and several people (mainly Vladimir and Erik)
  78 have been working on it.  There are a number of configurable things at the
  79 top of ash.c as well, so check those out if you want to tweak things.
  80
  81 ----------------
  82
  83 Getting help:
  84
  85 When you find you need help, you can check out the BusyBox mailing list
  86 archives at http://busybox.net/lists/busybox/ or even join
  87 the mailing list if you are interested.
  88
  89 ----------------
  90
  91 Bugs:
  92
  93 If you find bugs, please submit a bug report.  Full instructions on how to
  94 report a bug are found at http://bugs.busybox.net/Reporting.html.
  95
  96 For the impatient: To submit a bug, simply send an email describing the problem
  97 to submit@bugs.busybox.net.  Bug reports should look something like this:
  98
  99     To: submit@bugs.busybox.net
 100     From: diligent@testing.linux.org
 101     Subject: /bin/true doesn't work
 102
 103     Package: busybox
 104     Version: 0.51
 105
 106     When I invoke '/bin/true' it doesn't work.  I expected it to return
 107     a "0" but it returned a "1" instead.  Here is the transcript:
 108         $ /bin/true ; echo $?
 109         1
 110     With GNU /bin/true, I get the following output:
 111         $ /bin/true ; echo $?
 112         0
 113     I am using Debian 2.2r2, kernel version 2.2.18, and the latest
 114     uClibc from CVS.  Thanks for the wonderful program!
 115         -Diligent
 116
 117 Note the careful description and use of examples showing not only what BusyBox
 118 does, but also a counter example showing what an equivalent GNU app does.  Bug
 119 reports lacking such detail may take a _long_ time to be fixed...  Thanks for
 120 understanding.
 121
 122 ----------------
 123
 124 FTP:
 125
 126 Source for the latest released version, as well as daily snapshots, can always
 127 be downloaded from
 128     http://busybox.net/downloads/
 129
 130 ----------------
 131
 132 CVS:
 133
 134 BusyBox now has its own publicly browsable CVS tree at:
 135     http://busybox.net/cgi-bin/cvsweb/busybox/
 136
 137 Anonymous CVS access is available.  For instructions, check out:
 138     http://busybox.net/cvs_anon.html
 139
 140 For those that are actively contributing there is even CVS write access:
 141     http://busybox.net/cvs_write.html
 142
 143 ----------------
 144
 145 Please feed suggestions, bug reports, insults, and bribes back to:
 146         Erik Andersen
 147         <andersen@codepoet.org>
 148         <andersee@debian.org>
 149