busybox/Config.in
<<
>>
Prefs
   1#
   2# For a description of the syntax of this configuration file,
   3# see scripts/kbuild/config-language.txt.
   4#
   5
   6mainmenu "BusyBox Configuration"
   7
   8config HAVE_DOT_CONFIG
   9        bool
  10        default y
  11
  12menu "Busybox Settings"
  13
  14config DESKTOP
  15        bool "Enable options for full-blown desktop systems"
  16        default y
  17        help
  18          Enable options and features which are not essential.
  19          Select this if you plan to use busybox on full-blown desktop machine
  20          with common Linux distro, which needs higher level of command-line
  21          compatibility.
  22
  23          If you are preparing your build to be used on an embedded box
  24          where you have tighter control over the entire set of userspace
  25          tools, you can unselect this option for smaller code size.
  26
  27config EXTRA_COMPAT
  28        bool "Provide compatible behavior for rare corner cases (bigger code)"
  29        default n
  30        help
  31          This option makes grep, sed etc handle rare corner cases
  32          (embedded NUL bytes and such). This makes code bigger and uses
  33          some GNU extensions in libc. You probably only need this option
  34          if you plan to run busybox on desktop.
  35
  36config INCLUDE_SUSv2
  37        bool "Enable obsolete features removed before SUSv3"
  38        default y
  39        help
  40          This option will enable backwards compatibility with SuSv2,
  41          specifically, old-style numeric options ('command -1 <file>')
  42          will be supported in head, tail, and fold. (Note: should
  43          affect renice too.)
  44
  45config USE_PORTABLE_CODE
  46        bool "Avoid using GCC-specific code constructs"
  47        default n
  48        help
  49          Use this option if you are trying to compile busybox with
  50          compiler other than gcc.
  51          If you do use gcc, this option may needlessly increase code size.
  52
  53config SHOW_USAGE
  54        bool "Show applet usage messages"
  55        default y
  56        help
  57          Enabling this option, BusyBox applets will show terse help messages
  58          when invoked with wrong arguments.
  59          If you do not want to show any (helpful) usage message when
  60          issuing wrong command syntax, you can say 'N' here,
  61          saving approximately 7k.
  62
  63config FEATURE_VERBOSE_USAGE
  64        bool "Show verbose applet usage messages"
  65        default y
  66        depends on SHOW_USAGE
  67        help
  68          All BusyBox applets will show verbose help messages when
  69          busybox is invoked with --help. This will add a lot of text to the
  70          busybox binary. In the default configuration, this will add about
  71          13k, but it can add much more depending on your configuration.
  72
  73config FEATURE_COMPRESS_USAGE
  74        bool "Store applet usage messages in compressed form"
  75        default y
  76        depends on SHOW_USAGE
  77        help
  78          Store usage messages in .bz compressed form, uncompress them
  79          on-the-fly when <applet> --help is called.
  80
  81          If you have a really tiny busybox with few applets enabled (and
  82          bunzip2 isn't one of them), the overhead of the decompressor might
  83          be noticeable. Also, if you run executables directly from ROM
  84          and have very little memory, this might not be a win. Otherwise,
  85          you probably want this.
  86
  87config BUSYBOX
  88        bool "Include busybox applet"
  89        default y
  90        help
  91          The busybox applet provides general help regarding busybox and
  92          allows the included applets to be listed.  It's also required
  93          if applet links are to be installed at runtime.
  94
  95          If you can live without these features disabling this will save
  96          some space.
  97
  98config FEATURE_INSTALLER
  99        bool "Support --install [-s] to install applet links at runtime"
 100        default y
 101        depends on BUSYBOX
 102        help
 103          Enable 'busybox --install [-s]' support. This will allow you to use
 104          busybox at runtime to create hard links or symlinks for all the
 105          applets that are compiled into busybox.
 106
 107config INSTALL_NO_USR
 108        bool "Don't use /usr"
 109        default n
 110        help
 111          Disable use of /usr. busybox --install and "make install"
 112          will install applets only to /bin and /sbin,
 113          never to /usr/bin or /usr/sbin.
 114
 115config PAM
 116        bool "Support PAM (Pluggable Authentication Modules)"
 117        default n
 118        help
 119          Use PAM in some busybox applets (currently login and httpd) instead
 120          of direct access to password database.
 121
 122config LONG_OPTS
 123        bool "Support --long-options"
 124        default y
 125        help
 126          Enable this if you want busybox applets to use the gnu --long-option
 127          style, in addition to single character -a -b -c style options.
 128
 129config FEATURE_DEVPTS
 130        bool "Use the devpts filesystem for Unix98 PTYs"
 131        default y
 132        help
 133          Enable if you want BusyBox to use Unix98 PTY support. If enabled,
 134          busybox will use /dev/ptmx for the master side of the pseudoterminal
 135          and /dev/pts/<number> for the slave side. Otherwise, BSD style
 136          /dev/ttyp<number> will be used. To use this option, you should have
 137          devpts mounted.
 138
 139config FEATURE_CLEAN_UP
 140        bool "Clean up all memory before exiting (usually not needed)"
 141        default n
 142        help
 143          As a size optimization, busybox normally exits without explicitly
 144          freeing dynamically allocated memory or closing files. This saves
 145          space since the OS will clean up for us, but it can confuse debuggers
 146          like valgrind, which report tons of memory and resource leaks.
 147
 148          Don't enable this unless you have a really good reason to clean
 149          things up manually.
 150
 151config FEATURE_UTMP
 152        bool "Support utmp file"
 153        default y
 154        help
 155          The file /var/run/utmp is used to track who is currently logged in.
 156          With this option on, certain applets (getty, login, telnetd etc)
 157          will create and delete entries there.
 158          "who" applet requires this option.
 159
 160config FEATURE_WTMP
 161        bool "Support wtmp file"
 162        default y
 163        depends on FEATURE_UTMP
 164        help
 165          The file /var/run/wtmp is used to track when users have logged into
 166          and logged out of the system.
 167          With this option on, certain applets (getty, login, telnetd etc)
 168          will append new entries there.
 169          "last" applet requires this option.
 170
 171config FEATURE_PIDFILE
 172        bool "Support writing pidfiles"
 173        default y
 174        help
 175          This option makes some applets (e.g. crond, syslogd, inetd) write
 176          a pidfile at the configured PID_FILE_PATH.  It has no effect
 177          on applets which require pidfiles to run.
 178
 179config PID_FILE_PATH
 180        string "Path to directory for pidfile"
 181        default "/var/run"
 182        depends on FEATURE_PIDFILE
 183        help
 184          This is the default path where pidfiles are created.  Applets which
 185          allow you to set the pidfile path on the command line will override
 186          this value.  The option has no effect on applets that require you to
 187          specify a pidfile path.
 188
 189config FEATURE_SUID
 190        bool "Support SUID/SGID handling"
 191        default y
 192        help
 193          With this option you can install the busybox binary belonging
 194          to root with the suid bit set, enabling some applets to perform
 195          root-level operations even when run by ordinary users
 196          (for example, mounting of user mounts in fstab needs this).
 197
 198          Busybox will automatically drop privileges for applets
 199          that don't need root access.
 200
 201          If you are really paranoid and don't want to do this, build two
 202          busybox binaries with different applets in them (and the appropriate
 203          symlinks pointing to each binary), and only set the suid bit on the
 204          one that needs it.
 205
 206          The applets which require root rights (need suid bit or
 207          to be run by root) and will refuse to execute otherwise:
 208          crontab, login, passwd, su, vlock, wall.
 209
 210          The applets which will use root rights if they have them
 211          (via suid bit, or because run by root), but would try to work
 212          without root right nevertheless:
 213          findfs, ping[6], traceroute[6], mount.
 214
 215          Note that if you DONT select this option, but DO make busybox
 216          suid root, ALL applets will run under root, which is a huge
 217          security hole (think "cp /some/file /etc/passwd").
 218
 219config FEATURE_SUID_CONFIG
 220        bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
 221        default y
 222        depends on FEATURE_SUID
 223        help
 224          Allow the SUID / SGID state of an applet to be determined at runtime
 225          by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
 226          The format of this file is as follows:
 227
 228          APPLET = [Ssx-][Ssx-][x-] [USER.GROUP]
 229
 230          s: USER or GROUP is allowed to execute APPLET.
 231             APPLET will run under USER or GROUP
 232             (reagardless of who's running it).
 233          S: USER or GROUP is NOT allowed to execute APPLET.
 234             APPLET will run under USER or GROUP.
 235             This option is not very sensical.
 236          x: USER/GROUP/others are allowed to execute APPLET.
 237             No UID/GID change will be done when it is run.
 238          -: USER/GROUP/others are not allowed to execute APPLET.
 239
 240          An example might help:
 241
 242          [SUID]
 243          su = ssx root.0 # applet su can be run by anyone and runs with
 244                          # euid=0/egid=0
 245          su = ssx        # exactly the same
 246
 247          mount = sx- root.disk # applet mount can be run by root and members
 248                                # of group disk (but not anyone else)
 249                                # and runs with euid=0 (egid is not changed)
 250
 251          cp = --- # disable applet cp for everyone
 252
 253          The file has to be owned by user root, group root and has to be
 254          writeable only by root:
 255                (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
 256          The busybox executable has to be owned by user root, group
 257          root and has to be setuid root for this to work:
 258                (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
 259
 260          Robert 'sandman' Griebl has more information here:
 261          <url: http://www.softforge.de/bb/suid.html >.
 262
 263config FEATURE_SUID_CONFIG_QUIET
 264        bool "Suppress warning message if /etc/busybox.conf is not readable"
 265        default y
 266        depends on FEATURE_SUID_CONFIG
 267        help
 268          /etc/busybox.conf should be readable by the user needing the SUID,
 269          check this option to avoid users to be notified about missing
 270          permissions.
 271
 272config SELINUX
 273        bool "Support NSA Security Enhanced Linux"
 274        default n
 275        select PLATFORM_LINUX
 276        help
 277          Enable support for SELinux in applets ls, ps, and id. Also provide
 278          the option of compiling in SELinux applets.
 279
 280          If you do not have a complete SELinux userland installed, this stuff
 281          will not compile.  Specifially, libselinux 1.28 or better is
 282          directly required by busybox. If the installation is located in a
 283          non-standard directory, provide it by invoking make as follows:
 284                CFLAGS=-I<libselinux-include-path> \
 285                LDFLAGS=-L<libselinux-lib-path> \
 286                make
 287
 288          Most people will leave this set to 'N'.
 289
 290config FEATURE_PREFER_APPLETS
 291        bool "exec prefers applets"
 292        default n
 293        help
 294          This is an experimental option which directs applets about to
 295          call 'exec' to try and find an applicable busybox applet before
 296          searching the PATH. This is typically done by exec'ing
 297          /proc/self/exe.
 298          This may affect shell, find -exec, xargs and similar applets.
 299          They will use applets even if /bin/<applet> -> busybox link
 300          is missing (or is not a link to busybox). However, this causes
 301          problems in chroot jails without mounted /proc and with ps/top
 302          (command name can be shown as 'exe' for applets started this way).
 303
 304config BUSYBOX_EXEC_PATH
 305        string "Path to BusyBox executable"
 306        default "/proc/self/exe"
 307        help
 308          When Busybox applets need to run other busybox applets, BusyBox
 309          sometimes needs to exec() itself. When the /proc filesystem is
 310          mounted, /proc/self/exe always points to the currently running
 311          executable. If you haven't got /proc, set this to wherever you
 312          want to run BusyBox from.
 313
 314# These are auto-selected by other options
 315
 316config FEATURE_SYSLOG
 317        bool #No description makes it a hidden option
 318        default n
 319        #help
 320        #  This option is auto-selected when you select any applet which may
 321        #  send its output to syslog. You do not need to select it manually.
 322
 323config FEATURE_HAVE_RPC
 324        bool #No description makes it a hidden option
 325        default n
 326        #help
 327        #  This is automatically selected if any of enabled applets need it.
 328        #  You do not need to select it manually.
 329
 330config PLATFORM_LINUX
 331        bool #No description makes it a hidden option
 332        default n
 333        #help
 334        #  For the most part, busybox requires only POSIX compatibility
 335        #  from the target system, but some applets and features use
 336        #  Linux-specific interfaces.
 337        #
 338        #  This is automatically selected if any applet or feature requires
 339        #  Linux-specific interfaces. You do not need to select it manually.
 340
 341comment 'Build Options'
 342
 343config STATIC
 344        bool "Build BusyBox as a static binary (no shared libs)"
 345        default n
 346        help
 347          If you want to build a static BusyBox binary, which does not
 348          use or require any shared libraries, then enable this option.
 349          This can cause BusyBox to be considerably larger, so you should
 350          leave this option false unless you have a good reason (i.e.
 351          your target platform does not support shared libraries, or
 352          you are building an initrd which doesn't need anything but
 353          BusyBox, etc).
 354
 355          Most people will leave this set to 'N'.
 356
 357config PIE
 358        bool "Build BusyBox as a position independent executable"
 359        default n
 360        depends on !STATIC
 361        help
 362          Hardened code option. PIE binaries are loaded at a different
 363          address at each invocation. This has some overhead,
 364          particularly on x86-32 which is short on registers.
 365
 366          Most people will leave this set to 'N'.
 367
 368config NOMMU
 369        bool "Force NOMMU build"
 370        default n
 371        help
 372          Busybox tries to detect whether architecture it is being
 373          built against supports MMU or not. If this detection fails,
 374          or if you want to build NOMMU version of busybox for testing,
 375          you may force NOMMU build here.
 376
 377          Most people will leave this set to 'N'.
 378
 379# PIE can be made to work with BUILD_LIBBUSYBOX, but currently
 380# build system does not support that
 381config BUILD_LIBBUSYBOX
 382        bool "Build shared libbusybox"
 383        default n
 384        depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
 385        help
 386          Build a shared library libbusybox.so.N.N.N which contains all
 387          busybox code.
 388
 389          This feature allows every applet to be built as a tiny
 390          separate executable. Enabling it for "one big busybox binary"
 391          approach serves no purpose and increases code size.
 392          You should almost certainly say "no" to this.
 393
 394### config FEATURE_FULL_LIBBUSYBOX
 395###     bool "Feature-complete libbusybox"
 396###     default n if !FEATURE_SHARED_BUSYBOX
 397###     depends on BUILD_LIBBUSYBOX
 398###     help
 399###       Build a libbusybox with the complete feature-set, disregarding
 400###       the actually selected config.
 401###
 402###       Normally, libbusybox will only contain the features which are
 403###       used by busybox itself. If you plan to write a separate
 404###       standalone application which uses libbusybox say 'Y'.
 405###
 406###       Note: libbusybox is GPL, not LGPL, and exports no stable API that
 407###       might act as a copyright barrier. We can and will modify the
 408###       exported function set between releases (even minor version number
 409###       changes), and happily break out-of-tree features.
 410###
 411###       Say 'N' if in doubt.
 412
 413config FEATURE_INDIVIDUAL
 414        bool "Produce a binary for each applet, linked against libbusybox"
 415        default y
 416        depends on BUILD_LIBBUSYBOX
 417        help
 418          If your CPU architecture doesn't allow for sharing text/rodata
 419          sections of running binaries, but allows for runtime dynamic
 420          libraries, this option will allow you to reduce memory footprint
 421          when you have many different applets running at once.
 422
 423          If your CPU architecture allows for sharing text/rodata,
 424          having single binary is more optimal.
 425
 426          Each applet will be a tiny program, dynamically linked
 427          against libbusybox.so.N.N.N.
 428
 429          You need to have a working dynamic linker.
 430
 431config FEATURE_SHARED_BUSYBOX
 432        bool "Produce additional busybox binary linked against libbusybox"
 433        default y
 434        depends on BUILD_LIBBUSYBOX
 435        help
 436          Build busybox, dynamically linked against libbusybox.so.N.N.N.
 437
 438          You need to have a working dynamic linker.
 439
 440### config BUILD_AT_ONCE
 441###     bool "Compile all sources at once"
 442###     default n
 443###     help
 444###       Normally each source-file is compiled with one invocation of
 445###       the compiler.
 446###       If you set this option, all sources are compiled at once.
 447###       This gives the compiler more opportunities to optimize which can
 448###       result in smaller and/or faster binaries.
 449###
 450###       Setting this option will consume alot of memory, e.g. if you
 451###       enable all applets with all features, gcc uses more than 300MB
 452###       RAM during compilation of busybox.
 453###
 454###       This option is most likely only beneficial for newer compilers
 455###       such as gcc-4.1 and above.
 456###
 457###       Say 'N' unless you know what you are doing.
 458
 459config LFS
 460        bool "Build with Large File Support (for accessing files > 2 GB)"
 461        default y
 462        help
 463          If you want to build BusyBox with large file support, then enable
 464          this option. This will have no effect if your kernel or your C
 465          library lacks large file support for large files. Some of the
 466          programs that can benefit from large file support include dd, gzip,
 467          cp, mount, tar, and many others. If you want to access files larger
 468          than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
 469
 470config CROSS_COMPILER_PREFIX
 471        string "Cross Compiler prefix"
 472        default ""
 473        help
 474          If you want to build BusyBox with a cross compiler, then you
 475          will need to set this to the cross-compiler prefix, for example,
 476          "i386-uclibc-".
 477
 478          Note that CROSS_COMPILE environment variable or
 479          "make CROSS_COMPILE=xxx ..." will override this selection.
 480
 481          Native builds leave this empty.
 482
 483config SYSROOT
 484        string "Path to sysroot"
 485        default ""
 486        help
 487          If you want to build BusyBox with a cross compiler, then you
 488          might also need to specify where /usr/include and /usr/lib
 489          will be found.
 490
 491          For example, BusyBox can be built against an installed
 492          Android NDK, platform version 9, for ARM ABI with
 493
 494          CONFIG_SYSROOT=/opt/android-ndk/platforms/android-9/arch-arm
 495
 496          Native builds leave this empty.
 497
 498config EXTRA_CFLAGS
 499        string "Additional CFLAGS"
 500        default ""
 501        help
 502          Additional CFLAGS to pass to the compiler verbatim.
 503
 504config EXTRA_LDFLAGS
 505        string "Additional LDFLAGS"
 506        default ""
 507        help
 508          Additional LDFLAGS to pass to the linker verbatim.
 509
 510config EXTRA_LDLIBS
 511        string "Additional LDLIBS"
 512        default ""
 513        help
 514          Additional LDLIBS to pass to the linker with -l.
 515
 516comment 'Installation Options ("make install" behavior)'
 517
 518choice
 519        prompt "What kind of applet links to install"
 520        default INSTALL_APPLET_SYMLINKS
 521        help
 522          Choose what kind of links to applets are created by "make install".
 523
 524config INSTALL_APPLET_SYMLINKS
 525        bool "as soft-links"
 526        help
 527          Install applets as soft-links to the busybox binary. This needs some
 528          free inodes on the filesystem, but might help with filesystem
 529          generators that can't cope with hard-links.
 530
 531config INSTALL_APPLET_HARDLINKS
 532        bool "as hard-links"
 533        help
 534          Install applets as hard-links to the busybox binary. This might
 535          count on a filesystem with few inodes.
 536
 537config INSTALL_APPLET_SCRIPT_WRAPPERS
 538        bool "as script wrappers"
 539        help
 540          Install applets as script wrappers that call the busybox binary.
 541
 542config INSTALL_APPLET_DONT
 543        bool "not installed"
 544        help
 545          Do not install applet links. Useful when you plan to use
 546          busybox --install for installing links, or plan to use
 547          a standalone shell and thus don't need applet links.
 548
 549endchoice
 550
 551choice
 552        prompt "/bin/sh applet link"
 553        default INSTALL_SH_APPLET_SYMLINK
 554        depends on INSTALL_APPLET_SCRIPT_WRAPPERS
 555        help
 556          Choose how you install /bin/sh applet link.
 557
 558config INSTALL_SH_APPLET_SYMLINK
 559        bool "as soft-link"
 560        help
 561          Install /bin/sh applet as soft-link to the busybox binary.
 562
 563config INSTALL_SH_APPLET_HARDLINK
 564        bool "as hard-link"
 565        help
 566          Install /bin/sh applet as hard-link to the busybox binary.
 567
 568config INSTALL_SH_APPLET_SCRIPT_WRAPPER
 569        bool "as script wrapper"
 570        help
 571          Install /bin/sh applet as script wrapper that calls
 572          the busybox binary.
 573
 574endchoice
 575
 576config PREFIX
 577        string "BusyBox installation prefix"
 578        default "./_install"
 579        help
 580          Define your directory to install BusyBox files/subdirs in.
 581
 582comment 'Debugging Options'
 583
 584config DEBUG
 585        bool "Build BusyBox with extra Debugging symbols"
 586        default n
 587        help
 588          Say Y here if you wish to examine BusyBox internals while applets are
 589          running. This increases the size of the binary considerably, and
 590          should only be used when doing development. If you are doing
 591          development and want to debug BusyBox, answer Y.
 592
 593          Most people should answer N.
 594
 595config DEBUG_PESSIMIZE
 596        bool "Disable compiler optimizations"
 597        default n
 598        depends on DEBUG
 599        help
 600          The compiler's optimization of source code can eliminate and reorder
 601          code, resulting in an executable that's hard to understand when
 602          stepping through it with a debugger. This switches it off, resulting
 603          in a much bigger executable that more closely matches the source
 604          code.
 605
 606config DEBUG_SANITIZE
 607        bool "Enable runtime sanitizers (ASAN/LSAN/USAN/etc...)"
 608        default n
 609        help
 610          Say Y here if you want to enable runtime sanitizers. These help
 611          catch bad memory accesses (e.g. buffer overflows), but will make
 612          the executable larger and slow down runtime a bit.
 613
 614          This adds -fsanitize=foo options to gcc command line.
 615
 616          If you aren't developing/testing busybox, say N here.
 617
 618config UNIT_TEST
 619        bool "Build unit tests"
 620        default n
 621        help
 622          Say Y here if you want to build unit tests (both the framework and
 623          test cases) as a Busybox applet. This results in bigger code, so you
 624          probably don't want this option in production builds.
 625
 626config WERROR
 627        bool "Abort compilation on any warning"
 628        default n
 629        help
 630          This adds -Werror to gcc command line.
 631
 632          Most people should answer N.
 633
 634choice
 635        prompt "Additional debugging library"
 636        default NO_DEBUG_LIB
 637        help
 638          Using an additional debugging library will make BusyBox become
 639          considerable larger and will cause it to run more slowly. You
 640          should always leave this option disabled for production use.
 641
 642          dmalloc support:
 643          ----------------
 644          This enables compiling with dmalloc ( http://dmalloc.com/ )
 645          which is an excellent public domain mem leak and malloc problem
 646          detector. To enable dmalloc, before running busybox you will
 647          want to properly set your environment, for example:
 648            export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
 649          The 'debug=' value is generated using the following command
 650            dmalloc -p log-stats -p log-non-free -p log-bad-space \
 651               -p log-elapsed-time -p check-fence -p check-heap \
 652               -p check-lists -p check-blank -p check-funcs -p realloc-copy \
 653               -p allow-free-null
 654
 655          Electric-fence support:
 656          -----------------------
 657          This enables compiling with Electric-fence support. Electric
 658          fence is another very useful malloc debugging library which uses
 659          your computer's virtual memory hardware to detect illegal memory
 660          accesses. This support will make BusyBox be considerable larger
 661          and run slower, so you should leave this option disabled unless
 662          you are hunting a hard to find memory problem.
 663
 664
 665config NO_DEBUG_LIB
 666        bool "None"
 667
 668config DMALLOC
 669        bool "Dmalloc"
 670
 671config EFENCE
 672        bool "Electric-fence"
 673
 674endchoice
 675
 676endmenu
 677
 678source libbb/Config.in
 679
 680comment "Applets"
 681
 682source archival/Config.in
 683source coreutils/Config.in
 684source console-tools/Config.in
 685source debianutils/Config.in
 686source editors/Config.in
 687source findutils/Config.in
 688source init/Config.in
 689source loginutils/Config.in
 690source e2fsprogs/Config.in
 691source modutils/Config.in
 692source util-linux/Config.in
 693source miscutils/Config.in
 694source networking/Config.in
 695source printutils/Config.in
 696source mailutils/Config.in
 697source procps/Config.in
 698source runit/Config.in
 699source selinux/Config.in
 700source shell/Config.in
 701source sysklogd/Config.in
 702