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 INSTALL_NO_USR
127 bool "Don't use /usr"
129 depends on FEATURE_INSTALLER
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, invalid UTF-8 bytes are not substituted
253 with the selected substitution character.
254 For example, this means that entering 'l', 's', ' ', 0xff, [Enter]
255 at shell prompt will list file named 0xff (single char name
256 with char value 255), not file named '?'.
259 bool "Support for --long-options"
262 Enable this if you want busybox applets to use the gnu --long-option
263 style, in addition to single character -a -b -c style options.
265 config FEATURE_DEVPTS
266 bool "Use the devpts filesystem for Unix98 PTYs"
269 Enable if you want BusyBox to use Unix98 PTY support. If enabled,
270 busybox will use /dev/ptmx for the master side of the pseudoterminal
271 and /dev/pts/<number> for the slave side. Otherwise, BSD style
272 /dev/ttyp<number> will be used. To use this option, you should have
275 config FEATURE_CLEAN_UP
276 bool "Clean up all memory before exiting (usually not needed)"
279 As a size optimization, busybox normally exits without explicitly
280 freeing dynamically allocated memory or closing files. This saves
281 space since the OS will clean up for us, but it can confuse debuggers
282 like valgrind, which report tons of memory and resource leaks.
284 Don't enable this unless you have a really good reason to clean
288 bool "Support utmp file"
291 The file /var/run/utmp is used to track who is currently logged in.
292 With this option on, certain applets (getty, login, telnetd etc)
293 will create and delete entries there.
294 "who" applet requires this option.
297 bool "Support wtmp file"
299 depends on FEATURE_UTMP
301 The file /var/run/wtmp is used to track when users have logged into
302 and logged out of the system.
303 With this option on, certain applets (getty, login, telnetd etc)
304 will append new entries there.
305 "last" applet requires this option.
307 config FEATURE_PIDFILE
308 bool "Support writing pidfiles"
311 This option makes some applets (e.g. crond, syslogd, inetd) write
312 a pidfile in /var/run. Some applications rely on them.
315 bool "Support for SUID/SGID handling"
318 With this option you can install the busybox binary belonging
319 to root with the suid bit set, enabling some applets to perform
320 root-level operations even when run by ordinary users
321 (for example, mounting of user mounts in fstab needs this).
323 Busybox will automatically drop priviledges for applets
324 that don't need root access.
326 If you are really paranoid and don't want to do this, build two
327 busybox binaries with different applets in them (and the appropriate
328 symlinks pointing to each binary), and only set the suid bit on the
331 The applets which require root rights (need suid bit or
332 to be run by root) and will refuse to execute otherwise:
333 crontab, login, passwd, su, vlock, wall.
335 The applets which will use root rights if they have them
336 (via suid bit, or because run by root), but would try to work
337 without root right nevertheless:
338 findfs, ping[6], traceroute[6], mount.
340 Note that if you DONT select this option, but DO make busybox
341 suid root, ALL applets will run under root, which is a huge
342 security hole (think "cp /some/file /etc/passwd").
344 config FEATURE_SUID_CONFIG
345 bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
346 default y if FEATURE_SUID
347 depends on FEATURE_SUID
349 Allow the SUID / SGID state of an applet to be determined at runtime
350 by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
351 The format of this file is as follows:
353 <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
355 An example might help:
358 su = ssx root.0 # applet su can be run by anyone and runs with
360 su = ssx # exactly the same
362 mount = sx- root.disk # applet mount can be run by root and members
363 # of group disk and runs with euid=0
365 cp = --- # disable applet cp for everyone
367 The file has to be owned by user root, group root and has to be
368 writeable only by root:
369 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
370 The busybox executable has to be owned by user root, group
371 root and has to be setuid root for this to work:
372 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
374 Robert 'sandman' Griebl has more information here:
375 <url: http://www.softforge.de/bb/suid.html >.
377 config FEATURE_SUID_CONFIG_QUIET
378 bool "Suppress warning message if /etc/busybox.conf is not readable"
380 depends on FEATURE_SUID_CONFIG
382 /etc/busybox.conf should be readable by the user needing the SUID,
383 check this option to avoid users to be notified about missing
387 bool "Support NSA Security Enhanced Linux"
389 depends on PLATFORM_LINUX
391 Enable support for SELinux in applets ls, ps, and id. Also provide
392 the option of compiling in SELinux applets.
394 If you do not have a complete SELinux userland installed, this stuff
395 will not compile. Go visit
396 http://www.nsa.gov/selinux/index.html
397 to download the necessary stuff to allow busybox to compile with
398 this option enabled. Specifially, libselinux 1.28 or better is
399 directly required by busybox. If the installation is located in a
400 non-standard directory, provide it by invoking make as follows:
401 CFLAGS=-I<libselinux-include-path> \
402 LDFLAGS=-L<libselinux-lib-path> \
405 Most people will leave this set to 'N'.
407 config FEATURE_PREFER_APPLETS
408 bool "exec prefers applets"
411 This is an experimental option which directs applets about to
412 call 'exec' to try and find an applicable busybox applet before
413 searching the PATH. This is typically done by exec'ing
415 This may affect shell, find -exec, xargs and similar applets.
416 They will use applets even if /bin/<applet> -> busybox link
417 is missing (or is not a link to busybox). However, this causes
418 problems in chroot jails without mounted /proc and with ps/top
419 (command name can be shown as 'exe' for applets started this way).
421 config BUSYBOX_EXEC_PATH
422 string "Path to BusyBox executable"
423 default "/proc/self/exe"
425 When Busybox applets need to run other busybox applets, BusyBox
426 sometimes needs to exec() itself. When the /proc filesystem is
427 mounted, /proc/self/exe always points to the currently running
428 executable. If you haven't got /proc, set this to wherever you
429 want to run BusyBox from.
431 # These are auto-selected by other options
433 config FEATURE_SYSLOG
434 bool #No description makes it a hidden option
437 # This option is auto-selected when you select any applet which may
438 # send its output to syslog. You do not need to select it manually.
440 config FEATURE_HAVE_RPC
441 bool #No description makes it a hidden option
444 # This is automatically selected if any of enabled applets need it.
445 # You do not need to select it manually.
452 bool "Build BusyBox as a static binary (no shared libs)"
455 If you want to build a static BusyBox binary, which does not
456 use or require any shared libraries, then enable this option.
457 This can cause BusyBox to be considerably larger, so you should
458 leave this option false unless you have a good reason (i.e.
459 your target platform does not support shared libraries, or
460 you are building an initrd which doesn't need anything but
463 Most people will leave this set to 'N'.
466 bool "Build BusyBox as a position independent executable"
470 (TODO: what is it and why/when is it useful?)
471 Most people will leave this set to 'N'.
474 bool "Force NOMMU build"
477 Busybox tries to detect whether architecture it is being
478 built against supports MMU or not. If this detection fails,
479 or if you want to build NOMMU version of busybox for testing,
480 you may force NOMMU build here.
482 Most people will leave this set to 'N'.
484 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
485 # build system does not support that
486 config BUILD_LIBBUSYBOX
487 bool "Build shared libbusybox"
489 depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
491 Build a shared library libbusybox.so.N.N.N which contains all
494 This feature allows every applet to be built as a tiny
495 separate executable. Enabling it for "one big busybox binary"
496 approach serves no purpose and increases code size.
497 You should almost certainly say "no" to this.
499 ### config FEATURE_FULL_LIBBUSYBOX
500 ### bool "Feature-complete libbusybox"
501 ### default n if !FEATURE_SHARED_BUSYBOX
502 ### depends on BUILD_LIBBUSYBOX
504 ### Build a libbusybox with the complete feature-set, disregarding
505 ### the actually selected config.
507 ### Normally, libbusybox will only contain the features which are
508 ### used by busybox itself. If you plan to write a separate
509 ### standalone application which uses libbusybox say 'Y'.
511 ### Note: libbusybox is GPL, not LGPL, and exports no stable API that
512 ### might act as a copyright barrier. We can and will modify the
513 ### exported function set between releases (even minor version number
514 ### changes), and happily break out-of-tree features.
516 ### Say 'N' if in doubt.
518 config FEATURE_INDIVIDUAL
519 bool "Produce a binary for each applet, linked against libbusybox"
521 depends on BUILD_LIBBUSYBOX
523 If your CPU architecture doesn't allow for sharing text/rodata
524 sections of running binaries, but allows for runtime dynamic
525 libraries, this option will allow you to reduce memory footprint
526 when you have many different applets running at once.
528 If your CPU architecture allows for sharing text/rodata,
529 having single binary is more optimal.
531 Each applet will be a tiny program, dynamically linked
532 against libbusybox.so.N.N.N.
534 You need to have a working dynamic linker.
536 config FEATURE_SHARED_BUSYBOX
537 bool "Produce additional busybox binary linked against libbusybox"
539 depends on BUILD_LIBBUSYBOX
541 Build busybox, dynamically linked against libbusybox.so.N.N.N.
543 You need to have a working dynamic linker.
545 ### config BUILD_AT_ONCE
546 ### bool "Compile all sources at once"
549 ### Normally each source-file is compiled with one invocation of
551 ### If you set this option, all sources are compiled at once.
552 ### This gives the compiler more opportunities to optimize which can
553 ### result in smaller and/or faster binaries.
555 ### Setting this option will consume alot of memory, e.g. if you
556 ### enable all applets with all features, gcc uses more than 300MB
557 ### RAM during compilation of busybox.
559 ### This option is most likely only beneficial for newer compilers
560 ### such as gcc-4.1 and above.
562 ### Say 'N' unless you know what you are doing.
565 bool "Build with Large File Support (for accessing files > 2 GB)"
567 select FDISK_SUPPORT_LARGE_DISKS
569 If you want to build BusyBox with large file support, then enable
570 this option. This will have no effect if your kernel or your C
571 library lacks large file support for large files. Some of the
572 programs that can benefit from large file support include dd, gzip,
573 cp, mount, tar, and many others. If you want to access files larger
574 than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
576 config CROSS_COMPILER_PREFIX
577 string "Cross Compiler prefix"
580 If you want to build BusyBox with a cross compiler, then you
581 will need to set this to the cross-compiler prefix, for example,
584 Note that CROSS_COMPILE environment variable or
585 "make CROSS_COMPILE=xxx ..." will override this selection.
587 Native builds leave this empty.
590 string "Additional CFLAGS"
593 Additional CFLAGS to pass to the compiler verbatim.
597 menu 'Debugging Options'
600 bool "Build BusyBox with extra Debugging symbols"
603 Say Y here if you wish to examine BusyBox internals while applets are
604 running. This increases the size of the binary considerably, and
605 should only be used when doing development. If you are doing
606 development and want to debug BusyBox, answer Y.
608 Most people should answer N.
610 config DEBUG_PESSIMIZE
611 bool "Disable compiler optimizations"
615 The compiler's optimization of source code can eliminate and reorder
616 code, resulting in an executable that's hard to understand when
617 stepping through it with a debugger. This switches it off, resulting
618 in a much bigger executable that more closely matches the source
622 bool "Abort compilation on any warning"
625 Selecting this will add -Werror to gcc command line.
627 Most people should answer N.
630 prompt "Additional debugging library"
633 Using an additional debugging library will make BusyBox become
634 considerable larger and will cause it to run more slowly. You
635 should always leave this option disabled for production use.
639 This enables compiling with dmalloc ( http://dmalloc.com/ )
640 which is an excellent public domain mem leak and malloc problem
641 detector. To enable dmalloc, before running busybox you will
642 want to properly set your environment, for example:
643 export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
644 The 'debug=' value is generated using the following command
645 dmalloc -p log-stats -p log-non-free -p log-bad-space \
646 -p log-elapsed-time -p check-fence -p check-heap \
647 -p check-lists -p check-blank -p check-funcs -p realloc-copy \
650 Electric-fence support:
651 -----------------------
652 This enables compiling with Electric-fence support. Electric
653 fence is another very useful malloc debugging library which uses
654 your computer's virtual memory hardware to detect illegal memory
655 accesses. This support will make BusyBox be considerable larger
656 and run slower, so you should leave this option disabled unless
657 you are hunting a hard to find memory problem.
667 bool "Electric-fence"
672 ### bool "Uniform config file parser debugging applet: parse"
676 menu 'Installation Options ("make install" behavior)'
679 prompt "What kind of applet links to install"
680 default INSTALL_APPLET_SYMLINKS
682 Choose what kind of links to applets are created by "make install".
684 config INSTALL_APPLET_SYMLINKS
687 Install applets as soft-links to the busybox binary. This needs some
688 free inodes on the filesystem, but might help with filesystem
689 generators that can't cope with hard-links.
691 config INSTALL_APPLET_HARDLINKS
694 Install applets as hard-links to the busybox binary. This might
695 count on a filesystem with few inodes.
697 config INSTALL_APPLET_SCRIPT_WRAPPERS
698 bool "as script wrappers"
700 Install applets as script wrappers that call the busybox binary.
702 config INSTALL_APPLET_DONT
704 depends on FEATURE_INSTALLER || FEATURE_SH_STANDALONE || FEATURE_PREFER_APPLETS
706 Do not install applet links. Useful when you plan to use
707 busybox --install for installing links, or plan to use
708 a standalone shell and thus don't need applet links.
713 prompt "/bin/sh applet link"
714 default INSTALL_SH_APPLET_SYMLINK
715 depends on INSTALL_APPLET_SCRIPT_WRAPPERS
717 Choose how you install /bin/sh applet link.
719 config INSTALL_SH_APPLET_SYMLINK
722 Install /bin/sh applet as soft-link to the busybox binary.
724 config INSTALL_SH_APPLET_HARDLINK
727 Install /bin/sh applet as hard-link to the busybox binary.
729 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
730 bool "as script wrapper"
732 Install /bin/sh applet as script wrapper that calls
738 string "BusyBox installation prefix"
741 Define your directory to install BusyBox files/subdirs in.
745 source libbb/Config.in
751 source archival/Config.in
752 source coreutils/Config.in
753 source console-tools/Config.in
754 source debianutils/Config.in
755 source editors/Config.in
756 source findutils/Config.in
757 source init/Config.in
758 source loginutils/Config.in
759 source e2fsprogs/Config.in
760 source modutils/Config.in
761 source util-linux/Config.in
762 source miscutils/Config.in
763 source networking/Config.in
764 source printutils/Config.in
765 source mailutils/Config.in
766 source procps/Config.in
767 source runit/Config.in
768 source selinux/Config.in
769 source shell/Config.in
770 source sysklogd/Config.in