Remove bb_ prefixes from xfuncs.c (and a few other places), consolidate
[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 && CONFIG_NITPICK
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_SUID_CONFIG
154         bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
155         default n if CONFIG_FEATURE_SUID
156         depends on CONFIG_FEATURE_SUID
157         help
158           Allow the SUID / SGID state of an applet to be determined at runtime
159           by checking /etc/busybox.conf.  (This is sort of a poor man's sudo.)
160           The format of this file is as follows:
161
162           <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
163
164           An example might help:
165
166           [SUID]
167           su = ssx root.0 # applet su can be run by anyone and runs with euid=0/egid=0
168           su = ssx        # exactly the same
169
170           mount = sx- root.disk # applet mount can be run by root and members of group disk
171                                 # and runs with euid=0
172
173           cp = --- # disable applet cp for everyone
174
175           The file has to be owned by user root, group root and has to be
176           writeable only by root:
177                 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
178           The busybox executable has to be owned by user root, group
179           root and has to be setuid root for this to work:
180                 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
181
182           Robert 'sandman' Griebl has more information here:
183           <url: http://www.softforge.de/bb/suid.html >.
184
185 config CONFIG_FEATURE_SUID_CONFIG_QUIET
186         bool "Suppress warning message if /etc/busybox.conf is not readable"
187         default y
188         depends on CONFIG_FEATURE_SUID_CONFIG
189         help
190           /etc/busybox.conf should be readable by the user needing the SUID, check
191           this option to avoid users to be notified about missing permissions.
192
193 config CONFIG_SELINUX
194         bool "Support NSA Security Enhanced Linux"
195         default n
196         help
197           Enable support for SELinux in applets ls, ps, and id.  Also provide
198           the option of compiling in SELinux applets.
199
200           If you do not have a complete SELinux userland installed, this stuff
201           will not compile. Go visit
202                 http://www.nsa.gov/selinux/index.html
203           to download the necessary stuff to allow busybox to compile with
204           this option enabled. Specifially, libselinux 1.28 or better is
205           directly required by busybox. If the installation is located in a
206           non-standard directory, provide it by invoking make as follows:
207                 CFLAGS=-I<libselinux-include-path> \
208                 LDFLAGS=-L<libselinux-lib-path> \
209                 make
210
211           Most people will leave this set to 'N'.
212
213 config CONFIG_BUSYBOX_EXEC_PATH
214         string "Path to BusyBox executable"
215         default "/proc/self/exe"
216         help
217           When Busybox applets need to run other busybox applets, BusyBox
218           sometimes needs to exec() itself.  When the /proc filesystem is
219           mounted, /proc/self/exe always points to the currently running
220           executable.  If you haven't got /proc, set this to wherever you
221           want to run BusyBox from.
222
223 endmenu
224
225 menu 'Build Options'
226
227 config CONFIG_STATIC
228         bool "Build BusyBox as a static binary (no shared libs)"
229         default n
230         help
231           If you want to build a static BusyBox binary, which does not
232           use or require any shared libraries, then enable this option.
233           This can cause BusyBox to be considerably larger, so you should
234           leave this option false unless you have a good reason (i.e.
235           your target platform does not support shared libraries, or
236           you are building an initrd which doesn't need anything but
237           BusyBox, etc).
238
239           Most people will leave this set to 'N'.
240
241 config CONFIG_BUILD_LIBBUSYBOX
242         bool "Build shared libbusybox"
243         default n
244         help
245           Build a shared library libbusybox.so which contains all
246           libraries used inside busybox.
247
248           This is an experimental feature intended to support the upcoming
249           "make standalone" mode.  Enabling it against the one big busybox
250           binary serves no purpose (and increases the size).  You should
251           almost certainly say "no" to this right now.
252
253 config CONFIG_FEATURE_FULL_LIBBUSYBOX
254         bool "Feature-complete libbusybox"
255         default n if !CONFIG_FEATURE_SHARED_BUSYBOX
256         depends on CONFIG_BUILD_LIBBUSYBOX
257         help
258           Build a libbusybox with the complete feature-set, disregarding
259           the actually selected config.
260
261           Normally, libbusybox will only contain the features which are
262           used by busybox itself. If you plan to write a separate
263           standalone application which uses libbusybox say 'Y'.
264
265           Note: libbusybox is GPL, not LGPL, and exports no stable API that
266           might act as a copyright barrier.  We can and will modify the
267           exported function set between releases (even minor version number
268           changes), and happily break out-of-tree features.
269
270           Say 'N' if in doubt.
271
272 config CONFIG_FEATURE_SHARED_BUSYBOX
273         bool "Use shared libbusybox for busybox"
274         default y if CONFIG_BUILD_LIBBUSYBOX
275         depends on !CONFIG_STATIC && CONFIG_BUILD_LIBBUSYBOX
276         help
277           Use libbusybox.so also for busybox itself.
278           You need to have a working dynamic linker to use this variant.
279
280 config CONFIG_LFS
281         bool "Build with Large File Support (for accessing files > 2 GB)"
282         default n
283         select FDISK_SUPPORT_LARGE_DISKS
284         help
285           If you want to build BusyBox with large file support, then enable
286           this option.  This will have no effect if your kernel or your C
287           library lacks large file support for large files.  Some of the
288           programs that can benefit from large file support include dd, gzip,
289           cp, mount, tar, and many others.  If you want to access files larger
290           than 2 Gigabytes, enable this option.  Otherwise, leave it set to 'N'.
291
292 config CONFIG_BUILD_AT_ONCE
293         bool "Compile all sources at once"
294         default n
295         help
296           Normally each source-file is compiled with one invocation of
297           the compiler.
298           If you set this option, all sources are compiled at once.
299           This gives the compiler more opportunities to optimize which can
300           result in smaller and/or faster binaries.
301
302           Setting this option will consume alot of memory, e.g. if you
303           enable all applets with all features, gcc uses more than 300MB
304           RAM during compilation of busybox.
305
306           This option is most likely only beneficial for newer compilers
307           such as gcc-4.1 and above.
308
309           Say 'N' unless you know what you are doing.
310
311 endmenu
312
313 menu 'Debugging Options'
314
315 config CONFIG_DEBUG
316         bool "Build BusyBox with extra Debugging symbols"
317         default n
318         help
319           Say Y here if you wish to examine BusyBox internals while applets are
320           running.  This increases the size of the binary considerably, and
321           should only be used when doing development.  If you are doing
322           development and want to debug BusyBox, answer Y.
323
324           Most people should answer N.
325
326 config CONFIG_DEBUG_PESSIMIZE
327         bool "Disable compiler optimizations."
328         default n
329         depends on CONFIG_DEBUG
330         help
331           The compiler's optimization of source code can eliminate and reorder
332           code, resulting in an executable that's hard to understand when
333           stepping through it with a debugger.  This switches it off, resulting
334           in a much bigger executable that more closely matches the source
335           code.
336
337 choice
338         prompt "Additional debugging library"
339         default CONFIG_NO_DEBUG_LIB
340         depends on CONFIG_DEBUG
341         help
342           Using an additional debugging library will make BusyBox become
343           considerable larger and will cause it to run more slowly.  You
344           should always leave this option disabled for production use.
345
346           dmalloc support:
347           ----------------
348           This enables compiling with dmalloc ( http://dmalloc.com/ )
349           which is an excellent public domain mem leak and malloc problem
350           detector.  To enable dmalloc, before running busybox you will
351           want to properly set your environment, for example:
352             export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
353           The 'debug=' value is generated using the following command
354             dmalloc -p log-stats -p log-non-free -p log-bad-space -p log-elapsed-time \
355                -p check-fence -p check-heap -p check-lists -p check-blank \
356                -p check-funcs -p realloc-copy -p allow-free-null
357
358           Electric-fence support:
359           -----------------------
360           This enables compiling with Electric-fence support.  Electric
361           fence is another very useful malloc debugging library which uses
362           your computer's virtual memory hardware to detect illegal memory
363           accesses.  This support will make BusyBox be considerable larger
364           and run slower, so you should leave this option disabled unless
365           you are hunting a hard to find memory problem.
366
367
368 config CONFIG_NO_DEBUG_LIB
369         bool "None"
370
371 config CONFIG_DMALLOC
372         bool "Dmalloc"
373
374 config CONFIG_EFENCE
375         bool "Electric-fence"
376
377 endchoice
378
379 config CONFIG_DEBUG_YANK_SUSv2
380         bool "Disable obsolete features removed before SUSv3?"
381         default y
382         help
383           This option will disable backwards compatibility with SuSv2,
384           specifically, old-style numeric options ('command -1 <file>')
385           will not be supported in head, tail, and fold.  (Note: should
386           yank from renice too.)
387
388 endmenu
389
390 menu 'Installation Options'
391
392 config CONFIG_INSTALL_NO_USR
393         bool "Don't use /usr"
394         default n
395         help
396           Disable use of /usr. Don't activate this option if you don't know
397           that you really want this behaviour.
398
399 choice
400        prompt "Applets links"
401        default CONFIG_INSTALL_APPLET_SYMLINKS
402        help
403          Choose how you install applets links.
404
405 config CONFIG_INSTALL_APPLET_SYMLINKS
406        bool "as soft-links"
407        help
408          Install applets as soft-links to the busybox binary. This needs some
409          free inodes on the filesystem, but might help with filesystem
410          generators that can't cope with hard-links.
411
412 config CONFIG_INSTALL_APPLET_HARDLINKS
413        bool "as hard-links"
414        help
415          Install applets as hard-links to the busybox binary. This might count
416          on a filesystem with few inodes.
417
418 config CONFIG_INSTALL_APPLET_DONT
419        bool
420        prompt "not installed"
421        depends on CONFIG_FEATURE_INSTALLER || CONFIG_FEATURE_SH_STANDALONE_SHELL
422        help
423          Do not install applets links. Usefull when using the -install feature
424          or a standalone shell for rescue pruposes.
425
426 endchoice
427
428 config PREFIX
429         string "BusyBox installation prefix"
430         default "./_install"
431         help
432           Define your directory to install BusyBox files/subdirs in.
433
434 endmenu
435
436 source libbb/Config.in
437
438 endmenu
439
440 comment "Applets"
441
442 source archival/Config.in
443 source coreutils/Config.in
444 source console-tools/Config.in
445 source debianutils/Config.in
446 source editors/Config.in
447 source findutils/Config.in
448 source init/Config.in
449 source loginutils/Config.in
450 source e2fsprogs/Config.in
451 source modutils/Config.in
452 source util-linux/Config.in
453 source miscutils/Config.in
454 source networking/Config.in
455 source procps/Config.in
456 source shell/Config.in
457 source sysklogd/Config.in