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"
15 bool "Enable compatibility for full-blown desktop systems"
18 Enable applet options and features which are not essential.
19 Many applet options have dedicated config options to (de)select them
20 under that applet; this options enables those options which have no
21 individual config item for them.
23 Select this if you plan to use busybox on full-blown desktop machine
24 with common Linux distro, which needs higher level of command-line
27 If you are preparing your build to be used on an embedded box
28 where you have tighter control over the entire set of userspace
29 tools, you can unselect this option for smaller code size.
32 bool "Provide compatible behavior for rare corner cases (bigger code)"
35 This option makes grep, sed etc handle rare corner cases
36 (embedded NUL bytes and such). This makes code bigger and uses
37 some GNU extensions in libc. You probably only need this option
38 if you plan to run busybox on desktop.
41 bool "Enable obsolete features removed before SUSv3"
44 This option will enable backwards compatibility with SuSv2,
45 specifically, old-style numeric options ('command -1 <file>')
46 will be supported in head, tail, and fold. (Note: should
50 bool "Support --long-options"
53 Enable this if you want busybox applets to use the gnu --long-option
54 style, in addition to single character -a -b -c style options.
57 bool "Show applet usage messages"
60 Enabling this option, BusyBox applets will show terse help messages
61 when invoked with wrong arguments.
62 If you do not want to show any (helpful) usage message when
63 issuing wrong command syntax, you can say 'N' here,
64 saving approximately 7k.
66 config FEATURE_VERBOSE_USAGE
67 bool "Show verbose applet usage messages"
71 All BusyBox applets will show verbose help messages when
72 busybox is invoked with --help. This will add a lot of text to the
73 busybox binary. In the default configuration, this will add about
74 13k, but it can add much more depending on your configuration.
76 config FEATURE_COMPRESS_USAGE
77 bool "Store applet usage messages in compressed form"
81 Store usage messages in .bz compressed form, uncompress them
82 on-the-fly when <applet> --help is called.
84 If you have a really tiny busybox with few applets enabled (and
85 bunzip2 isn't one of them), the overhead of the decompressor might
86 be noticeable. Also, if you run executables directly from ROM
87 and have very little memory, this might not be a win. Otherwise,
88 you probably want this.
91 bool "Support files > 2 GB"
94 If you want to build BusyBox with large file support, then enable
95 this option. This will have no effect if your kernel or your C
96 library lacks large file support for large files. Some of the
97 programs that can benefit from large file support include dd, gzip,
98 cp, mount, tar, and many others. If you want to access files larger
99 than 2 Gigabytes, enable this option.
102 bool "Support PAM (Pluggable Authentication Modules)"
105 Use PAM in some busybox applets (currently login and httpd) instead
106 of direct access to password database.
108 config FEATURE_DEVPTS
109 bool "Use the devpts filesystem for Unix98 PTYs"
112 Enable if you want BusyBox to use Unix98 PTY support. If enabled,
113 busybox will use /dev/ptmx for the master side of the pseudoterminal
114 and /dev/pts/<number> for the slave side. Otherwise, BSD style
115 /dev/ttyp<number> will be used. To use this option, you should have
119 bool "Support utmp file"
122 The file /var/run/utmp is used to track who is currently logged in.
123 With this option on, certain applets (getty, login, telnetd etc)
124 will create and delete entries there.
125 "who" applet requires this option.
128 bool "Support wtmp file"
130 depends on FEATURE_UTMP
132 The file /var/run/wtmp is used to track when users have logged into
133 and logged out of the system.
134 With this option on, certain applets (getty, login, telnetd etc)
135 will append new entries there.
136 "last" applet requires this option.
138 config FEATURE_PIDFILE
139 bool "Support writing pidfiles"
142 This option makes some applets (e.g. crond, syslogd, inetd) write
143 a pidfile at the configured PID_FILE_PATH. It has no effect
144 on applets which require pidfiles to run.
147 string "Directory for pidfiles"
149 depends on FEATURE_PIDFILE
151 This is the default path where pidfiles are created. Applets which
152 allow you to set the pidfile path on the command line will override
153 this value. The option has no effect on applets that require you to
154 specify a pidfile path.
157 bool "Include busybox applet"
160 The busybox applet provides general help regarding busybox and
161 allows the included applets to be listed. It's also required
162 if applet links are to be installed at runtime. If you unselect
163 this option, running busybox without any arguments will give
164 just a cryptic error message:
167 busybox: applet not found
169 Running "busybox APPLET [ARGS...]" will still work, of course.
171 config FEATURE_INSTALLER
172 bool "Support --install [-s] to install applet links at runtime"
176 Enable 'busybox --install [-s]' support. This will allow you to use
177 busybox at runtime to create hard links or symlinks for all the
178 applets that are compiled into busybox.
180 config INSTALL_NO_USR
181 bool "Don't use /usr"
184 Disable use of /usr. busybox --install and "make install"
185 will install applets only to /bin and /sbin,
186 never to /usr/bin or /usr/sbin.
189 bool "Drop SUID state for most applets"
192 With this option you can install the busybox binary belonging
193 to root with the suid bit set, enabling some applets to perform
194 root-level operations even when run by ordinary users
195 (for example, mounting of user mounts in fstab needs this).
197 With this option enabled, Busybox drops privileges for applets
198 that don't need root access, before entering their main() function.
200 If you are really paranoid and don't want even initial busybox code
201 to run under root for evey applet, build two busybox binaries with
202 different applets in them (and the appropriate symlinks pointing
203 to each binary), and only set the suid bit on the one that needs it.
205 Some applets which require root rights (need suid bit on the binary
206 or to be run by root) and will refuse to execute otherwise:
207 crontab, login, passwd, su, vlock, wall.
209 The applets which will use root rights if they have them
210 (via suid bit, or because run by root), but would try to work
211 without root right nevertheless:
212 findfs, ping[6], traceroute[6], mount.
214 Note that if you DO NOT select this option, but DO make busybox
215 suid root, ALL applets will run under root, which is a huge
216 security hole (think "cp /some/file /etc/passwd").
218 config FEATURE_SUID_CONFIG
219 bool "Enable SUID configuration via /etc/busybox.conf"
221 depends on FEATURE_SUID
223 Allow the SUID/SGID state of an applet to be determined at runtime
224 by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
225 The format of this file is as follows:
227 APPLET = [Ssx-][Ssx-][x-] [USER.GROUP]
229 s: USER or GROUP is allowed to execute APPLET.
230 APPLET will run under USER or GROUP
231 (reagardless of who's running it).
232 S: USER or GROUP is NOT allowed to execute APPLET.
233 APPLET will run under USER or GROUP.
234 This option is not very sensical.
235 x: USER/GROUP/others are allowed to execute APPLET.
236 No UID/GID change will be done when it is run.
237 -: USER/GROUP/others are not allowed to execute APPLET.
239 An example might help:
242 su = ssx root.0 # applet su can be run by anyone and runs with
244 su = ssx # exactly the same
246 mount = sx- root.disk # applet mount can be run by root and members
247 # of group disk (but not anyone else)
248 # and runs with euid=0 (egid is not changed)
250 cp = --- # disable applet cp for everyone
252 The file has to be owned by user root, group root and has to be
253 writeable only by root:
254 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
255 The busybox executable has to be owned by user root, group
256 root and has to be setuid root for this to work:
257 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
259 Robert 'sandman' Griebl has more information here:
260 <url: http://www.softforge.de/bb/suid.html >.
262 config FEATURE_SUID_CONFIG_QUIET
263 bool "Suppress warning message if /etc/busybox.conf is not readable"
265 depends on FEATURE_SUID_CONFIG
267 /etc/busybox.conf should be readable by the user needing the SUID,
268 check this option to avoid users to be notified about missing
271 config FEATURE_PREFER_APPLETS
272 bool "exec prefers applets"
275 This is an experimental option which directs applets about to
276 call 'exec' to try and find an applicable busybox applet before
277 searching the PATH. This is typically done by exec'ing
280 This may affect shell, find -exec, xargs and similar applets.
281 They will use applets even if /bin/APPLET -> busybox link
282 is missing (or is not a link to busybox). However, this causes
283 problems in chroot jails without mounted /proc and with ps/top
284 (command name can be shown as 'exe' for applets started this way).
286 config BUSYBOX_EXEC_PATH
287 string "Path to BusyBox executable"
288 default "/proc/self/exe"
290 When Busybox applets need to run other busybox applets, BusyBox
291 sometimes needs to exec() itself. When the /proc filesystem is
292 mounted, /proc/self/exe always points to the currently running
293 executable. If you haven't got /proc, set this to wherever you
294 want to run BusyBox from.
297 bool "Support NSA Security Enhanced Linux"
299 select PLATFORM_LINUX
301 Enable support for SELinux in applets ls, ps, and id. Also provide
302 the option of compiling in SELinux applets.
304 If you do not have a complete SELinux userland installed, this stuff
305 will not compile. 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:
309 CFLAGS=-I<libselinux-include-path> \
310 LDFLAGS=-L<libselinux-lib-path> \
313 Most people will leave this set to 'N'.
315 config FEATURE_CLEAN_UP
316 bool "Clean up all memory before exiting (usually not needed)"
319 As a size optimization, busybox normally exits without explicitly
320 freeing dynamically allocated memory or closing files. This saves
321 space since the OS will clean up for us, but it can confuse debuggers
322 like valgrind, which report tons of memory and resource leaks.
324 Don't enable this unless you have a really good reason to clean
327 # These are auto-selected by other options
329 config FEATURE_SYSLOG
330 bool #No description makes it a hidden option
333 # This option is auto-selected when you select any applet which may
334 # send its output to syslog. You do not need to select it manually.
336 config FEATURE_HAVE_RPC
337 bool #No description makes it a hidden option
340 # This is automatically selected if any of enabled applets need it.
341 # You do not need to select it manually.
343 config PLATFORM_LINUX
344 bool #No description makes it a hidden option
347 # For the most part, busybox requires only POSIX compatibility
348 # from the target system, but some applets and features use
349 # Linux-specific interfaces.
351 # This is automatically selected if any applet or feature requires
352 # Linux-specific interfaces. You do not need to select it manually.
354 comment 'Build Options'
357 bool "Build BusyBox as a static binary (no shared libs)"
360 If you want to build a static BusyBox binary, which does not
361 use or require any shared libraries, then enable this option.
362 This can cause BusyBox to be considerably larger, so you should
363 leave this option false unless you have a good reason (i.e.
364 your target platform does not support shared libraries, or
365 you are building an initrd which doesn't need anything but
368 Most people will leave this set to 'N'.
371 bool "Build BusyBox as a position independent executable"
375 Hardened code option. PIE binaries are loaded at a different
376 address at each invocation. This has some overhead,
377 particularly on x86-32 which is short on registers.
379 Most people will leave this set to 'N'.
382 bool "Force NOMMU build"
385 Busybox tries to detect whether architecture it is being
386 built against supports MMU or not. If this detection fails,
387 or if you want to build NOMMU version of busybox for testing,
388 you may force NOMMU build here.
390 Most people will leave this set to 'N'.
392 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
393 # build system does not support that
394 config BUILD_LIBBUSYBOX
395 bool "Build shared libbusybox"
397 depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
399 Build a shared library libbusybox.so.N.N.N which contains all
402 This feature allows every applet to be built as a really tiny
403 separate executable linked against the library:
405 text data bss dec hex filename
406 939 212 28 1179 49b 0_lib/last
407 939 212 28 1179 49b 0_lib/less
408 919138 8328 1556 929022 e2cfe 0_lib/libbusybox.so.1.N.M
410 This is useful on NOMMU systems which are not capable
411 of sharing executables, but are capable of sharing code
412 in dynamic libraries.
414 config FEATURE_LIBBUSYBOX_STATIC
415 bool "Pull in all external references into libbusybox"
417 depends on BUILD_LIBBUSYBOX
419 Make libbusybox library independent, not using or requiring
420 any other shared libraries.
422 config FEATURE_INDIVIDUAL
423 bool "Produce a binary for each applet, linked against libbusybox"
425 depends on BUILD_LIBBUSYBOX
427 If your CPU architecture doesn't allow for sharing text/rodata
428 sections of running binaries, but allows for runtime dynamic
429 libraries, this option will allow you to reduce memory footprint
430 when you have many different applets running at once.
432 If your CPU architecture allows for sharing text/rodata,
433 having single binary is more optimal.
435 Each applet will be a tiny program, dynamically linked
436 against libbusybox.so.N.N.N.
438 You need to have a working dynamic linker.
440 config FEATURE_SHARED_BUSYBOX
441 bool "Produce additional busybox binary linked against libbusybox"
443 depends on BUILD_LIBBUSYBOX
445 Build busybox, dynamically linked against libbusybox.so.N.N.N.
447 You need to have a working dynamic linker.
449 ### config BUILD_AT_ONCE
450 ### bool "Compile all sources at once"
453 ### Normally each source-file is compiled with one invocation of
455 ### If you set this option, all sources are compiled at once.
456 ### This gives the compiler more opportunities to optimize which can
457 ### result in smaller and/or faster binaries.
459 ### Setting this option will consume alot of memory, e.g. if you
460 ### enable all applets with all features, gcc uses more than 300MB
461 ### RAM during compilation of busybox.
463 ### This option is most likely only beneficial for newer compilers
464 ### such as gcc-4.1 and above.
466 ### Say 'N' unless you know what you are doing.
468 config CROSS_COMPILER_PREFIX
469 string "Cross Compiler prefix"
472 If you want to build BusyBox with a cross compiler, then you
473 will need to set this to the cross-compiler prefix, for example,
476 Note that CROSS_COMPILE environment variable or
477 "make CROSS_COMPILE=xxx ..." will override this selection.
479 Native builds leave this empty.
482 string "Path to sysroot"
485 If you want to build BusyBox with a cross compiler, then you
486 might also need to specify where /usr/include and /usr/lib
489 For example, BusyBox can be built against an installed
490 Android NDK, platform version 9, for ARM ABI with
492 CONFIG_SYSROOT=/opt/android-ndk/platforms/android-9/arch-arm
494 Native builds leave this empty.
497 string "Additional CFLAGS"
500 Additional CFLAGS to pass to the compiler verbatim.
503 string "Additional LDFLAGS"
506 Additional LDFLAGS to pass to the linker verbatim.
509 string "Additional LDLIBS"
512 Additional LDLIBS to pass to the linker with -l.
514 config USE_PORTABLE_CODE
515 bool "Avoid using GCC-specific code constructs"
518 Use this option if you are trying to compile busybox with
519 compiler other than gcc.
520 If you do use gcc, this option may needlessly increase code size.
522 comment 'Installation Options ("make install" behavior)'
525 prompt "What kind of applet links to install"
526 default INSTALL_APPLET_SYMLINKS
528 Choose what kind of links to applets are created by "make install".
530 config INSTALL_APPLET_SYMLINKS
533 Install applets as soft-links to the busybox binary. This needs some
534 free inodes on the filesystem, but might help with filesystem
535 generators that can't cope with hard-links.
537 config INSTALL_APPLET_HARDLINKS
540 Install applets as hard-links to the busybox binary. This might
541 count on a filesystem with few inodes.
543 config INSTALL_APPLET_SCRIPT_WRAPPERS
544 bool "as script wrappers"
546 Install applets as script wrappers that call the busybox binary.
548 config INSTALL_APPLET_DONT
551 Do not install applet links. Useful when you plan to use
552 busybox --install for installing links, or plan to use
553 a standalone shell and thus don't need applet links.
558 prompt "/bin/sh applet link"
559 default INSTALL_SH_APPLET_SYMLINK
560 depends on INSTALL_APPLET_SCRIPT_WRAPPERS
562 Choose how you install /bin/sh applet link.
564 config INSTALL_SH_APPLET_SYMLINK
567 Install /bin/sh applet as soft-link to the busybox binary.
569 config INSTALL_SH_APPLET_HARDLINK
572 Install /bin/sh applet as hard-link to the busybox binary.
574 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
575 bool "as script wrapper"
577 Install /bin/sh applet as script wrapper that calls
583 string "BusyBox installation prefix"
586 Define your directory to install BusyBox files/subdirs in.
588 comment 'Debugging Options'
591 bool "Build BusyBox with extra Debugging symbols"
594 Say Y here if you wish to examine BusyBox internals while applets are
595 running. This increases the size of the binary considerably, and
596 should only be used when doing development. If you are doing
597 development and want to debug BusyBox, answer Y.
599 Most people should answer N.
601 config DEBUG_PESSIMIZE
602 bool "Disable compiler optimizations"
606 The compiler's optimization of source code can eliminate and reorder
607 code, resulting in an executable that's hard to understand when
608 stepping through it with a debugger. This switches it off, resulting
609 in a much bigger executable that more closely matches the source
612 config DEBUG_SANITIZE
613 bool "Enable runtime sanitizers (ASAN/LSAN/USAN/etc...)"
616 Say Y here if you want to enable runtime sanitizers. These help
617 catch bad memory accesses (e.g. buffer overflows), but will make
618 the executable larger and slow down runtime a bit.
620 This adds -fsanitize=foo options to gcc command line.
622 If you aren't developing/testing busybox, say N here.
625 bool "Build unit tests"
628 Say Y here if you want to build unit tests (both the framework and
629 test cases) as a Busybox applet. This results in bigger code, so you
630 probably don't want this option in production builds.
633 bool "Abort compilation on any warning"
636 This adds -Werror to gcc command line.
638 Most people should answer N.
641 prompt "Additional debugging library"
644 Using an additional debugging library will make BusyBox become
645 considerable larger and will cause it to run more slowly. You
646 should always leave this option disabled for production use.
650 This enables compiling with dmalloc ( http://dmalloc.com/ )
651 which is an excellent public domain mem leak and malloc problem
652 detector. To enable dmalloc, before running busybox you will
653 want to properly set your environment, for example:
654 export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
655 The 'debug=' value is generated using the following command
656 dmalloc -p log-stats -p log-non-free -p log-bad-space \
657 -p log-elapsed-time -p check-fence -p check-heap \
658 -p check-lists -p check-blank -p check-funcs -p realloc-copy \
661 Electric-fence support:
662 -----------------------
663 This enables compiling with Electric-fence support. Electric
664 fence is another very useful malloc debugging library which uses
665 your computer's virtual memory hardware to detect illegal memory
666 accesses. This support will make BusyBox be considerable larger
667 and run slower, so you should leave this option disabled unless
668 you are hunting a hard to find memory problem.
678 bool "Electric-fence"
682 source libbb/Config.in
688 source archival/Config.in
689 source coreutils/Config.in
690 source console-tools/Config.in
691 source debianutils/Config.in
692 source editors/Config.in
693 source findutils/Config.in
694 source init/Config.in
695 source loginutils/Config.in
696 source e2fsprogs/Config.in
697 source modutils/Config.in
698 source util-linux/Config.in
699 source miscutils/Config.in
700 source networking/Config.in
701 source printutils/Config.in
702 source mailutils/Config.in
703 source procps/Config.in
704 source runit/Config.in
705 source selinux/Config.in
706 source shell/Config.in
707 source sysklogd/Config.in