The tendency of vi to auto-indent can be really annoying at times.
[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 "General Configuration"
13
14 choice
15         prompt "Buffer allocation policy"
16         default CONFIG_FEATURE_BUFFERS_USE_MALLOC
17         help
18           There are 3 ways BusyBox can handle buffer allocations:
19           - Use malloc. This costs code size for the call to xmalloc.
20           - Put them on stack. For some very small machines with limited stack
21             space, this can be deadly.  For most folks, this works just fine.
22           - Put them in BSS. This works beautifully for computers with a real
23             MMU (and OS support), but wastes runtime RAM for uCLinux. This
24             behavior was the only one available for BusyBox versions 0.48 and
25             earlier.
26
27 config CONFIG_FEATURE_BUFFERS_USE_MALLOC
28         bool "Allocate with Malloc"
29
30 config CONFIG_FEATURE_BUFFERS_GO_ON_STACK
31         bool "Allocate on the Stack"
32
33 config CONFIG_FEATURE_BUFFERS_GO_IN_BSS
34         bool "Allocate in the .bss section"
35
36 endchoice
37
38 config CONFIG_FEATURE_VERBOSE_USAGE
39         bool "Show verbose applet usage messages"
40         default n
41         help
42           All BusyBox applets will show more verbose help messages when
43           busybox is invoked with --help.  This will add a lot of text to the
44           busybox binary.  In the default configuration, this will add about
45           13k, but it can add much more depending on your configuration.
46
47 config CONFIG_FEATURE_INSTALLER
48         bool "Support --install [-s] to install applet links at runtime"
49         default n
50         help
51           Enable 'busybox --install [-s]' support.  This will allow you to use
52           busybox at runtime to create hard links or symlinks for all the
53           applets that are compiled into busybox.  This feature requires the
54           /proc filesystem.
55
56 config CONFIG_LOCALE_SUPPORT
57         bool "Enable locale support (system needs locale for this to work)"
58         default n
59         help
60           Enable this if your system has locale support and you would like
61           busybox to support locale settings.
62
63 config CONFIG_FEATURE_DEVFS
64         bool "Support for devfs"
65         default n
66         help
67           Enable if you want BusyBox to work with devfs.
68
69 config CONFIG_FEATURE_DEVPTS
70         bool "Use the devpts filesystem for Unix98 PTYs"
71         default y if CONFIG_FEATURE_DEVFS
72         help
73           Enable if you want BusyBox to use Unix98 PTY support. If enabled,
74           busybox will use /dev/ptmx for the master side of the pseudoterminal
75           and /dev/pts/<number> for the slave side.  Otherwise, BSD style
76           /dev/ttyp<number> will be used. To use this option, you should have
77           devpts or devfs mounted.
78
79 config CONFIG_FEATURE_CLEAN_UP
80         bool "Clean up all memory before exiting (usually not needed)"
81         default n
82         help
83           As a size optimization, busybox normally exits without explicitly
84           freeing dynamically allocated memory or closing files.  This saves
85           space since the OS will clean up for us, but it can confuse debuggers
86           like valgrind, which report tons of memory and resource leaks.
87
88           Don't enable this unless you have a really good reason to clean
89           things up manually.
90
91 config CONFIG_FEATURE_SUID
92         bool "Support for SUID/SGID handling"
93         default n
94         help
95           Support SUID and SGID binaries.
96
97 config CONFIG_FEATURE_SUID_CONFIG
98         bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
99         default n if CONFIG_FEATURE_SUID
100         depends on CONFIG_FEATURE_SUID
101         help
102           Allow the SUID / SGID state of an applet to be determined runtime by
103           checking /etc/busybox.conf.  The format of this file is as follows:
104
105           <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
106
107           An example might help:
108
109           [SUID]
110           su = ssx root.0 # applet su can be run by anyone and runs with euid=0/egid=0
111           su = ssx        # exactly the same
112
113           mount = sx- root.disk # applet mount can be run by root and members of group disk
114                                 # and runs with euid=0
115
116           cp = --- # disable applet cp for everyone
117
118           The file has to be owned by user root, group root and has to be
119           writeable only by root:
120                 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
121           The busybox executable has to be owned by user root, group
122           root and has to be setuid root for this to work:
123                 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
124
125           Robert 'sandman' Griebl has more information here:
126           <url: http://www.softforge.de/bb/suid.html >.
127
128 config CONFIG_FEATURE_SUID_CONFIG_QUIET
129         bool "Suppress warning message if /etc/busybox.conf is not readable"
130         default n
131         depends on CONFIG_FEATURE_SUID_CONFIG
132         help
133           /etc/busybox.conf should be readable by the user needing the SUID, check
134           this option to avoid users to be notified about missing permissions.
135
136 config CONFIG_SELINUX
137         bool "Support NSA Security Enhanced Linux"
138         default n
139         help
140           Enable support for SE Linux in applets ls, ps, and id.  Also provide
141           the option of compiling in SE Linux applets.
142
143           If you do not have a complete SE Linux Full Userland installed, this
144           stuff will not compile.  Go visit
145                 http://www.nsa.gov/selinux/index.html
146           to download the necessary stuff to allow busybox to compile with this
147           option enabled.
148
149           Most people will leave this set to 'N'.
150
151 endmenu
152
153 menu 'Build Options'
154
155 config CONFIG_STATIC
156         bool "Build BusyBox as a static binary (no shared libs)"
157         default n
158         help
159           If you want to build a static BusyBox binary, which does not
160           use or require any shared libraries, then enable this option.
161           This can cause BusyBox to be considerably larger, so you should
162           leave this option false unless you have a good reason (i.e.
163           your target platform does not support shared libraries, or
164           you are building an initrd which doesn't need anything but
165           BusyBox, etc).
166
167           Most people will leave this set to 'N'.
168
169 config CONFIG_BUILD_LIBBUSYBOX
170         bool "Build shared libbusybox"
171         default y
172         help
173           Build a shared library libbusybox.so which contains all
174           libraries used inside busybox.
175
176 config CONFIG_FEATURE_FULL_LIBBUSYBOX
177         bool "Feature-complete libbusybox"
178         default n if !CONFIG_FEATURE_SHARED_BUSYBOX
179         depends on CONFIG_BUILD_LIBBUSYBOX
180         help
181           Build a libbusybox with the complete feature-set, disregarding
182           the actually selected config.
183
184           Normally, libbusybox will only contain the features which are
185           used by busybox itself. If you plan to write a separate
186           standalone application which uses libbusybox say 'Y'.
187
188           Note: libbusybox is GPL, not LGPL, and exports no stable API that
189           might act as a copyright barrier.  We can and will modify the
190           exported function set between releases (even minor version number
191           changes), and happily break out-of-tree features.
192
193           Say 'N' if in doubt.
194
195 config CONFIG_FEATURE_SHARED_BUSYBOX
196         bool "Use shared libbusybox for busybox"
197         default y if CONFIG_BUILD_LIBBUSYBOX
198         depends on !CONFIG_STATIC && CONFIG_BUILD_LIBBUSYBOX
199         help
200           Use libbusybox.so also for busybox itself.
201           You need to have a working dynamic linker to use this variant.
202
203 config CONFIG_LFS
204         bool "Build with Large File Support (for accessing files > 2 GB)"
205         default n
206         select FDISK_SUPPORT_LARGE_DISKS
207         help
208           If you want to build BusyBox with large file support, then enable
209           this option.  This will have no effect if your kernel or your C
210           library lacks large file support for large files.  Some of the
211           programs that can benefit from large file support include dd, gzip,
212           cp, mount, tar, and many others.  If you want to access files larger
213           than 2 Gigabytes, enable this option.  Otherwise, leave it set to 'N'.
214
215 config USING_CROSS_COMPILER
216         bool "Do you want to build BusyBox with a Cross Compiler?"
217         default n
218         help
219           Do you want to build BusyBox with a Cross Compiler?  If so,
220           then enable this option.  Otherwise leave it set to 'N'.
221
222 config CROSS_COMPILER_PREFIX
223         string "Cross Compiler prefix"
224         default "/usr/i386-linux-uclibc/bin/i386-uclibc-"
225         depends on USING_CROSS_COMPILER
226         help
227           If you want to build BusyBox with a cross compiler, then you
228           will need to set this to the cross-compiler prefix.  For example,
229           if my cross-compiler is /usr/i386-linux-uclibc/bin/i386-uclibc-gcc
230           then I would enter '/usr/i386-linux-uclibc/bin/i386-uclibc-' here,
231           which will ensure the correct compiler is used.
232
233 config EXTRA_CFLAGS_OPTIONS
234         string "Any extra CFLAGS options for the compiler?"
235         default ""
236         help
237           Do you want to pass any extra CFLAGS options to the compiler as
238           you build BusyBox? If so, this is the option for you...  For example,
239           if you want to add some simple compiler switches (like -march=i686),
240           or check for warnings using -Werror, just those options here.
241
242 config CONFIG_BUILD_AT_ONCE
243         bool "Compile all sources at once"
244         default n
245         help
246           Normally each source-file is compiled with one invocation of
247           the compiler.
248           If you set this option, all sources are compiled at once.
249           This gives the compiler more opportunities to optimize which can
250           result in smaller and/or faster binaries.
251
252           Setting this option will consume alot of memory, e.g. if you
253           enable all applets with all features, gcc uses more than 300MB
254           RAM during compilation of busybox.
255
256           This option is most likely only beneficial for newer compilers
257           such as gcc-4.1 and above.
258
259           Say 'N' unless you know what you are doing.
260
261 endmenu
262
263 menu 'Installation Options'
264
265 config CONFIG_INSTALL_NO_USR
266         bool "Don't use /usr"
267         default n
268         help
269           Disable use of /usr. Don't activate this option if you don't know
270           that you really want this behaviour.
271
272 choice
273        prompt "Applets links"
274        default CONFIG_INSTALL_APPLET_SYMLINKS
275        help
276          Choose how you install applets links.
277
278 config CONFIG_INSTALL_APPLET_SYMLINKS
279        bool "as soft-links"
280        help
281          Install applets as soft-links to the busybox binary. This needs some
282          free inodes on the filesystem, but might help with filesystem
283          generators that can't cope with hard-links.
284
285 config CONFIG_INSTALL_APPLET_HARDLINKS
286        bool "as hard-links"
287        help
288          Install applets as hard-links to the busybox binary. This might count
289          on a filesystem with few inodes.
290
291 config CONFIG_INSTALL_APPLET_DONT
292        bool
293        prompt "not installed"
294        depends on CONFIG_FEATURE_INSTALLER || CONFIG_FEATURE_SH_STANDALONE_SHELL
295        help
296          Do not install applets links. Usefull when using the -install feature
297          or a standalone shell for rescue pruposes.
298
299 endchoice
300
301 config PREFIX
302         string "BusyBox installation prefix"
303         default "./_install"
304         help
305           Define your directory to install BusyBox files/subdirs in.
306
307 endmenu
308
309 source archival/Config.in
310 source coreutils/Config.in
311 source console-tools/Config.in
312 source debianutils/Config.in
313 source editors/Config.in
314 source findutils/Config.in
315 source init/Config.in
316 source loginutils/Config.in
317 source e2fsprogs/Config.in
318 source modutils/Config.in
319 source util-linux/Config.in
320 source miscutils/Config.in
321 source networking/Config.in
322 source procps/Config.in
323 source shell/Config.in
324 source sysklogd/Config.in
325
326 menu 'Debugging Options'
327
328 config CONFIG_DEBUG
329         bool "Build BusyBox with Debugging symbols"
330         default n
331         help
332           Say Y here if you wish to compile BusyBox with debugging symbols.
333           This will allow you to use a debugger to examine BusyBox internals
334           while applets are running.  This increases the size of the binary
335           considerably and should only be used when doing development.
336           If you are doing development and want to debug BusyBox, answer Y.
337
338           Most people should answer N.
339
340 choice
341         prompt "Additional debugging library"
342         default CONFIG_NO_DEBUG_LIB
343         depends on CONFIG_DEBUG
344         help
345           Using an additional debugging library will make BusyBox become
346           considerable larger and will cause it to run more slowly.  You
347           should always leave this option disabled for production use.
348
349           dmalloc support:
350           ----------------
351           This enables compiling with dmalloc ( http://dmalloc.com/ )
352           which is an excellent public domain mem leak and malloc problem
353           detector.  To enable dmalloc, before running busybox you will
354           want to properly set your environment, for example:
355             export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
356           The 'debug=' value is generated using the following command
357             dmalloc -p log-stats -p log-non-free -p log-bad-space -p log-elapsed-time \
358                -p check-fence -p check-heap -p check-lists -p check-blank \
359                -p check-funcs -p realloc-copy -p allow-free-null
360
361           Electric-fence support:
362           -----------------------
363           This enables compiling with Electric-fence support.  Electric
364           fence is another very useful malloc debugging library which uses
365           your computer's virtual memory hardware to detect illegal memory
366           accesses.  This support will make BusyBox be considerable larger
367           and run slower, so you should leave this option disabled unless
368           you are hunting a hard to find memory problem.
369
370
371 config CONFIG_NO_DEBUG_LIB
372         bool "None"
373
374 config CONFIG_DMALLOC
375         bool "Dmalloc"
376
377 config CONFIG_EFENCE
378         bool "Electric-fence"
379
380 endchoice
381
382 config CONFIG_DEBUG_YANK_SUSv2
383         bool "Disable obsolete features removed before SUSv3?"
384         default y
385         help
386           This option will disable backwards compatability with SuSv2,
387           specifically, old-style numeric options ('command -1 <file>')
388           will not be supported in head, tail, and fold.  (Note: should
389           yank from renice too.)
390
391 endmenu