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 FEATURE_ASSUME_UNICODE
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 FEATURE_CHECK_UNICODE_IN_ENV
135 bool "Check $LANG environment variable"
137 depends on FEATURE_ASSUME_UNICODE && !LOCALE_SUPPORT
139 With this option on, Unicode support is activated
140 only if LANG variable has the value of the form "xxxx.utf8"
142 Otherwise, Unicode support will be always enabled and active.
145 int "Character code to substitute unprintable characters with"
146 depends on FEATURE_ASSUME_UNICODE
149 Typical values are 63 for '?' (works with any output device),
150 30 for ASCII substitute control code,
151 65533 (0xfffd) for Unicode replacement character.
153 config LAST_SUPPORTED_WCHAR
154 int "Range of supported Unicode characters"
155 depends on FEATURE_ASSUME_UNICODE
158 Any character with Unicode value bigger than this is assumed
159 to be non-printable on output device. Many applets replace
160 such chars with substitution character.
162 The idea is that many valid printable Unicode chars are
163 nevertheless are not displayed correctly. Think about
164 combining charachers, double-wide hieroglyphs, obscure
165 characters in dozens of ancient scripts...
166 Many terminals, terminal emulators, xterms etc will fail
167 to handle them correctly. Choose the smallest value
168 which suits your needs.
172 767 (0x2ff) - there are no combining chars in [0..767] range
173 (the range includes Latin 1, Latin Ext. A and B),
174 code is ~700 bytes smaller for this case.
175 4351 (0x10ff) - there are no double-wide chars in [0..4351] range,
176 code is ~300 bytes smaller for this case.
177 12799 (0x31ff) - nearly all non-ideographic characters are
178 available in [0..12799] range, including
179 East Asian scripts like katakana, hiragana, hangul,
181 0 - off, any valid printable Unicode character will be printed.
183 config UNICODE_COMBINING_WCHARS
184 bool "Allow zero-width Unicode characters on output"
186 depends on FEATURE_ASSUME_UNICODE
188 With this option off, any Unicode char with width of 0
189 is substituted on output.
191 config UNICODE_WIDE_WCHARS
192 bool "Allow wide Unicode characters on output"
194 depends on FEATURE_ASSUME_UNICODE
196 With this option off, any Unicode char with width > 1
197 is substituted on output.
200 bool "Support for --long-options"
203 Enable this if you want busybox applets to use the gnu --long-option
204 style, in addition to single character -a -b -c style options.
206 config FEATURE_DEVPTS
207 bool "Use the devpts filesystem for Unix98 PTYs"
210 Enable if you want BusyBox to use Unix98 PTY support. If enabled,
211 busybox will use /dev/ptmx for the master side of the pseudoterminal
212 and /dev/pts/<number> for the slave side. Otherwise, BSD style
213 /dev/ttyp<number> will be used. To use this option, you should have
216 config FEATURE_CLEAN_UP
217 bool "Clean up all memory before exiting (usually not needed)"
220 As a size optimization, busybox normally exits without explicitly
221 freeing dynamically allocated memory or closing files. This saves
222 space since the OS will clean up for us, but it can confuse debuggers
223 like valgrind, which report tons of memory and resource leaks.
225 Don't enable this unless you have a really good reason to clean
228 config FEATURE_PIDFILE
229 bool "Support writing pidfiles"
232 This option makes some applets (e.g. crond, syslogd, inetd) write
233 a pidfile in /var/run. Some applications rely on them.
236 bool "Support for SUID/SGID handling"
239 With this option you can install the busybox binary belonging
240 to root with the suid bit set, and it will automatically drop
241 priviledges for applets that don't need root access.
243 If you are really paranoid and don't want to do this, build two
244 busybox binaries with different applets in them (and the appropriate
245 symlinks pointing to each binary), and only set the suid bit on the
246 one that needs it. The applets currently marked to need the suid bit
249 crontab, dnsd, findfs, ipcrm, ipcs, login, passwd, ping, su,
252 config FEATURE_SUID_CONFIG
253 bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
254 default n if FEATURE_SUID
255 depends on FEATURE_SUID
257 Allow the SUID / SGID state of an applet to be determined at runtime
258 by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
259 The format of this file is as follows:
261 <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
263 An example might help:
266 su = ssx root.0 # applet su can be run by anyone and runs with
268 su = ssx # exactly the same
270 mount = sx- root.disk # applet mount can be run by root and members
271 # of group disk and runs with euid=0
273 cp = --- # disable applet cp for everyone
275 The file has to be owned by user root, group root and has to be
276 writeable only by root:
277 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
278 The busybox executable has to be owned by user root, group
279 root and has to be setuid root for this to work:
280 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
282 Robert 'sandman' Griebl has more information here:
283 <url: http://www.softforge.de/bb/suid.html >.
285 config FEATURE_SUID_CONFIG_QUIET
286 bool "Suppress warning message if /etc/busybox.conf is not readable"
288 depends on FEATURE_SUID_CONFIG
290 /etc/busybox.conf should be readable by the user needing the SUID,
291 check this option to avoid users to be notified about missing
295 bool "Support NSA Security Enhanced Linux"
298 Enable support for SELinux in applets ls, ps, and id. Also provide
299 the option of compiling in SELinux applets.
301 If you do not have a complete SELinux userland installed, this stuff
302 will not compile. Go visit
303 http://www.nsa.gov/selinux/index.html
304 to download the necessary stuff to allow busybox to compile with
305 this option enabled. Specifially, libselinux 1.28 or better is
306 directly required by busybox. If the installation is located in a
307 non-standard directory, provide it by invoking make as follows:
308 CFLAGS=-I<libselinux-include-path> \
309 LDFLAGS=-L<libselinux-lib-path> \
312 Most people will leave this set to 'N'.
314 config FEATURE_PREFER_APPLETS
315 bool "exec prefers applets"
318 This is an experimental option which directs applets about to
319 call 'exec' to try and find an applicable busybox applet before
320 searching the PATH. This is typically done by exec'ing
322 This may affect shell, find -exec, xargs and similar applets.
323 They will use applets even if /bin/<applet> -> busybox link
324 is missing (or is not a link to busybox). However, this causes
325 problems in chroot jails without mounted /proc and with ps/top
326 (command name can be shown as 'exe' for applets started this way).
328 config BUSYBOX_EXEC_PATH
329 string "Path to BusyBox executable"
330 default "/proc/self/exe"
332 When Busybox applets need to run other busybox applets, BusyBox
333 sometimes needs to exec() itself. When the /proc filesystem is
334 mounted, /proc/self/exe always points to the currently running
335 executable. If you haven't got /proc, set this to wherever you
336 want to run BusyBox from.
338 # These are auto-selected by other options
340 config FEATURE_SYSLOG
341 bool #No description makes it a hidden option
344 # This option is auto-selected when you select any applet which may
345 # send its output to syslog. You do not need to select it manually.
347 config FEATURE_HAVE_RPC
348 bool #No description makes it a hidden option
351 # This is automatically selected if any of enabled applets need it.
352 # You do not need to select it manually.
359 bool "Build BusyBox as a static binary (no shared libs)"
362 If you want to build a static BusyBox binary, which does not
363 use or require any shared libraries, then enable this option.
364 This can cause BusyBox to be considerably larger, so you should
365 leave this option false unless you have a good reason (i.e.
366 your target platform does not support shared libraries, or
367 you are building an initrd which doesn't need anything but
370 Most people will leave this set to 'N'.
373 bool "Build BusyBox as a position independent executable"
377 (TODO: what is it and why/when is it useful?)
378 Most people will leave this set to 'N'.
381 bool "Force NOMMU build"
384 Busybox tries to detect whether architecture it is being
385 built against supports MMU or not. If this detection fails,
386 or if you want to build NOMMU version of busybox for testing,
387 you may force NOMMU build here.
389 Most people will leave this set to 'N'.
391 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
392 # build system does not support that
393 config BUILD_LIBBUSYBOX
394 bool "Build shared libbusybox"
396 depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
398 Build a shared library libbusybox.so.N.N.N which contains all
401 This feature allows every applet to be built as a tiny
402 separate executable. Enabling it for "one big busybox binary"
403 approach serves no purpose and increases code size.
404 You should almost certainly say "no" to this.
406 ### config FEATURE_FULL_LIBBUSYBOX
407 ### bool "Feature-complete libbusybox"
408 ### default n if !FEATURE_SHARED_BUSYBOX
409 ### depends on BUILD_LIBBUSYBOX
411 ### Build a libbusybox with the complete feature-set, disregarding
412 ### the actually selected config.
414 ### Normally, libbusybox will only contain the features which are
415 ### used by busybox itself. If you plan to write a separate
416 ### standalone application which uses libbusybox say 'Y'.
418 ### Note: libbusybox is GPL, not LGPL, and exports no stable API that
419 ### might act as a copyright barrier. We can and will modify the
420 ### exported function set between releases (even minor version number
421 ### changes), and happily break out-of-tree features.
423 ### Say 'N' if in doubt.
425 config FEATURE_INDIVIDUAL
426 bool "Produce a binary for each applet, linked against libbusybox"
428 depends on BUILD_LIBBUSYBOX
430 If your CPU architecture doesn't allow for sharing text/rodata
431 sections of running binaries, but allows for runtime dynamic
432 libraries, this option will allow you to reduce memory footprint
433 when you have many different applets running at once.
435 If your CPU architecture allows for sharing text/rodata,
436 having single binary is more optimal.
438 Each applet will be a tiny program, dynamically linked
439 against libbusybox.so.N.N.N.
441 You need to have a working dynamic linker.
443 config FEATURE_SHARED_BUSYBOX
444 bool "Produce additional busybox binary linked against libbusybox"
446 depends on BUILD_LIBBUSYBOX
448 Build busybox, dynamically linked against libbusybox.so.N.N.N.
450 You need to have a working dynamic linker.
452 ### config BUILD_AT_ONCE
453 ### bool "Compile all sources at once"
456 ### Normally each source-file is compiled with one invocation of
458 ### If you set this option, all sources are compiled at once.
459 ### This gives the compiler more opportunities to optimize which can
460 ### result in smaller and/or faster binaries.
462 ### Setting this option will consume alot of memory, e.g. if you
463 ### enable all applets with all features, gcc uses more than 300MB
464 ### RAM during compilation of busybox.
466 ### This option is most likely only beneficial for newer compilers
467 ### such as gcc-4.1 and above.
469 ### Say 'N' unless you know what you are doing.
472 bool "Build with Large File Support (for accessing files > 2 GB)"
474 select FDISK_SUPPORT_LARGE_DISKS
476 If you want to build BusyBox with large file support, then enable
477 this option. This will have no effect if your kernel or your C
478 library lacks large file support for large files. Some of the
479 programs that can benefit from large file support include dd, gzip,
480 cp, mount, tar, and many others. If you want to access files larger
481 than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
483 config CROSS_COMPILER_PREFIX
484 string "Cross Compiler prefix"
487 If you want to build BusyBox with a cross compiler, then you
488 will need to set this to the cross-compiler prefix, for example,
491 Note that CROSS_COMPILE environment variable or
492 "make CROSS_COMPILE=xxx ..." will override this selection.
494 Native builds leave this empty.
497 string "Additional CFLAGS"
500 Additional CFLAGS to pass to the compiler verbatim.
504 menu 'Debugging Options'
507 bool "Build BusyBox with extra Debugging symbols"
510 Say Y here if you wish to examine BusyBox internals while applets are
511 running. This increases the size of the binary considerably, and
512 should only be used when doing development. If you are doing
513 development and want to debug BusyBox, answer Y.
515 Most people should answer N.
517 config DEBUG_PESSIMIZE
518 bool "Disable compiler optimizations"
522 The compiler's optimization of source code can eliminate and reorder
523 code, resulting in an executable that's hard to understand when
524 stepping through it with a debugger. This switches it off, resulting
525 in a much bigger executable that more closely matches the source
529 bool "Abort compilation on any warning"
532 Selecting this will add -Werror to gcc command line.
534 Most people should answer N.
537 prompt "Additional debugging library"
540 Using an additional debugging library will make BusyBox become
541 considerable larger and will cause it to run more slowly. You
542 should always leave this option disabled for production use.
546 This enables compiling with dmalloc ( http://dmalloc.com/ )
547 which is an excellent public domain mem leak and malloc problem
548 detector. To enable dmalloc, before running busybox you will
549 want to properly set your environment, for example:
550 export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
551 The 'debug=' value is generated using the following command
552 dmalloc -p log-stats -p log-non-free -p log-bad-space \
553 -p log-elapsed-time -p check-fence -p check-heap \
554 -p check-lists -p check-blank -p check-funcs -p realloc-copy \
557 Electric-fence support:
558 -----------------------
559 This enables compiling with Electric-fence support. Electric
560 fence is another very useful malloc debugging library which uses
561 your computer's virtual memory hardware to detect illegal memory
562 accesses. This support will make BusyBox be considerable larger
563 and run slower, so you should leave this option disabled unless
564 you are hunting a hard to find memory problem.
574 bool "Electric-fence"
579 ### bool "Uniform config file parser debugging applet: parse"
583 menu 'Installation Options'
585 config INSTALL_NO_USR
586 bool "Don't use /usr"
589 Disable use of /usr. Don't activate this option if you don't know
590 that you really want this behaviour.
593 prompt "Applets links"
594 default INSTALL_APPLET_SYMLINKS
596 Choose how you install applets links.
598 config INSTALL_APPLET_SYMLINKS
601 Install applets as soft-links to the busybox binary. This needs some
602 free inodes on the filesystem, but might help with filesystem
603 generators that can't cope with hard-links.
605 config INSTALL_APPLET_HARDLINKS
608 Install applets as hard-links to the busybox binary. This might
609 count on a filesystem with few inodes.
611 config INSTALL_APPLET_SCRIPT_WRAPPERS
612 bool "as script wrappers"
614 Install applets as script wrappers that call the busybox binary.
616 config INSTALL_APPLET_DONT
618 depends on FEATURE_INSTALLER || FEATURE_SH_STANDALONE || FEATURE_PREFER_APPLETS
620 Do not install applet links. Useful when using the -install feature
621 or a standalone shell for rescue purposes.
626 prompt "/bin/sh applet link"
627 default INSTALL_SH_APPLET_SYMLINK
628 depends on INSTALL_APPLET_SCRIPT_WRAPPERS
630 Choose how you install /bin/sh applet link.
632 config INSTALL_SH_APPLET_SYMLINK
635 Install /bin/sh applet as soft-link to the busybox binary.
637 config INSTALL_SH_APPLET_HARDLINK
640 Install /bin/sh applet as hard-link to the busybox binary.
642 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
643 bool "as script wrapper"
645 Install /bin/sh applet as script wrapper that call the busybox
651 string "BusyBox installation prefix"
654 Define your directory to install BusyBox files/subdirs in.
658 source libbb/Config.in
664 source archival/Config.in
665 source coreutils/Config.in
666 source console-tools/Config.in
667 source debianutils/Config.in
668 source editors/Config.in
669 source findutils/Config.in
670 source init/Config.in
671 source loginutils/Config.in
672 source e2fsprogs/Config.in
673 source modutils/Config.in
674 source util-linux/Config.in
675 source miscutils/Config.in
676 source networking/Config.in
677 source printutils/Config.in
678 source mailutils/Config.in
679 source procps/Config.in
680 source runit/Config.in
681 source selinux/Config.in
682 source shell/Config.in
683 source sysklogd/Config.in