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