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