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 applet usage messages"
89 Enabling this option, BusyBox applets will show terse help messages
90 when invoked with wrong arguments.
91 If you do not want to show any (helpful) usage message when
92 issuing wrong command syntax, you can say 'N' here,
93 saving approximately 7k.
95 config FEATURE_VERBOSE_USAGE
96 bool "Show verbose applet usage messages"
100 All BusyBox applets will show verbose help messages when
101 busybox is invoked with --help. This will add a lot of text to the
102 busybox binary. In the default configuration, this will add about
103 13k, but it can add much more depending on your configuration.
105 config FEATURE_COMPRESS_USAGE
106 bool "Store applet usage messages in compressed form"
108 depends on SHOW_USAGE
110 Store usage messages in .bz compressed form, uncompress them
111 on-the-fly when <applet> --help is called.
113 If you have a really tiny busybox with few applets enabled (and
114 bunzip2 isn't one of them), the overhead of the decompressor might
115 be noticeable. Also, if you run executables directly from ROM
116 and have very little memory, this might not be a win. Otherwise,
117 you probably want this.
119 config FEATURE_INSTALLER
120 bool "Support --install [-s] to install applet links at runtime"
123 Enable 'busybox --install [-s]' support. This will allow you to use
124 busybox at runtime to create hard links or symlinks for all the
125 applets that are compiled into busybox.
127 config INSTALL_NO_USR
128 bool "Don't use /usr"
131 Disable use of /usr. busybox --install and "make install"
132 will install applets only to /bin and /sbin,
133 never to /usr/bin or /usr/sbin.
135 config LOCALE_SUPPORT
136 bool "Enable locale support (system needs locale for this to work)"
139 Enable this if your system has locale support and you would like
140 busybox to support locale settings.
142 config UNICODE_SUPPORT
143 bool "Support Unicode"
146 This makes various applets aware that one byte is not
147 one character on screen.
149 Busybox aims to eventually work correctly with Unicode displays.
150 Any older encodings are not guaranteed to work.
151 Probably by the time when busybox will be fully Unicode-clean,
152 other encodings will be mainly of historic interest.
154 config UNICODE_USING_LOCALE
155 bool "Use libc routines for Unicode (else uses internal ones)"
157 depends on UNICODE_SUPPORT && LOCALE_SUPPORT
159 With this option on, Unicode support is implemented using libc
160 routines. Otherwise, internal implementation is used.
161 Internal implementation is smaller.
163 config FEATURE_CHECK_UNICODE_IN_ENV
164 bool "Check $LANG environment variable"
166 depends on UNICODE_SUPPORT && !UNICODE_USING_LOCALE
168 With this option on, Unicode support is activated
169 only if LANG variable has the value of the form "xxxx.utf8"
171 Otherwise, Unicode support will be always enabled and active.
174 int "Character code to substitute unprintable characters with"
175 depends on UNICODE_SUPPORT
178 Typical values are 63 for '?' (works with any output device),
179 30 for ASCII substitute control code,
180 65533 (0xfffd) for Unicode replacement character.
182 config LAST_SUPPORTED_WCHAR
183 int "Range of supported Unicode characters"
184 depends on UNICODE_SUPPORT
187 Any character with Unicode value bigger than this is assumed
188 to be non-printable on output device. Many applets replace
189 such chars with substitution character.
191 The idea is that many valid printable Unicode chars are
192 nevertheless are not displayed correctly. Think about
193 combining charachers, double-wide hieroglyphs, obscure
194 characters in dozens of ancient scripts...
195 Many terminals, terminal emulators, xterms etc will fail
196 to handle them correctly. Choose the smallest value
197 which suits your needs.
201 767 (0x2ff) - there are no combining chars in [0..767] range
202 (the range includes Latin 1, Latin Ext. A and B),
203 code is ~700 bytes smaller for this case.
204 4351 (0x10ff) - there are no double-wide chars in [0..4351] range,
205 code is ~300 bytes smaller for this case.
206 12799 (0x31ff) - nearly all non-ideographic characters are
207 available in [0..12799] range, including
208 East Asian scripts like katakana, hiragana, hangul,
210 0 - off, any valid printable Unicode character will be printed.
212 config UNICODE_COMBINING_WCHARS
213 bool "Allow zero-width Unicode characters on output"
215 depends on UNICODE_SUPPORT
217 With this option off, any Unicode char with width of 0
218 is substituted on output.
220 config UNICODE_WIDE_WCHARS
221 bool "Allow wide Unicode characters on output"
223 depends on UNICODE_SUPPORT
225 With this option off, any Unicode char with width > 1
226 is substituted on output.
228 config UNICODE_BIDI_SUPPORT
229 bool "Bidirectional character-aware line input"
231 depends on UNICODE_SUPPORT && !UNICODE_USING_LOCALE
233 With this option on, right-to-left Unicode characters
234 are treated differently on input (e.g. cursor movement).
236 config UNICODE_NEUTRAL_TABLE
237 bool "In bidi input, support non-ASCII neutral chars too"
239 depends on UNICODE_BIDI_SUPPORT
241 In most cases it's enough to treat only ASCII non-letters
242 (i.e. punctuation, numbers and space) as characters
243 with neutral directionality.
244 With this option on, more extensive (and bigger) table
245 of neutral chars will be used.
247 config UNICODE_PRESERVE_BROKEN
248 bool "Make it possible to enter sequences of chars which are not Unicode"
250 depends on UNICODE_SUPPORT
252 With this option on, on line-editing input (such as used by shells)
253 invalid UTF-8 bytes are not substituted with the selected
254 substitution character.
255 For example, this means that entering 'l', 's', ' ', 0xff, [Enter]
256 at shell prompt will list file named 0xff (single char name
257 with char value 255), not file named '?'.
260 bool "Support for --long-options"
263 Enable this if you want busybox applets to use the gnu --long-option
264 style, in addition to single character -a -b -c style options.
266 config FEATURE_DEVPTS
267 bool "Use the devpts filesystem for Unix98 PTYs"
270 Enable if you want BusyBox to use Unix98 PTY support. If enabled,
271 busybox will use /dev/ptmx for the master side of the pseudoterminal
272 and /dev/pts/<number> for the slave side. Otherwise, BSD style
273 /dev/ttyp<number> will be used. To use this option, you should have
276 config FEATURE_CLEAN_UP
277 bool "Clean up all memory before exiting (usually not needed)"
280 As a size optimization, busybox normally exits without explicitly
281 freeing dynamically allocated memory or closing files. This saves
282 space since the OS will clean up for us, but it can confuse debuggers
283 like valgrind, which report tons of memory and resource leaks.
285 Don't enable this unless you have a really good reason to clean
289 bool "Support utmp file"
292 The file /var/run/utmp is used to track who is currently logged in.
293 With this option on, certain applets (getty, login, telnetd etc)
294 will create and delete entries there.
295 "who" applet requires this option.
298 bool "Support wtmp file"
300 depends on FEATURE_UTMP
302 The file /var/run/wtmp is used to track when users have logged into
303 and logged out of the system.
304 With this option on, certain applets (getty, login, telnetd etc)
305 will append new entries there.
306 "last" applet requires this option.
308 config FEATURE_PIDFILE
309 bool "Support writing pidfiles"
312 This option makes some applets (e.g. crond, syslogd, inetd) write
313 a pidfile at the configured PID_FILE_PATH. It has no effect
314 on applets which require pidfiles to run.
317 string "Path to directory for pidfile"
319 depends on FEATURE_PIDFILE
321 This is the default path where pidfiles are created. Applets which
322 allow you to set the pidfile path on the command line will override
323 this value. The option has no effect on applets that require you to
324 specify a pidfile path.
327 bool "Support for SUID/SGID handling"
330 With this option you can install the busybox binary belonging
331 to root with the suid bit set, enabling some applets to perform
332 root-level operations even when run by ordinary users
333 (for example, mounting of user mounts in fstab needs this).
335 Busybox will automatically drop privileges for applets
336 that don't need root access.
338 If you are really paranoid and don't want to do this, build two
339 busybox binaries with different applets in them (and the appropriate
340 symlinks pointing to each binary), and only set the suid bit on the
343 The applets which require root rights (need suid bit or
344 to be run by root) and will refuse to execute otherwise:
345 crontab, login, passwd, su, vlock, wall.
347 The applets which will use root rights if they have them
348 (via suid bit, or because run by root), but would try to work
349 without root right nevertheless:
350 findfs, ping[6], traceroute[6], mount.
352 Note that if you DONT select this option, but DO make busybox
353 suid root, ALL applets will run under root, which is a huge
354 security hole (think "cp /some/file /etc/passwd").
356 config FEATURE_SUID_CONFIG
357 bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
359 depends on FEATURE_SUID
361 Allow the SUID / SGID state of an applet to be determined at runtime
362 by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
363 The format of this file is as follows:
365 APPLET = [Ssx-][Ssx-][x-] [USER.GROUP]
367 s: USER or GROUP is allowed to execute APPLET.
368 APPLET will run under USER or GROUP
369 (reagardless of who's running it).
370 S: USER or GROUP is NOT allowed to execute APPLET.
371 APPLET will run under USER or GROUP.
372 This option is not very sensical.
373 x: USER/GROUP/others are allowed to execute APPLET.
374 No UID/GID change will be done when it is run.
375 -: USER/GROUP/others are not allowed to execute APPLET.
377 An example might help:
380 su = ssx root.0 # applet su can be run by anyone and runs with
382 su = ssx # exactly the same
384 mount = sx- root.disk # applet mount can be run by root and members
385 # of group disk (but not anyone else)
386 # and runs with euid=0 (egid is not changed)
388 cp = --- # disable applet cp for everyone
390 The file has to be owned by user root, group root and has to be
391 writeable only by root:
392 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
393 The busybox executable has to be owned by user root, group
394 root and has to be setuid root for this to work:
395 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
397 Robert 'sandman' Griebl has more information here:
398 <url: http://www.softforge.de/bb/suid.html >.
400 config FEATURE_SUID_CONFIG_QUIET
401 bool "Suppress warning message if /etc/busybox.conf is not readable"
403 depends on FEATURE_SUID_CONFIG
405 /etc/busybox.conf should be readable by the user needing the SUID,
406 check this option to avoid users to be notified about missing
410 bool "Support NSA Security Enhanced Linux"
412 select PLATFORM_LINUX
414 Enable support for SELinux in applets ls, ps, and id. Also provide
415 the option of compiling in SELinux applets.
417 If you do not have a complete SELinux userland installed, this stuff
418 will not compile. Go visit
419 http://www.nsa.gov/selinux/index.html
420 to download the necessary stuff to allow busybox to compile with
421 this option enabled. Specifially, libselinux 1.28 or better is
422 directly required by busybox. If the installation is located in a
423 non-standard directory, provide it by invoking make as follows:
424 CFLAGS=-I<libselinux-include-path> \
425 LDFLAGS=-L<libselinux-lib-path> \
428 Most people will leave this set to 'N'.
430 config FEATURE_PREFER_APPLETS
431 bool "exec prefers applets"
434 This is an experimental option which directs applets about to
435 call 'exec' to try and find an applicable busybox applet before
436 searching the PATH. This is typically done by exec'ing
438 This may affect shell, find -exec, xargs and similar applets.
439 They will use applets even if /bin/<applet> -> busybox link
440 is missing (or is not a link to busybox). However, this causes
441 problems in chroot jails without mounted /proc and with ps/top
442 (command name can be shown as 'exe' for applets started this way).
444 config BUSYBOX_EXEC_PATH
445 string "Path to BusyBox executable"
446 default "/proc/self/exe"
448 When Busybox applets need to run other busybox applets, BusyBox
449 sometimes needs to exec() itself. When the /proc filesystem is
450 mounted, /proc/self/exe always points to the currently running
451 executable. If you haven't got /proc, set this to wherever you
452 want to run BusyBox from.
454 # These are auto-selected by other options
456 config FEATURE_SYSLOG
457 bool #No description makes it a hidden option
460 # This option is auto-selected when you select any applet which may
461 # send its output to syslog. You do not need to select it manually.
463 config FEATURE_HAVE_RPC
464 bool #No description makes it a hidden option
467 # This is automatically selected if any of enabled applets need it.
468 # You do not need to select it manually.
475 bool "Build BusyBox as a static binary (no shared libs)"
478 If you want to build a static BusyBox binary, which does not
479 use or require any shared libraries, then enable this option.
480 This can cause BusyBox to be considerably larger, so you should
481 leave this option false unless you have a good reason (i.e.
482 your target platform does not support shared libraries, or
483 you are building an initrd which doesn't need anything but
486 Most people will leave this set to 'N'.
489 bool "Build BusyBox as a position independent executable"
493 Hardened code option. PIE binaries are loaded at a different
494 address at each invocation. This has some overhead,
495 particularly on x86-32 which is short on registers.
497 Most people will leave this set to 'N'.
500 bool "Force NOMMU build"
503 Busybox tries to detect whether architecture it is being
504 built against supports MMU or not. If this detection fails,
505 or if you want to build NOMMU version of busybox for testing,
506 you may force NOMMU build here.
508 Most people will leave this set to 'N'.
510 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
511 # build system does not support that
512 config BUILD_LIBBUSYBOX
513 bool "Build shared libbusybox"
515 depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
517 Build a shared library libbusybox.so.N.N.N which contains all
520 This feature allows every applet to be built as a tiny
521 separate executable. Enabling it for "one big busybox binary"
522 approach serves no purpose and increases code size.
523 You should almost certainly say "no" to this.
525 ### config FEATURE_FULL_LIBBUSYBOX
526 ### bool "Feature-complete libbusybox"
527 ### default n if !FEATURE_SHARED_BUSYBOX
528 ### depends on BUILD_LIBBUSYBOX
530 ### Build a libbusybox with the complete feature-set, disregarding
531 ### the actually selected config.
533 ### Normally, libbusybox will only contain the features which are
534 ### used by busybox itself. If you plan to write a separate
535 ### standalone application which uses libbusybox say 'Y'.
537 ### Note: libbusybox is GPL, not LGPL, and exports no stable API that
538 ### might act as a copyright barrier. We can and will modify the
539 ### exported function set between releases (even minor version number
540 ### changes), and happily break out-of-tree features.
542 ### Say 'N' if in doubt.
544 config FEATURE_INDIVIDUAL
545 bool "Produce a binary for each applet, linked against libbusybox"
547 depends on BUILD_LIBBUSYBOX
549 If your CPU architecture doesn't allow for sharing text/rodata
550 sections of running binaries, but allows for runtime dynamic
551 libraries, this option will allow you to reduce memory footprint
552 when you have many different applets running at once.
554 If your CPU architecture allows for sharing text/rodata,
555 having single binary is more optimal.
557 Each applet will be a tiny program, dynamically linked
558 against libbusybox.so.N.N.N.
560 You need to have a working dynamic linker.
562 config FEATURE_SHARED_BUSYBOX
563 bool "Produce additional busybox binary linked against libbusybox"
565 depends on BUILD_LIBBUSYBOX
567 Build busybox, dynamically linked against libbusybox.so.N.N.N.
569 You need to have a working dynamic linker.
571 ### config BUILD_AT_ONCE
572 ### bool "Compile all sources at once"
575 ### Normally each source-file is compiled with one invocation of
577 ### If you set this option, all sources are compiled at once.
578 ### This gives the compiler more opportunities to optimize which can
579 ### result in smaller and/or faster binaries.
581 ### Setting this option will consume alot of memory, e.g. if you
582 ### enable all applets with all features, gcc uses more than 300MB
583 ### RAM during compilation of busybox.
585 ### This option is most likely only beneficial for newer compilers
586 ### such as gcc-4.1 and above.
588 ### Say 'N' unless you know what you are doing.
591 bool "Build with Large File Support (for accessing files > 2 GB)"
594 If you want to build BusyBox with large file support, then enable
595 this option. This will have no effect if your kernel or your C
596 library lacks large file support for large files. Some of the
597 programs that can benefit from large file support include dd, gzip,
598 cp, mount, tar, and many others. If you want to access files larger
599 than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
601 config CROSS_COMPILER_PREFIX
602 string "Cross Compiler prefix"
605 If you want to build BusyBox with a cross compiler, then you
606 will need to set this to the cross-compiler prefix, for example,
609 Note that CROSS_COMPILE environment variable or
610 "make CROSS_COMPILE=xxx ..." will override this selection.
612 Native builds leave this empty.
615 string "Path to sysroot"
618 If you want to build BusyBox with a cross compiler, then you
619 might also need to specify where /usr/include and /usr/lib
622 For example, BusyBox can be built against an installed
623 Android NDK, platform version 9, for ARM ABI with
625 CONFIG_SYSROOT=/opt/android-ndk/platforms/android-9/arch-arm
627 Native builds leave this empty.
630 string "Additional CFLAGS"
633 Additional CFLAGS to pass to the compiler verbatim.
636 string "Additional LDFLAGS"
639 Additional LDFLAGS to pass to the linker verbatim.
642 string "Additional LDLIBS"
645 Additional LDLIBS to pass to the linker with -l.
649 menu 'Debugging Options'
652 bool "Build BusyBox with extra Debugging symbols"
655 Say Y here if you wish to examine BusyBox internals while applets are
656 running. This increases the size of the binary considerably, and
657 should only be used when doing development. If you are doing
658 development and want to debug BusyBox, answer Y.
660 Most people should answer N.
662 config DEBUG_PESSIMIZE
663 bool "Disable compiler optimizations"
667 The compiler's optimization of source code can eliminate and reorder
668 code, resulting in an executable that's hard to understand when
669 stepping through it with a debugger. This switches it off, resulting
670 in a much bigger executable that more closely matches the source
674 bool "Abort compilation on any warning"
677 Selecting this will add -Werror to gcc command line.
679 Most people should answer N.
682 prompt "Additional debugging library"
685 Using an additional debugging library will make BusyBox become
686 considerable larger and will cause it to run more slowly. You
687 should always leave this option disabled for production use.
691 This enables compiling with dmalloc ( http://dmalloc.com/ )
692 which is an excellent public domain mem leak and malloc problem
693 detector. To enable dmalloc, before running busybox you will
694 want to properly set your environment, for example:
695 export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
696 The 'debug=' value is generated using the following command
697 dmalloc -p log-stats -p log-non-free -p log-bad-space \
698 -p log-elapsed-time -p check-fence -p check-heap \
699 -p check-lists -p check-blank -p check-funcs -p realloc-copy \
702 Electric-fence support:
703 -----------------------
704 This enables compiling with Electric-fence support. Electric
705 fence is another very useful malloc debugging library which uses
706 your computer's virtual memory hardware to detect illegal memory
707 accesses. This support will make BusyBox be considerable larger
708 and run slower, so you should leave this option disabled unless
709 you are hunting a hard to find memory problem.
719 bool "Electric-fence"
725 menu 'Installation Options ("make install" behavior)'
728 prompt "What kind of applet links to install"
729 default INSTALL_APPLET_SYMLINKS
731 Choose what kind of links to applets are created by "make install".
733 config INSTALL_APPLET_SYMLINKS
736 Install applets as soft-links to the busybox binary. This needs some
737 free inodes on the filesystem, but might help with filesystem
738 generators that can't cope with hard-links.
740 config INSTALL_APPLET_HARDLINKS
743 Install applets as hard-links to the busybox binary. This might
744 count on a filesystem with few inodes.
746 config INSTALL_APPLET_SCRIPT_WRAPPERS
747 bool "as script wrappers"
749 Install applets as script wrappers that call the busybox binary.
751 config INSTALL_APPLET_DONT
754 Do not install applet links. Useful when you plan to use
755 busybox --install for installing links, or plan to use
756 a standalone shell and thus don't need applet links.
761 prompt "/bin/sh applet link"
762 default INSTALL_SH_APPLET_SYMLINK
763 depends on INSTALL_APPLET_SCRIPT_WRAPPERS
765 Choose how you install /bin/sh applet link.
767 config INSTALL_SH_APPLET_SYMLINK
770 Install /bin/sh applet as soft-link to the busybox binary.
772 config INSTALL_SH_APPLET_HARDLINK
775 Install /bin/sh applet as hard-link to the busybox binary.
777 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
778 bool "as script wrapper"
780 Install /bin/sh applet as script wrapper that calls
786 string "BusyBox installation prefix"
789 Define your directory to install BusyBox files/subdirs in.
793 source libbb/Config.in
799 source archival/Config.in
800 source coreutils/Config.in
801 source console-tools/Config.in
802 source debianutils/Config.in
803 source editors/Config.in
804 source findutils/Config.in
805 source init/Config.in
806 source loginutils/Config.in
807 source e2fsprogs/Config.in
808 source modutils/Config.in
809 source util-linux/Config.in
810 source miscutils/Config.in
811 source networking/Config.in
812 source printutils/Config.in
813 source mailutils/Config.in
814 source procps/Config.in
815 source runit/Config.in
816 source selinux/Config.in
817 source shell/Config.in
818 source sysklogd/Config.in