1b87c12511c6e8f19209d4305471131ba34ef40a
[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 by default does not cleanup memory
84           that is dynamically allocated or close files before exiting. This
85           saves space and is usually not needed since the OS will clean up for
86           us.  Don't enable this unless you have a really good reason to clean
87           things up manually.
88
89 config CONFIG_FEATURE_SUID
90         bool "Support for SUID/SGID handling"
91         default n
92         help
93           Support SUID and SGID binaries.
94
95 config CONFIG_FEATURE_SUID_CONFIG
96         bool "Runtime SUID/SGID configuration via /etc/busybox.conf"
97         default n if CONFIG_FEATURE_SUID
98         depends on CONFIG_FEATURE_SUID
99         help
100           Allow the SUID / SGID state of an applet to be determined runtime by
101           checking /etc/busybox.conf.  The format of this file is as follows:
102
103           <applet> = [Ssx-][Ssx-][x-] (<username>|<uid>).(<groupname>|<gid>)
104
105           An example might help:
106
107           [SUID]
108           su = ssx root.0 # applet su can be run by anyone and runs with euid=0/egid=0
109           su = ssx        # exactly the same
110
111           mount = sx- root.disk # applet mount can be run by root and members of group disk
112                                 # and runs with euid=0
113
114           cp = --- # disable applet cp for everyone
115
116           The file has to be owned by user root, group root and has to be
117           writeable only by root:
118                 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
119           The busybox executable has to be owned by user root, group
120           root and has to be setuid root for this to work:
121                 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
122
123           Robert 'sandman' Griebl has more information here:
124           <url: http://www.softforge.de/bb/suid.html >.
125
126 config CONFIG_FEATURE_SUID_CONFIG_QUIET
127         bool "Suppress warning message if /etc/busybox.conf is not readable"
128         default n
129         depends on CONFIG_FEATURE_SUID_CONFIG
130         help
131           /etc/busybox.conf should be readable by the user needing the SUID, check
132           this option to avoid users to be notified about missing permissions.
133
134 config CONFIG_SELINUX
135         bool "Support NSA Security Enhanced Linux"
136         default n
137         help
138           Enable support for SE Linux in applets ls, ps, and id.  Also provide
139           the option of compiling in SE Linux applets.
140
141           If you do not have a complete SE Linux Full Userland installed, this
142           stuff will not compile.  Go visit
143                 http://www.nsa.gov/selinux/index.html
144           to download the necessary stuff to allow busybox to compile with this
145           option enabled.
146
147           Most people will leave this set to 'N'.
148
149 endmenu
150
151 menu 'Build Options'
152
153 config CONFIG_STATIC
154         bool "Build BusyBox as a static binary (no shared libs)"
155         default n
156         help
157           If you want to build a static BusyBox binary, which does not
158           use or require any shared libraries, then enable this option.
159           This can cause BusyBox to be considerably larger, so you should
160           leave this option false unless you have a good reason (i.e.
161           your target platform does not support shared libraries, or
162           you are building an initrd which doesn't need anything but
163           BusyBox, etc).
164
165           Most people will leave this set to 'N'.
166
167 config CONFIG_BUILD_LIBBUSYBOX
168         bool "Build shared libbusybox"
169         default y
170         help
171           Build a shared library libbusybox.so which contains all
172           libraries used inside busybox.
173
174 config CONFIG_FEATURE_FULL_LIBBUSYBOX
175         bool "Feature-complete libbusybox"
176         default n if !CONFIG_FEATURE_SHARED_BUSYBOX
177         depends on CONFIG_BUILD_LIBBUSYBOX
178         help
179           Build a libbusybox with the complete feature-set, disregarding
180           the actually selected config.
181
182           Normally, libbusybox will only contain the features which are
183           used by busybox itself. If you plan to write a separate
184           standalone application which uses libbusybox say 'Y'.
185
186           Say 'N' if in doubt.
187
188 config CONFIG_FEATURE_SHARED_BUSYBOX
189         bool "Use shared libbusybox for busybox"
190         default y if CONFIG_BUILD_LIBBUSYBOX
191         depends on !CONFIG_STATIC && CONFIG_BUILD_LIBBUSYBOX
192         help
193           Use libbusybox.so also for busybox itself.
194           You need to have a working dynamic linker to use this variant.
195
196 config CONFIG_LFS
197         bool "Build with Large File Support (for accessing files > 2 GB)"
198         default n
199         select FDISK_SUPPORT_LARGE_DISKS
200         help
201           If you want to build BusyBox with large file support, then enable
202           this option.  This will have no effect if your kernel or your C
203           library lacks large file support for large files.  Some of the
204           programs that can benefit from large file support include dd, gzip,
205           cp, mount, tar, and many others.  If you want to access files larger
206           than 2 Gigabytes, enable this option.  Otherwise, leave it set to 'N'.
207
208 config USING_CROSS_COMPILER
209         bool "Do you want to build BusyBox with a Cross Compiler?"
210         default n
211         help
212           Do you want to build BusyBox with a Cross Compiler?  If so,
213           then enable this option.  Otherwise leave it set to 'N'.
214
215 config CROSS_COMPILER_PREFIX
216         string "Cross Compiler prefix"
217         default "/usr/i386-linux-uclibc/bin/i386-uclibc-"
218         depends on USING_CROSS_COMPILER
219         help
220           If you want to build BusyBox with a cross compiler, then you
221           will need to set this to the cross-compiler prefix.  For example,
222           if my cross-compiler is /usr/i386-linux-uclibc/bin/i386-uclibc-gcc
223           then I would enter '/usr/i386-linux-uclibc/bin/i386-uclibc-' here,
224           which will ensure the correct compiler is used.
225
226 config EXTRA_CFLAGS_OPTIONS
227         string "Any extra CFLAGS options for the compiler?"
228         default ""
229         help
230           Do you want to pass any extra CFLAGS options to the compiler as
231           you build BusyBox? If so, this is the option for you...  For example,
232           if you want to add some simple compiler switches (like -march=i686),
233           or check for warnings using -Werror, just those options here.
234
235 config CONFIG_BUILD_AT_ONCE
236         bool "Compile all sources at once"
237         default n
238         help
239           Normally each source-file is compiled with one invocation of
240           the compiler.
241           If you set this option, all sources are compiled at once.
242           This gives the compiler more opportunities to optimize which can
243           result in smaller and/or faster binaries.
244
245           Setting this option will consume alot of memory, e.g. if you
246           enable all applets with all features, gcc uses more than 300MB
247           RAM during compilation of busybox.
248
249           This option is most likely only beneficial for newer compilers
250           such as gcc-4.1 and above.
251
252           Say 'N' unless you know what you are doing.
253
254 config CONFIG_FEATURE_SUSv2
255         bool "Enable features that are in SuSv2 but not SuSv3?"
256         default y
257         help
258           This option will enable backwards compatability with SuSv2,
259           specifically, numeric options such as 'head -1 <file>' will be
260           supported.
261
262 config CONFIG_FEATURE_SUSv2_OBSOLETE
263         bool "Enable features that are obsolete in SuSv2"
264         depends on CONFIG_FEATURE_SUSv2
265         default y
266         help
267           Enable pre- SuSv2 features which are deprecated in SuSv2 and
268           above.
269           Disables support for e.g. numeric arguments in fold.
270
271 endmenu
272
273 menu 'Installation Options'
274
275 config CONFIG_INSTALL_NO_USR
276         bool "Don't use /usr"
277         default n
278         help
279           Disable use of /usr. Don't activate this option if you don't know
280           that you really want this behaviour.
281
282 choice
283        prompt "Applets links"
284        default CONFIG_INSTALL_APPLET_SYMLINKS
285        help
286          Choose how you install applets links.
287
288 config CONFIG_INSTALL_APPLET_SYMLINKS
289        bool "as soft-links"
290        help
291          Install applets as soft-links to the busybox binary. This needs some
292          free inodes on the filesystem, but might help with filesystem
293          generators that can't cope with hard-links.
294
295 config CONFIG_INSTALL_APPLET_HARDLINKS
296        bool "as hard-links"
297        help
298          Install applets as hard-links to the busybox binary. This might count
299          on a filesystem with few inodes.
300
301 config CONFIG_INSTALL_APPLET_DONT
302        bool
303        prompt "not installed"
304        depends on CONFIG_FEATURE_INSTALLER || CONFIG_FEATURE_SH_STANDALONE_SHELL
305        help
306          Do not install applets links. Usefull when using the -install feature
307          or a standalone shell for rescue pruposes.
308
309 endchoice
310
311 config PREFIX
312         string "BusyBox installation prefix"
313         default "./_install"
314         help
315           Define your directory to install BusyBox files/subdirs in.
316
317 endmenu
318
319 source archival/Config.in
320 source coreutils/Config.in
321 source console-tools/Config.in
322 source debianutils/Config.in
323 source editors/Config.in
324 source findutils/Config.in
325 source init/Config.in
326 source loginutils/Config.in
327 source e2fsprogs/Config.in
328 source modutils/Config.in
329 source util-linux/Config.in
330 source miscutils/Config.in
331 source networking/Config.in
332 source procps/Config.in
333 source shell/Config.in
334 source sysklogd/Config.in
335
336 menu 'Debugging Options'
337
338 config CONFIG_DEBUG
339         bool "Build BusyBox with Debugging symbols"
340         default n
341         help
342           Say Y here if you wish to compile BusyBox with debugging symbols.
343           This will allow you to use a debugger to examine BusyBox internals
344           while applets are running.  This increases the size of the binary
345           considerably and should only be used when doing development.
346           If you are doing development and want to debug BusyBox, answer Y.
347
348           Most people should answer N.
349
350 choice
351         prompt "Additional debugging library"
352         default CONFIG_NO_DEBUG_LIB
353         depends on CONFIG_DEBUG
354         help
355           Using an additional debugging library will make BusyBox become
356           considerable larger and will cause it to run more slowly.  You
357           should always leave this option disabled for production use.
358
359           dmalloc support:
360           ----------------
361           This enables compiling with dmalloc ( http://dmalloc.com/ )
362           which is an excellent public domain mem leak and malloc problem
363           detector.  To enable dmalloc, before running busybox you will
364           want to properly set your environment, for example:
365             export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
366           The 'debug=' value is generated using the following command
367             dmalloc -p log-stats -p log-non-free -p log-bad-space -p log-elapsed-time \
368                -p check-fence -p check-heap -p check-lists -p check-blank \
369                -p check-funcs -p realloc-copy -p allow-free-null
370
371           Electric-fence support:
372           -----------------------
373           This enables compiling with Electric-fence support.  Electric
374           fence is another very useful malloc debugging library which uses
375           your computer's virtual memory hardware to detect illegal memory
376           accesses.  This support will make BusyBox be considerable larger
377           and run slower, so you should leave this option disabled unless
378           you are hunting a hard to find memory problem.
379
380
381 config CONFIG_NO_DEBUG_LIB
382         bool "None"
383
384 config CONFIG_DMALLOC
385         bool "Dmalloc"
386
387 config CONFIG_EFENCE
388         bool "Electric-fence"
389
390 endchoice
391
392
393 endmenu