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 SUBST_WCHAR
 145         int "Character code to substitute unprintable characters with"
 146         depends on FEATURE_ASSUME_UNICODE
 147         default 63
 148         help
 149           Typical values are 63 for '?' (works with any output device),
 150           30 for ASCII substitute control code,
 151           65533 (0xfffd) for Unicode replacement character.
 152
 153 config LAST_SUPPORTED_WCHAR
 154         int "Range of supported Unicode characters"
 155         depends on FEATURE_ASSUME_UNICODE
 156         default 767
 157         help
 158           Any character with Unicode value bigger than this is assumed
 159           to be non-printable on output device. Many applets replace
 160           such chars with substitution character.
 161
 162           The idea is that many valid printable Unicode chars are
 163           nevertheless are not displayed correctly. Think about
 164           combining charachers, double-wide hieroglyphs and such.
 165           Many terminals, xterms and such will fail to handle them
 166           correctly.
 167
 168           Typical values are:
 169           126 - ASCII only
 170           767 (0x2ff) - there are no combining chars in [0..767] range
 171                         (the range includes Latin 1, Latin Ext. A and B),
 172                         code is ~700 bytes smaller for this case.
 173           4351 (0x10ff) - there are no double-wide chars in [0..4351] range,
 174                         code is ~300 bytes smaller for this case.
 175           0 - off, any valid printable Unicode character will be printed.
 176
 177 config UNICODE_COMBINING_WCHARS
 178         bool "Allow zero-width Unicode characters on output"
 179         default n
 180         depends on FEATURE_ASSUME_UNICODE
 181         help
 182           With this option off, any Unicode char with width of 0
 183           is substituted on output.
 184
 185 config UNICODE_WIDE_WCHARS
 186         bool "Allow wide Unicode characters on output"
 187         default n
 188         depends on FEATURE_ASSUME_UNICODE
 189         help
 190           With this option off, any Unicode char with width > 1
 191           is substituted on output.
 192
 193 config LONG_OPTS
 194         bool "Support for --long-options"
 195         default y
 196         help
 197           Enable this if you want busybox applets to use the gnu --long-option
 198           style, in addition to single character -a -b -c style options.
 199
 200 config FEATURE_DEVPTS
 201         bool "Use the devpts filesystem for Unix98 PTYs"
 202         default y
 203         help
 204           Enable if you want BusyBox to use Unix98 PTY support. If enabled,
 205           busybox will use /dev/ptmx for the master side of the pseudoterminal
 206           and /dev/pts/<number> for the slave side. Otherwise, BSD style
 207           /dev/ttyp<number> will be used. To use this option, you should have
 208           devpts mounted.
 209
 210 config FEATURE_CLEAN_UP
 211         bool "Clean up all memory before exiting (usually not needed)"
 212         default n
 213         help
 214           As a size optimization, busybox normally exits without explicitly
 215           freeing dynamically allocated memory or closing files. This saves
 216           space since the OS will clean up for us, but it can confuse debuggers
 217           like valgrind, which report tons of memory and resource leaks.
 218
 219           Don't enable this unless you have a really good reason to clean
 220           things up manually.
 221
 222 config FEATURE_PIDFILE
 223         bool "Support writing pidfiles"
 224         default n
 225         help
 226           This option makes some applets (e.g. crond, syslogd, inetd) write
 227           a pidfile in /var/run. Some applications rely on them.
 228
 229 config FEATURE_SUID
 230         bool "Support for SUID/SGID handling"
 231         default n
 232         help
 233           With this option you can install the busybox binary belonging
 234           to root with the suid bit set, and it will automatically drop
 235           priviledges for applets that don't need root access.
 236
 237           If you are really paranoid and don't want to do this, build two
 238           busybox binaries with different applets in them (and the appropriate
 239           symlinks pointing to each binary), and only set the suid bit on the
 240           one that needs it. The applets currently marked to need the suid bit
 241           are:
 242
 243           crontab, dnsd, findfs, ipcrm, ipcs, login, passwd, ping, su,
 244           traceroute, vlock.
 245
 246 config FEATURE_SUID_CONFIG
 247         bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
 248         default n if FEATURE_SUID
 249         depends on FEATURE_SUID
 250         help
 251           Allow the SUID / SGID state of an applet to be determined at runtime
 252           by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
 253           The format of this file is as follows:
 254
 255           <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
 256
 257           An example might help:
 258
 259           [SUID]
 260           su = ssx root.0 # applet su can be run by anyone and runs with
 261                           # euid=0/egid=0
 262           su = ssx        # exactly the same
 263
 264           mount = sx- root.disk # applet mount can be run by root and members
 265                                 # of group disk and runs with euid=0
 266
 267           cp = --- # disable applet cp for everyone
 268
 269           The file has to be owned by user root, group root and has to be
 270           writeable only by root:
 271                 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
 272           The busybox executable has to be owned by user root, group
 273           root and has to be setuid root for this to work:
 274                 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
 275
 276           Robert 'sandman' Griebl has more information here:
 277           <url: http://www.softforge.de/bb/suid.html >.
 278
 279 config FEATURE_SUID_CONFIG_QUIET
 280         bool "Suppress warning message if /etc/busybox.conf is not readable"
 281         default y
 282         depends on FEATURE_SUID_CONFIG
 283         help
 284           /etc/busybox.conf should be readable by the user needing the SUID,
 285           check this option to avoid users to be notified about missing
 286           permissions.
 287
 288 config SELINUX
 289         bool "Support NSA Security Enhanced Linux"
 290         default n
 291         help
 292           Enable support for SELinux in applets ls, ps, and id. Also provide
 293           the option of compiling in SELinux applets.
 294
 295           If you do not have a complete SELinux userland installed, this stuff
 296           will not compile. Go visit
 297                 http://www.nsa.gov/selinux/index.html
 298           to download the necessary stuff to allow busybox to compile with
 299           this option enabled. Specifially, libselinux 1.28 or better is
 300           directly required by busybox. If the installation is located in a
 301           non-standard directory, provide it by invoking make as follows:
 302                 CFLAGS=-I<libselinux-include-path> \
 303                 LDFLAGS=-L<libselinux-lib-path> \
 304                 make
 305
 306           Most people will leave this set to 'N'.
 307
 308 config FEATURE_PREFER_APPLETS
 309         bool "exec prefers applets"
 310         default n
 311         help
 312           This is an experimental option which directs applets about to
 313           call 'exec' to try and find an applicable busybox applet before
 314           searching the PATH. This is typically done by exec'ing
 315           /proc/self/exe.
 316           This may affect shell, find -exec, xargs and similar applets.
 317           They will use applets even if /bin/<applet> -> busybox link
 318           is missing (or is not a link to busybox). However, this causes
 319           problems in chroot jails without mounted /proc and with ps/top
 320           (command name can be shown as 'exe' for applets started this way).
 321
 322 config BUSYBOX_EXEC_PATH
 323         string "Path to BusyBox executable"
 324         default "/proc/self/exe"
 325         help
 326           When Busybox applets need to run other busybox applets, BusyBox
 327           sometimes needs to exec() itself. When the /proc filesystem is
 328           mounted, /proc/self/exe always points to the currently running
 329           executable. If you haven't got /proc, set this to wherever you
 330           want to run BusyBox from.
 331
 332 # These are auto-selected by other options
 333
 334 config FEATURE_SYSLOG
 335         bool #No description makes it a hidden option
 336         default n
 337         #help
 338         #  This option is auto-selected when you select any applet which may
 339         #  send its output to syslog. You do not need to select it manually.
 340
 341 config FEATURE_HAVE_RPC
 342         bool #No description makes it a hidden option
 343         default n
 344         #help
 345         #  This is automatically selected if any of enabled applets need it.
 346         #  You do not need to select it manually.
 347
 348 endmenu
 349
 350 menu 'Build Options'
 351
 352 config STATIC
 353         bool "Build BusyBox as a static binary (no shared libs)"
 354         default n
 355         help
 356           If you want to build a static BusyBox binary, which does not
 357           use or require any shared libraries, then enable this option.
 358           This can cause BusyBox to be considerably larger, so you should
 359           leave this option false unless you have a good reason (i.e.
 360           your target platform does not support shared libraries, or
 361           you are building an initrd which doesn't need anything but
 362           BusyBox, etc).
 363
 364           Most people will leave this set to 'N'.
 365
 366 config PIE
 367         bool "Build BusyBox as a position independent executable"
 368         default n
 369         depends on !STATIC
 370         help
 371           (TODO: what is it and why/when is it useful?)
 372           Most people will leave this set to 'N'.
 373
 374 config NOMMU
 375         bool "Force NOMMU build"
 376         default n
 377         help
 378           Busybox tries to detect whether architecture it is being
 379           built against supports MMU or not. If this detection fails,
 380           or if you want to build NOMMU version of busybox for testing,
 381           you may force NOMMU build here.
 382
 383           Most people will leave this set to 'N'.
 384
 385 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
 386 # build system does not support that
 387 config BUILD_LIBBUSYBOX
 388         bool "Build shared libbusybox"
 389         default n
 390         depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
 391         help
 392           Build a shared library libbusybox.so.N.N.N which contains all
 393           busybox code.
 394
 395           This feature allows every applet to be built as a tiny
 396           separate executable. Enabling it for "one big busybox binary"
 397           approach serves no purpose and increases code size.
 398           You should almost certainly say "no" to this.
 399
 400 ### config FEATURE_FULL_LIBBUSYBOX
 401 ###     bool "Feature-complete libbusybox"
 402 ###     default n if !FEATURE_SHARED_BUSYBOX
 403 ###     depends on BUILD_LIBBUSYBOX
 404 ###     help
 405 ###       Build a libbusybox with the complete feature-set, disregarding
 406 ###       the actually selected config.
 407 ###
 408 ###       Normally, libbusybox will only contain the features which are
 409 ###       used by busybox itself. If you plan to write a separate
 410 ###       standalone application which uses libbusybox say 'Y'.
 411 ###
 412 ###       Note: libbusybox is GPL, not LGPL, and exports no stable API that
 413 ###       might act as a copyright barrier. We can and will modify the
 414 ###       exported function set between releases (even minor version number
 415 ###       changes), and happily break out-of-tree features.
 416 ###
 417 ###       Say 'N' if in doubt.
 418
 419 config FEATURE_INDIVIDUAL
 420         bool "Produce a binary for each applet, linked against libbusybox"
 421         default y
 422         depends on BUILD_LIBBUSYBOX
 423         help
 424           If your CPU architecture doesn't allow for sharing text/rodata
 425           sections of running binaries, but allows for runtime dynamic
 426           libraries, this option will allow you to reduce memory footprint
 427           when you have many different applets running at once.
 428
 429           If your CPU architecture allows for sharing text/rodata,
 430           having single binary is more optimal.
 431
 432           Each applet will be a tiny program, dynamically linked
 433           against libbusybox.so.N.N.N.
 434
 435           You need to have a working dynamic linker.
 436
 437 config FEATURE_SHARED_BUSYBOX
 438         bool "Produce additional busybox binary linked against libbusybox"
 439         default y
 440         depends on BUILD_LIBBUSYBOX
 441         help
 442           Build busybox, dynamically linked against libbusybox.so.N.N.N.
 443
 444           You need to have a working dynamic linker.
 445
 446 ### config BUILD_AT_ONCE
 447 ###     bool "Compile all sources at once"
 448 ###     default n
 449 ###     help
 450 ###       Normally each source-file is compiled with one invocation of
 451 ###       the compiler.
 452 ###       If you set this option, all sources are compiled at once.
 453 ###       This gives the compiler more opportunities to optimize which can
 454 ###       result in smaller and/or faster binaries.
 455 ###
 456 ###       Setting this option will consume alot of memory, e.g. if you
 457 ###       enable all applets with all features, gcc uses more than 300MB
 458 ###       RAM during compilation of busybox.
 459 ###
 460 ###       This option is most likely only beneficial for newer compilers
 461 ###       such as gcc-4.1 and above.
 462 ###
 463 ###       Say 'N' unless you know what you are doing.
 464
 465 config LFS
 466         bool "Build with Large File Support (for accessing files > 2 GB)"
 467         default n
 468         select FDISK_SUPPORT_LARGE_DISKS
 469         help
 470           If you want to build BusyBox with large file support, then enable
 471           this option. This will have no effect if your kernel or your C
 472           library lacks large file support for large files. Some of the
 473           programs that can benefit from large file support include dd, gzip,
 474           cp, mount, tar, and many others. If you want to access files larger
 475           than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
 476
 477 config CROSS_COMPILER_PREFIX
 478         string "Cross Compiler prefix"
 479         default ""
 480         help
 481           If you want to build BusyBox with a cross compiler, then you
 482           will need to set this to the cross-compiler prefix, for example,
 483           "i386-uclibc-".
 484
 485           Note that CROSS_COMPILE environment variable or
 486           "make CROSS_COMPILE=xxx ..." will override this selection.
 487
 488           Native builds leave this empty.
 489
 490 config EXTRA_CFLAGS
 491         string "Additional CFLAGS"
 492         default ""
 493         help
 494           Additional CFLAGS to pass to the compiler verbatim.
 495
 496 endmenu
 497
 498 menu 'Debugging Options'
 499
 500 config DEBUG
 501         bool "Build BusyBox with extra Debugging symbols"
 502         default n
 503         help
 504           Say Y here if you wish to examine BusyBox internals while applets are
 505           running. This increases the size of the binary considerably, and
 506           should only be used when doing development. If you are doing
 507           development and want to debug BusyBox, answer Y.
 508
 509           Most people should answer N.
 510
 511 config DEBUG_PESSIMIZE
 512         bool "Disable compiler optimizations"
 513         default n
 514         depends on DEBUG
 515         help
 516           The compiler's optimization of source code can eliminate and reorder
 517           code, resulting in an executable that's hard to understand when
 518           stepping through it with a debugger. This switches it off, resulting
 519           in a much bigger executable that more closely matches the source
 520           code.
 521
 522 config WERROR
 523         bool "Abort compilation on any warning"
 524         default n
 525         help
 526           Selecting this will add -Werror to gcc command line.
 527
 528           Most people should answer N.
 529
 530 choice
 531         prompt "Additional debugging library"
 532         default NO_DEBUG_LIB
 533         help
 534           Using an additional debugging library will make BusyBox become
 535           considerable larger and will cause it to run more slowly. You
 536           should always leave this option disabled for production use.
 537
 538           dmalloc support:
 539           ----------------
 540           This enables compiling with dmalloc ( http://dmalloc.com/ )
 541           which is an excellent public domain mem leak and malloc problem
 542           detector. To enable dmalloc, before running busybox you will
 543           want to properly set your environment, for example:
 544             export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
 545           The 'debug=' value is generated using the following command
 546             dmalloc -p log-stats -p log-non-free -p log-bad-space \
 547                -p log-elapsed-time -p check-fence -p check-heap \
 548                -p check-lists -p check-blank -p check-funcs -p realloc-copy \
 549                -p allow-free-null
 550
 551           Electric-fence support:
 552           -----------------------
 553           This enables compiling with Electric-fence support. Electric
 554           fence is another very useful malloc debugging library which uses
 555           your computer's virtual memory hardware to detect illegal memory
 556           accesses. This support will make BusyBox be considerable larger
 557           and run slower, so you should leave this option disabled unless
 558           you are hunting a hard to find memory problem.
 559
 560
 561 config NO_DEBUG_LIB
 562         bool "None"
 563
 564 config DMALLOC
 565         bool "Dmalloc"
 566
 567 config EFENCE
 568         bool "Electric-fence"
 569
 570 endchoice
 571
 572 ### config PARSE
 573 ###     bool "Uniform config file parser debugging applet: parse"
 574
 575 endmenu
 576
 577 menu 'Installation Options'
 578
 579 config INSTALL_NO_USR
 580         bool "Don't use /usr"
 581         default n
 582         help
 583           Disable use of /usr. Don't activate this option if you don't know
 584           that you really want this behaviour.
 585
 586 choice
 587         prompt "Applets links"
 588         default INSTALL_APPLET_SYMLINKS
 589         help
 590           Choose how you install applets links.
 591
 592 config INSTALL_APPLET_SYMLINKS
 593         bool "as soft-links"
 594         help
 595           Install applets as soft-links to the busybox binary. This needs some
 596           free inodes on the filesystem, but might help with filesystem
 597           generators that can't cope with hard-links.
 598
 599 config INSTALL_APPLET_HARDLINKS
 600         bool "as hard-links"
 601         help
 602           Install applets as hard-links to the busybox binary. This might
 603           count on a filesystem with few inodes.
 604
 605 config INSTALL_APPLET_SCRIPT_WRAPPERS
 606         bool "as script wrappers"
 607         help
 608           Install applets as script wrappers that call the busybox binary.
 609
 610 config INSTALL_APPLET_DONT
 611         bool "not installed"
 612         depends on FEATURE_INSTALLER || FEATURE_SH_STANDALONE || FEATURE_PREFER_APPLETS
 613         help
 614           Do not install applet links. Useful when using the -install feature
 615           or a standalone shell for rescue purposes.
 616
 617 endchoice
 618
 619 choice
 620         prompt "/bin/sh applet link"
 621         default INSTALL_SH_APPLET_SYMLINK
 622         depends on INSTALL_APPLET_SCRIPT_WRAPPERS
 623         help
 624           Choose how you install /bin/sh applet link.
 625
 626 config INSTALL_SH_APPLET_SYMLINK
 627         bool "as soft-link"
 628         help
 629           Install /bin/sh applet as soft-link to the busybox binary.
 630
 631 config INSTALL_SH_APPLET_HARDLINK
 632         bool "as hard-link"
 633         help
 634           Install /bin/sh applet as hard-link to the busybox binary.
 635
 636 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
 637         bool "as script wrapper"
 638         help
 639           Install /bin/sh applet as script wrapper that call the busybox
 640           binary.
 641
 642 endchoice
 643
 644 config PREFIX
 645         string "BusyBox installation prefix"
 646         default "./_install"
 647         help
 648           Define your directory to install BusyBox files/subdirs in.
 649
 650 endmenu
 651
 652 source libbb/Config.in
 653
 654 endmenu
 655
 656 comment "Applets"
 657
 658 source archival/Config.in
 659 source coreutils/Config.in
 660 source console-tools/Config.in
 661 source debianutils/Config.in
 662 source editors/Config.in
 663 source findutils/Config.in
 664 source init/Config.in
 665 source loginutils/Config.in
 666 source e2fsprogs/Config.in
 667 source modutils/Config.in
 668 source util-linux/Config.in
 669 source miscutils/Config.in
 670 source networking/Config.in
 671 source printutils/Config.in
 672 source mailutils/Config.in
 673 source procps/Config.in
 674 source runit/Config.in
 675 source selinux/Config.in
 676 source shell/Config.in
 677 source sysklogd/Config.in