unicode: s/FEATURE_ASSUME_UNICODE/UNICODE_SUPPORT, add UNICODE_USING_LOCALE
[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_PIDFILE
256         bool "Support writing pidfiles"
257         default n
258         help
259           This option makes some applets (e.g. crond, syslogd, inetd) write
260           a pidfile in /var/run. Some applications rely on them.
261
262 config FEATURE_SUID
263         bool "Support for SUID/SGID handling"
264         default n
265         help
266           With this option you can install the busybox binary belonging
267           to root with the suid bit set, and it will automatically drop
268           priviledges for applets that don't need root access.
269
270           If you are really paranoid and don't want to do this, build two
271           busybox binaries with different applets in them (and the appropriate
272           symlinks pointing to each binary), and only set the suid bit on the
273           one that needs it. The applets currently marked to need the suid bit
274           are:
275
276           crontab, dnsd, findfs, ipcrm, ipcs, login, passwd, ping, su,
277           traceroute, vlock.
278
279 config FEATURE_SUID_CONFIG
280         bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
281         default n if FEATURE_SUID
282         depends on FEATURE_SUID
283         help
284           Allow the SUID / SGID state of an applet to be determined at runtime
285           by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
286           The format of this file is as follows:
287
288           <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
289
290           An example might help:
291
292           [SUID]
293           su = ssx root.0 # applet su can be run by anyone and runs with
294                           # euid=0/egid=0
295           su = ssx        # exactly the same
296
297           mount = sx- root.disk # applet mount can be run by root and members
298                                 # of group disk and runs with euid=0
299
300           cp = --- # disable applet cp for everyone
301
302           The file has to be owned by user root, group root and has to be
303           writeable only by root:
304                 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
305           The busybox executable has to be owned by user root, group
306           root and has to be setuid root for this to work:
307                 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
308
309           Robert 'sandman' Griebl has more information here:
310           <url: http://www.softforge.de/bb/suid.html >.
311
312 config FEATURE_SUID_CONFIG_QUIET
313         bool "Suppress warning message if /etc/busybox.conf is not readable"
314         default y
315         depends on FEATURE_SUID_CONFIG
316         help
317           /etc/busybox.conf should be readable by the user needing the SUID,
318           check this option to avoid users to be notified about missing
319           permissions.
320
321 config SELINUX
322         bool "Support NSA Security Enhanced Linux"
323         default n
324         help
325           Enable support for SELinux in applets ls, ps, and id. Also provide
326           the option of compiling in SELinux applets.
327
328           If you do not have a complete SELinux userland installed, this stuff
329           will not compile. Go visit
330                 http://www.nsa.gov/selinux/index.html
331           to download the necessary stuff to allow busybox to compile with
332           this option enabled. Specifially, libselinux 1.28 or better is
333           directly required by busybox. If the installation is located in a
334           non-standard directory, provide it by invoking make as follows:
335                 CFLAGS=-I<libselinux-include-path> \
336                 LDFLAGS=-L<libselinux-lib-path> \
337                 make
338
339           Most people will leave this set to 'N'.
340
341 config FEATURE_PREFER_APPLETS
342         bool "exec prefers applets"
343         default n
344         help
345           This is an experimental option which directs applets about to
346           call 'exec' to try and find an applicable busybox applet before
347           searching the PATH. This is typically done by exec'ing
348           /proc/self/exe.
349           This may affect shell, find -exec, xargs and similar applets.
350           They will use applets even if /bin/<applet> -> busybox link
351           is missing (or is not a link to busybox). However, this causes
352           problems in chroot jails without mounted /proc and with ps/top
353           (command name can be shown as 'exe' for applets started this way).
354
355 config BUSYBOX_EXEC_PATH
356         string "Path to BusyBox executable"
357         default "/proc/self/exe"
358         help
359           When Busybox applets need to run other busybox applets, BusyBox
360           sometimes needs to exec() itself. When the /proc filesystem is
361           mounted, /proc/self/exe always points to the currently running
362           executable. If you haven't got /proc, set this to wherever you
363           want to run BusyBox from.
364
365 # These are auto-selected by other options
366
367 config FEATURE_SYSLOG
368         bool #No description makes it a hidden option
369         default n
370         #help
371         #  This option is auto-selected when you select any applet which may
372         #  send its output to syslog. You do not need to select it manually.
373
374 config FEATURE_HAVE_RPC
375         bool #No description makes it a hidden option
376         default n
377         #help
378         #  This is automatically selected if any of enabled applets need it.
379         #  You do not need to select it manually.
380
381 endmenu
382
383 menu 'Build Options'
384
385 config STATIC
386         bool "Build BusyBox as a static binary (no shared libs)"
387         default n
388         help
389           If you want to build a static BusyBox binary, which does not
390           use or require any shared libraries, then enable this option.
391           This can cause BusyBox to be considerably larger, so you should
392           leave this option false unless you have a good reason (i.e.
393           your target platform does not support shared libraries, or
394           you are building an initrd which doesn't need anything but
395           BusyBox, etc).
396
397           Most people will leave this set to 'N'.
398
399 config PIE
400         bool "Build BusyBox as a position independent executable"
401         default n
402         depends on !STATIC
403         help
404           (TODO: what is it and why/when is it useful?)
405           Most people will leave this set to 'N'.
406
407 config NOMMU
408         bool "Force NOMMU build"
409         default n
410         help
411           Busybox tries to detect whether architecture it is being
412           built against supports MMU or not. If this detection fails,
413           or if you want to build NOMMU version of busybox for testing,
414           you may force NOMMU build here.
415
416           Most people will leave this set to 'N'.
417
418 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
419 # build system does not support that
420 config BUILD_LIBBUSYBOX
421         bool "Build shared libbusybox"
422         default n
423         depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
424         help
425           Build a shared library libbusybox.so.N.N.N which contains all
426           busybox code.
427
428           This feature allows every applet to be built as a tiny
429           separate executable. Enabling it for "one big busybox binary"
430           approach serves no purpose and increases code size.
431           You should almost certainly say "no" to this.
432
433 ### config FEATURE_FULL_LIBBUSYBOX
434 ###     bool "Feature-complete libbusybox"
435 ###     default n if !FEATURE_SHARED_BUSYBOX
436 ###     depends on BUILD_LIBBUSYBOX
437 ###     help
438 ###       Build a libbusybox with the complete feature-set, disregarding
439 ###       the actually selected config.
440 ###
441 ###       Normally, libbusybox will only contain the features which are
442 ###       used by busybox itself. If you plan to write a separate
443 ###       standalone application which uses libbusybox say 'Y'.
444 ###
445 ###       Note: libbusybox is GPL, not LGPL, and exports no stable API that
446 ###       might act as a copyright barrier. We can and will modify the
447 ###       exported function set between releases (even minor version number
448 ###       changes), and happily break out-of-tree features.
449 ###
450 ###       Say 'N' if in doubt.
451
452 config FEATURE_INDIVIDUAL
453         bool "Produce a binary for each applet, linked against libbusybox"
454         default y
455         depends on BUILD_LIBBUSYBOX
456         help
457           If your CPU architecture doesn't allow for sharing text/rodata
458           sections of running binaries, but allows for runtime dynamic
459           libraries, this option will allow you to reduce memory footprint
460           when you have many different applets running at once.
461
462           If your CPU architecture allows for sharing text/rodata,
463           having single binary is more optimal.
464
465           Each applet will be a tiny program, dynamically linked
466           against libbusybox.so.N.N.N.
467
468           You need to have a working dynamic linker.
469
470 config FEATURE_SHARED_BUSYBOX
471         bool "Produce additional busybox binary linked against libbusybox"
472         default y
473         depends on BUILD_LIBBUSYBOX
474         help
475           Build busybox, dynamically linked against libbusybox.so.N.N.N.
476
477           You need to have a working dynamic linker.
478
479 ### config BUILD_AT_ONCE
480 ###     bool "Compile all sources at once"
481 ###     default n
482 ###     help
483 ###       Normally each source-file is compiled with one invocation of
484 ###       the compiler.
485 ###       If you set this option, all sources are compiled at once.
486 ###       This gives the compiler more opportunities to optimize which can
487 ###       result in smaller and/or faster binaries.
488 ###
489 ###       Setting this option will consume alot of memory, e.g. if you
490 ###       enable all applets with all features, gcc uses more than 300MB
491 ###       RAM during compilation of busybox.
492 ###
493 ###       This option is most likely only beneficial for newer compilers
494 ###       such as gcc-4.1 and above.
495 ###
496 ###       Say 'N' unless you know what you are doing.
497
498 config LFS
499         bool "Build with Large File Support (for accessing files > 2 GB)"
500         default n
501         select FDISK_SUPPORT_LARGE_DISKS
502         help
503           If you want to build BusyBox with large file support, then enable
504           this option. This will have no effect if your kernel or your C
505           library lacks large file support for large files. Some of the
506           programs that can benefit from large file support include dd, gzip,
507           cp, mount, tar, and many others. If you want to access files larger
508           than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
509
510 config CROSS_COMPILER_PREFIX
511         string "Cross Compiler prefix"
512         default ""
513         help
514           If you want to build BusyBox with a cross compiler, then you
515           will need to set this to the cross-compiler prefix, for example,
516           "i386-uclibc-".
517
518           Note that CROSS_COMPILE environment variable or
519           "make CROSS_COMPILE=xxx ..." will override this selection.
520
521           Native builds leave this empty.
522
523 config EXTRA_CFLAGS
524         string "Additional CFLAGS"
525         default ""
526         help
527           Additional CFLAGS to pass to the compiler verbatim.
528
529 endmenu
530
531 menu 'Debugging Options'
532
533 config DEBUG
534         bool "Build BusyBox with extra Debugging symbols"
535         default n
536         help
537           Say Y here if you wish to examine BusyBox internals while applets are
538           running. This increases the size of the binary considerably, and
539           should only be used when doing development. If you are doing
540           development and want to debug BusyBox, answer Y.
541
542           Most people should answer N.
543
544 config DEBUG_PESSIMIZE
545         bool "Disable compiler optimizations"
546         default n
547         depends on DEBUG
548         help
549           The compiler's optimization of source code can eliminate and reorder
550           code, resulting in an executable that's hard to understand when
551           stepping through it with a debugger. This switches it off, resulting
552           in a much bigger executable that more closely matches the source
553           code.
554
555 config WERROR
556         bool "Abort compilation on any warning"
557         default n
558         help
559           Selecting this will add -Werror to gcc command line.
560
561           Most people should answer N.
562
563 choice
564         prompt "Additional debugging library"
565         default NO_DEBUG_LIB
566         help
567           Using an additional debugging library will make BusyBox become
568           considerable larger and will cause it to run more slowly. You
569           should always leave this option disabled for production use.
570
571           dmalloc support:
572           ----------------
573           This enables compiling with dmalloc ( http://dmalloc.com/ )
574           which is an excellent public domain mem leak and malloc problem
575           detector. To enable dmalloc, before running busybox you will
576           want to properly set your environment, for example:
577             export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
578           The 'debug=' value is generated using the following command
579             dmalloc -p log-stats -p log-non-free -p log-bad-space \
580                -p log-elapsed-time -p check-fence -p check-heap \
581                -p check-lists -p check-blank -p check-funcs -p realloc-copy \
582                -p allow-free-null
583
584           Electric-fence support:
585           -----------------------
586           This enables compiling with Electric-fence support. Electric
587           fence is another very useful malloc debugging library which uses
588           your computer's virtual memory hardware to detect illegal memory
589           accesses. This support will make BusyBox be considerable larger
590           and run slower, so you should leave this option disabled unless
591           you are hunting a hard to find memory problem.
592
593
594 config NO_DEBUG_LIB
595         bool "None"
596
597 config DMALLOC
598         bool "Dmalloc"
599
600 config EFENCE
601         bool "Electric-fence"
602
603 endchoice
604
605 ### config PARSE
606 ###     bool "Uniform config file parser debugging applet: parse"
607
608 endmenu
609
610 menu 'Installation Options'
611
612 config INSTALL_NO_USR
613         bool "Don't use /usr"
614         default n
615         help
616           Disable use of /usr. Don't activate this option if you don't know
617           that you really want this behaviour.
618
619 choice
620         prompt "Applets links"
621         default INSTALL_APPLET_SYMLINKS
622         help
623           Choose how you install applets links.
624
625 config INSTALL_APPLET_SYMLINKS
626         bool "as soft-links"
627         help
628           Install applets as soft-links to the busybox binary. This needs some
629           free inodes on the filesystem, but might help with filesystem
630           generators that can't cope with hard-links.
631
632 config INSTALL_APPLET_HARDLINKS
633         bool "as hard-links"
634         help
635           Install applets as hard-links to the busybox binary. This might
636           count on a filesystem with few inodes.
637
638 config INSTALL_APPLET_SCRIPT_WRAPPERS
639         bool "as script wrappers"
640         help
641           Install applets as script wrappers that call the busybox binary.
642
643 config INSTALL_APPLET_DONT
644         bool "not installed"
645         depends on FEATURE_INSTALLER || FEATURE_SH_STANDALONE || FEATURE_PREFER_APPLETS
646         help
647           Do not install applet links. Useful when using the -install feature
648           or a standalone shell for rescue purposes.
649
650 endchoice
651
652 choice
653         prompt "/bin/sh applet link"
654         default INSTALL_SH_APPLET_SYMLINK
655         depends on INSTALL_APPLET_SCRIPT_WRAPPERS
656         help
657           Choose how you install /bin/sh applet link.
658
659 config INSTALL_SH_APPLET_SYMLINK
660         bool "as soft-link"
661         help
662           Install /bin/sh applet as soft-link to the busybox binary.
663
664 config INSTALL_SH_APPLET_HARDLINK
665         bool "as hard-link"
666         help
667           Install /bin/sh applet as hard-link to the busybox binary.
668
669 config INSTALL_SH_APPLET_SCRIPT_WRAPPER
670         bool "as script wrapper"
671         help
672           Install /bin/sh applet as script wrapper that call the busybox
673           binary.
674
675 endchoice
676
677 config PREFIX
678         string "BusyBox installation prefix"
679         default "./_install"
680         help
681           Define your directory to install BusyBox files/subdirs in.
682
683 endmenu
684
685 source libbb/Config.in
686
687 endmenu
688
689 comment "Applets"
690
691 source archival/Config.in
692 source coreutils/Config.in
693 source console-tools/Config.in
694 source debianutils/Config.in
695 source editors/Config.in
696 source findutils/Config.in
697 source init/Config.in
698 source loginutils/Config.in
699 source e2fsprogs/Config.in
700 source modutils/Config.in
701 source util-linux/Config.in
702 source miscutils/Config.in
703 source networking/Config.in
704 source printutils/Config.in
705 source mailutils/Config.in
706 source procps/Config.in
707 source runit/Config.in
708 source selinux/Config.in
709 source shell/Config.in
710 source sysklogd/Config.in