2 # For a description of the syntax of this configuration file,
3 # see scripts/kbuild/config-language.txt.
6 mainmenu "BusyBox Configuration"
12 menu "Busybox Settings"
14 menu "General Configuration"
17 bool "Enable options for full-blown desktop systems"
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.
25 bool "Provide compatible behavior for rare corner cases (bigger code)"
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.
34 bool "Enable obsolete features removed before SUSv3"
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
42 config USE_PORTABLE_CODE
43 bool "Avoid using GCC-specific code constructs"
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.
51 bool "Enable Linux-specific applets and features"
54 For the most part, busybox requires only POSIX compatibility
55 from the target system, but some applets and features use
56 Linux-specific interfaces.
58 Answering 'N' here will disable such applets and hide the
59 corresponding configuration options.
62 prompt "Buffer allocation policy"
63 default FEATURE_BUFFERS_USE_MALLOC
65 There are 3 ways BusyBox can handle buffer allocations:
66 - Use malloc. This costs code size for the call to xmalloc.
67 - Put them on stack. For some very small machines with limited stack
68 space, this can be deadly. For most folks, this works just fine.
69 - Put them in BSS. This works beautifully for computers with a real
70 MMU (and OS support), but wastes runtime RAM for uCLinux. This
71 behavior was the only one available for BusyBox versions 0.48 and
74 config FEATURE_BUFFERS_USE_MALLOC
75 bool "Allocate with Malloc"
77 config FEATURE_BUFFERS_GO_ON_STACK
78 bool "Allocate on the Stack"
80 config FEATURE_BUFFERS_GO_IN_BSS
81 bool "Allocate in the .bss section"
86 bool "Show terse applet usage messages"
89 All BusyBox applets will show help messages when invoked with
90 wrong arguments. You can turn off printing these terse usage
91 messages if you say no here.
92 This will save you up to 7k.
94 config FEATURE_VERBOSE_USAGE
95 bool "Show verbose applet usage messages"
99 All BusyBox applets will show more verbose help messages when
100 busybox is invoked with --help. This will add a lot of text to the
101 busybox binary. In the default configuration, this will add about
102 13k, but it can add much more depending on your configuration.
104 config FEATURE_COMPRESS_USAGE
105 bool "Store applet usage messages in compressed form"
107 depends on SHOW_USAGE
109 Store usage messages in compressed form, uncompress them on-the-fly
110 when <applet> --help is called.
112 If you have a really tiny busybox with few applets enabled (and
113 bunzip2 isn't one of them), the overhead of the decompressor might
114 be noticeable. Also, if you run executables directly from ROM
115 and have very little memory, this might not be a win. Otherwise,
116 you probably want this.
118 config FEATURE_INSTALLER
119 bool "Support --install [-s] to install applet links at runtime"
122 Enable 'busybox --install [-s]' support. This will allow you to use
123 busybox at runtime to create hard links or symlinks for all the
124 applets that are compiled into busybox.
126 config LOCALE_SUPPORT
127 bool "Enable locale support (system needs locale for this to work)"
130 Enable this if your system has locale support and you would like
131 busybox to support locale settings.
133 config UNICODE_SUPPORT
134 bool "Support Unicode"
137 This makes various applets aware that one byte is not
138 one character on screen.
140 Busybox aims to eventually work correctly with Unicode displays.
141 Any older encodings are not guaranteed to work.
142 Probably by the time when busybox will be fully Unicode-clean,
143 other encodings will be mainly of historic interest.
145 config UNICODE_USING_LOCALE
146 bool "Use libc routines for Unicode (else uses internal ones)"
148 depends on UNICODE_SUPPORT && LOCALE_SUPPORT
150 With this option on, Unicode support is implemented using libc
151 routines. Otherwise, internal implementation is used.
152 Internal implementation is smaller.
154 config FEATURE_CHECK_UNICODE_IN_ENV
155 bool "Check $LANG environment variable"
157 depends on UNICODE_SUPPORT && !UNICODE_USING_LOCALE
159 With this option on, Unicode support is activated
160 only if LANG variable has the value of the form "xxxx.utf8"
162 Otherwise, Unicode support will be always enabled and active.
165 int "Character code to substitute unprintable characters with"
166 depends on UNICODE_SUPPORT
169 Typical values are 63 for '?' (works with any output device),
170 30 for ASCII substitute control code,
171 65533 (0xfffd) for Unicode replacement character.
173 config LAST_SUPPORTED_WCHAR
174 int "Range of supported Unicode characters"
175 depends on UNICODE_SUPPORT
178 Any character with Unicode value bigger than this is assumed
179 to be non-printable on output device. Many applets replace
180 such chars with substitution character.
182 The idea is that many valid printable Unicode chars are
183 nevertheless are not displayed correctly. Think about
184 combining charachers, double-wide hieroglyphs, obscure
185 characters in dozens of ancient scripts...
186 Many terminals, terminal emulators, xterms etc will fail
187 to handle them correctly. Choose the smallest value
188 which suits your needs.
192 767 (0x2ff) - there are no combining chars in [0..767] range
193 (the range includes Latin 1, Latin Ext. A and B),
194 code is ~700 bytes smaller for this case.
195 4351 (0x10ff) - there are no double-wide chars in [0..4351] range,
196 code is ~300 bytes smaller for this case.
197 12799 (0x31ff) - nearly all non-ideographic characters are
198 available in [0..12799] range, including
199 East Asian scripts like katakana, hiragana, hangul,
201 0 - off, any valid printable Unicode character will be printed.
203 config UNICODE_COMBINING_WCHARS
204 bool "Allow zero-width Unicode characters on output"
206 depends on UNICODE_SUPPORT
208 With this option off, any Unicode char with width of 0
209 is substituted on output.
211 config UNICODE_WIDE_WCHARS
212 bool "Allow wide Unicode characters on output"
214 depends on UNICODE_SUPPORT
216 With this option off, any Unicode char with width > 1
217 is substituted on output.
219 config UNICODE_BIDI_SUPPORT
220 bool "Bidirectional character-aware line input"
222 depends on UNICODE_SUPPORT && !UNICODE_USING_LOCALE
224 With this option on, right-to-left Unicode characters
225 are treated differently on input (e.g. cursor movement).
227 config UNICODE_NEUTRAL_TABLE
228 bool "In bidi input, support non-ASCII neutral chars too"
230 depends on UNICODE_BIDI_SUPPORT
232 In most cases it's enough to treat only ASCII non-letters
233 (i.e. punctuation, numbers and space) as characters
234 with neutral directionality.
235 With this option on, more extensive (and bigger) table
236 of neutral chars will be used.
238 config UNICODE_PRESERVE_BROKEN
239 bool "Make it possible to enter sequences of chars which are not Unicode"
241 depends on UNICODE_SUPPORT
243 With this option on, invalid UTF-8 bytes are not substituted
244 with the selected substitution character.
245 For example, this means that entering 'l', 's', ' ', 0xff, [Enter]
246 at shell prompt will list file named 0xff (single char name
247 with char value 255), not file named '?'.
250 bool "Support for --long-options"
253 Enable this if you want busybox applets to use the gnu --long-option
254 style, in addition to single character -a -b -c style options.
256 config FEATURE_DEVPTS
257 bool "Use the devpts filesystem for Unix98 PTYs"
260 Enable if you want BusyBox to use Unix98 PTY support. If enabled,
261 busybox will use /dev/ptmx for the master side of the pseudoterminal
262 and /dev/pts/<number> for the slave side. Otherwise, BSD style
263 /dev/ttyp<number> will be used. To use this option, you should have
266 config FEATURE_CLEAN_UP
267 bool "Clean up all memory before exiting (usually not needed)"
270 As a size optimization, busybox normally exits without explicitly
271 freeing dynamically allocated memory or closing files. This saves
272 space since the OS will clean up for us, but it can confuse debuggers
273 like valgrind, which report tons of memory and resource leaks.
275 Don't enable this unless you have a really good reason to clean
279 bool "Support utmp file"
282 The file /var/run/utmp is used to track who is currently logged in.
283 With this option on, certain applets (getty, login, telnetd etc)
284 will create and delete entries there.
285 "who" applet requires this option.
288 bool "Support wtmp file"
292 The file /var/run/wtmp is used to track when users have logged into
293 and logged out of the system.
294 With this option on, certain applets (getty, login, telnetd etc)
295 will append new entries there.
296 "last" applet requires this option.
298 config FEATURE_PIDFILE
299 bool "Support writing pidfiles"
302 This option makes some applets (e.g. crond, syslogd, inetd) write
303 a pidfile in /var/run. Some applications rely on them.
306 bool "Support for SUID/SGID handling"
309 With this option you can install the busybox binary belonging
310 to root with the suid bit set, and it will automatically drop
311 priviledges for applets that don't need root access.
313 If you are really paranoid and don't want to do this, build two
314 busybox binaries with different applets in them (and the appropriate
315 symlinks pointing to each binary), and only set the suid bit on the
316 one that needs it. The applets currently marked to need the suid bit
319 crontab, dnsd, findfs, ipcrm, ipcs, login, passwd, ping, su,
322 config FEATURE_SUID_CONFIG
323 bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
324 default y if FEATURE_SUID
325 depends on FEATURE_SUID
327 Allow the SUID / SGID state of an applet to be determined at runtime
328 by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
329 The format of this file is as follows:
331 <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
333 An example might help:
336 su = ssx root.0 # applet su can be run by anyone and runs with
338 su = ssx # exactly the same
340 mount = sx- root.disk # applet mount can be run by root and members
341 # of group disk and runs with euid=0
343 cp = --- # disable applet cp for everyone
345 The file has to be owned by user root, group root and has to be
346 writeable only by root:
347 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
348 The busybox executable has to be owned by user root, group
349 root and has to be setuid root for this to work:
350 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
352 Robert 'sandman' Griebl has more information here:
353 <url: http://www.softforge.de/bb/suid.html >.
355 config FEATURE_SUID_CONFIG_QUIET
356 bool "Suppress warning message if /etc/busybox.conf is not readable"
358 depends on FEATURE_SUID_CONFIG
360 /etc/busybox.conf should be readable by the user needing the SUID,
361 check this option to avoid users to be notified about missing
365 bool "Support NSA Security Enhanced Linux"
367 depends on PLATFORM_LINUX
369 Enable support for SELinux in applets ls, ps, and id. Also provide
370 the option of compiling in SELinux applets.
372 If you do not have a complete SELinux userland installed, this stuff
373 will not compile. Go visit
374 http://www.nsa.gov/selinux/index.html
375 to download the necessary stuff to allow busybox to compile with
376 this option enabled. Specifially, libselinux 1.28 or better is
377 directly required by busybox. If the installation is located in a
378 non-standard directory, provide it by invoking make as follows:
379 CFLAGS=-I<libselinux-include-path> \
380 LDFLAGS=-L<libselinux-lib-path> \
383 Most people will leave this set to 'N'.
385 config FEATURE_PREFER_APPLETS
386 bool "exec prefers applets"
389 This is an experimental option which directs applets about to
390 call 'exec' to try and find an applicable busybox applet before
391 searching the PATH. This is typically done by exec'ing
393 This may affect shell, find -exec, xargs and similar applets.
394 They will use applets even if /bin/<applet> -> busybox link
395 is missing (or is not a link to busybox). However, this causes
396 problems in chroot jails without mounted /proc and with ps/top
397 (command name can be shown as 'exe' for applets started this way).
399 config BUSYBOX_EXEC_PATH
400 string "Path to BusyBox executable"
401 default "/proc/self/exe"
403 When Busybox applets need to run other busybox applets, BusyBox
404 sometimes needs to exec() itself. When the /proc filesystem is
405 mounted, /proc/self/exe always points to the currently running
406 executable. If you haven't got /proc, set this to wherever you
407 want to run BusyBox from.
409 # These are auto-selected by other options
411 config FEATURE_SYSLOG
412 bool #No description makes it a hidden option
415 # This option is auto-selected when you select any applet which may
416 # send its output to syslog. You do not need to select it manually.
418 config FEATURE_HAVE_RPC
419 bool #No description makes it a hidden option
422 # This is automatically selected if any of enabled applets need it.
423 # You do not need to select it manually.
430 bool "Build BusyBox as a static binary (no shared libs)"
433 If you want to build a static BusyBox binary, which does not
434 use or require any shared libraries, then enable this option.
435 This can cause BusyBox to be considerably larger, so you should
436 leave this option false unless you have a good reason (i.e.
437 your target platform does not support shared libraries, or
438 you are building an initrd which doesn't need anything but
441 Most people will leave this set to 'N'.
444 bool "Build BusyBox as a position independent executable"
448 (TODO: what is it and why/when is it useful?)
449 Most people will leave this set to 'N'.
452 bool "Force NOMMU build"
455 Busybox tries to detect whether architecture it is being
456 built against supports MMU or not. If this detection fails,
457 or if you want to build NOMMU version of busybox for testing,
458 you may force NOMMU build here.
460 Most people will leave this set to 'N'.
462 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
463 # build system does not support that
464 config BUILD_LIBBUSYBOX
465 bool "Build shared libbusybox"
467 depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
469 Build a shared library libbusybox.so.N.N.N which contains all
472 This feature allows every applet to be built as a tiny
473 separate executable. Enabling it for "one big busybox binary"
474 approach serves no purpose and increases code size.
475 You should almost certainly say "no" to this.
477 ### config FEATURE_FULL_LIBBUSYBOX
478 ### bool "Feature-complete libbusybox"
479 ### default n if !FEATURE_SHARED_BUSYBOX
480 ### depends on BUILD_LIBBUSYBOX
482 ### Build a libbusybox with the complete feature-set, disregarding
483 ### the actually selected config.
485 ### Normally, libbusybox will only contain the features which are
486 ### used by busybox itself. If you plan to write a separate
487 ### standalone application which uses libbusybox say 'Y'.
489 ### Note: libbusybox is GPL, not LGPL, and exports no stable API that
490 ### might act as a copyright barrier. We can and will modify the
491 ### exported function set between releases (even minor version number
492 ### changes), and happily break out-of-tree features.
494 ### Say 'N' if in doubt.
496 config FEATURE_INDIVIDUAL
497 bool "Produce a binary for each applet, linked against libbusybox"
499 depends on BUILD_LIBBUSYBOX
501 If your CPU architecture doesn't allow for sharing text/rodata
502 sections of running binaries, but allows for runtime dynamic
503 libraries, this option will allow you to reduce memory footprint
504 when you have many different applets running at once.
506 If your CPU architecture allows for sharing text/rodata,
507 having single binary is more optimal.
509 Each applet will be a tiny program, dynamically linked
510 against libbusybox.so.N.N.N.
512 You need to have a working dynamic linker.
514 config FEATURE_SHARED_BUSYBOX
515 bool "Produce additional busybox binary linked against libbusybox"
517 depends on BUILD_LIBBUSYBOX
519 Build busybox, dynamically linked against libbusybox.so.N.N.N.
521 You need to have a working dynamic linker.
523 ### config BUILD_AT_ONCE
524 ### bool "Compile all sources at once"
527 ### Normally each source-file is compiled with one invocation of
529 ### If you set this option, all sources are compiled at once.
530 ### This gives the compiler more opportunities to optimize which can
531 ### result in smaller and/or faster binaries.
533 ### Setting this option will consume alot of memory, e.g. if you
534 ### enable all applets with all features, gcc uses more than 300MB
535 ### RAM during compilation of busybox.
537 ### This option is most likely only beneficial for newer compilers
538 ### such as gcc-4.1 and above.
540 ### Say 'N' unless you know what you are doing.
543 bool "Build with Large File Support (for accessing files > 2 GB)"
545 select FDISK_SUPPORT_LARGE_DISKS
547 If you want to build BusyBox with large file support, then enable
548 this option. This will have no effect if your kernel or your C
549 library lacks large file support for large files. Some of the
550 programs that can benefit from large file support include dd, gzip,
551 cp, mount, tar, and many others. If you want to access files larger
552 than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
554 config CROSS_COMPILER_PREFIX
555 string "Cross Compiler prefix"
558 If you want to build BusyBox with a cross compiler, then you
559 will need to set this to the cross-compiler prefix, for example,
562 Note that CROSS_COMPILE environment variable or
563 "make CROSS_COMPILE=xxx ..." will override this selection.
565 Native builds leave this empty.
568 string "Additional CFLAGS"
571 Additional CFLAGS to pass to the compiler verbatim.
575 menu 'Debugging Options'
578 bool "Build BusyBox with extra Debugging symbols"
581 Say Y here if you wish to examine BusyBox internals while applets are
582 running. This increases the size of the binary considerably, and
583 should only be used when doing development. If you are doing
584 development and want to debug BusyBox, answer Y.
586 Most people should answer N.
588 config DEBUG_PESSIMIZE
589 bool "Disable compiler optimizations"
593 The compiler's optimization of source code can eliminate and reorder
594 code, resulting in an executable that's hard to understand when
595 stepping through it with a debugger. This switches it off, resulting
596 in a much bigger executable that more closely matches the source
600 bool "Abort compilation on any warning"
603 Selecting this will add -Werror to gcc command line.
605 Most people should answer N.
608 prompt "Additional debugging library"
611 Using an additional debugging library will make BusyBox become
612 considerable larger and will cause it to run more slowly. You
613 should always leave this option disabled for production use.
617 This enables compiling with dmalloc ( http://dmalloc.com/ )
618 which is an excellent public domain mem leak and malloc problem
619 detector. To enable dmalloc, before running busybox you will
620 want to properly set your environment, for example:
621 export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
622 The 'debug=' value is generated using the following command
623 dmalloc -p log-stats -p log-non-free -p log-bad-space \
624 -p log-elapsed-time -p check-fence -p check-heap \
625 -p check-lists -p check-blank -p check-funcs -p realloc-copy \
628 Electric-fence support:
629 -----------------------
630 This enables compiling with Electric-fence support. Electric
631 fence is another very useful malloc debugging library which uses
632 your computer's virtual memory hardware to detect illegal memory
633 accesses. This support will make BusyBox be considerable larger
634 and run slower, so you should leave this option disabled unless
635 you are hunting a hard to find memory problem.
645 bool "Electric-fence"
650 ### bool "Uniform config file parser debugging applet: parse"
654 menu 'Installation Options'
656 config INSTALL_NO_USR
657 bool "Don't use /usr"
660 Disable use of /usr. Don't activate this option if you don't know
661 that you really want this behaviour.
664 prompt "Applets links"
665 default INSTALL_APPLET_SYMLINKS
667 Choose how you install applets links.
669 config INSTALL_APPLET_SYMLINKS
672 Install applets as soft-links to the busybox binary. This needs some
673 free inodes on the filesystem, but might help with filesystem
674 generators that can't cope with hard-links.
676 config INSTALL_APPLET_HARDLINKS
679 Install applets as hard-links to the busybox binary. This might
680 count on a filesystem with few inodes.
682 config INSTALL_APPLET_SCRIPT_WRAPPERS
683 bool "as script wrappers"
685 Install applets as script wrappers that call the busybox binary.
687 config INSTALL_APPLET_DONT
689 depends on FEATURE_INSTALLER || FEATURE_SH_STANDALONE || FEATURE_PREFER_APPLETS
691 Do not install applet links. Useful when using the -install feature
692 or a standalone shell for rescue purposes.
697 prompt "/bin/sh applet link"
698 default INSTALL_SH_APPLET_SYMLINK
699 depends on INSTALL_APPLET_SCRIPT_WRAPPERS
701 Choose how you install /bin/sh applet link.
703 config INSTALL_SH_APPLET_SYMLINK
706 Install /bin/sh applet as soft-link to the busybox binary.
708 config INSTALL_SH_APPLET_HARDLINK
711 Install /bin/sh applet as hard-link to the busybox binary.
713 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
714 bool "as script wrapper"
716 Install /bin/sh applet as script wrapper that call the busybox
722 string "BusyBox installation prefix"
725 Define your directory to install BusyBox files/subdirs in.
729 source libbb/Config.in
735 source archival/Config.in
736 source coreutils/Config.in
737 source console-tools/Config.in
738 source debianutils/Config.in
739 source editors/Config.in
740 source findutils/Config.in
741 source init/Config.in
742 source loginutils/Config.in
743 source e2fsprogs/Config.in
744 source modutils/Config.in
745 source util-linux/Config.in
746 source miscutils/Config.in
747 source networking/Config.in
748 source printutils/Config.in
749 source mailutils/Config.in
750 source procps/Config.in
751 source runit/Config.in
752 source selinux/Config.in
753 source shell/Config.in
754 source sysklogd/Config.in