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 prompt "Buffer allocation policy"
52 default FEATURE_BUFFERS_USE_MALLOC
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
63 config FEATURE_BUFFERS_USE_MALLOC
64 bool "Allocate with Malloc"
66 config FEATURE_BUFFERS_GO_ON_STACK
67 bool "Allocate on the Stack"
69 config FEATURE_BUFFERS_GO_IN_BSS
70 bool "Allocate in the .bss section"
75 bool "Show terse applet usage messages"
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.
83 config FEATURE_VERBOSE_USAGE
84 bool "Show verbose applet usage messages"
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.
93 config FEATURE_COMPRESS_USAGE
94 bool "Store applet usage messages in compressed form"
98 Store usage messages in compressed form, uncompress them on-the-fly
99 when <applet> --help is called.
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.
107 config FEATURE_INSTALLER
108 bool "Support --install [-s] to install applet links at runtime"
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.
115 config LOCALE_SUPPORT
116 bool "Enable locale support (system needs locale for this to work)"
119 Enable this if your system has locale support and you would like
120 busybox to support locale settings.
122 config UNICODE_SUPPORT
123 bool "Support Unicode"
126 This makes various applets aware that one byte is not
127 one character on screen.
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.
134 config UNICODE_USING_LOCALE
135 bool "Use libc routines for Unicode (else uses internal ones)"
137 depends on UNICODE_SUPPORT && LOCALE_SUPPORT
139 With this option on, Unicode support is implemented using libc
140 routines. Otherwise, internal implementation is used.
142 config FEATURE_CHECK_UNICODE_IN_ENV
143 bool "Check $LANG environment variable"
145 depends on UNICODE_SUPPORT && !UNICODE_USING_LOCALE
147 With this option on, Unicode support is activated
148 only if LANG variable has the value of the form "xxxx.utf8"
150 Otherwise, Unicode support will be always enabled and active.
153 int "Character code to substitute unprintable characters with"
154 depends on UNICODE_SUPPORT
157 Typical values are 63 for '?' (works with any output device),
158 30 for ASCII substitute control code,
159 65533 (0xfffd) for Unicode replacement character.
161 config LAST_SUPPORTED_WCHAR
162 int "Range of supported Unicode characters"
163 depends on UNICODE_SUPPORT
166 Any character with Unicode value bigger than this is assumed
167 to be non-printable on output device. Many applets replace
168 such chars with substitution character.
170 The idea is that many valid printable Unicode chars are
171 nevertheless are not displayed correctly. Think about
172 combining charachers, double-wide hieroglyphs, obscure
173 characters in dozens of ancient scripts...
174 Many terminals, terminal emulators, xterms etc will fail
175 to handle them correctly. Choose the smallest value
176 which suits your needs.
180 767 (0x2ff) - there are no combining chars in [0..767] range
181 (the range includes Latin 1, Latin Ext. A and B),
182 code is ~700 bytes smaller for this case.
183 4351 (0x10ff) - there are no double-wide chars in [0..4351] range,
184 code is ~300 bytes smaller for this case.
185 12799 (0x31ff) - nearly all non-ideographic characters are
186 available in [0..12799] range, including
187 East Asian scripts like katakana, hiragana, hangul,
189 0 - off, any valid printable Unicode character will be printed.
191 config UNICODE_COMBINING_WCHARS
192 bool "Allow zero-width Unicode characters on output"
194 depends on UNICODE_SUPPORT
196 With this option off, any Unicode char with width of 0
197 is substituted on output.
199 config UNICODE_WIDE_WCHARS
200 bool "Allow wide Unicode characters on output"
202 depends on UNICODE_SUPPORT
204 With this option off, any Unicode char with width > 1
205 is substituted on output.
207 config UNICODE_BIDI_SUPPORT
208 bool "Bidirectional character-aware line input"
210 depends on UNICODE_SUPPORT && !UNICODE_USING_LOCALE
212 With this option on, right-to-left Unicode characters
213 are treated differently on input (e.g. cursor movement).
215 config UNICODE_NEUTRAL_TABLE
216 bool "In bidi input, support non-ASCII neutral chars too"
218 depends on UNICODE_BIDI_SUPPORT
220 In most cases it's enough to treat only ASCII non-letters
221 (i.e. punctuation, numbers and space) as characters
222 with neutral directionality.
223 With this option on, more extensive (and bigger) table
224 of neutral chars will be used.
226 config UNICODE_PRESERVE_BROKEN
227 bool "Make it possible to enter sequences of chars which are not Unicode"
229 depends on UNICODE_SUPPORT
231 With this option on, invalid UTF-8 bytes are not substituted
232 with the selected substitution character.
233 For example, this means that entering 'l', 's', ' ', 0xff, [Enter]
234 at shell prompt will list file named 0xff (single char name
235 with char value 255), not file named '?'.
238 bool "Support for --long-options"
241 Enable this if you want busybox applets to use the gnu --long-option
242 style, in addition to single character -a -b -c style options.
244 config FEATURE_DEVPTS
245 bool "Use the devpts filesystem for Unix98 PTYs"
248 Enable if you want BusyBox to use Unix98 PTY support. If enabled,
249 busybox will use /dev/ptmx for the master side of the pseudoterminal
250 and /dev/pts/<number> for the slave side. Otherwise, BSD style
251 /dev/ttyp<number> will be used. To use this option, you should have
254 config FEATURE_CLEAN_UP
255 bool "Clean up all memory before exiting (usually not needed)"
258 As a size optimization, busybox normally exits without explicitly
259 freeing dynamically allocated memory or closing files. This saves
260 space since the OS will clean up for us, but it can confuse debuggers
261 like valgrind, which report tons of memory and resource leaks.
263 Don't enable this unless you have a really good reason to clean
267 bool "Support utmp file"
270 The file /var/run/utmp is used to track who is currently logged in.
271 With this option on, certain applets (getty, login, telnetd etc)
272 will create and delete entries there.
273 "who" applet requires this option.
276 bool "Support wtmp file"
280 The file /var/run/wtmp is used to track when users have logged into
281 and logged out of the system.
282 With this option on, certain applets (getty, login, telnetd etc)
283 will append new entries there.
284 "last" applet requires this option.
286 config FEATURE_PIDFILE
287 bool "Support writing pidfiles"
290 This option makes some applets (e.g. crond, syslogd, inetd) write
291 a pidfile in /var/run. Some applications rely on them.
294 bool "Support for SUID/SGID handling"
297 With this option you can install the busybox binary belonging
298 to root with the suid bit set, and it will automatically drop
299 priviledges for applets that don't need root access.
301 If you are really paranoid and don't want to do this, build two
302 busybox binaries with different applets in them (and the appropriate
303 symlinks pointing to each binary), and only set the suid bit on the
304 one that needs it. The applets currently marked to need the suid bit
307 crontab, dnsd, findfs, ipcrm, ipcs, login, passwd, ping, su,
310 config FEATURE_SUID_CONFIG
311 bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
312 default y if FEATURE_SUID
313 depends on FEATURE_SUID
315 Allow the SUID / SGID state of an applet to be determined at runtime
316 by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
317 The format of this file is as follows:
319 <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
321 An example might help:
324 su = ssx root.0 # applet su can be run by anyone and runs with
326 su = ssx # exactly the same
328 mount = sx- root.disk # applet mount can be run by root and members
329 # of group disk and runs with euid=0
331 cp = --- # disable applet cp for everyone
333 The file has to be owned by user root, group root and has to be
334 writeable only by root:
335 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
336 The busybox executable has to be owned by user root, group
337 root and has to be setuid root for this to work:
338 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
340 Robert 'sandman' Griebl has more information here:
341 <url: http://www.softforge.de/bb/suid.html >.
343 config FEATURE_SUID_CONFIG_QUIET
344 bool "Suppress warning message if /etc/busybox.conf is not readable"
346 depends on FEATURE_SUID_CONFIG
348 /etc/busybox.conf should be readable by the user needing the SUID,
349 check this option to avoid users to be notified about missing
353 bool "Support NSA Security Enhanced Linux"
356 Enable support for SELinux in applets ls, ps, and id. Also provide
357 the option of compiling in SELinux applets.
359 If you do not have a complete SELinux userland installed, this stuff
360 will not compile. Go visit
361 http://www.nsa.gov/selinux/index.html
362 to download the necessary stuff to allow busybox to compile with
363 this option enabled. Specifially, libselinux 1.28 or better is
364 directly required by busybox. If the installation is located in a
365 non-standard directory, provide it by invoking make as follows:
366 CFLAGS=-I<libselinux-include-path> \
367 LDFLAGS=-L<libselinux-lib-path> \
370 Most people will leave this set to 'N'.
372 config FEATURE_PREFER_APPLETS
373 bool "exec prefers applets"
376 This is an experimental option which directs applets about to
377 call 'exec' to try and find an applicable busybox applet before
378 searching the PATH. This is typically done by exec'ing
380 This may affect shell, find -exec, xargs and similar applets.
381 They will use applets even if /bin/<applet> -> busybox link
382 is missing (or is not a link to busybox). However, this causes
383 problems in chroot jails without mounted /proc and with ps/top
384 (command name can be shown as 'exe' for applets started this way).
386 config BUSYBOX_EXEC_PATH
387 string "Path to BusyBox executable"
388 default "/proc/self/exe"
390 When Busybox applets need to run other busybox applets, BusyBox
391 sometimes needs to exec() itself. When the /proc filesystem is
392 mounted, /proc/self/exe always points to the currently running
393 executable. If you haven't got /proc, set this to wherever you
394 want to run BusyBox from.
396 # These are auto-selected by other options
398 config FEATURE_SYSLOG
399 bool #No description makes it a hidden option
402 # This option is auto-selected when you select any applet which may
403 # send its output to syslog. You do not need to select it manually.
405 config FEATURE_HAVE_RPC
406 bool #No description makes it a hidden option
409 # This is automatically selected if any of enabled applets need it.
410 # You do not need to select it manually.
417 bool "Build BusyBox as a static binary (no shared libs)"
420 If you want to build a static BusyBox binary, which does not
421 use or require any shared libraries, then enable this option.
422 This can cause BusyBox to be considerably larger, so you should
423 leave this option false unless you have a good reason (i.e.
424 your target platform does not support shared libraries, or
425 you are building an initrd which doesn't need anything but
428 Most people will leave this set to 'N'.
431 bool "Build BusyBox as a position independent executable"
435 (TODO: what is it and why/when is it useful?)
436 Most people will leave this set to 'N'.
439 bool "Force NOMMU build"
442 Busybox tries to detect whether architecture it is being
443 built against supports MMU or not. If this detection fails,
444 or if you want to build NOMMU version of busybox for testing,
445 you may force NOMMU build here.
447 Most people will leave this set to 'N'.
449 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
450 # build system does not support that
451 config BUILD_LIBBUSYBOX
452 bool "Build shared libbusybox"
454 depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
456 Build a shared library libbusybox.so.N.N.N which contains all
459 This feature allows every applet to be built as a tiny
460 separate executable. Enabling it for "one big busybox binary"
461 approach serves no purpose and increases code size.
462 You should almost certainly say "no" to this.
464 ### config FEATURE_FULL_LIBBUSYBOX
465 ### bool "Feature-complete libbusybox"
466 ### default n if !FEATURE_SHARED_BUSYBOX
467 ### depends on BUILD_LIBBUSYBOX
469 ### Build a libbusybox with the complete feature-set, disregarding
470 ### the actually selected config.
472 ### Normally, libbusybox will only contain the features which are
473 ### used by busybox itself. If you plan to write a separate
474 ### standalone application which uses libbusybox say 'Y'.
476 ### Note: libbusybox is GPL, not LGPL, and exports no stable API that
477 ### might act as a copyright barrier. We can and will modify the
478 ### exported function set between releases (even minor version number
479 ### changes), and happily break out-of-tree features.
481 ### Say 'N' if in doubt.
483 config FEATURE_INDIVIDUAL
484 bool "Produce a binary for each applet, linked against libbusybox"
486 depends on BUILD_LIBBUSYBOX
488 If your CPU architecture doesn't allow for sharing text/rodata
489 sections of running binaries, but allows for runtime dynamic
490 libraries, this option will allow you to reduce memory footprint
491 when you have many different applets running at once.
493 If your CPU architecture allows for sharing text/rodata,
494 having single binary is more optimal.
496 Each applet will be a tiny program, dynamically linked
497 against libbusybox.so.N.N.N.
499 You need to have a working dynamic linker.
501 config FEATURE_SHARED_BUSYBOX
502 bool "Produce additional busybox binary linked against libbusybox"
504 depends on BUILD_LIBBUSYBOX
506 Build busybox, dynamically linked against libbusybox.so.N.N.N.
508 You need to have a working dynamic linker.
510 ### config BUILD_AT_ONCE
511 ### bool "Compile all sources at once"
514 ### Normally each source-file is compiled with one invocation of
516 ### If you set this option, all sources are compiled at once.
517 ### This gives the compiler more opportunities to optimize which can
518 ### result in smaller and/or faster binaries.
520 ### Setting this option will consume alot of memory, e.g. if you
521 ### enable all applets with all features, gcc uses more than 300MB
522 ### RAM during compilation of busybox.
524 ### This option is most likely only beneficial for newer compilers
525 ### such as gcc-4.1 and above.
527 ### Say 'N' unless you know what you are doing.
530 bool "Build with Large File Support (for accessing files > 2 GB)"
532 select FDISK_SUPPORT_LARGE_DISKS
534 If you want to build BusyBox with large file support, then enable
535 this option. This will have no effect if your kernel or your C
536 library lacks large file support for large files. Some of the
537 programs that can benefit from large file support include dd, gzip,
538 cp, mount, tar, and many others. If you want to access files larger
539 than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
541 config CROSS_COMPILER_PREFIX
542 string "Cross Compiler prefix"
545 If you want to build BusyBox with a cross compiler, then you
546 will need to set this to the cross-compiler prefix, for example,
549 Note that CROSS_COMPILE environment variable or
550 "make CROSS_COMPILE=xxx ..." will override this selection.
552 Native builds leave this empty.
555 string "Additional CFLAGS"
558 Additional CFLAGS to pass to the compiler verbatim.
562 menu 'Debugging Options'
565 bool "Build BusyBox with extra Debugging symbols"
568 Say Y here if you wish to examine BusyBox internals while applets are
569 running. This increases the size of the binary considerably, and
570 should only be used when doing development. If you are doing
571 development and want to debug BusyBox, answer Y.
573 Most people should answer N.
575 config DEBUG_PESSIMIZE
576 bool "Disable compiler optimizations"
580 The compiler's optimization of source code can eliminate and reorder
581 code, resulting in an executable that's hard to understand when
582 stepping through it with a debugger. This switches it off, resulting
583 in a much bigger executable that more closely matches the source
587 bool "Abort compilation on any warning"
590 Selecting this will add -Werror to gcc command line.
592 Most people should answer N.
595 prompt "Additional debugging library"
598 Using an additional debugging library will make BusyBox become
599 considerable larger and will cause it to run more slowly. You
600 should always leave this option disabled for production use.
604 This enables compiling with dmalloc ( http://dmalloc.com/ )
605 which is an excellent public domain mem leak and malloc problem
606 detector. To enable dmalloc, before running busybox you will
607 want to properly set your environment, for example:
608 export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
609 The 'debug=' value is generated using the following command
610 dmalloc -p log-stats -p log-non-free -p log-bad-space \
611 -p log-elapsed-time -p check-fence -p check-heap \
612 -p check-lists -p check-blank -p check-funcs -p realloc-copy \
615 Electric-fence support:
616 -----------------------
617 This enables compiling with Electric-fence support. Electric
618 fence is another very useful malloc debugging library which uses
619 your computer's virtual memory hardware to detect illegal memory
620 accesses. This support will make BusyBox be considerable larger
621 and run slower, so you should leave this option disabled unless
622 you are hunting a hard to find memory problem.
632 bool "Electric-fence"
637 ### bool "Uniform config file parser debugging applet: parse"
641 menu 'Installation Options'
643 config INSTALL_NO_USR
644 bool "Don't use /usr"
647 Disable use of /usr. Don't activate this option if you don't know
648 that you really want this behaviour.
651 prompt "Applets links"
652 default INSTALL_APPLET_SYMLINKS
654 Choose how you install applets links.
656 config INSTALL_APPLET_SYMLINKS
659 Install applets as soft-links to the busybox binary. This needs some
660 free inodes on the filesystem, but might help with filesystem
661 generators that can't cope with hard-links.
663 config INSTALL_APPLET_HARDLINKS
666 Install applets as hard-links to the busybox binary. This might
667 count on a filesystem with few inodes.
669 config INSTALL_APPLET_SCRIPT_WRAPPERS
670 bool "as script wrappers"
672 Install applets as script wrappers that call the busybox binary.
674 config INSTALL_APPLET_DONT
676 depends on FEATURE_INSTALLER || FEATURE_SH_STANDALONE || FEATURE_PREFER_APPLETS
678 Do not install applet links. Useful when using the -install feature
679 or a standalone shell for rescue purposes.
684 prompt "/bin/sh applet link"
685 default INSTALL_SH_APPLET_SYMLINK
686 depends on INSTALL_APPLET_SCRIPT_WRAPPERS
688 Choose how you install /bin/sh applet link.
690 config INSTALL_SH_APPLET_SYMLINK
693 Install /bin/sh applet as soft-link to the busybox binary.
695 config INSTALL_SH_APPLET_HARDLINK
698 Install /bin/sh applet as hard-link to the busybox binary.
700 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
701 bool "as script wrapper"
703 Install /bin/sh applet as script wrapper that call the busybox
709 string "BusyBox installation prefix"
712 Define your directory to install BusyBox files/subdirs in.
716 source libbb/Config.in
722 source archival/Config.in
723 source coreutils/Config.in
724 source console-tools/Config.in
725 source debianutils/Config.in
726 source editors/Config.in
727 source findutils/Config.in
728 source init/Config.in
729 source loginutils/Config.in
730 source e2fsprogs/Config.in
731 source modutils/Config.in
732 source util-linux/Config.in
733 source miscutils/Config.in
734 source networking/Config.in
735 source printutils/Config.in
736 source mailutils/Config.in
737 source procps/Config.in
738 source runit/Config.in
739 source selinux/Config.in
740 source shell/Config.in
741 source sysklogd/Config.in