emo/busybox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Rob Landley 2006-03-13 04:38:40 +00:00
parent 19808fea76
commit 965030e35a
1 changed files with 36 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
INSTALL
View File

@ -16,9 +16,14 @@ Quick Start:
The easy way to try out BusyBox for the first time, without having to install The easy way to try out BusyBox for the first time, without having to install
it, is to enable all features and then use "standalone shell" mode with a it, is to enable all features and then use "standalone shell" mode with a
blank command $PATH: blank command $PATH.
make allyesconfig To enable all features, use "make defconfig", which produces the largest
general-purpose configuration. (It's allyesconfig minus debugging options,
optional packaging choices, and a few special-purpose features requiring
extra configuration to use.)
make defconfig
make make
PATH= ./busybox ash PATH= ./busybox ash
@ -27,25 +32,34 @@ any built-in busybox applets directly, without looking for external
programs by that name. Supplying an empty command path (as above) means programs by that name. Supplying an empty command path (as above) means
the only commands busybox can find are the built-in ones. the only commands busybox can find are the built-in ones.
(Note that the standalone shell requires the /proc directory to function.) (Note that the standalone shell currently requires /proc/self/exe to
launch new applets.)
Configuring Busybox: Configuring Busybox:
==================== ====================
Busybox is optimized for size, but enabling the full set of functionality Busybox is optimized for size, but enabling the full set of functionality
still results in a fairly large executable (more than 1 megabyte when still results in a fairly large executable -- more than 1 megabyte when
statically linked). To save space, busybox can be configured with only the statically linked. To save space, busybox can be configured with only the
set of applets needed for each environment. The minimal configuration, with set of applets needed for each environment. The minimal configuration, with
all applets disabled, produces a 4k executable. (It's useless, but very small.) all applets disabled, produces a 4k executable. (It's useless, but very small.)
The manual configurators "make config" and "make menuconfig" modify the The manual configurator "make menuconfig" modifies the existing configuration.
existing configuration. Quick ways to get starting configurations include (For systems without ncurses, try "make config" instead.) The two most
"make allyesconfig" (enables almost all options), "make allnoconfig" (disables interesting starting configurations are "make allnoconfig" (to start with
all options), "make allbaseconfig" (enables all applets but disables all everything disabled and add just what you need), and "make defconfig" (to
optional features), and "make defconfig" (reset to defaults). start with everything enabled and remove what you don't need). If menuconfig
is run without an existing configuration, make defconfig will run first to
create a known starting point.
Other starting configurations (mostly used for testing purposes) include
"make allbaseconfig" (enables all applets but disables all optional features),
"make allyesconfig" (enables absolutely everything including debug features),
and "make randconfig" (produce a random configuration).
Configuring BusyBox produces a file ".config", which can be saved for future Configuring BusyBox produces a file ".config", which can be saved for future
use. use. Run "make oldconfig" to bring a .config file from an older version of
busybox up to date.
Installing Busybox: Installing Busybox:
=================== ===================
@ -72,37 +86,34 @@ also configure a standaone install capability into the busybox base applet,
and then install such links at runtime with one of "busybox --install" (for and then install such links at runtime with one of "busybox --install" (for
hardlinks) or "busybox --install -s" (for symlinks). hardlinks) or "busybox --install -s" (for symlinks).
If you built busybox as shared object which uses libbusybox.so and have not If you enabled the busybox shared library feature (libbusybox.so) and want
yet installed the binary but want to run tests, then set your LD_LIBRARY_PATH to run tests without installing, set your LD_LIBRARY_PATH accordingly when
accordingly before running the executable: running the executable:
export LD_LIBRARY_PATH=`pwd` LD_LIBRARY_PATH=`pwd` ./busybox
./busybox
Building out-of-tree: Building out-of-tree:
===================== =====================
By default, the BusyBox build puts its temporary files in the source tree. By default, the BusyBox build puts its temporary files in the source tree.
Building from a read-only source tree, or to building multiple Building from a read-only source tree, or building multiple configurations from
configurations from the same source directory, requires the ability to the same source directory, requires the ability to put the temporary files
put the temporary files somewhere else. somewhere else.
To build out of tree, cd to the empty directory and do this instead: To build out of tree, cd to an empty directory and configure busybox from there:
make -f /path/to/source/Makefile allyesconfig make -f /path/to/source/Makefile defconfig
make make
make install make install
Alternately, use the O=$BUILDPATH option during the configuration step, as in: Alternately, use the O=$BUILDPATH option (with an absolute path) during the
configuration step, as in:
make O=/some/empty/directory allyesconfig make O=/some/empty/directory allyesconfig
cd /some/empty/directory cd /some/empty/directory
make make
make PREFIX=. install make PREFIX=. install
(Note, O= requires an absolute path.)
More Information: More Information:
================= =================