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