fix whitespace
[oweals/busybox.git] / Config.in
index 0afc34a943d011ad26ca8712689172a3e1d6db19..bd94f493c1c44824eff91f1411dc4eeef10b2561 100644 (file)
--- a/Config.in
+++ b/Config.in
@@ -9,6 +9,8 @@ config HAVE_DOT_CONFIG
        bool
        default y
 
+menu "Busybox Settings"
+
 menu "General Configuration"
 
 choice
@@ -35,15 +37,33 @@ config CONFIG_FEATURE_BUFFERS_GO_IN_BSS
 
 endchoice
 
+config CONFIG_SHOW_USAGE
+       bool "Show terse applet usage messages"
+       default y
+       help
+         All BusyBox applets will show help messages when invoked with
+         wrong arguments. You can turn off printing these terse usage
+         messages if you say no here.
+         This will save you up to 7k.
+
 config CONFIG_FEATURE_VERBOSE_USAGE
        bool "Show verbose applet usage messages"
        default n
+       select CONFIG_SHOW_USAGE
        help
          All BusyBox applets will show more verbose help messages when
          busybox is invoked with --help.  This will add a lot of text to the
          busybox binary.  In the default configuration, this will add about
          13k, but it can add much more depending on your configuration.
 
+config CONFIG_FEATURE_COMPRESS_USAGE
+       bool "Store applet usage messages in compressed form"
+       default y
+       depends on CONFIG_SHOW_USAGE
+       help
+         Store usage messages in compressed form, uncompress them on-the-fly
+         when <applet> --help is called.
+
 config CONFIG_FEATURE_INSTALLER
        bool "Support --install [-s] to install applet links at runtime"
        default n
@@ -61,10 +81,12 @@ config CONFIG_LOCALE_SUPPORT
          busybox to support locale settings.
 
 config CONFIG_FEATURE_DEVFS
-       bool "Support for devfs"
+       bool "Use devfs names for devices"
        default n
        help
-         Enable if you want BusyBox to work with devfs.
+         This tells busybox to look for names like /dev/loop/0 instead of
+          /dev/loop0.  If your /dev directory has normal names instead of
+          devfs names, you don't want this.
 
 config CONFIG_FEATURE_DEVPTS
        bool "Use the devpts filesystem for Unix98 PTYs"
@@ -80,10 +102,12 @@ config CONFIG_FEATURE_CLEAN_UP
        bool "Clean up all memory before exiting (usually not needed)"
        default n
        help
-         As a size optimization, busybox by default does not cleanup memory
-         that is dynamically allocated or close files before exiting. This
-         saves space and is usually not needed since the OS will clean up for
-         us.  Don't enable this unless you have a really good reason to clean
+         As a size optimization, busybox normally exits without explicitly
+         freeing dynamically allocated memory or closing files.  This saves
+         space since the OS will clean up for us, but it can confuse debuggers
+         like valgrind, which report tons of memory and resource leaks.
+
+         Don't enable this unless you have a really good reason to clean
          things up manually.
 
 config CONFIG_FEATURE_SUID
@@ -135,14 +159,19 @@ config CONFIG_SELINUX
        bool "Support NSA Security Enhanced Linux"
        default n
        help
-         Enable support for SE Linux in applets ls, ps, and id.  Also provide
-         the option of compiling in SE Linux applets.
+         Enable support for SELinux in applets ls, ps, and id.  Also provide
+         the option of compiling in SELinux applets.
 
-         If you do not have a complete SE Linux Full Userland installed, this
-         stuff will not compile.  Go visit
+         If you do not have a complete SELinux userland installed, this stuff
+         will not compile. Go visit
                http://www.nsa.gov/selinux/index.html
-         to download the necessary stuff to allow busybox to compile with this
-         option enabled.
+         to download the necessary stuff to allow busybox to compile with
+         this option enabled. Specifially, libselinux 1.28 or better is
+         directly required by busybox. If the installation is located in a
+         non-standard directory, provide it by invoking make as follows:
+               CFLAGS=-I<libselinux-include-path> \
+               LDFLAGS=-L<libselinux-lib-path> \
+               make
 
          Most people will leave this set to 'N'.
 
@@ -258,6 +287,83 @@ config CONFIG_BUILD_AT_ONCE
 
 endmenu
 
+menu 'Debugging Options'
+
+config CONFIG_DEBUG
+       bool "Build BusyBox with extra Debugging symbols"
+       default n
+       help
+         Say Y here if you wish to examine BusyBox internals while applets are
+         running.  This increases the size of the binary considerably, and
+         should only be used when doing development.  If you are doing
+         development and want to debug BusyBox, answer Y.
+
+         Most people should answer N.
+
+config CONFIG_DEBUG_PESSIMIZE
+       bool "Disable compiler optimizations."
+       default n
+       depends on CONFIG_DEBUG
+       help
+         The compiler's optimization of source code can eliminate and reorder
+         code, resulting in an executable that's hard to understand when
+         stepping through it with a debugger.  This switches it off, resulting
+         in a much bigger executable that more closely matches the source
+         code.
+
+choice
+       prompt "Additional debugging library"
+       default CONFIG_NO_DEBUG_LIB
+       depends on CONFIG_DEBUG
+       help
+         Using an additional debugging library will make BusyBox become
+         considerable larger and will cause it to run more slowly.  You
+         should always leave this option disabled for production use.
+
+         dmalloc support:
+         ----------------
+         This enables compiling with dmalloc ( http://dmalloc.com/ )
+         which is an excellent public domain mem leak and malloc problem
+         detector.  To enable dmalloc, before running busybox you will
+         want to properly set your environment, for example:
+           export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
+         The 'debug=' value is generated using the following command
+           dmalloc -p log-stats -p log-non-free -p log-bad-space -p log-elapsed-time \
+              -p check-fence -p check-heap -p check-lists -p check-blank \
+              -p check-funcs -p realloc-copy -p allow-free-null
+
+         Electric-fence support:
+         -----------------------
+         This enables compiling with Electric-fence support.  Electric
+         fence is another very useful malloc debugging library which uses
+         your computer's virtual memory hardware to detect illegal memory
+         accesses.  This support will make BusyBox be considerable larger
+         and run slower, so you should leave this option disabled unless
+         you are hunting a hard to find memory problem.
+
+
+config CONFIG_NO_DEBUG_LIB
+       bool "None"
+
+config CONFIG_DMALLOC
+       bool "Dmalloc"
+
+config CONFIG_EFENCE
+       bool "Electric-fence"
+
+endchoice
+
+config CONFIG_DEBUG_YANK_SUSv2
+       bool "Disable obsolete features removed before SUSv3?"
+       default y
+       help
+         This option will disable backwards compatibility with SuSv2,
+         specifically, old-style numeric options ('command -1 <file>')
+         will not be supported in head, tail, and fold.  (Note: should
+         yank from renice too.)
+
+endmenu
+
 menu 'Installation Options'
 
 config CONFIG_INSTALL_NO_USR
@@ -304,6 +410,12 @@ config PREFIX
 
 endmenu
 
+source libbb/Config.in
+
+endmenu
+
+comment "Applets"
+
 source archival/Config.in
 source coreutils/Config.in
 source console-tools/Config.in
@@ -320,70 +432,3 @@ source networking/Config.in
 source procps/Config.in
 source shell/Config.in
 source sysklogd/Config.in
-
-menu 'Debugging Options'
-
-config CONFIG_DEBUG
-       bool "Build BusyBox with Debugging symbols"
-       default n
-       help
-         Say Y here if you wish to compile BusyBox with debugging symbols.
-         This will allow you to use a debugger to examine BusyBox internals
-         while applets are running.  This increases the size of the binary
-         considerably and should only be used when doing development.
-         If you are doing development and want to debug BusyBox, answer Y.
-
-         Most people should answer N.
-
-choice
-       prompt "Additional debugging library"
-       default CONFIG_NO_DEBUG_LIB
-       depends on CONFIG_DEBUG
-       help
-         Using an additional debugging library will make BusyBox become
-         considerable larger and will cause it to run more slowly.  You
-         should always leave this option disabled for production use.
-
-         dmalloc support:
-         ----------------
-         This enables compiling with dmalloc ( http://dmalloc.com/ )
-         which is an excellent public domain mem leak and malloc problem
-         detector.  To enable dmalloc, before running busybox you will
-         want to properly set your environment, for example:
-           export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
-         The 'debug=' value is generated using the following command
-           dmalloc -p log-stats -p log-non-free -p log-bad-space -p log-elapsed-time \
-              -p check-fence -p check-heap -p check-lists -p check-blank \
-              -p check-funcs -p realloc-copy -p allow-free-null
-
-         Electric-fence support:
-         -----------------------
-         This enables compiling with Electric-fence support.  Electric
-         fence is another very useful malloc debugging library which uses
-         your computer's virtual memory hardware to detect illegal memory
-         accesses.  This support will make BusyBox be considerable larger
-         and run slower, so you should leave this option disabled unless
-         you are hunting a hard to find memory problem.
-
-
-config CONFIG_NO_DEBUG_LIB
-       bool "None"
-
-config CONFIG_DMALLOC
-       bool "Dmalloc"
-
-config CONFIG_EFENCE
-       bool "Electric-fence"
-
-endchoice
-
-config CONFIG_DEBUG_YANK_SUSv2
-       bool "Disable obsolete features removed before SUSv3?"
-       default y
-       help
-         This option will disable backwards compatability with SuSv2,
-         specifically, old-style numeric options ('command -1 <file>')
-         will not be supported in head, tail, and fold.  (Note: should
-         yank from renice too.)
-
-endmenu