| Eric Andersen | 9b5a953 | 2001-10-24 06:33:31 +0000 | [diff] [blame] | 1 | # BusyBox configuration option Help File |
| 2 | # |
| 3 | # Format of this file: description<nl>variable<nl>help text<nl><nl>. |
| 4 | # The help texts may contain empty lines, but every non-empty line must |
| 5 | # be indented two positions. Order of the help texts does not matter, |
| 6 | # however, no variable should be documented twice: if it is, only the |
| 7 | # first occurrence will be used. We try to keep the help texts of related |
| 8 | # variables close together. Lines starting with `#' are ignored. To be |
| 9 | # nice to menuconfig, limit your line length to 70 characters. |
| 10 | # |
| 11 | # Comments of the form "# Choice:" followed by a menu name are used |
| 12 | # internally by the maintainers' consistency-checking tools. |
| 13 | # |
| 14 | # If you add a help text to this file, please try to be as gentle as |
| 15 | # possible. Don't use unexplained acronyms and generally write for the |
| 16 | # hypothetical ignorant but intelligent user who has just bought a PC, |
| 17 | # removed Windows, installed Linux and is now compiling up BusyBox |
| 18 | # for the first time. Tell them what to do if they're unsure. |
| 19 | # |
| 20 | # Mention all the relevant READMEs and HOWTOs in the help text. |
| 21 | # Make them file URLs relative to the top level of the source tree so |
| 22 | # that help browsers can turn them into hotlinks. All URLs ahould be |
| 23 | # surrounded by <>. |
| 24 | # |
| 25 | # Repetitions are fine since the help texts are not meant to be read |
| 26 | # in sequence. It is good style to include URLs pointing to more |
| 27 | # detailed technical information, pictures of the hardware, etc. |
| 28 | # |
| 29 | # The most important thing to include in a help entry is *motivation*. |
| 30 | # Explain why someone configuring BusyBox might want to select your |
| 31 | # option. |
| 32 | # |
| 33 | |
| 34 | Enable the ar applet |
| 35 | CONFIG_AR |
| 36 | ar is an archival utility program used to creates, modify, and |
| 37 | extract contents from archives. An archive is a single file holding |
| 38 | a collection of other files in a structure that makes it possible to |
| 39 | retrieve the original individual files (called archive members). The |
| 40 | original files' contents, mode (permissions), timestamp, owner, and |
| 41 | group are preserved in the archive, and can be restored on |
| 42 | extraction. On an x86 system, the ar applet adds about XXX bytes. |
| 43 | |
| 44 | Unless you have a specific application which requires ar, you should |
| 45 | probably say N here. |
| 46 | |
| 47 | Enable the bunzip2 applet |
| 48 | CONFIG_BUNZIP2 |
| 49 | bunzip2 is an compression utility using the Burrows-Wheeler block |
| 50 | sorting text compression algorithm, and Huffman coding. Compression |
| 51 | is generally considerably better than that achieved by more |
| 52 | conventional LZ77/LZ78-based compressors, and approaches the |
| 53 | performance of the PPM family of statistical compressors. |
| 54 | |
| 55 | The BusyBox bunzip2 applet is limited to de-compression only. On an |
| 56 | x86 system, this applet adds about XXX bytes. |
| 57 | |
| 58 | Unless you have a specific application which requires bunzip2, you |
| 59 | should probably say N here. |
| 60 | |
| 61 | # FIXME -- document the rest of the BusyBox config options.... |
| 62 | |
| 63 | |
| 64 | # The following sets edit modes for GNU EMACS |
| 65 | # Local Variables: |
| 66 | # case-fold-search:nil |
| 67 | # fill-prefix:" " |
| 68 | # adaptive-fill:nil |
| 69 | # fill-column:70 |
| 70 | # End: |