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