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