examples: make udhcpc script handle /32 netmasks
[oweals/busybox.git] / Config.in
index e0c01f3ef88b8243f83271cb5eed9e641c5b1349..cfb3aa0ee255ec36158cebf8f0a0442476d8238e 100644 (file)
--- a/Config.in
+++ b/Config.in
@@ -11,15 +11,18 @@ config HAVE_DOT_CONFIG
 
 menu "Busybox Settings"
 
-menu "General Configuration"
-
 config DESKTOP
        bool "Enable options for full-blown desktop systems"
-       default n
+       default y
        help
          Enable options and features which are not essential.
-         Select this only if you plan to use busybox on full-blown
-         desktop machine with common Linux distro, not on an embedded box.
+         Select this if you plan to use busybox on full-blown desktop machine
+         with common Linux distro, which needs higher level of command-line
+         compatibility.
+
+         If you are preparing your build to be used on an embedded box
+         where you have tighter control over the entire set of userspace
+         tools, you can unselect this option for smaller code size.
 
 config EXTRA_COMPAT
        bool "Provide compatible behavior for rare corner cases (bigger code)"
@@ -47,45 +50,22 @@ config USE_PORTABLE_CODE
          compiler other than gcc.
          If you do use gcc, this option may needlessly increase code size.
 
-choice
-       prompt "Buffer allocation policy"
-       default FEATURE_BUFFERS_USE_MALLOC
-       help
-         There are 3 ways BusyBox can handle buffer allocations:
-         - Use malloc. This costs code size for the call to xmalloc.
-         - Put them on stack. For some very small machines with limited stack
-           space, this can be deadly. For most folks, this works just fine.
-         - Put them in BSS. This works beautifully for computers with a real
-           MMU (and OS support), but wastes runtime RAM for uCLinux. This
-           behavior was the only one available for BusyBox versions 0.48 and
-           earlier.
-
-config FEATURE_BUFFERS_USE_MALLOC
-       bool "Allocate with Malloc"
-
-config FEATURE_BUFFERS_GO_ON_STACK
-       bool "Allocate on the Stack"
-
-config FEATURE_BUFFERS_GO_IN_BSS
-       bool "Allocate in the .bss section"
-
-endchoice
-
 config SHOW_USAGE
-       bool "Show terse applet usage messages"
+       bool "Show 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.
+         Enabling this option, BusyBox applets will show terse help messages
+         when invoked with wrong arguments.
+         If you do not want to show any (helpful) usage message when
+         issuing wrong command syntax, you can say 'N' here,
+         saving approximately 7k.
 
 config FEATURE_VERBOSE_USAGE
        bool "Show verbose applet usage messages"
-       default n
-       select SHOW_USAGE
+       default y
+       depends on SHOW_USAGE
        help
-         All BusyBox applets will show more verbose help messages when
+         All BusyBox applets will show 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.
@@ -95,8 +75,8 @@ config FEATURE_COMPRESS_USAGE
        default y
        depends on SHOW_USAGE
        help
-         Store usage messages in compressed form, uncompress them on-the-fly
-         when <applet> --help is called.
+         Store usage messages in .bz compressed form, uncompress them
+         on-the-fly when <applet> --help is called.
 
          If you have a really tiny busybox with few applets enabled (and
          bunzip2 isn't one of them), the overhead of the decompressor might
@@ -104,108 +84,43 @@ config FEATURE_COMPRESS_USAGE
          and have very little memory, this might not be a win. Otherwise,
          you probably want this.
 
+config BUSYBOX
+       bool "Include busybox applet"
+       default y
+       help
+         The busybox applet provides general help regarding busybox and
+         allows the included applets to be listed.  It's also required
+         if applet links are to be installed at runtime.
+
+         If you can live without these features disabling this will save
+         some space.
+
 config FEATURE_INSTALLER
        bool "Support --install [-s] to install applet links at runtime"
-       default n
+       default y
+       depends on BUSYBOX
        help
          Enable 'busybox --install [-s]' support. This will allow you to use
          busybox at runtime to create hard links or symlinks for all the
          applets that are compiled into busybox.
 
-config LOCALE_SUPPORT
-       bool "Enable locale support (system needs locale for this to work)"
-       default n
-       help
-         Enable this if your system has locale support and you would like
-         busybox to support locale settings.
-
-config FEATURE_ASSUME_UNICODE
-       bool "Support Unicode"
-       default n
-       help
-         This makes various applets aware that one byte is not
-         one character on screen.
-
-         Busybox aims to eventually work correctly with Unicode displays.
-         Any older encodings are not guaranteed to work.
-         Probably by the time when busybox will be fully Unicode-clean,
-         other encodings will be mainly of historic interest.
-
-config FEATURE_CHECK_UNICODE_IN_ENV
-       bool "Check $LANG environment variable"
-       default y
-       depends on FEATURE_ASSUME_UNICODE && !LOCALE_SUPPORT
-       help
-         With this option on, Unicode support is activated
-         only if LANG variable has the value of the form "xxxx.utf8"
-
-         Otherwise, Unicode support will be always enabled and active.
-
-config SUBST_WCHAR
-       int "Character code to substitute unprintable characters with"
-       depends on FEATURE_ASSUME_UNICODE
-       default 63
-       help
-         Typical values are 63 for '?' (works with any output device),
-         30 for ASCII substitute control code,
-         65533 (0xfffd) for Unicode replacement character.
-
-config LAST_SUPPORTED_WCHAR
-       int "Range of supported Unicode characters"
-       depends on FEATURE_ASSUME_UNICODE
-       default 767
-       help
-         Any character with Unicode value bigger than this is assumed
-         to be non-printable on output device. Many applets replace
-         such chars with substitution character.
-
-         The idea is that many valid printable Unicode chars are
-         nevertheless are not displayed correctly. Think about
-         combining charachers, double-wide hieroglyphs, obscure
-         characters in dozens of ancient scripts...
-         Many terminals, terminal emulators, xterms etc will fail
-         to handle them correctly. Choose the smallest value
-         which suits your needs.
-
-         Typical values are:
-         126 - ASCII only
-         767 (0x2ff) - there are no combining chars in [0..767] range
-                       (the range includes Latin 1, Latin Ext. A and B),
-                       code is ~700 bytes smaller for this case.
-         4351 (0x10ff) - there are no double-wide chars in [0..4351] range,
-                       code is ~300 bytes smaller for this case.
-         12799 (0x31ff) - nearly all non-ideographic characters are
-                       available in [0..12799] range, including
-                       East Asian scripts like katakana, hiragana, hangul,
-                       bopomofo...
-         0 - off, any valid printable Unicode character will be printed.
-
-config UNICODE_COMBINING_WCHARS
-       bool "Allow zero-width Unicode characters on output"
+config INSTALL_NO_USR
+       bool "Don't use /usr"
        default n
-       depends on FEATURE_ASSUME_UNICODE
        help
-         With this option off, any Unicode char with width of 0
-         is substituted on output.
+         Disable use of /usr. busybox --install and "make install"
+         will install applets only to /bin and /sbin,
+         never to /usr/bin or /usr/sbin.
 
-config UNICODE_WIDE_WCHARS
-       bool "Allow wide Unicode characters on output"
+config PAM
+       bool "Support PAM (Pluggable Authentication Modules)"
        default n
-       depends on FEATURE_ASSUME_UNICODE
        help
-         With this option off, any Unicode char with width > 1
-         is substituted on output.
-
-config UNICODE_BIDI_SUPPORT
-       bool "Bidirectional character-aware line input"
-       default y
-       depends on FEATURE_ASSUME_UNICODE && !LOCALE_SUPPORT
-       help
-         With this option on, right-to-left Unicode characters
-         are treated differently on input (e.g. cursor movement).
+         Use PAM in some busybox applets (currently login and httpd) instead
+         of direct access to password database.
 
 config LONG_OPTS
-       bool "Support for --long-options"
+       bool "Support --long-options"
        default y
        help
          Enable this if you want busybox applets to use the gnu --long-option
@@ -233,40 +148,94 @@ config FEATURE_CLEAN_UP
          Don't enable this unless you have a really good reason to clean
          things up manually.
 
+config FEATURE_UTMP
+       bool "Support utmp file"
+       default y
+       help
+         The file /var/run/utmp is used to track who is currently logged in.
+         With this option on, certain applets (getty, login, telnetd etc)
+         will create and delete entries there.
+         "who" applet requires this option.
+
+config FEATURE_WTMP
+       bool "Support wtmp file"
+       default y
+       depends on FEATURE_UTMP
+       help
+         The file /var/run/wtmp is used to track when users have logged into
+         and logged out of the system.
+         With this option on, certain applets (getty, login, telnetd etc)
+         will append new entries there.
+         "last" applet requires this option.
+
 config FEATURE_PIDFILE
        bool "Support writing pidfiles"
-       default n
+       default y
        help
          This option makes some applets (e.g. crond, syslogd, inetd) write
-         a pidfile in /var/run. Some applications rely on them.
+         a pidfile at the configured PID_FILE_PATH.  It has no effect
+         on applets which require pidfiles to run.
+
+config PID_FILE_PATH
+       string "Path to directory for pidfile"
+       default "/var/run"
+       depends on FEATURE_PIDFILE
+       help
+         This is the default path where pidfiles are created.  Applets which
+         allow you to set the pidfile path on the command line will override
+         this value.  The option has no effect on applets that require you to
+         specify a pidfile path.
 
 config FEATURE_SUID
-       bool "Support for SUID/SGID handling"
-       default n
+       bool "Support SUID/SGID handling"
+       default y
        help
          With this option you can install the busybox binary belonging
-         to root with the suid bit set, and it will automatically drop
-         priviledges for applets that don't need root access.
+         to root with the suid bit set, enabling some applets to perform
+         root-level operations even when run by ordinary users
+         (for example, mounting of user mounts in fstab needs this).
+
+         Busybox will automatically drop privileges for applets
+         that don't need root access.
 
          If you are really paranoid and don't want to do this, build two
          busybox binaries with different applets in them (and the appropriate
          symlinks pointing to each binary), and only set the suid bit on the
-         one that needs it. The applets currently marked to need the suid bit
-         are:
+         one that needs it.
+
+         The applets which require root rights (need suid bit or
+         to be run by root) and will refuse to execute otherwise:
+         crontab, login, passwd, su, vlock, wall.
+
+         The applets which will use root rights if they have them
+         (via suid bit, or because run by root), but would try to work
+         without root right nevertheless:
+         findfs, ping[6], traceroute[6], mount.
 
-         crontab, dnsd, findfs, ipcrm, ipcs, login, passwd, ping, su,
-         traceroute, vlock.
+         Note that if you DONT select this option, but DO make busybox
+         suid root, ALL applets will run under root, which is a huge
+         security hole (think "cp /some/file /etc/passwd").
 
 config FEATURE_SUID_CONFIG
        bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
-       default n if FEATURE_SUID
+       default y
        depends on FEATURE_SUID
        help
          Allow the SUID / SGID state of an applet to be determined at runtime
          by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
          The format of this file is as follows:
 
-         <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
+         APPLET = [Ssx-][Ssx-][x-] [USER.GROUP]
+
+         s: USER or GROUP is allowed to execute APPLET.
+            APPLET will run under USER or GROUP
+            (reagardless of who's running it).
+         S: USER or GROUP is NOT allowed to execute APPLET.
+            APPLET will run under USER or GROUP.
+            This option is not very sensical.
+         x: USER/GROUP/others are allowed to execute APPLET.
+            No UID/GID change will be done when it is run.
+         -: USER/GROUP/others are not allowed to execute APPLET.
 
          An example might help:
 
@@ -276,7 +245,8 @@ config FEATURE_SUID_CONFIG
          su = ssx        # exactly the same
 
          mount = sx- root.disk # applet mount can be run by root and members
-                               # of group disk and runs with euid=0
+                               # of group disk (but not anyone else)
+                               # and runs with euid=0 (egid is not changed)
 
          cp = --- # disable applet cp for everyone
 
@@ -302,15 +272,13 @@ config FEATURE_SUID_CONFIG_QUIET
 config SELINUX
        bool "Support NSA Security Enhanced Linux"
        default n
+       select PLATFORM_LINUX
        help
          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 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. Specifially, libselinux 1.28 or better is
+         will not compile.  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> \
@@ -359,9 +327,18 @@ config FEATURE_HAVE_RPC
        #  This is automatically selected if any of enabled applets need it.
        #  You do not need to select it manually.
 
-endmenu
+config PLATFORM_LINUX
+       bool #No description makes it a hidden option
+       default n
+       #help
+       #  For the most part, busybox requires only POSIX compatibility
+       #  from the target system, but some applets and features use
+       #  Linux-specific interfaces.
+       #
+       #  This is automatically selected if any applet or feature requires
+       #  Linux-specific interfaces. You do not need to select it manually.
 
-menu 'Build Options'
+comment 'Build Options'
 
 config STATIC
        bool "Build BusyBox as a static binary (no shared libs)"
@@ -382,7 +359,10 @@ config PIE
        default n
        depends on !STATIC
        help
-         (TODO: what is it and why/when is it useful?)
+         Hardened code option. PIE binaries are loaded at a different
+         address at each invocation. This has some overhead,
+         particularly on x86-32 which is short on registers.
+
          Most people will leave this set to 'N'.
 
 config NOMMU
@@ -478,8 +458,7 @@ config FEATURE_SHARED_BUSYBOX
 
 config LFS
        bool "Build with Large File Support (for accessing files > 2 GB)"
-       default n
-       select FDISK_SUPPORT_LARGE_DISKS
+       default y
        help
          If you want to build BusyBox with large file support, then enable
          this option. This will have no effect if your kernel or your C
@@ -501,15 +480,106 @@ config CROSS_COMPILER_PREFIX
 
          Native builds leave this empty.
 
+config SYSROOT
+       string "Path to sysroot"
+       default ""
+       help
+         If you want to build BusyBox with a cross compiler, then you
+         might also need to specify where /usr/include and /usr/lib
+         will be found.
+
+         For example, BusyBox can be built against an installed
+         Android NDK, platform version 9, for ARM ABI with
+
+         CONFIG_SYSROOT=/opt/android-ndk/platforms/android-9/arch-arm
+
+         Native builds leave this empty.
+
 config EXTRA_CFLAGS
        string "Additional CFLAGS"
        default ""
        help
          Additional CFLAGS to pass to the compiler verbatim.
 
-endmenu
+config EXTRA_LDFLAGS
+       string "Additional LDFLAGS"
+       default ""
+       help
+         Additional LDFLAGS to pass to the linker verbatim.
+
+config EXTRA_LDLIBS
+       string "Additional LDLIBS"
+       default ""
+       help
+         Additional LDLIBS to pass to the linker with -l.
+
+comment 'Installation Options ("make install" behavior)'
+
+choice
+       prompt "What kind of applet links to install"
+       default INSTALL_APPLET_SYMLINKS
+       help
+         Choose what kind of links to applets are created by "make install".
+
+config INSTALL_APPLET_SYMLINKS
+       bool "as soft-links"
+       help
+         Install applets as soft-links to the busybox binary. This needs some
+         free inodes on the filesystem, but might help with filesystem
+         generators that can't cope with hard-links.
+
+config INSTALL_APPLET_HARDLINKS
+       bool "as hard-links"
+       help
+         Install applets as hard-links to the busybox binary. This might
+         count on a filesystem with few inodes.
+
+config INSTALL_APPLET_SCRIPT_WRAPPERS
+       bool "as script wrappers"
+       help
+         Install applets as script wrappers that call the busybox binary.
+
+config INSTALL_APPLET_DONT
+       bool "not installed"
+       help
+         Do not install applet links. Useful when you plan to use
+         busybox --install for installing links, or plan to use
+         a standalone shell and thus don't need applet links.
+
+endchoice
+
+choice
+       prompt "/bin/sh applet link"
+       default INSTALL_SH_APPLET_SYMLINK
+       depends on INSTALL_APPLET_SCRIPT_WRAPPERS
+       help
+         Choose how you install /bin/sh applet link.
+
+config INSTALL_SH_APPLET_SYMLINK
+       bool "as soft-link"
+       help
+         Install /bin/sh applet as soft-link to the busybox binary.
+
+config INSTALL_SH_APPLET_HARDLINK
+       bool "as hard-link"
+       help
+         Install /bin/sh applet as hard-link to the busybox binary.
+
+config INSTALL_SH_APPLET_SCRIPT_WRAPPER
+       bool "as script wrapper"
+       help
+         Install /bin/sh applet as script wrapper that calls
+         the busybox binary.
+
+endchoice
+
+config PREFIX
+       string "BusyBox installation prefix"
+       default "./_install"
+       help
+         Define your directory to install BusyBox files/subdirs in.
 
-menu 'Debugging Options'
+comment 'Debugging Options'
 
 config DEBUG
        bool "Build BusyBox with extra Debugging symbols"
@@ -533,11 +603,31 @@ config DEBUG_PESSIMIZE
          in a much bigger executable that more closely matches the source
          code.
 
+config DEBUG_SANITIZE
+       bool "Enable runtime sanitizers (ASAN/LSAN/USAN/etc...)"
+       default n
+       help
+         Say Y here if you want to enable runtime sanitizers. These help
+         catch bad memory accesses (e.g. buffer overflows), but will make
+         the executable larger and slow down runtime a bit.
+
+         This adds -fsanitize=foo options to gcc command line.
+
+         If you aren't developing/testing busybox, say N here.
+
+config UNIT_TEST
+       bool "Build unit tests"
+       default n
+       help
+         Say Y here if you want to build unit tests (both the framework and
+         test cases) as a Busybox applet. This results in bigger code, so you
+         probably don't want this option in production builds.
+
 config WERROR
        bool "Abort compilation on any warning"
        default n
        help
-         Selecting this will add -Werror to gcc command line.
+         This adds -Werror to gcc command line.
 
          Most people should answer N.
 
@@ -583,90 +673,10 @@ config EFENCE
 
 endchoice
 
-### config PARSE
-###    bool "Uniform config file parser debugging applet: parse"
-
-endmenu
-
-menu 'Installation Options'
-
-config INSTALL_NO_USR
-       bool "Don't use /usr"
-       default n
-       help
-         Disable use of /usr. Don't activate this option if you don't know
-         that you really want this behaviour.
-
-choice
-       prompt "Applets links"
-       default INSTALL_APPLET_SYMLINKS
-       help
-         Choose how you install applets links.
-
-config INSTALL_APPLET_SYMLINKS
-       bool "as soft-links"
-       help
-         Install applets as soft-links to the busybox binary. This needs some
-         free inodes on the filesystem, but might help with filesystem
-         generators that can't cope with hard-links.
-
-config INSTALL_APPLET_HARDLINKS
-       bool "as hard-links"
-       help
-         Install applets as hard-links to the busybox binary. This might
-         count on a filesystem with few inodes.
-
-config INSTALL_APPLET_SCRIPT_WRAPPERS
-       bool "as script wrappers"
-       help
-         Install applets as script wrappers that call the busybox binary.
-
-config INSTALL_APPLET_DONT
-       bool "not installed"
-       depends on FEATURE_INSTALLER || FEATURE_SH_STANDALONE || FEATURE_PREFER_APPLETS
-       help
-         Do not install applet links. Useful when using the -install feature
-         or a standalone shell for rescue purposes.
-
-endchoice
-
-choice
-       prompt "/bin/sh applet link"
-       default INSTALL_SH_APPLET_SYMLINK
-       depends on INSTALL_APPLET_SCRIPT_WRAPPERS
-       help
-         Choose how you install /bin/sh applet link.
-
-config INSTALL_SH_APPLET_SYMLINK
-       bool "as soft-link"
-       help
-         Install /bin/sh applet as soft-link to the busybox binary.
-
-config INSTALL_SH_APPLET_HARDLINK
-       bool "as hard-link"
-       help
-         Install /bin/sh applet as hard-link to the busybox binary.
-
-config INSTALL_SH_APPLET_SCRIPT_WRAPPER
-       bool "as script wrapper"
-       help
-         Install /bin/sh applet as script wrapper that call the busybox
-         binary.
-
-endchoice
-
-config PREFIX
-       string "BusyBox installation prefix"
-       default "./_install"
-       help
-         Define your directory to install BusyBox files/subdirs in.
-
 endmenu
 
 source libbb/Config.in
 
-endmenu
-
 comment "Applets"
 
 source archival/Config.in