blob: ae21f52ef43fdbc9a644fdcb0ae0465a912679e2 [file] [log] [blame]
Eric Andersenc9f20d92002-12-05 08:41:41 +00001#
2# For a description of the syntax of this configuration file,
Kartik Agaram43b17b12018-05-31 22:15:55 -07003# see docs/Kconfig-language.txt.
Eric Andersenc9f20d92002-12-05 08:41:41 +00004#
5
Denys Vlasenko86d5bf42017-07-27 02:59:13 +02006mainmenu "Configuration"
Eric Andersenc9f20d92002-12-05 08:41:41 +00007
Eric Andersen068b6b02002-12-13 22:53:28 +00008config HAVE_DOT_CONFIG
9 bool
10 default y
11
Denys Vlasenko86d5bf42017-07-27 02:59:13 +020012menu "Settings"
Mike Frysinger72d59db2006-03-10 23:17:17 +000013
Denis Vlasenko7d219aa2006-10-05 10:17:08 +000014config DESKTOP
Denys Vlasenko2c8929c2017-07-15 21:14:16 +020015 bool "Enable compatibility for full-blown desktop systems"
Denys Vlasenkoba085c62010-07-21 08:58:11 +020016 default y
Denis Vlasenko97a8dd32006-10-01 15:55:11 +000017 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020018 Enable applet options and features which are not essential.
19 Many applet options have dedicated config options to (de)select them
20 under that applet; this options enables those options which have no
21 individual config item for them.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +020022
Denys Vlasenko72089cf2017-07-21 09:50:55 +020023 Select this if you plan to use busybox on full-blown desktop machine
24 with common Linux distro, which needs higher level of command-line
25 compatibility.
Denys Vlasenko33602262016-11-24 22:08:12 +010026
Denys Vlasenko72089cf2017-07-21 09:50:55 +020027 If you are preparing your build to be used on an embedded box
28 where you have tighter control over the entire set of userspace
29 tools, you can unselect this option for smaller code size.
Denis Vlasenko97a8dd32006-10-01 15:55:11 +000030
Denis Vlasenko3fd15e12008-08-09 16:15:14 +000031config EXTRA_COMPAT
32 bool "Provide compatible behavior for rare corner cases (bigger code)"
33 default n
34 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020035 This option makes grep, sed etc handle rare corner cases
36 (embedded NUL bytes and such). This makes code bigger and uses
37 some GNU extensions in libc. You probably only need this option
38 if you plan to run busybox on desktop.
Denis Vlasenko3fd15e12008-08-09 16:15:14 +000039
Denys Vlasenko663ae522017-08-03 03:46:14 +020040config FEDORA_COMPAT
41 bool "Building for Fedora distribution"
42 default n
43 help
44 This option makes some tools behave like they do on Fedora.
45
46 At the time of this writing (2017-08) this only affects uname:
47 normally, uname -p (processor) and uname -i (platform)
48 are shown as "unknown", but with this option uname -p
49 shows the same string as uname -m (machine type),
50 and so does uname -i unless machine type is i486/i586/i686 -
51 then uname -i shows "i386".
52
Denys Vlasenkoa8df4c02009-10-19 18:56:26 +020053config INCLUDE_SUSv2
54 bool "Enable obsolete features removed before SUSv3"
55 default y
56 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020057 This option will enable backwards compatibility with SuSv2,
58 specifically, old-style numeric options ('command -1 <file>')
59 will be supported in head, tail, and fold. (Note: should
60 affect renice too.)
Denys Vlasenkoa8df4c02009-10-19 18:56:26 +020061
Denys Vlasenko2c8929c2017-07-15 21:14:16 +020062config LONG_OPTS
63 bool "Support --long-options"
64 default y
Denys Vlasenkoaa7da732009-09-13 14:57:24 +020065 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020066 Enable this if you want busybox applets to use the gnu --long-option
67 style, in addition to single character -a -b -c style options.
Denys Vlasenkoaa7da732009-09-13 14:57:24 +020068
Denis Vlasenko7d219aa2006-10-05 10:17:08 +000069config SHOW_USAGE
Bernhard Reutner-Fischerb9f4cd82011-11-09 20:23:38 +010070 bool "Show applet usage messages"
Bernhard Reutner-Fischer81901a02006-03-31 18:43:55 +000071 default y
72 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +020073 Enabling this option, applets will show terse help messages
Denys Vlasenko72089cf2017-07-21 09:50:55 +020074 when invoked with wrong arguments.
75 If you do not want to show any (helpful) usage message when
76 issuing wrong command syntax, you can say 'N' here,
77 saving approximately 7k.
Bernhard Reutner-Fischer81901a02006-03-31 18:43:55 +000078
Denis Vlasenko7d219aa2006-10-05 10:17:08 +000079config FEATURE_VERBOSE_USAGE
Eric Andersenc9f20d92002-12-05 08:41:41 +000080 bool "Show verbose applet usage messages"
Denys Vlasenko2f32bf82010-06-06 04:14:28 +020081 default y
Denys Vlasenko0e5ba082010-06-05 23:11:07 +020082 depends on SHOW_USAGE
Eric Andersenc9f20d92002-12-05 08:41:41 +000083 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +020084 All applets will show verbose help messages when invoked with --help.
85 This will add a lot of text to the binary.
Eric Andersenc9f20d92002-12-05 08:41:41 +000086
Denis Vlasenko7d219aa2006-10-05 10:17:08 +000087config FEATURE_COMPRESS_USAGE
Rob Landley7e21d5f2006-04-27 23:34:46 +000088 bool "Store applet usage messages in compressed form"
89 default y
Denis Vlasenko7d219aa2006-10-05 10:17:08 +000090 depends on SHOW_USAGE
Rob Landley7e21d5f2006-04-27 23:34:46 +000091 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +020092 Store usage messages in .bz2 compressed form, uncompress them
93 on-the-fly when "APPLET --help" is run.
Rob Landley7e21d5f2006-04-27 23:34:46 +000094
Denys Vlasenko72089cf2017-07-21 09:50:55 +020095 If you have a really tiny busybox with few applets enabled (and
96 bunzip2 isn't one of them), the overhead of the decompressor might
97 be noticeable. Also, if you run executables directly from ROM
98 and have very little memory, this might not be a win. Otherwise,
99 you probably want this.
Rob Landleyc7ddefc2006-06-14 01:24:33 +0000100
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200101config LFS
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200102 bool "Support files > 2 GB"
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200103 default y
104 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200105 If you need to work with large files, enable this option.
106 This will have no effect if your kernel or your C
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200107 library lacks large file support for large files. Some of the
108 programs that can benefit from large file support include dd, gzip,
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200109 cp, mount, tar.
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200110
Bartosz Golaszewski265a74b2014-02-11 21:31:42 +0100111config PAM
Denys Vlasenkof5604222017-01-10 14:58:54 +0100112 bool "Support PAM (Pluggable Authentication Modules)"
Bartosz Golaszewski265a74b2014-02-11 21:31:42 +0100113 default n
114 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200115 Use PAM in some applets (currently login and httpd) instead
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200116 of direct access to password database.
Bartosz Golaszewski265a74b2014-02-11 21:31:42 +0100117
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000118config FEATURE_DEVPTS
Eric Andersenc9f20d92002-12-05 08:41:41 +0000119 bool "Use the devpts filesystem for Unix98 PTYs"
Rob Landleyc7ddefc2006-06-14 01:24:33 +0000120 default y
Eric Andersenc9f20d92002-12-05 08:41:41 +0000121 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200122 Enable if you want to use Unix98 PTY support. If enabled,
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200123 busybox will use /dev/ptmx for the master side of the pseudoterminal
124 and /dev/pts/<number> for the slave side. Otherwise, BSD style
125 /dev/ttyp<number> will be used. To use this option, you should have
126 devpts mounted.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000127
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200128config FEATURE_UTMP
129 bool "Support utmp file"
130 default y
131 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200132 The file /var/run/utmp is used to track who is currently logged in.
133 With this option on, certain applets (getty, login, telnetd etc)
134 will create and delete entries there.
135 "who" applet requires this option.
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200136
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +0100137config FEATURE_WTMP
138 bool "Support wtmp file"
139 default y
140 depends on FEATURE_UTMP
141 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200142 The file /var/run/wtmp is used to track when users have logged into
143 and logged out of the system.
144 With this option on, certain applets (getty, login, telnetd etc)
145 will append new entries there.
146 "last" applet requires this option.
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +0100147
Denis Vlasenko10457b92007-03-27 22:01:31 +0000148config FEATURE_PIDFILE
149 bool "Support writing pidfiles"
Denys Vlasenko2f32bf82010-06-06 04:14:28 +0200150 default y
Denis Vlasenko10457b92007-03-27 22:01:31 +0000151 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200152 This option makes some applets (e.g. crond, syslogd, inetd) write
153 a pidfile at the configured PID_FILE_PATH. It has no effect
154 on applets which require pidfiles to run.
Anthony G. Basile12677ac2012-12-10 14:49:39 -0500155
156config PID_FILE_PATH
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200157 string "Directory for pidfiles"
Anthony G. Basile12677ac2012-12-10 14:49:39 -0500158 default "/var/run"
159 depends on FEATURE_PIDFILE
160 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200161 This is the default path where pidfiles are created. Applets which
162 allow you to set the pidfile path on the command line will override
163 this value. The option has no effect on applets that require you to
164 specify a pidfile path.
Denis Vlasenko10457b92007-03-27 22:01:31 +0000165
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200166config BUSYBOX
167 bool "Include busybox applet"
168 default y
169 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200170 The busybox applet provides general help message and allows
171 the included applets to be listed. It also provides
172 optional --install command to create applet links. If you unselect
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200173 this option, running busybox without any arguments will give
174 just a cryptic error message:
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200175
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200176 $ busybox
177 busybox: applet not found
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200178
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200179 Running "busybox APPLET [ARGS...]" will still work, of course.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200180
181config FEATURE_INSTALLER
182 bool "Support --install [-s] to install applet links at runtime"
183 default y
184 depends on BUSYBOX
185 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200186 Enable 'busybox --install [-s]' support. This will allow you to use
187 busybox at runtime to create hard links or symlinks for all the
188 applets that are compiled into busybox.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200189
190config INSTALL_NO_USR
191 bool "Don't use /usr"
192 default n
193 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200194 Disable use of /usr. "busybox --install" and "make install"
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200195 will install applets only to /bin and /sbin,
196 never to /usr/bin or /usr/sbin.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200197
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000198config FEATURE_SUID
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200199 bool "Drop SUID state for most applets"
Denys Vlasenko2f32bf82010-06-06 04:14:28 +0200200 default y
Eric Andersenc9f20d92002-12-05 08:41:41 +0000201 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200202 With this option you can install the busybox binary belonging
203 to root with the suid bit set, enabling some applets to perform
204 root-level operations even when run by ordinary users
205 (for example, mounting of user mounts in fstab needs this).
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200206
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200207 With this option enabled, busybox drops privileges for applets
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200208 that don't need root access, before entering their main() function.
Rob Landleyd5b9b602006-05-31 23:23:42 +0000209
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200210 If you are really paranoid and don't want even initial busybox code
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200211 to run under root for every applet, build two busybox binaries with
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200212 different applets in them (and the appropriate symlinks pointing
213 to each binary), and only set the suid bit on the one that needs it.
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200214
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200215 Some applets which require root rights (need suid bit on the binary
216 or to be run by root) and will refuse to execute otherwise:
217 crontab, login, passwd, su, vlock, wall.
Bernhard Reutner-Fischeraa2a1c02008-10-24 19:48:47 +0000218
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200219 The applets which will use root rights if they have them
220 (via suid bit, or because run by root), but would try to work
221 without root right nevertheless:
222 findfs, ping[6], traceroute[6], mount.
Denys Vlasenko3b5acaa2011-01-18 13:52:48 +0100223
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200224 Note that if you DO NOT select this option, but DO make busybox
225 suid root, ALL applets will run under root, which is a huge
226 security hole (think "cp /some/file /etc/passwd").
Eric Andersenc9f20d92002-12-05 08:41:41 +0000227
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000228config FEATURE_SUID_CONFIG
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200229 bool "Enable SUID configuration via /etc/busybox.conf"
Denys Vlasenkoe0238f82011-05-14 15:23:55 +0200230 default y
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000231 depends on FEATURE_SUID
Eric Andersenc9f20d92002-12-05 08:41:41 +0000232 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200233 Allow the SUID/SGID state of an applet to be determined at runtime
234 by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
235 The format of this file is as follows:
Eric Andersene5272072003-07-22 22:15:21 +0000236
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200237 APPLET = [Ssx-][Ssx-][x-] [USER.GROUP]
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200238
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200239 s: USER or GROUP is allowed to execute APPLET.
240 APPLET will run under USER or GROUP
241 (regardless of who's running it).
242 S: USER or GROUP is NOT allowed to execute APPLET.
243 APPLET will run under USER or GROUP.
244 This option is not very sensical.
245 x: USER/GROUP/others are allowed to execute APPLET.
246 No UID/GID change will be done when it is run.
247 -: USER/GROUP/others are not allowed to execute APPLET.
Eric Andersen5043ea12005-06-23 19:15:40 +0000248
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200249 An example might help:
Eric Andersene5272072003-07-22 22:15:21 +0000250
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200251 |[SUID]
252 |su = ssx root.0 # applet su can be run by anyone and runs with
253 | # euid=0,egid=0
254 |su = ssx # exactly the same
255 |
256 |mount = sx- root.disk # applet mount can be run by root and members
257 | # of group disk (but not anyone else)
258 | # and runs with euid=0 (egid is not changed)
259 |
260 |cp = --- # disable applet cp for everyone
Eric Andersene5272072003-07-22 22:15:21 +0000261
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200262 The file has to be owned by user root, group root and has to be
263 writeable only by root:
264 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
265 The busybox executable has to be owned by user root, group
266 root and has to be setuid root for this to work:
267 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
Eric Andersene5272072003-07-22 22:15:21 +0000268
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200269 Robert 'sandman' Griebl has more information here:
270 <url: http://www.softforge.de/bb/suid.html >.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000271
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000272config FEATURE_SUID_CONFIG_QUIET
Eric Andersenc9f20d92002-12-05 08:41:41 +0000273 bool "Suppress warning message if /etc/busybox.conf is not readable"
Rob Landleyd5b9b602006-05-31 23:23:42 +0000274 default y
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000275 depends on FEATURE_SUID_CONFIG
Eric Andersenc9f20d92002-12-05 08:41:41 +0000276 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200277 /etc/busybox.conf should be readable by the user needing the SUID,
278 check this option to avoid users to be notified about missing
279 permissions.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000280
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000281config FEATURE_PREFER_APPLETS
Denis Vlasenko2f0c0d02007-01-21 00:41:04 +0000282 bool "exec prefers applets"
283 default n
284 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200285 This is an experimental option which directs applets about to
286 call 'exec' to try and find an applicable busybox applet before
287 searching the PATH. This is typically done by exec'ing
288 /proc/self/exe.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200289
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200290 This may affect shell, find -exec, xargs and similar applets.
291 They will use applets even if /bin/APPLET -> busybox link
292 is missing (or is not a link to busybox). However, this causes
293 problems in chroot jails without mounted /proc and with ps/top
294 (command name can be shown as 'exe' for applets started this way).
Denis Vlasenko2f0c0d02007-01-21 00:41:04 +0000295
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000296config BUSYBOX_EXEC_PATH
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200297 string "Path to busybox executable"
Rob Landleyc7ddefc2006-06-14 01:24:33 +0000298 default "/proc/self/exe"
299 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200300 When applets need to run other applets, busybox
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200301 sometimes needs to exec() itself. When the /proc filesystem is
302 mounted, /proc/self/exe always points to the currently running
303 executable. If you haven't got /proc, set this to wherever you
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200304 want to run busybox from.
Rob Landleyc7ddefc2006-06-14 01:24:33 +0000305
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200306config SELINUX
307 bool "Support NSA Security Enhanced Linux"
308 default n
309 select PLATFORM_LINUX
310 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200311 Enable support for SELinux in applets ls, ps, and id. Also provide
312 the option of compiling in SELinux applets.
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200313
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200314 If you do not have a complete SELinux userland installed, this stuff
315 will not compile. Specifially, libselinux 1.28 or better is
316 directly required by busybox. If the installation is located in a
317 non-standard directory, provide it by invoking make as follows:
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200318
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200319 CFLAGS=-I<libselinux-include-path> \
320 LDFLAGS=-L<libselinux-lib-path> \
321 make
322
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200323 Most people will leave this set to 'N'.
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200324
325config FEATURE_CLEAN_UP
326 bool "Clean up all memory before exiting (usually not needed)"
327 default n
328 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200329 As a size optimization, busybox normally exits without explicitly
330 freeing dynamically allocated memory or closing files. This saves
331 space since the OS will clean up for us, but it can confuse debuggers
332 like valgrind, which report tons of memory and resource leaks.
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200333
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200334 Don't enable this unless you have a really good reason to clean
335 things up manually.
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200336
Denis Vlasenkoa7825f22007-06-16 13:56:51 +0000337# These are auto-selected by other options
338
339config FEATURE_SYSLOG
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000340 bool #No description makes it a hidden option
Denis Vlasenkoa7825f22007-06-16 13:56:51 +0000341 default n
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000342 #help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200343 #This option is auto-selected when you select any applet which may
344 #send its output to syslog. You do not need to select it manually.
Denis Vlasenkoa7825f22007-06-16 13:56:51 +0000345
Kang-Che Sung4d06b312017-01-07 15:16:46 +0800346config PLATFORM_LINUX
347 bool #No description makes it a hidden option
348 default n
349 #help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200350 #For the most part, busybox requires only POSIX compatibility
351 #from the target system, but some applets and features use
352 #Linux-specific interfaces.
Kang-Che Sung4d06b312017-01-07 15:16:46 +0800353 #
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200354 #This is automatically selected if any applet or feature requires
355 #Linux-specific interfaces. You do not need to select it manually.
Kang-Che Sung4d06b312017-01-07 15:16:46 +0800356
Denys Vlasenko33602262016-11-24 22:08:12 +0100357comment 'Build Options'
Eric Andersenc9f20d92002-12-05 08:41:41 +0000358
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000359config STATIC
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200360 bool "Build static binary (no shared libs)"
Eric Andersenc9f20d92002-12-05 08:41:41 +0000361 default n
362 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200363 If you want to build a static binary, which does not use
364 or require any shared libraries, enable this option.
365 Static binaries are larger, but do not require functioning
366 dynamic libraries to be present, which is important if used
367 as a system rescue tool.
Eric Andersene5272072003-07-22 22:15:21 +0000368
Denis Vlasenko1da86d22008-06-04 11:28:24 +0000369config PIE
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200370 bool "Build position independent executable"
Denis Vlasenko1da86d22008-06-04 11:28:24 +0000371 default n
372 depends on !STATIC
373 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200374 Hardened code option. PIE binaries are loaded at a different
375 address at each invocation. This has some overhead,
376 particularly on x86-32 which is short on registers.
Gilles Espinasse26b80e82011-02-13 22:54:37 +0100377
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200378 Most people will leave this set to 'N'.
Denis Vlasenko1da86d22008-06-04 11:28:24 +0000379
Denis Vlasenkod2c450c2008-01-08 20:32:12 +0000380config NOMMU
381 bool "Force NOMMU build"
382 default n
383 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200384 Busybox tries to detect whether architecture it is being
385 built against supports MMU or not. If this detection fails,
386 or if you want to build NOMMU version of busybox for testing,
387 you may force NOMMU build here.
Denis Vlasenkod2c450c2008-01-08 20:32:12 +0000388
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200389 Most people will leave this set to 'N'.
Denis Vlasenkod2c450c2008-01-08 20:32:12 +0000390
Denis Vlasenkocc3f20b2008-06-23 22:31:52 +0000391# PIE can be made to work with BUILD_LIBBUSYBOX, but currently
392# build system does not support that
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000393config BUILD_LIBBUSYBOX
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000394 bool "Build shared libbusybox"
Rob Landleyc7ddefc2006-06-14 01:24:33 +0000395 default n
Denis Vlasenkofc5e8062008-07-09 21:24:18 +0000396 depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000397 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200398 Build a shared library libbusybox.so.N.N.N which contains all
399 busybox code.
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000400
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200401 This feature allows every applet to be built as a really tiny
402 separate executable linked against the library:
403 |$ size 0_lib/l*
404 | text data bss dec hex filename
405 | 939 212 28 1179 49b 0_lib/last
406 | 939 212 28 1179 49b 0_lib/less
407 | 919138 8328 1556 929022 e2cfe 0_lib/libbusybox.so.1.N.M
Denys Vlasenko367a55c2017-07-15 14:52:26 +0200408
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200409 This is useful on NOMMU systems which are not capable
410 of sharing executables, but are capable of sharing code
411 in dynamic libraries.
Denys Vlasenko367a55c2017-07-15 14:52:26 +0200412
413config FEATURE_LIBBUSYBOX_STATIC
414 bool "Pull in all external references into libbusybox"
415 default n
416 depends on BUILD_LIBBUSYBOX
417 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200418 Make libbusybox library independent, not using or requiring
419 any other shared libraries.
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000420
Denis Vlasenkof545be02007-10-07 17:06:26 +0000421config FEATURE_INDIVIDUAL
422 bool "Produce a binary for each applet, linked against libbusybox"
423 default y
Denis Vlasenkofc5e8062008-07-09 21:24:18 +0000424 depends on BUILD_LIBBUSYBOX
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000425 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200426 If your CPU architecture doesn't allow for sharing text/rodata
427 sections of running binaries, but allows for runtime dynamic
428 libraries, this option will allow you to reduce memory footprint
429 when you have many different applets running at once.
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000430
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200431 If your CPU architecture allows for sharing text/rodata,
432 having single binary is more optimal.
Denis Vlasenkof545be02007-10-07 17:06:26 +0000433
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200434 Each applet will be a tiny program, dynamically linked
435 against libbusybox.so.N.N.N.
Denis Vlasenkof545be02007-10-07 17:06:26 +0000436
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200437 You need to have a working dynamic linker.
Denis Vlasenkof545be02007-10-07 17:06:26 +0000438
439config FEATURE_SHARED_BUSYBOX
440 bool "Produce additional busybox binary linked against libbusybox"
441 default y
Denis Vlasenkofc5e8062008-07-09 21:24:18 +0000442 depends on BUILD_LIBBUSYBOX
Eric Andersenc9f20d92002-12-05 08:41:41 +0000443 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200444 Build busybox, dynamically linked against libbusybox.so.N.N.N.
Denis Vlasenkof545be02007-10-07 17:06:26 +0000445
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200446 You need to have a working dynamic linker.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000447
Denis Vlasenkodef88982007-10-07 17:06:01 +0000448### config BUILD_AT_ONCE
449### bool "Compile all sources at once"
450### default n
451### help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200452### Normally each source-file is compiled with one invocation of
453### the compiler.
454### If you set this option, all sources are compiled at once.
455### This gives the compiler more opportunities to optimize which can
456### result in smaller and/or faster binaries.
Denis Vlasenkodef88982007-10-07 17:06:01 +0000457###
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200458### Setting this option will consume alot of memory, e.g. if you
459### enable all applets with all features, gcc uses more than 300MB
460### RAM during compilation of busybox.
Denis Vlasenkodef88982007-10-07 17:06:01 +0000461###
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200462### This option is most likely only beneficial for newer compilers
463### such as gcc-4.1 and above.
Denis Vlasenkodef88982007-10-07 17:06:01 +0000464###
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200465### Say 'N' unless you know what you are doing.
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000466
Denis Vlasenkob8e653b2008-06-02 04:51:29 +0000467config CROSS_COMPILER_PREFIX
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200468 string "Cross compiler prefix"
Denis Vlasenkob8e653b2008-06-02 04:51:29 +0000469 default ""
470 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200471 If you want to build busybox with a cross compiler, then you
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200472 will need to set this to the cross-compiler prefix, for example,
473 "i386-uclibc-".
Bernhard Reutner-Fischer7d0d3e22008-08-22 08:25:26 +0000474
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200475 Note that CROSS_COMPILE environment variable or
476 "make CROSS_COMPILE=xxx ..." will override this selection.
Bernhard Reutner-Fischer7d0d3e22008-08-22 08:25:26 +0000477
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200478 Native builds leave this empty.
Denis Vlasenkob8e653b2008-06-02 04:51:29 +0000479
Rob Walkerbf634372012-03-07 12:25:53 +0100480config SYSROOT
481 string "Path to sysroot"
482 default ""
483 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200484 If you want to build busybox with a cross compiler, then you
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200485 might also need to specify where /usr/include and /usr/lib
486 will be found.
Rob Walkerbf634372012-03-07 12:25:53 +0100487
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200488 For example, busybox can be built against an installed
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200489 Android NDK, platform version 9, for ARM ABI with
Rob Walkerbf634372012-03-07 12:25:53 +0100490
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200491 CONFIG_SYSROOT=/opt/android-ndk/platforms/android-9/arch-arm
Rob Walkerbf634372012-03-07 12:25:53 +0100492
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200493 Native builds leave this empty.
Rob Walkerbf634372012-03-07 12:25:53 +0100494
Bernhard Reutner-Fischerf6107c72009-01-22 13:27:14 +0000495config EXTRA_CFLAGS
496 string "Additional CFLAGS"
497 default ""
498 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200499 Additional CFLAGS to pass to the compiler verbatim.
Bernhard Reutner-Fischerf6107c72009-01-22 13:27:14 +0000500
Rob Walkerbf634372012-03-07 12:25:53 +0100501config EXTRA_LDFLAGS
502 string "Additional LDFLAGS"
503 default ""
504 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200505 Additional LDFLAGS to pass to the linker verbatim.
Rob Walkerbf634372012-03-07 12:25:53 +0100506
507config EXTRA_LDLIBS
508 string "Additional LDLIBS"
509 default ""
510 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200511 Additional LDLIBS to pass to the linker with -l.
Rob Walkerbf634372012-03-07 12:25:53 +0100512
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200513config USE_PORTABLE_CODE
514 bool "Avoid using GCC-specific code constructs"
515 default n
516 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200517 Use this option if you are trying to compile busybox with
518 compiler other than gcc.
519 If you do use gcc, this option may needlessly increase code size.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200520
Denys Vlasenko2c997022018-04-06 18:55:35 +0200521config STACK_OPTIMIZATION_386
522 bool "Use -mpreferred-stack-boundary=2 on i386 arch"
523 default y
524 help
525 This option makes for smaller code, but some libc versions
526 do not work with it (they use SSE instructions without
527 ensuring stack alignment).
528
Denys Vlasenko33602262016-11-24 22:08:12 +0100529comment 'Installation Options ("make install" behavior)'
Eric Andersenc9f20d92002-12-05 08:41:41 +0000530
Denys Vlasenko33602262016-11-24 22:08:12 +0100531choice
532 prompt "What kind of applet links to install"
533 default INSTALL_APPLET_SYMLINKS
534 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200535 Choose what kind of links to applets are created by "make install".
Denys Vlasenko33602262016-11-24 22:08:12 +0100536
537config INSTALL_APPLET_SYMLINKS
538 bool "as soft-links"
539 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200540 Install applets as soft-links to the busybox binary. This needs some
541 free inodes on the filesystem, but might help with filesystem
542 generators that can't cope with hard-links.
Denys Vlasenko33602262016-11-24 22:08:12 +0100543
544config INSTALL_APPLET_HARDLINKS
545 bool "as hard-links"
546 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200547 Install applets as hard-links to the busybox binary. This might
548 count on a filesystem with few inodes.
Denys Vlasenko33602262016-11-24 22:08:12 +0100549
550config INSTALL_APPLET_SCRIPT_WRAPPERS
551 bool "as script wrappers"
552 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200553 Install applets as script wrappers that call the busybox binary.
Denys Vlasenko33602262016-11-24 22:08:12 +0100554
555config INSTALL_APPLET_DONT
556 bool "not installed"
557 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200558 Do not install applet links. Useful when you plan to use
559 busybox --install for installing links, or plan to use
560 a standalone shell and thus don't need applet links.
Denys Vlasenko33602262016-11-24 22:08:12 +0100561
562endchoice
563
564choice
565 prompt "/bin/sh applet link"
566 default INSTALL_SH_APPLET_SYMLINK
567 depends on INSTALL_APPLET_SCRIPT_WRAPPERS
568 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200569 Choose how you install /bin/sh applet link.
Denys Vlasenko33602262016-11-24 22:08:12 +0100570
571config INSTALL_SH_APPLET_SYMLINK
572 bool "as soft-link"
573 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200574 Install /bin/sh applet as soft-link to the busybox binary.
Denys Vlasenko33602262016-11-24 22:08:12 +0100575
576config INSTALL_SH_APPLET_HARDLINK
577 bool "as hard-link"
578 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200579 Install /bin/sh applet as hard-link to the busybox binary.
Denys Vlasenko33602262016-11-24 22:08:12 +0100580
581config INSTALL_SH_APPLET_SCRIPT_WRAPPER
582 bool "as script wrapper"
583 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200584 Install /bin/sh applet as script wrapper that calls
585 the busybox binary.
Denys Vlasenko33602262016-11-24 22:08:12 +0100586
587endchoice
588
589config PREFIX
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200590 string "Destination path for 'make install'"
Denys Vlasenko33602262016-11-24 22:08:12 +0100591 default "./_install"
592 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200593 Where "make install" should install busybox binary and links.
Denys Vlasenko33602262016-11-24 22:08:12 +0100594
595comment 'Debugging Options'
Eric Andersenc9f20d92002-12-05 08:41:41 +0000596
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000597config DEBUG
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200598 bool "Build with debug information"
Eric Andersenc9f20d92002-12-05 08:41:41 +0000599 default n
600 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200601 Say Y here to compile with debug information.
602 This increases the size of the binary considerably, and
603 should only be used when doing development.
604
605 This adds -g option to gcc command line.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000606
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200607 Most people should answer N.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000608
Denis Vlasenkobd8390a2008-06-12 20:23:03 +0000609config DEBUG_PESSIMIZE
Denis Vlasenkoc185e292008-07-16 23:45:11 +0000610 bool "Disable compiler optimizations"
Denis Vlasenkobd8390a2008-06-12 20:23:03 +0000611 default n
612 depends on DEBUG
613 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200614 The compiler's optimization of source code can eliminate and reorder
615 code, resulting in an executable that's hard to understand when
616 stepping through it with a debugger. This switches it off, resulting
617 in a much bigger executable that more closely matches the source
618 code.
Denis Vlasenkobd8390a2008-06-12 20:23:03 +0000619
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200620 This replaces -Os/-O2 with -O0 in gcc command line.
621
Mike Frysinger43e56632016-02-12 22:12:47 -0500622config DEBUG_SANITIZE
623 bool "Enable runtime sanitizers (ASAN/LSAN/USAN/etc...)"
624 default n
625 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200626 Say Y here if you want to enable runtime sanitizers. These help
627 catch bad memory accesses (e.g. buffer overflows), but will make
628 the executable larger and slow down runtime a bit.
Mike Frysinger43e56632016-02-12 22:12:47 -0500629
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200630 This adds -fsanitize=foo options to gcc command line.
Denys Vlasenkof5604222017-01-10 14:58:54 +0100631
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200632 If you aren't developing/testing busybox, say N here.
Mike Frysinger43e56632016-02-12 22:12:47 -0500633
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +0200634config UNIT_TEST
635 bool "Build unit tests"
636 default n
637 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200638 Say Y here if you want to build unit tests (both the framework and
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200639 test cases) as an applet. This results in bigger code, so you
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200640 probably don't want this option in production builds.
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +0200641
Denis Vlasenkoe0eebc12007-01-27 13:44:53 +0000642config WERROR
643 bool "Abort compilation on any warning"
Rob Landleyc503df52006-05-09 22:08:56 +0000644 default n
Rob Landleyc503df52006-05-09 22:08:56 +0000645 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200646 This adds -Werror to gcc command line.
Denis Vlasenkoe0eebc12007-01-27 13:44:53 +0000647
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200648 Most people should answer N.
Denis Vlasenkoe0eebc12007-01-27 13:44:53 +0000649
Eric Andersenf086ed82004-05-25 11:30:22 +0000650choice
651 prompt "Additional debugging library"
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000652 default NO_DEBUG_LIB
Eric Andersenc9f20d92002-12-05 08:41:41 +0000653 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200654 Using an additional debugging library will make busybox become
655 considerably larger and will cause it to run more slowly. You
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200656 should always leave this option disabled for production use.
Eric Andersenf086ed82004-05-25 11:30:22 +0000657
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200658 dmalloc support:
659 ----------------
660 This enables compiling with dmalloc ( http://dmalloc.com/ )
661 which is an excellent public domain mem leak and malloc problem
662 detector. To enable dmalloc, before running busybox you will
663 want to properly set your environment, for example:
664 export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
665 The 'debug=' value is generated using the following command
666 dmalloc -p log-stats -p log-non-free -p log-bad-space \
667 -p log-elapsed-time -p check-fence -p check-heap \
668 -p check-lists -p check-blank -p check-funcs -p realloc-copy \
669 -p allow-free-null
Eric Andersenc9f20d92002-12-05 08:41:41 +0000670
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200671 Electric-fence support:
672 -----------------------
673 This enables compiling with Electric-fence support. Electric
674 fence is another very useful malloc debugging library which uses
675 your computer's virtual memory hardware to detect illegal memory
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200676 accesses. This support will make busybox be considerably larger
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200677 and run slower, so you should leave this option disabled unless
678 you are hunting a hard to find memory problem.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000679
Eric Andersenf086ed82004-05-25 11:30:22 +0000680
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000681config NO_DEBUG_LIB
Eric Andersenf086ed82004-05-25 11:30:22 +0000682 bool "None"
683
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000684config DMALLOC
Eric Andersenf086ed82004-05-25 11:30:22 +0000685 bool "Dmalloc"
686
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000687config EFENCE
Eric Andersenf086ed82004-05-25 11:30:22 +0000688 bool "Electric-fence"
689
690endchoice
691
Mike Frysinger72d59db2006-03-10 23:17:17 +0000692source libbb/Config.in
693
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200694endmenu
695
Mike Frysinger72d59db2006-03-10 23:17:17 +0000696comment "Applets"
697
698source archival/Config.in
699source coreutils/Config.in
700source console-tools/Config.in
701source debianutils/Config.in
Denys Vlasenkoab77e812017-08-18 19:15:29 +0200702source klibc-utils/Config.in
Mike Frysinger72d59db2006-03-10 23:17:17 +0000703source editors/Config.in
704source findutils/Config.in
705source init/Config.in
706source loginutils/Config.in
707source e2fsprogs/Config.in
708source modutils/Config.in
709source util-linux/Config.in
710source miscutils/Config.in
711source networking/Config.in
Bernhard Reutner-Fischeraa2a1c02008-10-24 19:48:47 +0000712source printutils/Config.in
Denis Vlasenkob9d572a2008-11-06 23:41:38 +0000713source mailutils/Config.in
Mike Frysinger72d59db2006-03-10 23:17:17 +0000714source procps/Config.in
Denis Vlasenkofe544582006-10-03 15:57:40 +0000715source runit/Config.in
Denis Vlasenkod46d3c22007-02-06 19:28:50 +0000716source selinux/Config.in
Bernhard Reutner-Fischeraa2a1c02008-10-24 19:48:47 +0000717source shell/Config.in
718source sysklogd/Config.in