fix typo
[oweals/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 DESKTOP
17         bool "Enable options for full-blown desktop systems"
18         default n
19         help
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.
23
24 config EXTRA_COMPAT
25         bool "Provide compatible behavior for rare corner cases (bigger code)"
26         default n
27         help
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.
32
33 config INCLUDE_SUSv2
34         bool "Enable obsolete features removed before SUSv3"
35         default y
36         help
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
40           affect renice too.)
41
42 config USE_PORTABLE_CODE
43         bool "Avoid using GCC-specific code constructs"
44         default n
45         help
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.
49
50 choice
51         prompt "Buffer allocation policy"
52         default FEATURE_BUFFERS_USE_MALLOC
53         help
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
61             earlier.
62
63 config FEATURE_BUFFERS_USE_MALLOC
64         bool "Allocate with Malloc"
65
66 config FEATURE_BUFFERS_GO_ON_STACK
67         bool "Allocate on the Stack"
68
69 config FEATURE_BUFFERS_GO_IN_BSS
70         bool "Allocate in the .bss section"
71
72 endchoice
73
74 config SHOW_USAGE
75         bool "Show terse applet usage messages"
76         default y
77         help
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.
82
83 config FEATURE_VERBOSE_USAGE
84         bool "Show verbose applet usage messages"
85         default n
86         select SHOW_USAGE
87         help
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.
92
93 config FEATURE_COMPRESS_USAGE
94         bool "Store applet usage messages in compressed form"
95         default y
96         depends on SHOW_USAGE
97         help
98           Store usage messages in compressed form, uncompress them on-the-fly
99           when <applet> --help is called.
100
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.
106
107 config FEATURE_INSTALLER
108         bool "Support --install [-s] to install applet links at runtime"
109         default n
110         help
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.
114
115 config LOCALE_SUPPORT
116         bool "Enable locale support (system needs locale for this to work)"
117         default n
118         help
119           Enable this if your system has locale support and you would like
120           busybox to support locale settings.
121
122 config UNICODE_SUPPORT
123         bool "Support Unicode"
124         default n
125         help
126           This makes various applets aware that one byte is not
127           one character on screen.
128
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.
133
134 config UNICODE_USING_LOCALE
135         bool "Use libc routines for Unicode (else uses internal ones)"
136         default n
137         depends on UNICODE_SUPPORT && LOCALE_SUPPORT
138         help
139           With this option on, Unicode support is implemented using libc
140           routines. Otherwise, internal implementation is used.
141
142 config FEATURE_CHECK_UNICODE_IN_ENV
143         bool "Check $LANG environment variable"
144         default y
145         depends on UNICODE_SUPPORT && !UNICODE_USING_LOCALE
146         help
147           With this option on, Unicode support is activated
148           only if LANG variable has the value of the form "xxxx.utf8"
149
150           Otherwise, Unicode support will be always enabled and active.
151
152 config SUBST_WCHAR
153         int "Character code to substitute unprintable characters with"
154         depends on UNICODE_SUPPORT
155         default 63
156         help
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.
160
161 config LAST_SUPPORTED_WCHAR
162         int "Range of supported Unicode characters"
163         depends on UNICODE_SUPPORT
164         default 767
165         help
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.
169
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.
177
178           Typical values are:
179           126 - ASCII only
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,
188                         bopomofo...
189           0 - off, any valid printable Unicode character will be printed.
190
191 config UNICODE_COMBINING_WCHARS
192         bool "Allow zero-width Unicode characters on output"
193         default n
194         depends on UNICODE_SUPPORT
195         help
196           With this option off, any Unicode char with width of 0
197           is substituted on output.
198
199 config UNICODE_WIDE_WCHARS
200         bool "Allow wide Unicode characters on output"
201         default n
202         depends on UNICODE_SUPPORT
203         help
204           With this option off, any Unicode char with width > 1
205           is substituted on output.
206
207 config UNICODE_BIDI_SUPPORT
208         bool "Bidirectional character-aware line input"
209         default n
210         depends on UNICODE_SUPPORT && !UNICODE_USING_LOCALE
211         help
212           With this option on, right-to-left Unicode characters
213           are treated differently on input (e.g. cursor movement).
214
215 config UNICODE_NEUTRAL_TABLE
216         bool "In bidi input, support non-ASCII neutral chars too"
217         default n
218         depends on UNICODE_BIDI_SUPPORT
219         help
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.
225
226 config LONG_OPTS
227         bool "Support for --long-options"
228         default y
229         help
230           Enable this if you want busybox applets to use the gnu --long-option
231           style, in addition to single character -a -b -c style options.
232
233 config FEATURE_DEVPTS
234         bool "Use the devpts filesystem for Unix98 PTYs"
235         default y
236         help
237           Enable if you want BusyBox to use Unix98 PTY support. If enabled,
238           busybox will use /dev/ptmx for the master side of the pseudoterminal
239           and /dev/pts/<number> for the slave side. Otherwise, BSD style
240           /dev/ttyp<number> will be used. To use this option, you should have
241           devpts mounted.
242
243 config FEATURE_CLEAN_UP
244         bool "Clean up all memory before exiting (usually not needed)"
245         default n
246         help
247           As a size optimization, busybox normally exits without explicitly
248           freeing dynamically allocated memory or closing files. This saves
249           space since the OS will clean up for us, but it can confuse debuggers
250           like valgrind, which report tons of memory and resource leaks.
251
252           Don't enable this unless you have a really good reason to clean
253           things up manually.
254
255 config FEATURE_UTMP
256         bool "Support utmp file"
257         default n
258         help
259           The file /var/run/utmp is used to track who is currently logged in.
260           With this option on, certain applets (getty, login, telnetd etc)
261           will create and delete entries there.
262           "who" applet requires this option.
263
264 config FEATURE_WTMP
265         bool "Support wtmp file"
266         default n
267         select FEATURE_UTMP
268         help
269           The file /var/run/wtmp is used to track when users have logged into
270           and logged out of the system.
271           With this option on, certain applets (getty, login, telnetd etc)
272           will append new entries there.
273           "last" applet requires this option.
274
275 config FEATURE_PIDFILE
276         bool "Support writing pidfiles"
277         default n
278         help
279           This option makes some applets (e.g. crond, syslogd, inetd) write
280           a pidfile in /var/run. Some applications rely on them.
281
282 config FEATURE_SUID
283         bool "Support for SUID/SGID handling"
284         default n
285         help
286           With this option you can install the busybox binary belonging
287           to root with the suid bit set, and it will automatically drop
288           priviledges for applets that don't need root access.
289
290           If you are really paranoid and don't want to do this, build two
291           busybox binaries with different applets in them (and the appropriate
292           symlinks pointing to each binary), and only set the suid bit on the
293           one that needs it. The applets currently marked to need the suid bit
294           are:
295
296           crontab, dnsd, findfs, ipcrm, ipcs, login, passwd, ping, su,
297           traceroute, vlock.
298
299 config FEATURE_SUID_CONFIG
300         bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
301         default n if FEATURE_SUID
302         depends on FEATURE_SUID
303         help
304           Allow the SUID / SGID state of an applet to be determined at runtime
305           by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
306           The format of this file is as follows:
307
308           <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
309
310           An example might help:
311
312           [SUID]
313           su = ssx root.0 # applet su can be run by anyone and runs with
314                           # euid=0/egid=0
315           su = ssx        # exactly the same
316
317           mount = sx- root.disk # applet mount can be run by root and members
318                                 # of group disk and runs with euid=0
319
320           cp = --- # disable applet cp for everyone
321
322           The file has to be owned by user root, group root and has to be
323           writeable only by root:
324                 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
325           The busybox executable has to be owned by user root, group
326           root and has to be setuid root for this to work:
327                 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
328
329           Robert 'sandman' Griebl has more information here:
330           <url: http://www.softforge.de/bb/suid.html >.
331
332 config FEATURE_SUID_CONFIG_QUIET
333         bool "Suppress warning message if /etc/busybox.conf is not readable"
334         default y
335         depends on FEATURE_SUID_CONFIG
336         help
337           /etc/busybox.conf should be readable by the user needing the SUID,
338           check this option to avoid users to be notified about missing
339           permissions.
340
341 config SELINUX
342         bool "Support NSA Security Enhanced Linux"
343         default n
344         help
345           Enable support for SELinux in applets ls, ps, and id. Also provide
346           the option of compiling in SELinux applets.
347
348           If you do not have a complete SELinux userland installed, this stuff
349           will not compile. Go visit
350                 http://www.nsa.gov/selinux/index.html
351           to download the necessary stuff to allow busybox to compile with
352           this option enabled. Specifially, libselinux 1.28 or better is
353           directly required by busybox. If the installation is located in a
354           non-standard directory, provide it by invoking make as follows:
355                 CFLAGS=-I<libselinux-include-path> \
356                 LDFLAGS=-L<libselinux-lib-path> \
357                 make
358
359           Most people will leave this set to 'N'.
360
361 config FEATURE_PREFER_APPLETS
362         bool "exec prefers applets"
363         default n
364         help
365           This is an experimental option which directs applets about to
366           call 'exec' to try and find an applicable busybox applet before
367           searching the PATH. This is typically done by exec'ing
368           /proc/self/exe.
369           This may affect shell, find -exec, xargs and similar applets.
370           They will use applets even if /bin/<applet> -> busybox link
371           is missing (or is not a link to busybox). However, this causes
372           problems in chroot jails without mounted /proc and with ps/top
373           (command name can be shown as 'exe' for applets started this way).
374
375 config BUSYBOX_EXEC_PATH
376         string "Path to BusyBox executable"
377         default "/proc/self/exe"
378         help
379           When Busybox applets need to run other busybox applets, BusyBox
380           sometimes needs to exec() itself. When the /proc filesystem is
381           mounted, /proc/self/exe always points to the currently running
382           executable. If you haven't got /proc, set this to wherever you
383           want to run BusyBox from.
384
385 # These are auto-selected by other options
386
387 config FEATURE_SYSLOG
388         bool #No description makes it a hidden option
389         default n
390         #help
391         #  This option is auto-selected when you select any applet which may
392         #  send its output to syslog. You do not need to select it manually.
393
394 config FEATURE_HAVE_RPC
395         bool #No description makes it a hidden option
396         default n
397         #help
398         #  This is automatically selected if any of enabled applets need it.
399         #  You do not need to select it manually.
400
401 endmenu
402
403 menu 'Build Options'
404
405 config STATIC
406         bool "Build BusyBox as a static binary (no shared libs)"
407         default n
408         help
409           If you want to build a static BusyBox binary, which does not
410           use or require any shared libraries, then enable this option.
411           This can cause BusyBox to be considerably larger, so you should
412           leave this option false unless you have a good reason (i.e.
413           your target platform does not support shared libraries, or
414           you are building an initrd which doesn't need anything but
415           BusyBox, etc).
416
417           Most people will leave this set to 'N'.
418
419 config PIE
420         bool "Build BusyBox as a position independent executable"
421         default n
422         depends on !STATIC
423         help
424           (TODO: what is it and why/when is it useful?)
425           Most people will leave this set to 'N'.
426
427 config NOMMU
428         bool "Force NOMMU build"
429         default n
430         help
431           Busybox tries to detect whether architecture it is being
432           built against supports MMU or not. If this detection fails,
433           or if you want to build NOMMU version of busybox for testing,
434           you may force NOMMU build here.
435
436           Most people will leave this set to 'N'.
437
438 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
439 # build system does not support that
440 config BUILD_LIBBUSYBOX
441         bool "Build shared libbusybox"
442         default n
443         depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
444         help
445           Build a shared library libbusybox.so.N.N.N which contains all
446           busybox code.
447
448           This feature allows every applet to be built as a tiny
449           separate executable. Enabling it for "one big busybox binary"
450           approach serves no purpose and increases code size.
451           You should almost certainly say "no" to this.
452
453 ### config FEATURE_FULL_LIBBUSYBOX
454 ###     bool "Feature-complete libbusybox"
455 ###     default n if !FEATURE_SHARED_BUSYBOX
456 ###     depends on BUILD_LIBBUSYBOX
457 ###     help
458 ###       Build a libbusybox with the complete feature-set, disregarding
459 ###       the actually selected config.
460 ###
461 ###       Normally, libbusybox will only contain the features which are
462 ###       used by busybox itself. If you plan to write a separate
463 ###       standalone application which uses libbusybox say 'Y'.
464 ###
465 ###       Note: libbusybox is GPL, not LGPL, and exports no stable API that
466 ###       might act as a copyright barrier. We can and will modify the
467 ###       exported function set between releases (even minor version number
468 ###       changes), and happily break out-of-tree features.
469 ###
470 ###       Say 'N' if in doubt.
471
472 config FEATURE_INDIVIDUAL
473         bool "Produce a binary for each applet, linked against libbusybox"
474         default y
475         depends on BUILD_LIBBUSYBOX
476         help
477           If your CPU architecture doesn't allow for sharing text/rodata
478           sections of running binaries, but allows for runtime dynamic
479           libraries, this option will allow you to reduce memory footprint
480           when you have many different applets running at once.
481
482           If your CPU architecture allows for sharing text/rodata,
483           having single binary is more optimal.
484
485           Each applet will be a tiny program, dynamically linked
486           against libbusybox.so.N.N.N.
487
488           You need to have a working dynamic linker.
489
490 config FEATURE_SHARED_BUSYBOX
491         bool "Produce additional busybox binary linked against libbusybox"
492         default y
493         depends on BUILD_LIBBUSYBOX
494         help
495           Build busybox, dynamically linked against libbusybox.so.N.N.N.
496
497           You need to have a working dynamic linker.
498
499 ### config BUILD_AT_ONCE
500 ###     bool "Compile all sources at once"
501 ###     default n
502 ###     help
503 ###       Normally each source-file is compiled with one invocation of
504 ###       the compiler.
505 ###       If you set this option, all sources are compiled at once.
506 ###       This gives the compiler more opportunities to optimize which can
507 ###       result in smaller and/or faster binaries.
508 ###
509 ###       Setting this option will consume alot of memory, e.g. if you
510 ###       enable all applets with all features, gcc uses more than 300MB
511 ###       RAM during compilation of busybox.
512 ###
513 ###       This option is most likely only beneficial for newer compilers
514 ###       such as gcc-4.1 and above.
515 ###
516 ###       Say 'N' unless you know what you are doing.
517
518 config LFS
519         bool "Build with Large File Support (for accessing files > 2 GB)"
520         default n
521         select FDISK_SUPPORT_LARGE_DISKS
522         help
523           If you want to build BusyBox with large file support, then enable
524           this option. This will have no effect if your kernel or your C
525           library lacks large file support for large files. Some of the
526           programs that can benefit from large file support include dd, gzip,
527           cp, mount, tar, and many others. If you want to access files larger
528           than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
529
530 config CROSS_COMPILER_PREFIX
531         string "Cross Compiler prefix"
532         default ""
533         help
534           If you want to build BusyBox with a cross compiler, then you
535           will need to set this to the cross-compiler prefix, for example,
536           "i386-uclibc-".
537
538           Note that CROSS_COMPILE environment variable or
539           "make CROSS_COMPILE=xxx ..." will override this selection.
540
541           Native builds leave this empty.
542
543 config EXTRA_CFLAGS
544         string "Additional CFLAGS"
545         default ""
546         help
547           Additional CFLAGS to pass to the compiler verbatim.
548
549 endmenu
550
551 menu 'Debugging Options'
552
553 config DEBUG
554         bool "Build BusyBox with extra Debugging symbols"
555         default n
556         help
557           Say Y here if you wish to examine BusyBox internals while applets are
558           running. This increases the size of the binary considerably, and
559           should only be used when doing development. If you are doing
560           development and want to debug BusyBox, answer Y.
561
562           Most people should answer N.
563
564 config DEBUG_PESSIMIZE
565         bool "Disable compiler optimizations"
566         default n
567         depends on DEBUG
568         help
569           The compiler's optimization of source code can eliminate and reorder
570           code, resulting in an executable that's hard to understand when
571           stepping through it with a debugger. This switches it off, resulting
572           in a much bigger executable that more closely matches the source
573           code.
574
575 config WERROR
576         bool "Abort compilation on any warning"
577         default n
578         help
579           Selecting this will add -Werror to gcc command line.
580
581           Most people should answer N.
582
583 choice
584         prompt "Additional debugging library"
585         default NO_DEBUG_LIB
586         help
587           Using an additional debugging library will make BusyBox become
588           considerable larger and will cause it to run more slowly. You
589           should always leave this option disabled for production use.
590
591           dmalloc support:
592           ----------------
593           This enables compiling with dmalloc ( http://dmalloc.com/ )
594           which is an excellent public domain mem leak and malloc problem
595           detector. To enable dmalloc, before running busybox you will
596           want to properly set your environment, for example:
597             export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
598           The 'debug=' value is generated using the following command
599             dmalloc -p log-stats -p log-non-free -p log-bad-space \
600                -p log-elapsed-time -p check-fence -p check-heap \
601                -p check-lists -p check-blank -p check-funcs -p realloc-copy \
602                -p allow-free-null
603
604           Electric-fence support:
605           -----------------------
606           This enables compiling with Electric-fence support. Electric
607           fence is another very useful malloc debugging library which uses
608           your computer's virtual memory hardware to detect illegal memory
609           accesses. This support will make BusyBox be considerable larger
610           and run slower, so you should leave this option disabled unless
611           you are hunting a hard to find memory problem.
612
613
614 config NO_DEBUG_LIB
615         bool "None"
616
617 config DMALLOC
618         bool "Dmalloc"
619
620 config EFENCE
621         bool "Electric-fence"
622
623 endchoice
624
625 ### config PARSE
626 ###     bool "Uniform config file parser debugging applet: parse"
627
628 endmenu
629
630 menu 'Installation Options'
631
632 config INSTALL_NO_USR
633         bool "Don't use /usr"
634         default n
635         help
636           Disable use of /usr. Don't activate this option if you don't know
637           that you really want this behaviour.
638
639 choice
640         prompt "Applets links"
641         default INSTALL_APPLET_SYMLINKS
642         help
643           Choose how you install applets links.
644
645 config INSTALL_APPLET_SYMLINKS
646         bool "as soft-links"
647         help
648           Install applets as soft-links to the busybox binary. This needs some
649           free inodes on the filesystem, but might help with filesystem
650           generators that can't cope with hard-links.
651
652 config INSTALL_APPLET_HARDLINKS
653         bool "as hard-links"
654         help
655           Install applets as hard-links to the busybox binary. This might
656           count on a filesystem with few inodes.
657
658 config INSTALL_APPLET_SCRIPT_WRAPPERS
659         bool "as script wrappers"
660         help
661           Install applets as script wrappers that call the busybox binary.
662
663 config INSTALL_APPLET_DONT
664         bool "not installed"
665         depends on FEATURE_INSTALLER || FEATURE_SH_STANDALONE || FEATURE_PREFER_APPLETS
666         help
667           Do not install applet links. Useful when using the -install feature
668           or a standalone shell for rescue purposes.
669
670 endchoice
671
672 choice
673         prompt "/bin/sh applet link"
674         default INSTALL_SH_APPLET_SYMLINK
675         depends on INSTALL_APPLET_SCRIPT_WRAPPERS
676         help
677           Choose how you install /bin/sh applet link.
678
679 config INSTALL_SH_APPLET_SYMLINK
680         bool "as soft-link"
681         help
682           Install /bin/sh applet as soft-link to the busybox binary.
683
684 config INSTALL_SH_APPLET_HARDLINK
685         bool "as hard-link"
686         help
687           Install /bin/sh applet as hard-link to the busybox binary.
688
689 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
690         bool "as script wrapper"
691         help
692           Install /bin/sh applet as script wrapper that call the busybox
693           binary.
694
695 endchoice
696
697 config PREFIX
698         string "BusyBox installation prefix"
699         default "./_install"
700         help
701           Define your directory to install BusyBox files/subdirs in.
702
703 endmenu
704
705 source libbb/Config.in
706
707 endmenu
708
709 comment "Applets"
710
711 source archival/Config.in
712 source coreutils/Config.in
713 source console-tools/Config.in
714 source debianutils/Config.in
715 source editors/Config.in
716 source findutils/Config.in
717 source init/Config.in
718 source loginutils/Config.in
719 source e2fsprogs/Config.in
720 source modutils/Config.in
721 source util-linux/Config.in
722 source miscutils/Config.in
723 source networking/Config.in
724 source printutils/Config.in
725 source mailutils/Config.in
726 source procps/Config.in
727 source runit/Config.in
728 source selinux/Config.in
729 source shell/Config.in
730 source sysklogd/Config.in