Announce 1.8.0
[platform/upstream/busybox.git] / Config.in
1 #
2 # For a description of the syntax of this configuration file,
3 # see scripts/kbuild/config-language.txt.
4 #
5
6 mainmenu "BusyBox Configuration"
7
8 config HAVE_DOT_CONFIG
9         bool
10         default y
11
12 menu "Busybox Settings"
13
14 menu "General Configuration"
15
16 config NITPICK
17         bool "See lots more (probably unnecessary) configuration options."
18         default n
19         help
20           Some BusyBox applets have more configuration options than anyone
21           will ever care about.  To avoid drowining people in complexity, most
22           of the applet features that can be set to a sane default value are
23           hidden, unless you hit the above switch.
24
25           This is better than to telling people to edit the busybox source
26           code, but not by much.
27
28           See http://en.wikipedia.org/wiki/Fibber_McGee_and_Molly#The_Closet
29
30           You have been warned.
31
32 config DESKTOP
33         bool "Enable options for full-blown desktop systems"
34         default n
35         help
36           Enable options and features which are not essential.
37           Select this only if you plan to use busybox on full-blown
38           desktop machine with common Linux distro, not on an embedded box.
39
40 choice
41         prompt "Buffer allocation policy"
42         default FEATURE_BUFFERS_USE_MALLOC
43         depends on NITPICK
44         help
45           There are 3 ways BusyBox can handle buffer allocations:
46           - Use malloc. This costs code size for the call to xmalloc.
47           - Put them on stack. For some very small machines with limited stack
48             space, this can be deadly.  For most folks, this works just fine.
49           - Put them in BSS. This works beautifully for computers with a real
50             MMU (and OS support), but wastes runtime RAM for uCLinux. This
51             behavior was the only one available for BusyBox versions 0.48 and
52             earlier.
53
54 config FEATURE_BUFFERS_USE_MALLOC
55         bool "Allocate with Malloc"
56
57 config FEATURE_BUFFERS_GO_ON_STACK
58         bool "Allocate on the Stack"
59
60 config FEATURE_BUFFERS_GO_IN_BSS
61         bool "Allocate in the .bss section"
62
63 endchoice
64
65 config SHOW_USAGE
66         bool "Show terse applet usage messages"
67         default y
68         help
69           All BusyBox applets will show help messages when invoked with
70           wrong arguments. You can turn off printing these terse usage
71           messages if you say no here.
72           This will save you up to 7k.
73
74 config FEATURE_VERBOSE_USAGE
75         bool "Show verbose applet usage messages"
76         default n
77         select SHOW_USAGE
78         help
79           All BusyBox applets will show more verbose help messages when
80           busybox is invoked with --help.  This will add a lot of text to the
81           busybox binary.  In the default configuration, this will add about
82           13k, but it can add much more depending on your configuration.
83
84 config FEATURE_COMPRESS_USAGE
85         bool "Store applet usage messages in compressed form"
86         default y
87         depends on SHOW_USAGE
88         help
89           Store usage messages in compressed form, uncompress them on-the-fly
90           when <applet> --help is called.
91
92           If you have a really tiny busybox with few applets enabled (and
93           bunzip2 isn't one of them), the overhead of the decompressor might
94           be noticeable.  Also, if you run executables directly from ROM
95           and have very little memory, this might not be a win.  Otherwise,
96           you probably want this.
97
98 config FEATURE_INSTALLER
99         bool "Support --install [-s] to install applet links at runtime"
100         default n
101         help
102           Enable 'busybox --install [-s]' support.  This will allow you to use
103           busybox at runtime to create hard links or symlinks for all the
104           applets that are compiled into busybox.
105
106 config LOCALE_SUPPORT
107         bool "Enable locale support (system needs locale for this to work)"
108         default n
109         help
110           Enable this if your system has locale support and you would like
111           busybox to support locale settings.
112
113 config GETOPT_LONG
114         bool "Enable support for --long-options"
115         default y
116         help
117           Enable this if you want busybox applets to use the gnu --long-option
118           style, in addition to single character -a -b -c style options.
119
120 config FEATURE_DEVPTS
121         bool "Use the devpts filesystem for Unix98 PTYs"
122         default y
123         help
124           Enable if you want BusyBox to use Unix98 PTY support. If enabled,
125           busybox will use /dev/ptmx for the master side of the pseudoterminal
126           and /dev/pts/<number> for the slave side.  Otherwise, BSD style
127           /dev/ttyp<number> will be used. To use this option, you should have
128           devpts mounted.
129
130 config FEATURE_CLEAN_UP
131         bool "Clean up all memory before exiting (usually not needed)"
132         default n
133         depends on NITPICK
134         help
135           As a size optimization, busybox normally exits without explicitly
136           freeing dynamically allocated memory or closing files.  This saves
137           space since the OS will clean up for us, but it can confuse debuggers
138           like valgrind, which report tons of memory and resource leaks.
139
140           Don't enable this unless you have a really good reason to clean
141           things up manually.
142
143 config FEATURE_PIDFILE
144         bool "Support writing pidfiles"
145         default n
146         help
147           This option makes some applets (e.g. crond, syslogd, inetd) write
148           a pidfile in /var/run. Some applications rely on them.
149
150 config FEATURE_SUID
151         bool "Support for SUID/SGID handling"
152         default n
153         help
154           With this option you can install the busybox binary belonging
155           to root with the suid bit set, and it'll and it'll automatically drop
156           priviledges for applets that don't need root access.
157
158           If you're really paranoid and don't want to do this, build two
159           busybox binaries with different applets in them (and the appropriate
160           symlinks pointing to each binary), and only set the suid bit on the
161           one that needs it.  The applets currently marked to need the suid bit
162           are login, passwd, su, ping, traceroute, crontab, dnsd, ipcrm, ipcs,
163           and vlock.
164
165 config FEATURE_SUID_CONFIG
166         bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
167         default n if FEATURE_SUID
168         depends on FEATURE_SUID
169         help
170           Allow the SUID / SGID state of an applet to be determined at runtime
171           by checking /etc/busybox.conf.  (This is sort of a poor man's sudo.)
172           The format of this file is as follows:
173
174           <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
175
176           An example might help:
177
178           [SUID]
179           su = ssx root.0 # applet su can be run by anyone and runs with euid=0/egid=0
180           su = ssx        # exactly the same
181
182           mount = sx- root.disk # applet mount can be run by root and members of group disk
183                                 # and runs with euid=0
184
185           cp = --- # disable applet cp for everyone
186
187           The file has to be owned by user root, group root and has to be
188           writeable only by root:
189                 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
190           The busybox executable has to be owned by user root, group
191           root and has to be setuid root for this to work:
192                 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
193
194           Robert 'sandman' Griebl has more information here:
195           <url: http://www.softforge.de/bb/suid.html >.
196
197 config FEATURE_SUID_CONFIG_QUIET
198         bool "Suppress warning message if /etc/busybox.conf is not readable"
199         default y
200         depends on FEATURE_SUID_CONFIG
201         help
202           /etc/busybox.conf should be readable by the user needing the SUID, check
203           this option to avoid users to be notified about missing permissions.
204
205 config SELINUX
206         bool "Support NSA Security Enhanced Linux"
207         default n
208         help
209           Enable support for SELinux in applets ls, ps, and id.  Also provide
210           the option of compiling in SELinux applets.
211
212           If you do not have a complete SELinux userland installed, this stuff
213           will not compile. Go visit
214                 http://www.nsa.gov/selinux/index.html
215           to download the necessary stuff to allow busybox to compile with
216           this option enabled. Specifially, libselinux 1.28 or better is
217           directly required by busybox. If the installation is located in a
218           non-standard directory, provide it by invoking make as follows:
219                 CFLAGS=-I<libselinux-include-path> \
220                 LDFLAGS=-L<libselinux-lib-path> \
221                 make
222
223           Most people will leave this set to 'N'.
224
225 config FEATURE_PREFER_APPLETS
226         bool "exec prefers applets"
227         default n
228         help
229           This is an experimental option which directs applets about to
230           call 'exec' to try and find an applicable busybox applet before
231           searching the PATH. This is typically done by exec'ing
232           /proc/self/exe.
233           This may affect shell, find -exec, xargs and similar applets.
234           They will use applets even if /bin/<applet> -> busybox link
235           is missing (or is not a link to busybox). However, this causes
236           problems in chroot jails without mounted /proc and with ps/top
237           (command name can be shown as 'exe' for applets started this way).
238
239 config BUSYBOX_EXEC_PATH
240         string "Path to BusyBox executable"
241         default "/proc/self/exe"
242         help
243           When Busybox applets need to run other busybox applets, BusyBox
244           sometimes needs to exec() itself.  When the /proc filesystem is
245           mounted, /proc/self/exe always points to the currently running
246           executable.  If you haven't got /proc, set this to wherever you
247           want to run BusyBox from.
248
249 # These are auto-selected by other options
250
251 config FEATURE_SYSLOG
252         bool "Support for logging to syslog"
253         default n
254         help
255           This option is auto-selected when you select any applet which may
256           send its output to syslog. You do not need to select it manually.
257
258 config FEATURE_HAVE_RPC
259         bool "RPC support"
260         default n
261         help
262           This is automatically selected if any of enabled applets need it.
263           You do not need to select it manually.
264
265 endmenu
266
267 menu 'Build Options'
268
269 config STATIC
270         bool "Build BusyBox as a static binary (no shared libs)"
271         default n
272         help
273           If you want to build a static BusyBox binary, which does not
274           use or require any shared libraries, then enable this option.
275           This can cause BusyBox to be considerably larger, so you should
276           leave this option false unless you have a good reason (i.e.
277           your target platform does not support shared libraries, or
278           you are building an initrd which doesn't need anything but
279           BusyBox, etc).
280
281           Most people will leave this set to 'N'.
282
283 config BUILD_LIBBUSYBOX
284         bool "Build shared libbusybox"
285         default n
286         depends on !FEATURE_PREFER_APPLETS
287         help
288           Build a shared library libbusybox.so.N.N.N which contains all
289           busybox code.
290
291           This feature allows every applet to be built as a tiny
292           separate executable.  Enabling it for "one big busybox binary"
293           approach serves no purpose and increases code size.
294           You should almost certainly say "no" to this.
295
296 ### config FEATURE_FULL_LIBBUSYBOX
297 ###     bool "Feature-complete libbusybox"
298 ###     default n if !FEATURE_SHARED_BUSYBOX
299 ###     depends on BUILD_LIBBUSYBOX
300 ###     help
301 ###       Build a libbusybox with the complete feature-set, disregarding
302 ###       the actually selected config.
303 ###
304 ###       Normally, libbusybox will only contain the features which are
305 ###       used by busybox itself. If you plan to write a separate
306 ###       standalone application which uses libbusybox say 'Y'.
307 ###
308 ###       Note: libbusybox is GPL, not LGPL, and exports no stable API that
309 ###       might act as a copyright barrier.  We can and will modify the
310 ###       exported function set between releases (even minor version number
311 ###       changes), and happily break out-of-tree features.
312 ###
313 ###       Say 'N' if in doubt.
314
315 config FEATURE_INDIVIDUAL
316         bool "Produce a binary for each applet, linked against libbusybox"
317         default y
318         depends on !STATIC && BUILD_LIBBUSYBOX
319         help
320           If your CPU architecture doesn't allow for sharing text/rodata
321           sections of running binaries, but allows for runtime dynamic
322           libraries, this option will allow you to reduce memory footprint
323           when you have many different applets running at once.
324
325           If your CPU architecture allows for sharing text/rodata,
326           having single binary is more optimal.
327
328           Each applet will be a tiny program, dynamically linked
329           against libbusybox.so.N.N.N.
330
331           You need to have a working dynamic linker.
332
333 config FEATURE_SHARED_BUSYBOX
334         bool "Produce additional busybox binary linked against libbusybox"
335         default y
336         depends on !STATIC && BUILD_LIBBUSYBOX
337         help
338           Build busybox, dynamically linked against libbusybox.so.N.N.N.
339
340           You need to have a working dynamic linker.
341
342 ### config BUILD_AT_ONCE
343 ###     bool "Compile all sources at once"
344 ###     default n
345 ###     help
346 ###       Normally each source-file is compiled with one invocation of
347 ###       the compiler.
348 ###       If you set this option, all sources are compiled at once.
349 ###       This gives the compiler more opportunities to optimize which can
350 ###       result in smaller and/or faster binaries.
351 ###
352 ###       Setting this option will consume alot of memory, e.g. if you
353 ###       enable all applets with all features, gcc uses more than 300MB
354 ###       RAM during compilation of busybox.
355 ###
356 ###       This option is most likely only beneficial for newer compilers
357 ###       such as gcc-4.1 and above.
358 ###
359 ###       Say 'N' unless you know what you are doing.
360
361 config LFS
362         bool "Build with Large File Support (for accessing files > 2 GB)"
363         default n
364         select FDISK_SUPPORT_LARGE_DISKS
365         help
366           If you want to build BusyBox with large file support, then enable
367           this option.  This will have no effect if your kernel or your C
368           library lacks large file support for large files.  Some of the
369           programs that can benefit from large file support include dd, gzip,
370           cp, mount, tar, and many others.  If you want to access files larger
371           than 2 Gigabytes, enable this option.  Otherwise, leave it set to 'N'.
372
373 endmenu
374
375 menu 'Debugging Options'
376
377 config DEBUG
378         bool "Build BusyBox with extra Debugging symbols"
379         default n
380         help
381           Say Y here if you wish to examine BusyBox internals while applets are
382           running.  This increases the size of the binary considerably, and
383           should only be used when doing development.  If you are doing
384           development and want to debug BusyBox, answer Y.
385
386           Most people should answer N.
387
388 config WERROR
389         bool "Abort compilation on any warning"
390         default n
391         help
392           Selecting this will add -Werror to gcc command line.
393
394           Most people should answer N.
395
396 # Seems to be unused
397 #config DEBUG_PESSIMIZE
398 #       bool "Disable compiler optimizations."
399 #       default n
400 #       depends on DEBUG
401 #       help
402 #         The compiler's optimization of source code can eliminate and reorder
403 #         code, resulting in an executable that's hard to understand when
404 #         stepping through it with a debugger.  This switches it off, resulting
405 #         in a much bigger executable that more closely matches the source
406 #         code.
407
408 choice
409         prompt "Additional debugging library"
410         default NO_DEBUG_LIB
411         help
412           Using an additional debugging library will make BusyBox become
413           considerable larger and will cause it to run more slowly.  You
414           should always leave this option disabled for production use.
415
416           dmalloc support:
417           ----------------
418           This enables compiling with dmalloc ( http://dmalloc.com/ )
419           which is an excellent public domain mem leak and malloc problem
420           detector.  To enable dmalloc, before running busybox you will
421           want to properly set your environment, for example:
422             export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
423           The 'debug=' value is generated using the following command
424             dmalloc -p log-stats -p log-non-free -p log-bad-space -p log-elapsed-time \
425                -p check-fence -p check-heap -p check-lists -p check-blank \
426                -p check-funcs -p realloc-copy -p allow-free-null
427
428           Electric-fence support:
429           -----------------------
430           This enables compiling with Electric-fence support.  Electric
431           fence is another very useful malloc debugging library which uses
432           your computer's virtual memory hardware to detect illegal memory
433           accesses.  This support will make BusyBox be considerable larger
434           and run slower, so you should leave this option disabled unless
435           you are hunting a hard to find memory problem.
436
437
438 config NO_DEBUG_LIB
439         bool "None"
440
441 config DMALLOC
442         bool "Dmalloc"
443
444 config EFENCE
445         bool "Electric-fence"
446
447 endchoice
448
449 config INCLUDE_SUSv2
450         bool "Enable obsolete features removed before SUSv3?"
451         default y
452         help
453           This option will enable backwards compatibility with SuSv2,
454           specifically, old-style numeric options ('command -1 <file>')
455           will be supported in head, tail, and fold.  (Note: should
456           affect renice too.)
457
458 endmenu
459
460 menu 'Installation Options'
461
462 config INSTALL_NO_USR
463         bool "Don't use /usr"
464         default n
465         help
466           Disable use of /usr. Don't activate this option if you don't know
467           that you really want this behaviour.
468
469 choice
470         prompt "Applets links"
471         default INSTALL_APPLET_SYMLINKS
472         help
473           Choose how you install applets links.
474
475 config INSTALL_APPLET_SYMLINKS
476         bool "as soft-links"
477         help
478           Install applets as soft-links to the busybox binary. This needs some
479           free inodes on the filesystem, but might help with filesystem
480           generators that can't cope with hard-links.
481
482 config INSTALL_APPLET_HARDLINKS
483         bool "as hard-links"
484         help
485           Install applets as hard-links to the busybox binary. This might count
486           on a filesystem with few inodes.
487
488 config INSTALL_APPLET_SCRIPT_WRAPPERS
489         bool "as script wrappers"
490         help
491           Install applets as script wrappers that call the busybox binary.
492
493 config INSTALL_APPLET_DONT
494         bool "not installed"
495         depends on FEATURE_INSTALLER || FEATURE_SH_STANDALONE || FEATURE_PREFER_APPLETS
496         help
497           Do not install applet links. Useful when using the -install feature
498           or a standalone shell for rescue purposes.
499
500 endchoice
501
502 choice
503         prompt "/bin/sh applet link"
504         default INSTALL_SH_APPLET_SYMLINK
505         depends on INSTALL_APPLET_SCRIPT_WRAPPERS
506         help
507           Choose how you install /bin/sh applet link.
508
509 config INSTALL_SH_APPLET_SYMLINK
510         bool "as soft-link"
511         help
512           Install /bin/sh applet as soft-link to the busybox binary.
513
514 config INSTALL_SH_APPLET_HARDLINK
515         bool "as hard-link"
516         help
517           Install /bin/sh applet as hard-link to the busybox binary.
518
519 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
520         bool "as script wrapper"
521         help
522           Install /bin/sh applet as script wrapper that call the busybox binary.
523
524 endchoice
525
526 config PREFIX
527         string "BusyBox installation prefix"
528         default "./_install"
529         help
530           Define your directory to install BusyBox files/subdirs in.
531
532 endmenu
533
534 source libbb/Config.in
535
536 endmenu
537
538 comment "Applets"
539
540 source archival/Config.in
541 source coreutils/Config.in
542 source console-tools/Config.in
543 source debianutils/Config.in
544 source editors/Config.in
545 source findutils/Config.in
546 source init/Config.in
547 source loginutils/Config.in
548 source e2fsprogs/Config.in
549 source modutils/Config.in
550 source util-linux/Config.in
551 source miscutils/Config.in
552 source networking/Config.in
553 source procps/Config.in
554 source shell/Config.in
555 source sysklogd/Config.in
556 source runit/Config.in
557 source selinux/Config.in
558 source ipsvd/Config.in