f7ee7b3d412d75b0ed8f7475eb465c2487fdace5
[openwrt/openwrt.git] / package / busybox / config / Config.in
1 #
2 # For a description of the syntax of this configuration file,
3 # see scripts/kbuild/config-language.txt.
4 #
5
6
7 config BUSYBOX_CONFIG_HAVE_DOT_CONFIG
8 bool
9 default y
10
11 menu "Busybox Settings"
12
13 menu "General Configuration"
14
15 config BUSYBOX_CONFIG_DESKTOP
16 bool "Enable options for full-blown desktop systems"
17 default n
18 help
19 Enable options and features which are not essential.
20 Select this only if you plan to use busybox on full-blown
21 desktop machine with common Linux distro, not on an embedded box.
22
23 config BUSYBOX_CONFIG_EXTRA_COMPAT
24 bool "Provide compatible behavior for rare corner cases (bigger code)"
25 default n
26 help
27 This option makes grep, sed etc handle rare corner cases
28 (embedded NUL bytes and such). This makes code bigger and uses
29 some GNU extensions in libc. You probably only need this option
30 if you plan to run busybox on desktop.
31
32 config BUSYBOX_CONFIG_INCLUDE_SUSv2
33 bool "Enable obsolete features removed before SUSv3"
34 default y
35 help
36 This option will enable backwards compatibility with SuSv2,
37 specifically, old-style numeric options ('command -1 <file>')
38 will be supported in head, tail, and fold. (Note: should
39 affect renice too.)
40
41 config BUSYBOX_CONFIG_USE_PORTABLE_CODE
42 bool "Avoid using GCC-specific code constructs"
43 default n
44 help
45 Use this option if you are trying to compile busybox with
46 compiler other than gcc.
47 If you do use gcc, this option may needlessly increase code size.
48
49 choice
50 prompt "Buffer allocation policy"
51 default BUSYBOX_CONFIG_FEATURE_BUFFERS_GO_ON_STACK
52 help
53 There are 3 ways BusyBox can handle buffer allocations:
54 - Use malloc. This costs code size for the call to xmalloc.
55 - Put them on stack. For some very small machines with limited stack
56 space, this can be deadly. For most folks, this works just fine.
57 - Put them in BSS. This works beautifully for computers with a real
58 MMU (and OS support), but wastes runtime RAM for uCLinux. This
59 behavior was the only one available for BusyBox versions 0.48 and
60 earlier.
61
62 config BUSYBOX_CONFIG_FEATURE_BUFFERS_USE_MALLOC
63 bool "Allocate with Malloc"
64
65 config BUSYBOX_CONFIG_FEATURE_BUFFERS_GO_ON_STACK
66 bool "Allocate on the Stack"
67
68 config BUSYBOX_CONFIG_FEATURE_BUFFERS_GO_IN_BSS
69 bool "Allocate in the .bss section"
70
71 endchoice
72
73 config BUSYBOX_CONFIG_SHOW_USAGE
74 bool "Show terse applet usage messages"
75 default y
76 help
77 All BusyBox applets will show help messages when invoked with
78 wrong arguments. You can turn off printing these terse usage
79 messages if you say no here.
80 This will save you up to 7k.
81
82 config BUSYBOX_CONFIG_FEATURE_VERBOSE_USAGE
83 bool "Show verbose applet usage messages"
84 default y
85 select BUSYBOX_CONFIG_SHOW_USAGE
86 help
87 All BusyBox applets will show more verbose help messages when
88 busybox is invoked with --help. This will add a lot of text to the
89 busybox binary. In the default configuration, this will add about
90 13k, but it can add much more depending on your configuration.
91
92 config BUSYBOX_CONFIG_FEATURE_COMPRESS_USAGE
93 bool "Store applet usage messages in compressed form"
94 default y
95 depends on BUSYBOX_CONFIG_SHOW_USAGE
96 help
97 Store usage messages in compressed form, uncompress them on-the-fly
98 when <applet> --help is called.
99
100 If you have a really tiny busybox with few applets enabled (and
101 bunzip2 isn't one of them), the overhead of the decompressor might
102 be noticeable. Also, if you run executables directly from ROM
103 and have very little memory, this might not be a win. Otherwise,
104 you probably want this.
105
106 config BUSYBOX_CONFIG_FEATURE_INSTALLER
107 bool "Support --install [-s] to install applet links at runtime"
108 default n
109 help
110 Enable 'busybox --install [-s]' support. This will allow you to use
111 busybox at runtime to create hard links or symlinks for all the
112 applets that are compiled into busybox.
113
114 config BUSYBOX_CONFIG_LOCALE_SUPPORT
115 bool "Enable locale support (system needs locale for this to work)"
116 default n
117 help
118 Enable this if your system has locale support and you would like
119 busybox to support locale settings.
120
121 config BUSYBOX_CONFIG_FEATURE_ASSUME_UNICODE
122 bool "Support Unicode"
123 default n
124 help
125 This makes various applets aware that one byte is not
126 one character on screen.
127
128 Busybox aims to eventually work correctly with Unicode displays.
129 Any older encodings are not guaranteed to work.
130 Probably by the time when busybox will be fully Unicode-clean,
131 other encodings will be mainly of historic interest.
132
133 config BUSYBOX_CONFIG_FEATURE_CHECK_UNICODE_IN_ENV
134 bool "Check $LANG environment variable"
135 default n
136 depends on BUSYBOX_CONFIG_FEATURE_ASSUME_UNICODE && !BUSYBOX_CONFIG_LOCALE_SUPPORT
137 help
138 With this option on, Unicode support is activated
139 only if LANG variable has the value of the form "xxxx.utf8"
140
141 Otherwise, Unicode support will be always enabled and active.
142
143 config BUSYBOX_CONFIG_LONG_OPTS
144 bool "Support for --long-options"
145 default y
146 help
147 Enable this if you want busybox applets to use the gnu --long-option
148 style, in addition to single character -a -b -c style options.
149
150 config BUSYBOX_CONFIG_FEATURE_DEVPTS
151 bool "Use the devpts filesystem for Unix98 PTYs"
152 default y
153 help
154 Enable if you want BusyBox to use Unix98 PTY support. If enabled,
155 busybox will use /dev/ptmx for the master side of the pseudoterminal
156 and /dev/pts/<number> for the slave side. Otherwise, BSD style
157 /dev/ttyp<number> will be used. To use this option, you should have
158 devpts mounted.
159
160 config BUSYBOX_CONFIG_FEATURE_CLEAN_UP
161 bool "Clean up all memory before exiting (usually not needed)"
162 default n
163 help
164 As a size optimization, busybox normally exits without explicitly
165 freeing dynamically allocated memory or closing files. This saves
166 space since the OS will clean up for us, but it can confuse debuggers
167 like valgrind, which report tons of memory and resource leaks.
168
169 Don't enable this unless you have a really good reason to clean
170 things up manually.
171
172 config BUSYBOX_CONFIG_FEATURE_PIDFILE
173 bool "Support writing pidfiles"
174 default y
175 help
176 This option makes some applets (e.g. crond, syslogd, inetd) write
177 a pidfile in /var/run. Some applications rely on them.
178
179 config BUSYBOX_CONFIG_FEATURE_SUID
180 bool "Support for SUID/SGID handling"
181 default y
182 help
183 With this option you can install the busybox binary belonging
184 to root with the suid bit set, and it will automatically drop
185 priviledges for applets that don't need root access.
186
187 If you are really paranoid and don't want to do this, build two
188 busybox binaries with different applets in them (and the appropriate
189 symlinks pointing to each binary), and only set the suid bit on the
190 one that needs it. The applets currently marked to need the suid bit
191 are:
192
193 crontab, dnsd, findfs, ipcrm, ipcs, login, passwd, ping, su,
194 traceroute, vlock.
195
196 config BUSYBOX_CONFIG_FEATURE_SUID_CONFIG
197 bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
198 default n if BUSYBOX_CONFIG_FEATURE_SUID
199 depends on BUSYBOX_CONFIG_FEATURE_SUID
200 help
201 Allow the SUID / SGID state of an applet to be determined at runtime
202 by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
203 The format of this file is as follows:
204
205 <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
206
207 An example might help:
208
209 [SUID]
210 su = ssx root.0 # applet su can be run by anyone and runs with
211 # euid=0/egid=0
212 su = ssx # exactly the same
213
214 mount = sx- root.disk # applet mount can be run by root and members
215 # of group disk and runs with euid=0
216
217 cp = --- # disable applet cp for everyone
218
219 The file has to be owned by user root, group root and has to be
220 writeable only by root:
221 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
222 The busybox executable has to be owned by user root, group
223 root and has to be setuid root for this to work:
224 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
225
226 Robert 'sandman' Griebl has more information here:
227 <url: http://www.softforge.de/bb/suid.html >.
228
229 config BUSYBOX_CONFIG_FEATURE_SUID_CONFIG_QUIET
230 bool "Suppress warning message if /etc/busybox.conf is not readable"
231 default n
232 depends on BUSYBOX_CONFIG_FEATURE_SUID_CONFIG
233 help
234 /etc/busybox.conf should be readable by the user needing the SUID,
235 check this option to avoid users to be notified about missing
236 permissions.
237
238 config BUSYBOX_CONFIG_SELINUX
239 bool "Support NSA Security Enhanced Linux"
240 default n
241 help
242 Enable support for SELinux in applets ls, ps, and id. Also provide
243 the option of compiling in SELinux applets.
244
245 If you do not have a complete SELinux userland installed, this stuff
246 will not compile. Go visit
247 http://www.nsa.gov/selinux/index.html
248 to download the necessary stuff to allow busybox to compile with
249 this option enabled. Specifially, libselinux 1.28 or better is
250 directly required by busybox. If the installation is located in a
251 non-standard directory, provide it by invoking make as follows:
252 CFLAGS=-I<libselinux-include-path> \
253 LDFLAGS=-L<libselinux-lib-path> \
254 make
255
256 Most people will leave this set to 'N'.
257
258 config BUSYBOX_CONFIG_FEATURE_PREFER_APPLETS
259 bool "exec prefers applets"
260 default y
261 help
262 This is an experimental option which directs applets about to
263 call 'exec' to try and find an applicable busybox applet before
264 searching the PATH. This is typically done by exec'ing
265 /proc/self/exe.
266 This may affect shell, find -exec, xargs and similar applets.
267 They will use applets even if /bin/<applet> -> busybox link
268 is missing (or is not a link to busybox). However, this causes
269 problems in chroot jails without mounted /proc and with ps/top
270 (command name can be shown as 'exe' for applets started this way).
271
272 config BUSYBOX_CONFIG_BUSYBOX_EXEC_PATH
273 string "Path to BusyBox executable"
274 default "/proc/self/exe"
275 help
276 When Busybox applets need to run other busybox applets, BusyBox
277 sometimes needs to exec() itself. When the /proc filesystem is
278 mounted, /proc/self/exe always points to the currently running
279 executable. If you haven't got /proc, set this to wherever you
280 want to run BusyBox from.
281
282 # These are auto-selected by other options
283
284 config BUSYBOX_CONFIG_FEATURE_SYSLOG
285 bool #No description makes it a hidden option
286 default y
287 #help
288 # This option is auto-selected when you select any applet which may
289 # send its output to syslog. You do not need to select it manually.
290
291 config BUSYBOX_CONFIG_FEATURE_HAVE_RPC
292 bool #No description makes it a hidden option
293 default y
294 #help
295 # This is automatically selected if any of enabled applets need it.
296 # You do not need to select it manually.
297
298 endmenu
299
300 menu 'Build Options'
301
302 config BUSYBOX_CONFIG_STATIC
303 bool "Build BusyBox as a static binary (no shared libs)"
304 default n
305 help
306 If you want to build a static BusyBox binary, which does not
307 use or require any shared libraries, then enable this option.
308 This can cause BusyBox to be considerably larger, so you should
309 leave this option false unless you have a good reason (i.e.
310 your target platform does not support shared libraries, or
311 you are building an initrd which doesn't need anything but
312 BusyBox, etc).
313
314 Most people will leave this set to 'N'.
315
316 config BUSYBOX_CONFIG_PIE
317 bool "Build BusyBox as a position independent executable"
318 default n
319 depends on !BUSYBOX_CONFIG_STATIC
320 help
321 (TODO: what is it and why/when is it useful?)
322 Most people will leave this set to 'N'.
323
324 config BUSYBOX_CONFIG_NOMMU
325 bool "Force NOMMU build"
326 default n
327 help
328 Busybox tries to detect whether architecture it is being
329 built against supports MMU or not. If this detection fails,
330 or if you want to build NOMMU version of busybox for testing,
331 you may force NOMMU build here.
332
333 Most people will leave this set to 'N'.
334
335 # PIE can be made to work with BUILD_LIBBUSYBOX, but currently
336 # build system does not support that
337 config BUSYBOX_CONFIG_BUILD_LIBBUSYBOX
338 bool "Build shared libbusybox"
339 default n
340 depends on !BUSYBOX_CONFIG_FEATURE_PREFER_APPLETS && !BUSYBOX_CONFIG_PIE && !BUSYBOX_CONFIG_STATIC
341 help
342 Build a shared library libbusybox.so.N.N.N which contains all
343 busybox code.
344
345 This feature allows every applet to be built as a tiny
346 separate executable. Enabling it for "one big busybox binary"
347 approach serves no purpose and increases code size.
348 You should almost certainly say "no" to this.
349
350 ### config FEATURE_FULL_LIBBUSYBOX
351 ### bool "Feature-complete libbusybox"
352 ### default n if !FEATURE_SHARED_BUSYBOX
353 ### depends on BUILD_LIBBUSYBOX
354 ### help
355 ### Build a libbusybox with the complete feature-set, disregarding
356 ### the actually selected config.
357 ###
358 ### Normally, libbusybox will only contain the features which are
359 ### used by busybox itself. If you plan to write a separate
360 ### standalone application which uses libbusybox say 'Y'.
361 ###
362 ### Note: libbusybox is GPL, not LGPL, and exports no stable API that
363 ### might act as a copyright barrier. We can and will modify the
364 ### exported function set between releases (even minor version number
365 ### changes), and happily break out-of-tree features.
366 ###
367 ### Say 'N' if in doubt.
368
369 config BUSYBOX_CONFIG_FEATURE_INDIVIDUAL
370 bool "Produce a binary for each applet, linked against libbusybox"
371 default n
372 depends on BUSYBOX_CONFIG_BUILD_LIBBUSYBOX
373 help
374 If your CPU architecture doesn't allow for sharing text/rodata
375 sections of running binaries, but allows for runtime dynamic
376 libraries, this option will allow you to reduce memory footprint
377 when you have many different applets running at once.
378
379 If your CPU architecture allows for sharing text/rodata,
380 having single binary is more optimal.
381
382 Each applet will be a tiny program, dynamically linked
383 against libbusybox.so.N.N.N.
384
385 You need to have a working dynamic linker.
386
387 config BUSYBOX_CONFIG_FEATURE_SHARED_BUSYBOX
388 bool "Produce additional busybox binary linked against libbusybox"
389 default n
390 depends on BUSYBOX_CONFIG_BUILD_LIBBUSYBOX
391 help
392 Build busybox, dynamically linked against libbusybox.so.N.N.N.
393
394 You need to have a working dynamic linker.
395
396 ### config BUILD_AT_ONCE
397 ### bool "Compile all sources at once"
398 ### default n
399 ### help
400 ### Normally each source-file is compiled with one invocation of
401 ### the compiler.
402 ### If you set this option, all sources are compiled at once.
403 ### This gives the compiler more opportunities to optimize which can
404 ### result in smaller and/or faster binaries.
405 ###
406 ### Setting this option will consume alot of memory, e.g. if you
407 ### enable all applets with all features, gcc uses more than 300MB
408 ### RAM during compilation of busybox.
409 ###
410 ### This option is most likely only beneficial for newer compilers
411 ### such as gcc-4.1 and above.
412 ###
413 ### Say 'N' unless you know what you are doing.
414
415 config BUSYBOX_CONFIG_LFS
416 bool
417 default y
418 select BUSYBOX_CONFIG_FDISK_SUPPORT_LARGE_DISKS
419 help
420 If you want to build BusyBox with large file support, then enable
421 this option. This will have no effect if your kernel or your C
422 library lacks large file support for large files. Some of the
423 programs that can benefit from large file support include dd, gzip,
424 cp, mount, tar, and many others. If you want to access files larger
425 than 2 Gigabytes, enable this option. Otherwise, leave it set to 'N'.
426
427 config BUSYBOX_CONFIG_CROSS_COMPILER_PREFIX
428 string "Cross Compiler prefix"
429 default ""
430 help
431 If you want to build BusyBox with a cross compiler, then you
432 will need to set this to the cross-compiler prefix, for example,
433 "i386-uclibc-".
434
435 Note that CROSS_COMPILE environment variable or
436 "make CROSS_COMPILE=xxx ..." will override this selection.
437
438 Native builds leave this empty.
439
440 config BUSYBOX_CONFIG_EXTRA_CFLAGS
441 string "Additional CFLAGS"
442 default ""
443 help
444 Additional CFLAGS to pass to the compiler verbatim.
445
446 endmenu
447
448 menu 'Debugging Options'
449
450 config BUSYBOX_CONFIG_DEBUG
451 bool "Build BusyBox with extra Debugging symbols"
452 default n
453 help
454 Say Y here if you wish to examine BusyBox internals while applets are
455 running. This increases the size of the binary considerably, and
456 should only be used when doing development. If you are doing
457 development and want to debug BusyBox, answer Y.
458
459 Most people should answer N.
460
461 config BUSYBOX_CONFIG_DEBUG_PESSIMIZE
462 bool "Disable compiler optimizations"
463 default n
464 depends on BUSYBOX_CONFIG_DEBUG
465 help
466 The compiler's optimization of source code can eliminate and reorder
467 code, resulting in an executable that's hard to understand when
468 stepping through it with a debugger. This switches it off, resulting
469 in a much bigger executable that more closely matches the source
470 code.
471
472 config BUSYBOX_CONFIG_WERROR
473 bool "Abort compilation on any warning"
474 default n
475 help
476 Selecting this will add -Werror to gcc command line.
477
478 Most people should answer N.
479
480 choice
481 prompt "Additional debugging library"
482 default BUSYBOX_CONFIG_NO_DEBUG_LIB
483 help
484 Using an additional debugging library will make BusyBox become
485 considerable larger and will cause it to run more slowly. You
486 should always leave this option disabled for production use.
487
488 dmalloc support:
489 ----------------
490 This enables compiling with dmalloc ( http://dmalloc.com/ )
491 which is an excellent public domain mem leak and malloc problem
492 detector. To enable dmalloc, before running busybox you will
493 want to properly set your environment, for example:
494 export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
495 The 'debug=' value is generated using the following command
496 dmalloc -p log-stats -p log-non-free -p log-bad-space \
497 -p log-elapsed-time -p check-fence -p check-heap \
498 -p check-lists -p check-blank -p check-funcs -p realloc-copy \
499 -p allow-free-null
500
501 Electric-fence support:
502 -----------------------
503 This enables compiling with Electric-fence support. Electric
504 fence is another very useful malloc debugging library which uses
505 your computer's virtual memory hardware to detect illegal memory
506 accesses. This support will make BusyBox be considerable larger
507 and run slower, so you should leave this option disabled unless
508 you are hunting a hard to find memory problem.
509
510
511 config BUSYBOX_CONFIG_NO_DEBUG_LIB
512 bool "None"
513
514 config BUSYBOX_CONFIG_DMALLOC
515 bool "Dmalloc"
516
517 config BUSYBOX_CONFIG_EFENCE
518 bool "Electric-fence"
519
520 endchoice
521
522 ### config PARSE
523 ### bool "Uniform config file parser debugging applet: parse"
524
525 endmenu
526
527 menu 'Installation Options'
528
529 config BUSYBOX_CONFIG_INSTALL_NO_USR
530 bool "Don't use /usr"
531 default n
532 help
533 Disable use of /usr. Don't activate this option if you don't know
534 that you really want this behaviour.
535
536 choice
537 prompt "Applets links"
538 default BUSYBOX_CONFIG_INSTALL_APPLET_SYMLINKS
539 help
540 Choose how you install applets links.
541
542 config BUSYBOX_CONFIG_INSTALL_APPLET_SYMLINKS
543 bool "as soft-links"
544 help
545 Install applets as soft-links to the busybox binary. This needs some
546 free inodes on the filesystem, but might help with filesystem
547 generators that can't cope with hard-links.
548
549 config BUSYBOX_CONFIG_INSTALL_APPLET_HARDLINKS
550 bool "as hard-links"
551 help
552 Install applets as hard-links to the busybox binary. This might
553 count on a filesystem with few inodes.
554
555 config BUSYBOX_CONFIG_INSTALL_APPLET_SCRIPT_WRAPPERS
556 bool "as script wrappers"
557 help
558 Install applets as script wrappers that call the busybox binary.
559
560 config BUSYBOX_CONFIG_INSTALL_APPLET_DONT
561 bool "not installed"
562 depends on BUSYBOX_CONFIG_FEATURE_INSTALLER || BUSYBOX_CONFIG_FEATURE_SH_STANDALONE || BUSYBOX_CONFIG_FEATURE_PREFER_APPLETS
563 help
564 Do not install applet links. Useful when using the -install feature
565 or a standalone shell for rescue purposes.
566
567 endchoice
568
569 choice
570 prompt "/bin/sh applet link"
571 default BUSYBOX_CONFIG_INSTALL_SH_APPLET_SYMLINK
572 depends on BUSYBOX_CONFIG_INSTALL_APPLET_SCRIPT_WRAPPERS
573 help
574 Choose how you install /bin/sh applet link.
575
576 config BUSYBOX_CONFIG_INSTALL_SH_APPLET_SYMLINK
577 bool "as soft-link"
578 help
579 Install /bin/sh applet as soft-link to the busybox binary.
580
581 config BUSYBOX_CONFIG_INSTALL_SH_APPLET_HARDLINK
582 bool "as hard-link"
583 help
584 Install /bin/sh applet as hard-link to the busybox binary.
585
586 config BUSYBOX_CONFIG_INSTALL_SH_APPLET_SCRIPT_WRAPPER
587 bool "as script wrapper"
588 help
589 Install /bin/sh applet as script wrapper that call the busybox
590 binary.
591
592 endchoice
593
594 config BUSYBOX_CONFIG_PREFIX
595 string "BusyBox installation prefix"
596 default "./_install"
597 help
598 Define your directory to install BusyBox files/subdirs in.
599
600 endmenu
601
602 source package/busybox/config/libbb/Config.in
603
604 endmenu
605
606 comment "Applets"
607
608 source package/busybox/config/archival/Config.in
609 source package/busybox/config/coreutils/Config.in
610 source package/busybox/config/console-tools/Config.in
611 source package/busybox/config/debianutils/Config.in
612 source package/busybox/config/editors/Config.in
613 source package/busybox/config/findutils/Config.in
614 source package/busybox/config/init/Config.in
615 source package/busybox/config/loginutils/Config.in
616 source package/busybox/config/e2fsprogs/Config.in
617 source package/busybox/config/modutils/Config.in
618 source package/busybox/config/util-linux/Config.in
619 source package/busybox/config/miscutils/Config.in
620 source package/busybox/config/networking/Config.in
621 source package/busybox/config/printutils/Config.in
622 source package/busybox/config/mailutils/Config.in
623 source package/busybox/config/procps/Config.in
624 source package/busybox/config/runit/Config.in
625 source package/busybox/config/selinux/Config.in
626 source package/busybox/config/shell/Config.in
627 source package/busybox/config/sysklogd/Config.in