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