- add central knob to turn off getopt_long everywhere. EXPERIMENTAL!
[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 choice
17         prompt "Buffer allocation policy"
18         default CONFIG_FEATURE_BUFFERS_USE_MALLOC
19         help
20           There are 3 ways BusyBox can handle buffer allocations:
21           - Use malloc. This costs code size for the call to xmalloc.
22           - Put them on stack. For some very small machines with limited stack
23             space, this can be deadly.  For most folks, this works just fine.
24           - Put them in BSS. This works beautifully for computers with a real
25             MMU (and OS support), but wastes runtime RAM for uCLinux. This
26             behavior was the only one available for BusyBox versions 0.48 and
27             earlier.
28
29 config CONFIG_FEATURE_BUFFERS_USE_MALLOC
30         bool "Allocate with Malloc"
31
32 config CONFIG_FEATURE_BUFFERS_GO_ON_STACK
33         bool "Allocate on the Stack"
34
35 config CONFIG_FEATURE_BUFFERS_GO_IN_BSS
36         bool "Allocate in the .bss section"
37
38 endchoice
39
40 config CONFIG_SHOW_USAGE
41         bool "Show terse applet usage messages"
42         default y
43         help
44           All BusyBox applets will show help messages when invoked with
45           wrong arguments. You can turn off printing these terse usage
46           messages if you say no here.
47           This will save you up to 7k.
48
49 config CONFIG_FEATURE_VERBOSE_USAGE
50         bool "Show verbose applet usage messages"
51         default n
52         select CONFIG_SHOW_USAGE
53         help
54           All BusyBox applets will show more verbose help messages when
55           busybox is invoked with --help.  This will add a lot of text to the
56           busybox binary.  In the default configuration, this will add about
57           13k, but it can add much more depending on your configuration.
58
59 config CONFIG_FEATURE_COMPRESS_USAGE
60         bool "Store applet usage messages in compressed form"
61         default y
62         depends on CONFIG_SHOW_USAGE
63         help
64           Store usage messages in compressed form, uncompress them on-the-fly
65           when <applet> --help is called.
66
67 config CONFIG_FEATURE_INSTALLER
68         bool "Support --install [-s] to install applet links at runtime"
69         default n
70         help
71           Enable 'busybox --install [-s]' support.  This will allow you to use
72           busybox at runtime to create hard links or symlinks for all the
73           applets that are compiled into busybox.  This feature requires the
74           /proc filesystem.
75
76 config CONFIG_LOCALE_SUPPORT
77         bool "Enable locale support (system needs locale for this to work)"
78         default n
79         help
80           Enable this if your system has locale support and you would like
81           busybox to support locale settings.
82
83 config CONFIG_GETOPT_LONG
84         bool "Enable getopt long (system needs struct option for this to work)"
85         default n
86         depends on !CONFIG_NO_GETOPT_LONG
87         help
88           EXPERIMENTAL!
89           Enable this if your system support long options for getopt and
90           you want to use them in busybox.
91
92 # remove this comment to disable getopt_long per default.
93 #config CONFIG_NO_GETOPT_LONG
94 #       bool
95 #       default y
96 #       depends on !CONFIG_GETOPT_LONG
97
98 config CONFIG_FEATURE_DEVFS
99         bool "Use devfs names for devices"
100         default n
101         help
102           This tells busybox to look for names like /dev/loop/0 instead of
103           /dev/loop0.  If your /dev directory has normal names instead of
104           devfs names, you don't want this.
105
106 config CONFIG_FEATURE_DEVPTS
107         bool "Use the devpts filesystem for Unix98 PTYs"
108         default y if CONFIG_FEATURE_DEVFS
109         help
110           Enable if you want BusyBox to use Unix98 PTY support. If enabled,
111           busybox will use /dev/ptmx for the master side of the pseudoterminal
112           and /dev/pts/<number> for the slave side.  Otherwise, BSD style
113           /dev/ttyp<number> will be used. To use this option, you should have
114           devpts or devfs mounted.
115
116 config CONFIG_FEATURE_CLEAN_UP
117         bool "Clean up all memory before exiting (usually not needed)"
118         default n
119         help
120           As a size optimization, busybox normally exits without explicitly
121           freeing dynamically allocated memory or closing files.  This saves
122           space since the OS will clean up for us, but it can confuse debuggers
123           like valgrind, which report tons of memory and resource leaks.
124
125           Don't enable this unless you have a really good reason to clean
126           things up manually.
127
128 config CONFIG_FEATURE_SUID
129         bool "Support for SUID/SGID handling"
130         default n
131         help
132           Support SUID and SGID binaries.
133
134 config CONFIG_FEATURE_SUID_CONFIG
135         bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
136         default n if CONFIG_FEATURE_SUID
137         depends on CONFIG_FEATURE_SUID
138         help
139           Allow the SUID / SGID state of an applet to be determined runtime by
140           checking /etc/busybox.conf.  The format of this file is as follows:
141
142           <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
143
144           An example might help:
145
146           [SUID]
147           su = ssx root.0 # applet su can be run by anyone and runs with euid=0/egid=0
148           su = ssx        # exactly the same
149
150           mount = sx- root.disk # applet mount can be run by root and members of group disk
151                                 # and runs with euid=0
152
153           cp = --- # disable applet cp for everyone
154
155           The file has to be owned by user root, group root and has to be
156           writeable only by root:
157                 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
158           The busybox executable has to be owned by user root, group
159           root and has to be setuid root for this to work:
160                 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
161
162           Robert 'sandman' Griebl has more information here:
163           <url: http://www.softforge.de/bb/suid.html >.
164
165 config CONFIG_FEATURE_SUID_CONFIG_QUIET
166         bool "Suppress warning message if /etc/busybox.conf is not readable"
167         default n
168         depends on CONFIG_FEATURE_SUID_CONFIG
169         help
170           /etc/busybox.conf should be readable by the user needing the SUID, check
171           this option to avoid users to be notified about missing permissions.
172
173 config CONFIG_SELINUX
174         bool "Support NSA Security Enhanced Linux"
175         default n
176         help
177           Enable support for SELinux in applets ls, ps, and id.  Also provide
178           the option of compiling in SELinux applets.
179
180           If you do not have a complete SELinux userland installed, this stuff
181           will not compile. Go visit
182                 http://www.nsa.gov/selinux/index.html
183           to download the necessary stuff to allow busybox to compile with
184           this option enabled. Specifially, libselinux 1.28 or better is
185           directly required by busybox. If the installation is located in a
186           non-standard directory, provide it by invoking make as follows:
187                 CFLAGS=-I<libselinux-include-path> \
188                 LDFLAGS=-L<libselinux-lib-path> \
189                 make
190
191           Most people will leave this set to 'N'.
192
193 endmenu
194
195 menu 'Build Options'
196
197 config CONFIG_STATIC
198         bool "Build BusyBox as a static binary (no shared libs)"
199         default n
200         help
201           If you want to build a static BusyBox binary, which does not
202           use or require any shared libraries, then enable this option.
203           This can cause BusyBox to be considerably larger, so you should
204           leave this option false unless you have a good reason (i.e.
205           your target platform does not support shared libraries, or
206           you are building an initrd which doesn't need anything but
207           BusyBox, etc).
208
209           Most people will leave this set to 'N'.
210
211 config CONFIG_BUILD_LIBBUSYBOX
212         bool "Build shared libbusybox"
213         default y
214         help
215           Build a shared library libbusybox.so which contains all
216           libraries used inside busybox.
217
218 config CONFIG_FEATURE_FULL_LIBBUSYBOX
219         bool "Feature-complete libbusybox"
220         default n if !CONFIG_FEATURE_SHARED_BUSYBOX
221         depends on CONFIG_BUILD_LIBBUSYBOX
222         help
223           Build a libbusybox with the complete feature-set, disregarding
224           the actually selected config.
225
226           Normally, libbusybox will only contain the features which are
227           used by busybox itself. If you plan to write a separate
228           standalone application which uses libbusybox say 'Y'.
229
230           Note: libbusybox is GPL, not LGPL, and exports no stable API that
231           might act as a copyright barrier.  We can and will modify the
232           exported function set between releases (even minor version number
233           changes), and happily break out-of-tree features.
234
235           Say 'N' if in doubt.
236
237 config CONFIG_FEATURE_SHARED_BUSYBOX
238         bool "Use shared libbusybox for busybox"
239         default y if CONFIG_BUILD_LIBBUSYBOX
240         depends on !CONFIG_STATIC && CONFIG_BUILD_LIBBUSYBOX
241         help
242           Use libbusybox.so also for busybox itself.
243           You need to have a working dynamic linker to use this variant.
244
245 config CONFIG_LFS
246         bool "Build with Large File Support (for accessing files > 2 GB)"
247         default n
248         select FDISK_SUPPORT_LARGE_DISKS
249         help
250           If you want to build BusyBox with large file support, then enable
251           this option.  This will have no effect if your kernel or your C
252           library lacks large file support for large files.  Some of the
253           programs that can benefit from large file support include dd, gzip,
254           cp, mount, tar, and many others.  If you want to access files larger
255           than 2 Gigabytes, enable this option.  Otherwise, leave it set to 'N'.
256
257 config USING_CROSS_COMPILER
258         bool "Do you want to build BusyBox with a Cross Compiler?"
259         default n
260         help
261           Do you want to build BusyBox with a Cross Compiler?  If so,
262           then enable this option.  Otherwise leave it set to 'N'.
263
264 config CROSS_COMPILER_PREFIX
265         string "Cross Compiler prefix"
266         default "/usr/i386-linux-uclibc/bin/i386-uclibc-"
267         depends on USING_CROSS_COMPILER
268         help
269           If you want to build BusyBox with a cross compiler, then you
270           will need to set this to the cross-compiler prefix.  For example,
271           if my cross-compiler is /usr/i386-linux-uclibc/bin/i386-uclibc-gcc
272           then I would enter '/usr/i386-linux-uclibc/bin/i386-uclibc-' here,
273           which will ensure the correct compiler is used.
274
275 config EXTRA_CFLAGS_OPTIONS
276         string "Any extra CFLAGS options for the compiler?"
277         default ""
278         help
279           Do you want to pass any extra CFLAGS options to the compiler as
280           you build BusyBox? If so, this is the option for you...  For example,
281           if you want to add some simple compiler switches (like -march=i686),
282           or check for warnings using -Werror, just those options here.
283
284 config CONFIG_BUILD_AT_ONCE
285         bool "Compile all sources at once"
286         default n
287         help
288           Normally each source-file is compiled with one invocation of
289           the compiler.
290           If you set this option, all sources are compiled at once.
291           This gives the compiler more opportunities to optimize which can
292           result in smaller and/or faster binaries.
293
294           Setting this option will consume alot of memory, e.g. if you
295           enable all applets with all features, gcc uses more than 300MB
296           RAM during compilation of busybox.
297
298           This option is most likely only beneficial for newer compilers
299           such as gcc-4.1 and above.
300
301           Say 'N' unless you know what you are doing.
302
303 endmenu
304
305 menu 'Debugging Options'
306
307 config CONFIG_DEBUG
308         bool "Build BusyBox with extra Debugging symbols"
309         default n
310         help
311           Say Y here if you wish to examine BusyBox internals while applets are
312           running.  This increases the size of the binary considerably, and
313           should only be used when doing development.  If you are doing
314           development and want to debug BusyBox, answer Y.
315
316           Most people should answer N.
317
318 config CONFIG_DEBUG_PESSIMIZE
319         bool "Disable compiler optimizations."
320         default n
321         depends on CONFIG_DEBUG
322         help
323           The compiler's optimization of source code can eliminate and reorder
324           code, resulting in an executable that's hard to understand when
325           stepping through it with a debugger.  This switches it off, resulting
326           in a much bigger executable that more closely matches the source
327           code.
328
329 choice
330         prompt "Additional debugging library"
331         default CONFIG_NO_DEBUG_LIB
332         depends on CONFIG_DEBUG
333         help
334           Using an additional debugging library will make BusyBox become
335           considerable larger and will cause it to run more slowly.  You
336           should always leave this option disabled for production use.
337
338           dmalloc support:
339           ----------------
340           This enables compiling with dmalloc ( http://dmalloc.com/ )
341           which is an excellent public domain mem leak and malloc problem
342           detector.  To enable dmalloc, before running busybox you will
343           want to properly set your environment, for example:
344             export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
345           The 'debug=' value is generated using the following command
346             dmalloc -p log-stats -p log-non-free -p log-bad-space -p log-elapsed-time \
347                -p check-fence -p check-heap -p check-lists -p check-blank \
348                -p check-funcs -p realloc-copy -p allow-free-null
349
350           Electric-fence support:
351           -----------------------
352           This enables compiling with Electric-fence support.  Electric
353           fence is another very useful malloc debugging library which uses
354           your computer's virtual memory hardware to detect illegal memory
355           accesses.  This support will make BusyBox be considerable larger
356           and run slower, so you should leave this option disabled unless
357           you are hunting a hard to find memory problem.
358
359
360 config CONFIG_NO_DEBUG_LIB
361         bool "None"
362
363 config CONFIG_DMALLOC
364         bool "Dmalloc"
365
366 config CONFIG_EFENCE
367         bool "Electric-fence"
368
369 endchoice
370
371 config CONFIG_DEBUG_YANK_SUSv2
372         bool "Disable obsolete features removed before SUSv3?"
373         default y
374         help
375           This option will disable backwards compatibility with SuSv2,
376           specifically, old-style numeric options ('command -1 <file>')
377           will not be supported in head, tail, and fold.  (Note: should
378           yank from renice too.)
379
380 endmenu
381
382 menu 'Installation Options'
383
384 config CONFIG_INSTALL_NO_USR
385         bool "Don't use /usr"
386         default n
387         help
388           Disable use of /usr. Don't activate this option if you don't know
389           that you really want this behaviour.
390
391 choice
392        prompt "Applets links"
393        default CONFIG_INSTALL_APPLET_SYMLINKS
394        help
395          Choose how you install applets links.
396
397 config CONFIG_INSTALL_APPLET_SYMLINKS
398        bool "as soft-links"
399        help
400          Install applets as soft-links to the busybox binary. This needs some
401          free inodes on the filesystem, but might help with filesystem
402          generators that can't cope with hard-links.
403
404 config CONFIG_INSTALL_APPLET_HARDLINKS
405        bool "as hard-links"
406        help
407          Install applets as hard-links to the busybox binary. This might count
408          on a filesystem with few inodes.
409
410 config CONFIG_INSTALL_APPLET_DONT
411        bool
412        prompt "not installed"
413        depends on CONFIG_FEATURE_INSTALLER || CONFIG_FEATURE_SH_STANDALONE_SHELL
414        help
415          Do not install applets links. Usefull when using the -install feature
416          or a standalone shell for rescue pruposes.
417
418 endchoice
419
420 config PREFIX
421         string "BusyBox installation prefix"
422         default "./_install"
423         help
424           Define your directory to install BusyBox files/subdirs in.
425
426 endmenu
427
428 source libbb/Config.in
429
430 endmenu
431
432 comment "Applets"
433
434 source archival/Config.in
435 source coreutils/Config.in
436 source console-tools/Config.in
437 source debianutils/Config.in
438 source editors/Config.in
439 source findutils/Config.in
440 source init/Config.in
441 source loginutils/Config.in
442 source e2fsprogs/Config.in
443 source modutils/Config.in
444 source util-linux/Config.in
445 source miscutils/Config.in
446 source networking/Config.in
447 source procps/Config.in
448 source shell/Config.in
449 source sysklogd/Config.in