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, a shell (such as ash),
  15 and an editor (such as elvis-tiny or ae).
  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 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
  24 need 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 Getting help:
  34 When you find you need help, you can check out the BusyBox mailing list
  35 archives at http://opensource.lineo.com/lists/busybox/ or even join
  36 the mailing list if you are interested.
  37
  38 ----------------
  39 Bugs:
  40 If you find bugs, follow the instructions at http://bugs.lineo.com/Reporting.html
  41 and submit a bug report.  This way, we can be sure nothing falls through the
  42 cracks...
  43
  44 ----------------
  45 FTP:
  46 Source for the latest released version can always be downloaded from
  47     ftp://ftp.lineo.com/pub/busybox.
  48
  49 ----------------
  50 CVS:
  51 BusyBox now has its own publicly browsable CVS tree at:
  52     http://opensource.lineo.com/cgi-bin/cvsweb/busybox/
  53
  54 Anonymous CVS access is available.  For instructions, check out:
  55     http://opensource.lineo.com/cvs_anon.html
  56
  57 For those that are actively contributing there is even CVS write access:
  58     http://opensource.lineo.com/cvs_write.html
  59
  60
  61 ----------------
  62
  63 Please feed suggestions, bug reports, insults, and bribes back to:
  64         Erik Andersen
  65         <andersen@lineo.com>
  66         <andersee@debian.org>
  67
  68 <blatant plug>
  69 Many thanks to go to Lineo for paying me to work on busybox.
  70 </blatant plug>
  71