Config.in

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