diff options
author | Eric Andersen <andersen@codepoet.org> | 2004-03-27 09:40:15 +0000 |
---|---|---|
committer | Eric Andersen <andersen@codepoet.org> | 2004-03-27 09:40:15 +0000 |
commit | fbcf06d2960f8f0959aac71d0fad8d9ab446b439 (patch) | |
tree | d3518bfe5e398abef0ac3fd0af9254cbbfd56808 /docs/busybox_header.pod | |
parent | 97310d025390e96f34140cff13034fcd2b5da18f (diff) | |
download | busybox-w32-fbcf06d2960f8f0959aac71d0fad8d9ab446b439.tar.gz busybox-w32-fbcf06d2960f8f0959aac71d0fad8d9ab446b439.tar.bz2 busybox-w32-fbcf06d2960f8f0959aac71d0fad8d9ab446b439.zip |
Update docs
Diffstat (limited to 'docs/busybox_header.pod')
-rw-r--r-- | docs/busybox_header.pod | 87 |
1 files changed, 67 insertions, 20 deletions
diff --git a/docs/busybox_header.pod b/docs/busybox_header.pod index 132aa3b65..395e2c81a 100644 --- a/docs/busybox_header.pod +++ b/docs/busybox_header.pod | |||
@@ -14,42 +14,67 @@ BusyBox - The Swiss Army Knife of Embedded Linux | |||
14 | 14 | ||
15 | BusyBox combines tiny versions of many common UNIX utilities into a single | 15 | BusyBox combines tiny versions of many common UNIX utilities into a single |
16 | small executable. It provides minimalist replacements for most of the utilities | 16 | small executable. It provides minimalist replacements for most of the utilities |
17 | you usually find in fileutils, shellutils, findutils, textutils, grep, gzip, | 17 | you usually find in GNU coreutils, util-linux, etc. The utilities in BusyBox |
18 | tar, etc. BusyBox provides a fairly complete POSIX environment for any small | 18 | generally have fewer options than their full-featured GNU cousins; however, the |
19 | or embedded system. The utilities in BusyBox generally have fewer options than | 19 | options that are included provide the expected functionality and behave very |
20 | their full-featured GNU cousins; however, the options that are included provide | 20 | much like their GNU counterparts. BusyBox provides a fairly complete POSIX |
21 | the expected functionality and behave very much like their GNU counterparts. | 21 | environment for any small or embedded system. |
22 | 22 | ||
23 | BusyBox has been written with size-optimization and limited resources in mind. | 23 | BusyBox has been written with size-optimization and limited resources in mind. |
24 | It is also extremely modular so you can easily include or exclude commands (or | 24 | It is also extremely modular so you can easily include or exclude commands (or |
25 | features) at compile time. This makes it easy to customize your embedded | 25 | features) at compile time. This makes it easy to customize your embedded |
26 | systems. To create a working system, just add a kernel, a shell (such as ash), | 26 | systems. To create a working system, just add /dev, /etc, and a Linux kernel. |
27 | and an editor (such as elvis-tiny or ae). | 27 | |
28 | BusyBox is extremely configurable. This allows you to include only the | ||
29 | components you need, thereby reducing binary size. Run 'make config' or 'make | ||
30 | menuconfig' for select the functionality that you wish to enable. The run | ||
31 | 'make' to compile BusyBox using your configuration. | ||
32 | |||
33 | After the compile has finished, you should use 'make install' to install | ||
34 | BusyBox. This will install the '/bin/busybox' binary, and will also create | ||
35 | symlinks pointing to the '/bin/busybox' binary for each utility that you | ||
36 | compile into BusyBox. By default, 'make install' will place these symlinks | ||
37 | into the './_install' directory, unless you have defined 'PREFIX', thereby | ||
38 | specifying some alternative location (i.e., 'make PREFIX=/tmp/foo install'). | ||
39 | If you wish to install using hardlinks, rather than the default of using | ||
40 | symlinks, you can use 'make PREFIX=/tmp/foo install-hardlinks' instead. | ||
28 | 41 | ||
29 | =head1 USAGE | 42 | =head1 USAGE |
30 | 43 | ||
31 | When you create a link to BusyBox for the function you wish to use, when BusyBox | 44 | BusyBox is a multi-call binary. A multi-call binary is an executable program |
32 | is called using that link it will behave as if the command itself has been invoked. | 45 | that performs the same job as more than one utility program. That means there |
46 | is just a single BusyBox binary, but that single binary acts like a large | ||
47 | number of utilities. This allows BusyBox to be smaller since all the built-in | ||
48 | utility programs (we call them applets) can share code for many common operations. | ||
49 | |||
50 | You can also invoke BusyBox by issuing the command as an argument on the | ||
51 | command line. For example, entering | ||
52 | |||
53 | /bin/busybox ls | ||
54 | |||
55 | will also cause BusyBox to behave as 'ls'. | ||
56 | |||
57 | Of course, adding '/bin/busybox' into every command would be painful. So most | ||
58 | people will invoke BusyBox using links to the BusyBox binary. | ||
33 | 59 | ||
34 | For example, entering | 60 | For example, entering |
35 | 61 | ||
36 | ln -s ./BusyBox ls | 62 | ln -s /bin/busybox ls |
37 | ./ls | 63 | ./ls |
38 | 64 | ||
39 | will cause BusyBox to behave as 'ls' (if the 'ls' command has been compiled | 65 | will cause BusyBox to behave as 'ls' (if the 'ls' command has been compiled |
40 | into BusyBox). | 66 | into BusyBox). Generally speaking, you should never need to make all these |
41 | 67 | links yourself, as the BusyBox build system will do this for you when you run | |
42 | You can also invoke BusyBox by issuing the command as an argument on the | 68 | the 'make install' command. |
43 | command line. For example, entering | ||
44 | 69 | ||
45 | ./BusyBox ls | 70 | If you invoke BusyBox with no arguments, it will provide you with a list of the |
46 | 71 | applets that have been compiled into your BusyBox binary. | |
47 | will also cause BusyBox to behave as 'ls'. | ||
48 | 72 | ||
49 | =head1 COMMON OPTIONS | 73 | =head1 COMMON OPTIONS |
50 | 74 | ||
51 | Most BusyBox commands support the B<-h> option to provide a | 75 | Most BusyBox commands support the B<--help> argument to provide a terse runtime |
52 | terse runtime description of their behavior. | 76 | description of their behavior. If the CONFIG_FEATURE_VERBOSE_USAGE option has |
77 | been enabled, more detailed usage information will also be available. | ||
53 | 78 | ||
54 | =head1 COMMANDS | 79 | =head1 COMMANDS |
55 | 80 | ||
@@ -80,4 +105,26 @@ Currently defined functions include: | |||
80 | 105 | ||
81 | =over 4 | 106 | =over 4 |
82 | 107 | ||
108 | =head1 LIBC NSS | ||
109 | |||
110 | GNU Libc (glibc) uses the Name Service Switch (NSS) to configure the behavior | ||
111 | of the C library for the local environment, and to configure how it reads | ||
112 | system data, such as passwords and group information. This is implemented | ||
113 | using an /etc/nsswitch.conf configuration file, and using one or more of the | ||
114 | /lib/libnss_* libraries. BusyBox tries to avoid using any libc calls that make | ||
115 | use of NSS. Some applets, such as login and su, will use libc functions that | ||
116 | usually require NSS. | ||
117 | |||
118 | If you enable CONFIG_USE_BB_PWD_GRP, BusyBox will use internal functions to | ||
119 | directly access the /etc/passwd, /etc/group, and /etc/shadow files without | ||
120 | using NSS. This may allow you to run your system without the need for | ||
121 | installing any of the NSS configuration files and libraries. | ||
122 | |||
123 | When used with glibc, the BusyBox 'networking' applets will similarly require | ||
124 | that you install at least some of the glibc NSS stuff (in particular, | ||
125 | /etc/nsswitch.conf, /lib/libnss_dns*, /lib/libnss_files*, and /lib/libresolv*). | ||
126 | |||
127 | Shameless Plug: As an alternative one could use a C library such as uClibc. In | ||
128 | addition to making your system significantly smaller, uClibc does not need or | ||
129 | use any NSS support files or libraries. | ||
83 | 130 | ||