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