blob: 1a44c5b6dd0d37a5754fa971cbe8994fd5590981 [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 Vlasenko4bdc9142019-01-06 20:12:16 +010015 bool "Enable compatibility for full-blown desktop systems (8kb)"
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
Ron Yorstond1b2ae22018-11-18 19:12:26 +0100181config FEATURE_SHOW_SCRIPT
182 bool "Support --show SCRIPT"
183 default y
184 depends on BUSYBOX
185
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200186config FEATURE_INSTALLER
187 bool "Support --install [-s] to install applet links at runtime"
188 default y
189 depends on BUSYBOX
190 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200191 Enable 'busybox --install [-s]' support. This will allow you to use
192 busybox at runtime to create hard links or symlinks for all the
193 applets that are compiled into busybox.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200194
195config INSTALL_NO_USR
196 bool "Don't use /usr"
197 default n
198 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200199 Disable use of /usr. "busybox --install" and "make install"
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200200 will install applets only to /bin and /sbin,
201 never to /usr/bin or /usr/sbin.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200202
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000203config FEATURE_SUID
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200204 bool "Drop SUID state for most applets"
Denys Vlasenko2f32bf82010-06-06 04:14:28 +0200205 default y
Eric Andersenc9f20d92002-12-05 08:41:41 +0000206 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200207 With this option you can install the busybox binary belonging
208 to root with the suid bit set, enabling some applets to perform
209 root-level operations even when run by ordinary users
210 (for example, mounting of user mounts in fstab needs this).
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200211
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200212 With this option enabled, busybox drops privileges for applets
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200213 that don't need root access, before entering their main() function.
Rob Landleyd5b9b602006-05-31 23:23:42 +0000214
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200215 If you are really paranoid and don't want even initial busybox code
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200216 to run under root for every applet, build two busybox binaries with
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200217 different applets in them (and the appropriate symlinks pointing
218 to each binary), and only set the suid bit on the one that needs it.
Denys Vlasenkod4d289a2010-10-12 04:18:05 +0200219
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200220 Some applets which require root rights (need suid bit on the binary
221 or to be run by root) and will refuse to execute otherwise:
222 crontab, login, passwd, su, vlock, wall.
Bernhard Reutner-Fischeraa2a1c02008-10-24 19:48:47 +0000223
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200224 The applets which will use root rights if they have them
225 (via suid bit, or because run by root), but would try to work
226 without root right nevertheless:
227 findfs, ping[6], traceroute[6], mount.
Denys Vlasenko3b5acaa2011-01-18 13:52:48 +0100228
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200229 Note that if you DO NOT select this option, but DO make busybox
230 suid root, ALL applets will run under root, which is a huge
231 security hole (think "cp /some/file /etc/passwd").
Eric Andersenc9f20d92002-12-05 08:41:41 +0000232
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000233config FEATURE_SUID_CONFIG
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200234 bool "Enable SUID configuration via /etc/busybox.conf"
Denys Vlasenkoe0238f82011-05-14 15:23:55 +0200235 default y
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000236 depends on FEATURE_SUID
Eric Andersenc9f20d92002-12-05 08:41:41 +0000237 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200238 Allow the SUID/SGID state of an applet to be determined at runtime
239 by checking /etc/busybox.conf. (This is sort of a poor man's sudo.)
240 The format of this file is as follows:
Eric Andersene5272072003-07-22 22:15:21 +0000241
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200242 APPLET = [Ssx-][Ssx-][x-] [USER.GROUP]
Denys Vlasenko3770b6b2011-05-16 13:19:25 +0200243
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200244 s: USER or GROUP is allowed to execute APPLET.
245 APPLET will run under USER or GROUP
246 (regardless of who's running it).
247 S: USER or GROUP is NOT allowed to execute APPLET.
248 APPLET will run under USER or GROUP.
249 This option is not very sensical.
250 x: USER/GROUP/others are allowed to execute APPLET.
251 No UID/GID change will be done when it is run.
252 -: USER/GROUP/others are not allowed to execute APPLET.
Eric Andersen5043ea12005-06-23 19:15:40 +0000253
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200254 An example might help:
Eric Andersene5272072003-07-22 22:15:21 +0000255
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200256 |[SUID]
257 |su = ssx root.0 # applet su can be run by anyone and runs with
258 | # euid=0,egid=0
259 |su = ssx # exactly the same
260 |
261 |mount = sx- root.disk # applet mount can be run by root and members
262 | # of group disk (but not anyone else)
263 | # and runs with euid=0 (egid is not changed)
264 |
265 |cp = --- # disable applet cp for everyone
Eric Andersene5272072003-07-22 22:15:21 +0000266
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200267 The file has to be owned by user root, group root and has to be
268 writeable only by root:
269 (chown 0.0 /etc/busybox.conf; chmod 600 /etc/busybox.conf)
270 The busybox executable has to be owned by user root, group
271 root and has to be setuid root for this to work:
272 (chown 0.0 /bin/busybox; chmod 4755 /bin/busybox)
Eric Andersene5272072003-07-22 22:15:21 +0000273
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200274 Robert 'sandman' Griebl has more information here:
275 <url: http://www.softforge.de/bb/suid.html >.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000276
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000277config FEATURE_SUID_CONFIG_QUIET
Eric Andersenc9f20d92002-12-05 08:41:41 +0000278 bool "Suppress warning message if /etc/busybox.conf is not readable"
Rob Landleyd5b9b602006-05-31 23:23:42 +0000279 default y
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000280 depends on FEATURE_SUID_CONFIG
Eric Andersenc9f20d92002-12-05 08:41:41 +0000281 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200282 /etc/busybox.conf should be readable by the user needing the SUID,
283 check this option to avoid users to be notified about missing
284 permissions.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000285
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000286config FEATURE_PREFER_APPLETS
Denis Vlasenko2f0c0d02007-01-21 00:41:04 +0000287 bool "exec prefers applets"
288 default n
289 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200290 This is an experimental option which directs applets about to
291 call 'exec' to try and find an applicable busybox applet before
292 searching the PATH. This is typically done by exec'ing
293 /proc/self/exe.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200294
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200295 This may affect shell, find -exec, xargs and similar applets.
296 They will use applets even if /bin/APPLET -> busybox link
297 is missing (or is not a link to busybox). However, this causes
298 problems in chroot jails without mounted /proc and with ps/top
299 (command name can be shown as 'exe' for applets started this way).
Denis Vlasenko2f0c0d02007-01-21 00:41:04 +0000300
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000301config BUSYBOX_EXEC_PATH
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200302 string "Path to busybox executable"
Rob Landleyc7ddefc2006-06-14 01:24:33 +0000303 default "/proc/self/exe"
304 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200305 When applets need to run other applets, busybox
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200306 sometimes needs to exec() itself. When the /proc filesystem is
307 mounted, /proc/self/exe always points to the currently running
308 executable. If you haven't got /proc, set this to wherever you
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200309 want to run busybox from.
Rob Landleyc7ddefc2006-06-14 01:24:33 +0000310
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200311config SELINUX
312 bool "Support NSA Security Enhanced Linux"
313 default n
314 select PLATFORM_LINUX
315 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200316 Enable support for SELinux in applets ls, ps, and id. Also provide
317 the option of compiling in SELinux applets.
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200318
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200319 If you do not have a complete SELinux userland installed, this stuff
320 will not compile. Specifially, libselinux 1.28 or better is
321 directly required by busybox. If the installation is located in a
322 non-standard directory, provide it by invoking make as follows:
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200323
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200324 CFLAGS=-I<libselinux-include-path> \
325 LDFLAGS=-L<libselinux-lib-path> \
326 make
327
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200328 Most people will leave this set to 'N'.
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200329
330config FEATURE_CLEAN_UP
331 bool "Clean up all memory before exiting (usually not needed)"
332 default n
333 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200334 As a size optimization, busybox normally exits without explicitly
335 freeing dynamically allocated memory or closing files. This saves
336 space since the OS will clean up for us, but it can confuse debuggers
337 like valgrind, which report tons of memory and resource leaks.
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200338
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200339 Don't enable this unless you have a really good reason to clean
340 things up manually.
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200341
Denis Vlasenkoa7825f22007-06-16 13:56:51 +0000342# These are auto-selected by other options
343
344config FEATURE_SYSLOG
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000345 bool #No description makes it a hidden option
Denis Vlasenkoa7825f22007-06-16 13:56:51 +0000346 default n
Denis Vlasenko35a064b2008-11-06 00:49:59 +0000347 #help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200348 #This option is auto-selected when you select any applet which may
349 #send its output to syslog. You do not need to select it manually.
Denis Vlasenkoa7825f22007-06-16 13:56:51 +0000350
Kang-Che Sung4d06b312017-01-07 15:16:46 +0800351config PLATFORM_LINUX
352 bool #No description makes it a hidden option
353 default n
354 #help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200355 #For the most part, busybox requires only POSIX compatibility
356 #from the target system, but some applets and features use
357 #Linux-specific interfaces.
Kang-Che Sung4d06b312017-01-07 15:16:46 +0800358 #
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200359 #This is automatically selected if any applet or feature requires
360 #Linux-specific interfaces. You do not need to select it manually.
Kang-Che Sung4d06b312017-01-07 15:16:46 +0800361
Denys Vlasenko33602262016-11-24 22:08:12 +0100362comment 'Build Options'
Eric Andersenc9f20d92002-12-05 08:41:41 +0000363
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000364config STATIC
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200365 bool "Build static binary (no shared libs)"
Eric Andersenc9f20d92002-12-05 08:41:41 +0000366 default n
367 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200368 If you want to build a static binary, which does not use
369 or require any shared libraries, enable this option.
370 Static binaries are larger, but do not require functioning
371 dynamic libraries to be present, which is important if used
372 as a system rescue tool.
Eric Andersene5272072003-07-22 22:15:21 +0000373
Denis Vlasenko1da86d22008-06-04 11:28:24 +0000374config PIE
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200375 bool "Build position independent executable"
Denis Vlasenko1da86d22008-06-04 11:28:24 +0000376 default n
377 depends on !STATIC
378 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200379 Hardened code option. PIE binaries are loaded at a different
380 address at each invocation. This has some overhead,
381 particularly on x86-32 which is short on registers.
Gilles Espinasse26b80e82011-02-13 22:54:37 +0100382
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200383 Most people will leave this set to 'N'.
Denis Vlasenko1da86d22008-06-04 11:28:24 +0000384
Denis Vlasenkod2c450c2008-01-08 20:32:12 +0000385config NOMMU
386 bool "Force NOMMU build"
387 default n
388 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200389 Busybox tries to detect whether architecture it is being
390 built against supports MMU or not. If this detection fails,
391 or if you want to build NOMMU version of busybox for testing,
392 you may force NOMMU build here.
Denis Vlasenkod2c450c2008-01-08 20:32:12 +0000393
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200394 Most people will leave this set to 'N'.
Denis Vlasenkod2c450c2008-01-08 20:32:12 +0000395
Denis Vlasenkocc3f20b2008-06-23 22:31:52 +0000396# PIE can be made to work with BUILD_LIBBUSYBOX, but currently
397# build system does not support that
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000398config BUILD_LIBBUSYBOX
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000399 bool "Build shared libbusybox"
Rob Landleyc7ddefc2006-06-14 01:24:33 +0000400 default n
Denis Vlasenkofc5e8062008-07-09 21:24:18 +0000401 depends on !FEATURE_PREFER_APPLETS && !PIE && !STATIC
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000402 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200403 Build a shared library libbusybox.so.N.N.N which contains all
404 busybox code.
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000405
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200406 This feature allows every applet to be built as a really tiny
407 separate executable linked against the library:
408 |$ size 0_lib/l*
409 | text data bss dec hex filename
410 | 939 212 28 1179 49b 0_lib/last
411 | 939 212 28 1179 49b 0_lib/less
412 | 919138 8328 1556 929022 e2cfe 0_lib/libbusybox.so.1.N.M
Denys Vlasenko367a55c2017-07-15 14:52:26 +0200413
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200414 This is useful on NOMMU systems which are not capable
415 of sharing executables, but are capable of sharing code
416 in dynamic libraries.
Denys Vlasenko367a55c2017-07-15 14:52:26 +0200417
418config FEATURE_LIBBUSYBOX_STATIC
419 bool "Pull in all external references into libbusybox"
420 default n
421 depends on BUILD_LIBBUSYBOX
422 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200423 Make libbusybox library independent, not using or requiring
424 any other shared libraries.
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000425
Denis Vlasenkof545be02007-10-07 17:06:26 +0000426config FEATURE_INDIVIDUAL
427 bool "Produce a binary for each applet, linked against libbusybox"
428 default y
Denis Vlasenkofc5e8062008-07-09 21:24:18 +0000429 depends on BUILD_LIBBUSYBOX
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000430 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200431 If your CPU architecture doesn't allow for sharing text/rodata
432 sections of running binaries, but allows for runtime dynamic
433 libraries, this option will allow you to reduce memory footprint
434 when you have many different applets running at once.
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000435
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200436 If your CPU architecture allows for sharing text/rodata,
437 having single binary is more optimal.
Denis Vlasenkof545be02007-10-07 17:06:26 +0000438
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200439 Each applet will be a tiny program, dynamically linked
440 against libbusybox.so.N.N.N.
Denis Vlasenkof545be02007-10-07 17:06:26 +0000441
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200442 You need to have a working dynamic linker.
Denis Vlasenkof545be02007-10-07 17:06:26 +0000443
444config FEATURE_SHARED_BUSYBOX
445 bool "Produce additional busybox binary linked against libbusybox"
446 default y
Denis Vlasenkofc5e8062008-07-09 21:24:18 +0000447 depends on BUILD_LIBBUSYBOX
Eric Andersenc9f20d92002-12-05 08:41:41 +0000448 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200449 Build busybox, dynamically linked against libbusybox.so.N.N.N.
Denis Vlasenkof545be02007-10-07 17:06:26 +0000450
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200451 You need to have a working dynamic linker.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000452
Denis Vlasenkodef88982007-10-07 17:06:01 +0000453### config BUILD_AT_ONCE
454### bool "Compile all sources at once"
455### default n
456### help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200457### Normally each source-file is compiled with one invocation of
458### the compiler.
459### If you set this option, all sources are compiled at once.
460### This gives the compiler more opportunities to optimize which can
461### result in smaller and/or faster binaries.
Denis Vlasenkodef88982007-10-07 17:06:01 +0000462###
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200463### Setting this option will consume alot of memory, e.g. if you
464### enable all applets with all features, gcc uses more than 300MB
465### RAM during compilation of busybox.
Denis Vlasenkodef88982007-10-07 17:06:01 +0000466###
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200467### This option is most likely only beneficial for newer compilers
468### such as gcc-4.1 and above.
Denis Vlasenkodef88982007-10-07 17:06:01 +0000469###
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200470### Say 'N' unless you know what you are doing.
Bernhard Reutner-Fischer2aba3952006-01-24 16:14:14 +0000471
Denis Vlasenkob8e653b2008-06-02 04:51:29 +0000472config CROSS_COMPILER_PREFIX
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200473 string "Cross compiler prefix"
Denis Vlasenkob8e653b2008-06-02 04:51:29 +0000474 default ""
475 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200476 If you want to build busybox with a cross compiler, then you
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200477 will need to set this to the cross-compiler prefix, for example,
478 "i386-uclibc-".
Bernhard Reutner-Fischer7d0d3e22008-08-22 08:25:26 +0000479
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200480 Note that CROSS_COMPILE environment variable or
481 "make CROSS_COMPILE=xxx ..." will override this selection.
Bernhard Reutner-Fischer7d0d3e22008-08-22 08:25:26 +0000482
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200483 Native builds leave this empty.
Denis Vlasenkob8e653b2008-06-02 04:51:29 +0000484
Rob Walkerbf634372012-03-07 12:25:53 +0100485config SYSROOT
486 string "Path to sysroot"
487 default ""
488 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200489 If you want to build busybox with a cross compiler, then you
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200490 might also need to specify where /usr/include and /usr/lib
491 will be found.
Rob Walkerbf634372012-03-07 12:25:53 +0100492
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200493 For example, busybox can be built against an installed
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200494 Android NDK, platform version 9, for ARM ABI with
Rob Walkerbf634372012-03-07 12:25:53 +0100495
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200496 CONFIG_SYSROOT=/opt/android-ndk/platforms/android-9/arch-arm
Rob Walkerbf634372012-03-07 12:25:53 +0100497
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200498 Native builds leave this empty.
Rob Walkerbf634372012-03-07 12:25:53 +0100499
Bernhard Reutner-Fischerf6107c72009-01-22 13:27:14 +0000500config EXTRA_CFLAGS
501 string "Additional CFLAGS"
502 default ""
503 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200504 Additional CFLAGS to pass to the compiler verbatim.
Bernhard Reutner-Fischerf6107c72009-01-22 13:27:14 +0000505
Rob Walkerbf634372012-03-07 12:25:53 +0100506config EXTRA_LDFLAGS
507 string "Additional LDFLAGS"
508 default ""
509 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200510 Additional LDFLAGS to pass to the linker verbatim.
Rob Walkerbf634372012-03-07 12:25:53 +0100511
512config EXTRA_LDLIBS
513 string "Additional LDLIBS"
514 default ""
515 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200516 Additional LDLIBS to pass to the linker with -l.
Rob Walkerbf634372012-03-07 12:25:53 +0100517
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200518config USE_PORTABLE_CODE
519 bool "Avoid using GCC-specific code constructs"
520 default n
521 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200522 Use this option if you are trying to compile busybox with
523 compiler other than gcc.
524 If you do use gcc, this option may needlessly increase code size.
Denys Vlasenko2c8929c2017-07-15 21:14:16 +0200525
Denys Vlasenko2c997022018-04-06 18:55:35 +0200526config STACK_OPTIMIZATION_386
527 bool "Use -mpreferred-stack-boundary=2 on i386 arch"
528 default y
529 help
530 This option makes for smaller code, but some libc versions
531 do not work with it (they use SSE instructions without
532 ensuring stack alignment).
533
Denys Vlasenko33602262016-11-24 22:08:12 +0100534comment 'Installation Options ("make install" behavior)'
Eric Andersenc9f20d92002-12-05 08:41:41 +0000535
Denys Vlasenko33602262016-11-24 22:08:12 +0100536choice
537 prompt "What kind of applet links to install"
538 default INSTALL_APPLET_SYMLINKS
539 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200540 Choose what kind of links to applets are created by "make install".
Denys Vlasenko33602262016-11-24 22:08:12 +0100541
542config INSTALL_APPLET_SYMLINKS
543 bool "as soft-links"
544 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200545 Install applets as soft-links to the busybox binary. This needs some
546 free inodes on the filesystem, but might help with filesystem
547 generators that can't cope with hard-links.
Denys Vlasenko33602262016-11-24 22:08:12 +0100548
549config INSTALL_APPLET_HARDLINKS
550 bool "as hard-links"
551 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200552 Install applets as hard-links to the busybox binary. This might
553 count on a filesystem with few inodes.
Denys Vlasenko33602262016-11-24 22:08:12 +0100554
555config INSTALL_APPLET_SCRIPT_WRAPPERS
556 bool "as script wrappers"
557 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200558 Install applets as script wrappers that call the busybox binary.
Denys Vlasenko33602262016-11-24 22:08:12 +0100559
560config INSTALL_APPLET_DONT
561 bool "not installed"
562 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200563 Do not install applet links. Useful when you plan to use
564 busybox --install for installing links, or plan to use
565 a standalone shell and thus don't need applet links.
Denys Vlasenko33602262016-11-24 22:08:12 +0100566
567endchoice
568
569choice
570 prompt "/bin/sh applet link"
571 default INSTALL_SH_APPLET_SYMLINK
572 depends on INSTALL_APPLET_SCRIPT_WRAPPERS
573 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200574 Choose how you install /bin/sh applet link.
Denys Vlasenko33602262016-11-24 22:08:12 +0100575
576config INSTALL_SH_APPLET_SYMLINK
577 bool "as soft-link"
578 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200579 Install /bin/sh applet as soft-link to the busybox binary.
Denys Vlasenko33602262016-11-24 22:08:12 +0100580
581config INSTALL_SH_APPLET_HARDLINK
582 bool "as hard-link"
583 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200584 Install /bin/sh applet as hard-link to the busybox binary.
Denys Vlasenko33602262016-11-24 22:08:12 +0100585
586config INSTALL_SH_APPLET_SCRIPT_WRAPPER
587 bool "as script wrapper"
588 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200589 Install /bin/sh applet as script wrapper that calls
590 the busybox binary.
Denys Vlasenko33602262016-11-24 22:08:12 +0100591
592endchoice
593
594config PREFIX
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200595 string "Destination path for 'make install'"
Denys Vlasenko33602262016-11-24 22:08:12 +0100596 default "./_install"
597 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200598 Where "make install" should install busybox binary and links.
Denys Vlasenko33602262016-11-24 22:08:12 +0100599
600comment 'Debugging Options'
Eric Andersenc9f20d92002-12-05 08:41:41 +0000601
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000602config DEBUG
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200603 bool "Build with debug information"
Eric Andersenc9f20d92002-12-05 08:41:41 +0000604 default n
605 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200606 Say Y here to compile with debug information.
607 This increases the size of the binary considerably, and
608 should only be used when doing development.
609
610 This adds -g option to gcc command line.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000611
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200612 Most people should answer N.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000613
Denis Vlasenkobd8390a2008-06-12 20:23:03 +0000614config DEBUG_PESSIMIZE
Denis Vlasenkoc185e292008-07-16 23:45:11 +0000615 bool "Disable compiler optimizations"
Denis Vlasenkobd8390a2008-06-12 20:23:03 +0000616 default n
617 depends on DEBUG
618 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200619 The compiler's optimization of source code can eliminate and reorder
620 code, resulting in an executable that's hard to understand when
621 stepping through it with a debugger. This switches it off, resulting
622 in a much bigger executable that more closely matches the source
623 code.
Denis Vlasenkobd8390a2008-06-12 20:23:03 +0000624
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200625 This replaces -Os/-O2 with -O0 in gcc command line.
626
Mike Frysinger43e56632016-02-12 22:12:47 -0500627config DEBUG_SANITIZE
628 bool "Enable runtime sanitizers (ASAN/LSAN/USAN/etc...)"
629 default n
630 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200631 Say Y here if you want to enable runtime sanitizers. These help
632 catch bad memory accesses (e.g. buffer overflows), but will make
633 the executable larger and slow down runtime a bit.
Mike Frysinger43e56632016-02-12 22:12:47 -0500634
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200635 This adds -fsanitize=foo options to gcc command line.
Denys Vlasenkof5604222017-01-10 14:58:54 +0100636
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200637 If you aren't developing/testing busybox, say N here.
Mike Frysinger43e56632016-02-12 22:12:47 -0500638
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +0200639config UNIT_TEST
640 bool "Build unit tests"
641 default n
642 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200643 Say Y here if you want to build unit tests (both the framework and
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200644 test cases) as an applet. This results in bigger code, so you
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200645 probably don't want this option in production builds.
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +0200646
Denis Vlasenkoe0eebc12007-01-27 13:44:53 +0000647config WERROR
648 bool "Abort compilation on any warning"
Rob Landleyc503df52006-05-09 22:08:56 +0000649 default n
Rob Landleyc503df52006-05-09 22:08:56 +0000650 help
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200651 This adds -Werror to gcc command line.
Denis Vlasenkoe0eebc12007-01-27 13:44:53 +0000652
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200653 Most people should answer N.
Denis Vlasenkoe0eebc12007-01-27 13:44:53 +0000654
Eric Andersenf086ed82004-05-25 11:30:22 +0000655choice
656 prompt "Additional debugging library"
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000657 default NO_DEBUG_LIB
Eric Andersenc9f20d92002-12-05 08:41:41 +0000658 help
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200659 Using an additional debugging library will make busybox become
660 considerably larger and will cause it to run more slowly. You
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200661 should always leave this option disabled for production use.
Eric Andersenf086ed82004-05-25 11:30:22 +0000662
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200663 dmalloc support:
664 ----------------
665 This enables compiling with dmalloc ( http://dmalloc.com/ )
666 which is an excellent public domain mem leak and malloc problem
667 detector. To enable dmalloc, before running busybox you will
668 want to properly set your environment, for example:
669 export DMALLOC_OPTIONS=debug=0x34f47d83,inter=100,log=logfile
670 The 'debug=' value is generated using the following command
671 dmalloc -p log-stats -p log-non-free -p log-bad-space \
672 -p log-elapsed-time -p check-fence -p check-heap \
673 -p check-lists -p check-blank -p check-funcs -p realloc-copy \
674 -p allow-free-null
Eric Andersenc9f20d92002-12-05 08:41:41 +0000675
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200676 Electric-fence support:
677 -----------------------
678 This enables compiling with Electric-fence support. Electric
679 fence is another very useful malloc debugging library which uses
680 your computer's virtual memory hardware to detect illegal memory
Denys Vlasenko86d5bf42017-07-27 02:59:13 +0200681 accesses. This support will make busybox be considerably larger
Denys Vlasenko72089cf2017-07-21 09:50:55 +0200682 and run slower, so you should leave this option disabled unless
683 you are hunting a hard to find memory problem.
Eric Andersenc9f20d92002-12-05 08:41:41 +0000684
Eric Andersenf086ed82004-05-25 11:30:22 +0000685
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000686config NO_DEBUG_LIB
Eric Andersenf086ed82004-05-25 11:30:22 +0000687 bool "None"
688
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000689config DMALLOC
Eric Andersenf086ed82004-05-25 11:30:22 +0000690 bool "Dmalloc"
691
Denis Vlasenko7d219aa2006-10-05 10:17:08 +0000692config EFENCE
Eric Andersenf086ed82004-05-25 11:30:22 +0000693 bool "Electric-fence"
694
695endchoice
696
Mike Frysinger72d59db2006-03-10 23:17:17 +0000697source libbb/Config.in
698
Denys Vlasenkoa3df2fa2017-07-15 20:49:32 +0200699endmenu
700
Mike Frysinger72d59db2006-03-10 23:17:17 +0000701comment "Applets"
702
703source archival/Config.in
704source coreutils/Config.in
705source console-tools/Config.in
706source debianutils/Config.in
Denys Vlasenkoab77e812017-08-18 19:15:29 +0200707source klibc-utils/Config.in
Mike Frysinger72d59db2006-03-10 23:17:17 +0000708source editors/Config.in
709source findutils/Config.in
710source init/Config.in
711source loginutils/Config.in
712source e2fsprogs/Config.in
713source modutils/Config.in
714source util-linux/Config.in
715source miscutils/Config.in
716source networking/Config.in
Bernhard Reutner-Fischeraa2a1c02008-10-24 19:48:47 +0000717source printutils/Config.in
Denis Vlasenkob9d572a2008-11-06 23:41:38 +0000718source mailutils/Config.in
Mike Frysinger72d59db2006-03-10 23:17:17 +0000719source procps/Config.in
Denis Vlasenkofe544582006-10-03 15:57:40 +0000720source runit/Config.in
Denis Vlasenkod46d3c22007-02-06 19:28:50 +0000721source selinux/Config.in
Bernhard Reutner-Fischeraa2a1c02008-10-24 19:48:47 +0000722source shell/Config.in
723source sysklogd/Config.in