freebsd-dev/share/man/man5/src.conf.5

1758 lines
41 KiB
Groff
Raw Normal View History

.\" DO NOT EDIT-- this file is @generated by tools/build/options/makeman.
.\" $FreeBSD$
.Dd December 2, 2021
.Dt SRC.CONF 5
.Os
.Sh NAME
.Nm src.conf
2006-07-31 13:15:04 +00:00
.Nd "source build options"
.Sh DESCRIPTION
The
.Nm
file contains variables that control what components will be generated during
the build process of the
.Fx
source tree; see
.Xr build 7 .
.Pp
The
.Nm
file uses the standard makefile syntax.
However,
.Nm
should not specify any dependencies to
.Xr make 1 .
Instead,
.Nm
is to set
.Xr make 1
variables that control the aspects of how the system builds.
.Pp
The default location of
.Nm
is
.Pa /etc/src.conf ,
though an alternative location can be specified in the
.Xr make 1
variable
.Va SRCCONF .
Overriding the location of
.Nm
may be necessary if the system-wide settings are not suitable
for a particular build.
For instance, setting
.Va SRCCONF
to
.Pa /dev/null
effectively resets all build controls to their defaults.
.Pp
The only purpose of
.Nm
is to control the compilation of the
.Fx
2006-07-31 13:15:04 +00:00
source code, which is usually located in
.Pa /usr/src .
As a rule, the system administrator creates
.Nm
when the values of certain control variables need to be changed
from their defaults.
.Pp
In addition, control variables can be specified
for a particular build via the
.Fl D
option of
.Xr make 1
or in its environment; see
.Xr environ 7 .
.Pp
2015-09-17 20:48:42 +00:00
The environment of
.Xr make 1
for the build can be controlled via the
.Va SRC_ENV_CONF
variable, which defaults to
.Pa /etc/src-env.conf .
Some examples that may only be set in this file are
2015-11-14 04:50:28 +00:00
.Va WITH_DIRDEPS_BUILD ,
2015-09-17 20:48:42 +00:00
and
.Va WITH_META_MODE ,
and
2015-12-15 18:44:28 +00:00
.Va MAKEOBJDIRPREFIX
as they are environment-only variables.
2015-09-17 20:48:42 +00:00
.Pp
2006-07-31 13:15:04 +00:00
The values of variables are ignored regardless of their setting;
even if they would be set to
.Dq Li FALSE
or
2006-07-31 13:15:04 +00:00
.Dq Li NO .
The presence of an option causes
it to be honored by
2006-07-31 13:15:04 +00:00
.Xr make 1 .
.Pp
This list provides a name and short description for variables
that can be used for source builds.
.Bl -tag -width indent
2008-09-23 16:18:15 +00:00
.It Va WITHOUT_ACCT
2021-04-10 02:22:05 +00:00
Do not build process accounting tools such as
2011-06-17 20:49:30 +00:00
.Xr accton 8
2008-09-23 16:18:15 +00:00
and
2011-06-17 20:49:30 +00:00
.Xr sa 8 .
.It Va WITHOUT_ACPI
2021-04-10 02:22:05 +00:00
Do not build
.Xr acpiconf 8 ,
.Xr acpidump 8
and related programs.
2008-09-23 16:18:15 +00:00
.It Va WITHOUT_APM
2021-04-10 02:22:05 +00:00
Do not build
2008-09-23 16:18:15 +00:00
.Xr apm 8 ,
.Xr apmd 8
and related programs.
.It Va WITH_ASAN
Build the base system with Address Sanitizer (ASan) to detect
memory corruption bugs such as buffer overflows or use-after-free.
Requires that Clang be used as the base system compiler
and that the runtime support library is available.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITH_LLVM_BINUTILS
.It
.Va WITH_LLVM_CXXFILT
.El
2006-09-11 13:56:28 +00:00
.It Va WITHOUT_ASSERT_DEBUG
2021-04-10 02:22:05 +00:00
Compile programs and libraries without the
2006-09-11 13:56:28 +00:00
.Xr assert 3
checks.
2008-09-23 16:18:15 +00:00
.It Va WITHOUT_AT
2021-04-10 02:22:05 +00:00
Do not build
2008-09-23 16:18:15 +00:00
.Xr at 1
and related utilities.
.It Va WITHOUT_ATM
2021-04-10 02:22:05 +00:00
Do not build
programs and libraries related to ATM networking.
.It Va WITHOUT_AUDIT
2021-04-10 02:22:05 +00:00
Do not build audit support into system programs.
.It Va WITHOUT_AUTHPF
2021-04-10 02:22:05 +00:00
Do not build
.Xr authpf 8 .
2015-01-26 07:24:18 +00:00
.It Va WITHOUT_AUTOFS
2021-04-10 02:22:05 +00:00
Do not build
.Xr autofs 5
2015-01-26 07:24:18 +00:00
related programs, libraries, and kernel modules.
.It Va WITHOUT_AUTO_OBJ
Disable automatic creation of objdirs.
This is enabled by default if the wanted OBJDIR is writable by the current user.
2015-09-17 20:48:42 +00:00
.Pp
2015-09-17 22:07:40 +00:00
This must be set in the environment, make command line, or
2015-09-17 20:48:42 +00:00
.Pa /etc/src-env.conf ,
not
.Pa /etc/src.conf .
.It Va WITH_BEARSSL
Build the BearSSL library.
.Pp
BearSSL is a tiny SSL library suitable for embedded environments.
For details see
.Lk http://www.BearSSL.org/
.Pp
This library is currently only used to perform
signature verification and related operations
for Verified Exec and
.Xr loader 8 .
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITH_LOADER_EFI_SECUREBOOT
(unless
.Va WITHOUT_LOADER_EFI_SECUREBOOT
is set explicitly)
.It Va WITH_LOADER_VERIEXEC
(unless
.Va WITHOUT_LOADER_VERIEXEC
is set explicitly)
.It Va WITH_LOADER_VERIEXEC_VECTX
(unless
.Va WITHOUT_LOADER_VERIEXEC_VECTX
is set explicitly)
.It Va WITH_VERIEXEC
(unless
.Va WITHOUT_VERIEXEC
is set explicitly)
.El
2015-01-26 07:24:18 +00:00
.It Va WITHOUT_BHYVE
2021-04-10 02:22:05 +00:00
Do not build or install
2015-01-26 07:24:18 +00:00
.Xr bhyve 8 ,
associated utilities, and examples.
.Pp
This option only affects amd64/amd64.
Initial support for bhyve save and restore. Save and restore (also known as suspend and resume) permits a snapshot to be taken of a guest's state that can later be resumed. In the current implementation, bhyve(8) creates a UNIX domain socket that is used by bhyvectl(8) to send a request to save a snapshot (and optionally exit after the snapshot has been taken). A snapshot currently consists of two files: the first holds a copy of guest RAM, and the second file holds other guest state such as vCPU register values and device model state. To resume a guest, bhyve(8) must be started with a matching pair of command line arguments to instantiate the same set of device models as well as a pointer to the saved snapshot. While the current implementation is useful for several uses cases, it has a few limitations. The file format for saving the guest state is tied to the ABI of internal bhyve structures and is not self-describing (in that it does not communicate the set of device models present in the system). In addition, the state saved for some device models closely matches the internal data structures which might prove a challenge for compatibility of snapshot files across a range of bhyve versions. The file format also does not currently support versioning of individual chunks of state. As a result, the current file format is not a fixed binary format and future revisions to save and restore will break binary compatiblity of snapshot files. The goal is to move to a more flexible format that adds versioning, etc. and at that point to commit to providing a reasonable level of compatibility. As a result, the current implementation is not enabled by default. It can be enabled via the WITH_BHYVE_SNAPSHOT=yes option for userland builds, and the kernel option BHYVE_SHAPSHOT. Submitted by: Mihai Tiganus, Flavius Anton, Darius Mihai Submitted by: Elena Mihailescu, Mihai Carabas, Sergiu Weisz Relnotes: yes Sponsored by: University Politehnica of Bucharest Sponsored by: Matthew Grooms (student scholarships) Sponsored by: iXsystems Differential Revision: https://reviews.freebsd.org/D19495
2020-05-05 00:02:04 +00:00
.It Va WITH_BHYVE_SNAPSHOT
2021-04-10 02:22:05 +00:00
Include support for save and restore (snapshots) in
Initial support for bhyve save and restore. Save and restore (also known as suspend and resume) permits a snapshot to be taken of a guest's state that can later be resumed. In the current implementation, bhyve(8) creates a UNIX domain socket that is used by bhyvectl(8) to send a request to save a snapshot (and optionally exit after the snapshot has been taken). A snapshot currently consists of two files: the first holds a copy of guest RAM, and the second file holds other guest state such as vCPU register values and device model state. To resume a guest, bhyve(8) must be started with a matching pair of command line arguments to instantiate the same set of device models as well as a pointer to the saved snapshot. While the current implementation is useful for several uses cases, it has a few limitations. The file format for saving the guest state is tied to the ABI of internal bhyve structures and is not self-describing (in that it does not communicate the set of device models present in the system). In addition, the state saved for some device models closely matches the internal data structures which might prove a challenge for compatibility of snapshot files across a range of bhyve versions. The file format also does not currently support versioning of individual chunks of state. As a result, the current file format is not a fixed binary format and future revisions to save and restore will break binary compatiblity of snapshot files. The goal is to move to a more flexible format that adds versioning, etc. and at that point to commit to providing a reasonable level of compatibility. As a result, the current implementation is not enabled by default. It can be enabled via the WITH_BHYVE_SNAPSHOT=yes option for userland builds, and the kernel option BHYVE_SHAPSHOT. Submitted by: Mihai Tiganus, Flavius Anton, Darius Mihai Submitted by: Elena Mihailescu, Mihai Carabas, Sergiu Weisz Relnotes: yes Sponsored by: University Politehnica of Bucharest Sponsored by: Matthew Grooms (student scholarships) Sponsored by: iXsystems Differential Revision: https://reviews.freebsd.org/D19495
2020-05-05 00:02:04 +00:00
.Xr bhyve 8
and
.Xr bhyvectl 8 .
.Pp
This option only affects amd64/amd64.
2018-11-06 15:57:17 +00:00
.It Va WITH_BIND_NOW
Build all binaries with the
.Dv DF_BIND_NOW
flag set to indicate that the run-time loader should perform all relocation
processing at process startup rather than on demand.
2016-06-08 12:46:54 +00:00
.It Va WITHOUT_BLACKLIST
Set this if you do not want to build
.Xr blacklistd 8
and
.Xr blacklistctl 8 .
2018-06-27 17:18:12 +00:00
When set, these options are also in effect:
2016-06-08 12:46:54 +00:00
.Pp
2018-06-27 17:18:12 +00:00
.Bl -inset -compact
.It Va WITHOUT_BLACKLIST_SUPPORT
(unless
.Va WITH_BLACKLIST_SUPPORT
is set explicitly)
2016-06-08 12:46:54 +00:00
.El
.It Va WITHOUT_BLACKLIST_SUPPORT
2021-04-10 02:22:05 +00:00
Build some programs without
.Xr libblacklist 3
support, like
2016-06-08 12:46:54 +00:00
.Xr fingerd 8 ,
.Xr ftpd 8 ,
and
.Xr sshd 8 .
.It Va WITHOUT_BLUETOOTH
2021-04-10 02:22:05 +00:00
Do not build Bluetooth related kernel modules, programs and libraries.
.It Va WITHOUT_BOOT
2021-04-10 02:22:05 +00:00
Do not build the boot blocks and loader.
2015-02-04 10:29:53 +00:00
.It Va WITHOUT_BOOTPARAMD
2021-04-10 02:22:05 +00:00
Do not build or install
2015-02-04 10:29:53 +00:00
.Xr bootparamd 8 .
.It Va WITHOUT_BOOTPD
2021-04-10 02:22:05 +00:00
Do not build or install
2015-02-04 10:29:53 +00:00
.Xr bootpd 8 .
2015-01-25 04:56:43 +00:00
.It Va WITHOUT_BSDINSTALL
2021-04-10 02:22:05 +00:00
Do not build
2015-01-25 04:56:43 +00:00
.Xr bsdinstall 8 ,
.Xr sade 8 ,
and related programs.
.It Va WITHOUT_BSD_CPIO
2021-04-10 02:22:05 +00:00
Do not build the BSD licensed version of cpio based on
.Xr libarchive 3 .
.It Va WITHOUT_BSNMP
2021-04-10 02:22:05 +00:00
Do not build or install
.Xr bsnmpd 1
and related libraries and data files.
.It Va WITHOUT_BZIP2
2021-04-10 02:22:05 +00:00
Do not build contributed bzip2 software as a part of the base system.
.Bf -symbolic
The option has no effect yet.
.Ef
2018-06-27 17:18:12 +00:00
When set, these options are also in effect:
.Pp
2018-06-27 17:18:12 +00:00
.Bl -inset -compact
.It Va WITHOUT_BZIP2_SUPPORT
(unless
.Va WITH_BZIP2_SUPPORT
is set explicitly)
.El
.It Va WITHOUT_BZIP2_SUPPORT
2021-04-10 02:22:05 +00:00
Build some programs without optional bzip2 support.
.It Va WITHOUT_CALENDAR
2021-04-10 02:22:05 +00:00
Do not build
.Xr calendar 1 .
.It Va WITHOUT_CAPSICUM
2021-04-10 02:22:05 +00:00
Do not build Capsicum support into system programs.
When set, it enforces these options:
2016-12-10 13:30:18 +00:00
.Pp
.Bl -item -compact
.It
.Va WITHOUT_CASPER
.El
.It Va WITHOUT_CAROOT
2021-04-10 02:22:05 +00:00
Do not add the trusted certificates from the Mozilla NSS bundle to
base.
.It Va WITHOUT_CASPER
2021-04-10 02:22:05 +00:00
Do not build Casper program and related libraries.
.It Va WITH_CCACHE_BUILD
2021-04-10 02:22:05 +00:00
Use
.Xr ccache 1
for the build.
No configuration is required except to install the
.Sy devel/ccache
package.
When using with
.Xr distcc 1 ,
set
.Sy CCACHE_PREFIX=/usr/local/bin/distcc .
The default cache directory of
.Pa $HOME/.ccache
will be used, which can be overridden by setting
.Sy CCACHE_DIR .
The
.Sy CCACHE_COMPILERCHECK
option defaults to
.Sy content
when using the in-tree bootstrap compiler,
and
.Sy mtime
when using an external compiler.
The
.Sy CCACHE_CPP2
option is used for Clang but not GCC.
.Pp
Sharing a cache between multiple work directories requires using a layout
similar to
.Pa /some/prefix/src
.Pa /some/prefix/obj
and an environment such as:
.Bd -literal -offset indent
CCACHE_BASEDIR='${SRCTOP:H}' MAKEOBJDIRPREFIX='${SRCTOP:H}/obj'
.Ed
.Pp
See
.Xr ccache 1
for more configuration options.
2015-01-25 04:56:43 +00:00
.It Va WITHOUT_CCD
2021-04-10 02:22:05 +00:00
Do not build
2015-01-25 04:56:43 +00:00
.Xr geom_ccd 4
and related utilities.
.It Va WITHOUT_CDDL
2021-04-10 02:22:05 +00:00
Do not build code licensed under Sun's CDDL.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_CTF
.It
2019-01-31 15:50:11 +00:00
.Va WITHOUT_LOADER_ZFS
.It
.Va WITHOUT_ZFS
.El
.It Va WITHOUT_CLANG
2021-04-10 02:22:05 +00:00
Do not build the Clang C/C++ compiler during the regular phase of the build.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_CLANG_EXTRAS
.It
2020-06-24 17:31:21 +00:00
.Va WITHOUT_CLANG_FORMAT
.It
.Va WITHOUT_CLANG_FULL
.It
.Va WITHOUT_LLVM_COV
.El
.Pp
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITHOUT_LLVM_TARGET_AARCH64
(unless
.Va WITH_LLVM_TARGET_AARCH64
is set explicitly)
.It Va WITHOUT_LLVM_TARGET_ALL
(unless
.Va WITH_LLVM_TARGET_ALL
is set explicitly)
.It Va WITHOUT_LLVM_TARGET_ARM
(unless
.Va WITH_LLVM_TARGET_ARM
is set explicitly)
.It Va WITHOUT_LLVM_TARGET_MIPS
(unless
.Va WITH_LLVM_TARGET_MIPS
is set explicitly)
.It Va WITHOUT_LLVM_TARGET_POWERPC
(unless
.Va WITH_LLVM_TARGET_POWERPC
is set explicitly)
.It Va WITHOUT_LLVM_TARGET_RISCV
(unless
.Va WITH_LLVM_TARGET_RISCV
is set explicitly)
.El
.It Va WITHOUT_CLANG_BOOTSTRAP
2021-04-10 02:22:05 +00:00
Do not build the Clang C/C++ compiler during the bootstrap phase of
the build.
To be able to build the system, either gcc or clang bootstrap must be
enabled unless an alternate compiler is provided via XCC.
.It Va WITH_CLANG_EXTRAS
2021-04-10 02:22:05 +00:00
Build additional clang and llvm tools, such as bugpoint and
2019-02-15 22:28:34 +00:00
clang-format.
2020-06-24 17:31:21 +00:00
.It Va WITH_CLANG_FORMAT
2021-04-10 02:22:05 +00:00
Build clang-format.
.It Va WITHOUT_CLANG_FULL
2021-04-10 02:22:05 +00:00
Avoid building the ARCMigrate, Rewriter and StaticAnalyzer components of
the Clang C/C++ compiler.
.It Va WITHOUT_CLANG_IS_CC
Do not install links to the Clang C/C++ compiler as
.Pa /usr/bin/cc ,
.Pa /usr/bin/c++
and
.Pa /usr/bin/cpp .
.It Va WITHOUT_CLEAN
Do not clean before building world and/or kernel.
.It Va WITHOUT_CPP
2021-04-10 02:22:05 +00:00
Do not build
.Xr cpp 1 .
.It Va WITHOUT_CROSS_COMPILER
2021-04-10 02:22:05 +00:00
Do not build any cross compiler in the cross-tools stage of buildworld.
When compiling a different version of
.Fx
than what is installed on the system, provide an alternate
compiler with XCC to ensure success.
When compiling with an identical version of
.Fx
to the host, this option may be safely used.
This option may also be safe when the host version of
.Fx
is close to the sources being built, but all bets are off if there have
been any changes to the toolchain between the versions.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_CLANG_BOOTSTRAP
.It
2015-09-17 05:07:39 +00:00
.Va WITHOUT_ELFTOOLCHAIN_BOOTSTRAP
.It
.Va WITHOUT_LLD_BOOTSTRAP
.El
.It Va WITHOUT_CRYPT
2021-04-10 02:22:05 +00:00
Do not build any crypto code.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_DMAGENT
.It
.Va WITHOUT_KERBEROS
.It
.Va WITHOUT_KERBEROS_SUPPORT
.It
.Va WITHOUT_LDNS
.It
.Va WITHOUT_LDNS_UTILS
.It
.Va WITHOUT_OPENSSH
.It
.Va WITHOUT_OPENSSL
.It
.Va WITHOUT_OPENSSL_KTLS
.It
.Va WITHOUT_PKGBOOTSTRAP
.It
.Va WITHOUT_UNBOUND
.It
.Va WITHOUT_ZFS
.El
.Pp
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITHOUT_GSSAPI
(unless
.Va WITH_GSSAPI
is set explicitly)
.El
.It Va WITH_CTF
2021-04-10 02:22:05 +00:00
Compile with CTF (Compact C Type Format) data.
CTF data encapsulates a reduced form of debugging information
similar to DWARF and the venerable stabs and is required for DTrace.
2014-08-19 15:46:40 +00:00
.It Va WITHOUT_CUSE
2021-04-10 02:22:05 +00:00
Do not build CUSE-related programs and libraries.
.It Va WITHOUT_CXGBETOOL
2021-04-10 02:22:05 +00:00
Do not build
.Xr cxgbetool 8
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
arm/armv6, arm/armv7, powerpc/powerpc, riscv/riscv64 and riscv/riscv64sf.
.It Va WITH_CXGBETOOL
2021-04-10 02:22:05 +00:00
Build
.Xr cxgbetool 8
.Pp
This is a default setting on
amd64/amd64, arm64/aarch64, i386/i386 and powerpc/powerpc64.
.It Va WITHOUT_CXX
Do not build C++ headers and runtime libraries.
It also prevents building binaries and libraries written in C++, including
.Xr devd 8 .
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_CLANG
.It
.Va WITHOUT_CLANG_EXTRAS
.It
2020-06-24 17:31:21 +00:00
.Va WITHOUT_CLANG_FORMAT
.It
.Va WITHOUT_CLANG_FULL
.It
2016-08-22 17:53:18 +00:00
.Va WITHOUT_DTRACE_TESTS
.It
.Va WITHOUT_GOOGLETEST
.It
.Va WITHOUT_LLVM_COV
.It
.Va WITHOUT_OFED
.It
.Va WITHOUT_OFED_EXTRA
.It
.Va WITHOUT_OPENMP
.It
.Va WITHOUT_PMC
.It
2016-08-22 17:53:18 +00:00
.Va WITHOUT_TESTS
.El
.It Va WITHOUT_DEBUG_FILES
2021-04-10 02:22:05 +00:00
Avoid building or installing standalone debug files for each
executable binary and shared library.
.It Va WITH_DETECT_TZ_CHANGES
Make the time handling code detect changes to the timezone files.
.It Va WITHOUT_DIALOG
2021-04-10 02:22:05 +00:00
Do not build
.Xr dialog 1 ,
.Xr dialog 3 ,
.Xr dpv 1 ,
and
.Xr dpv 3 .
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_BSDINSTALL
.El
.It Va WITHOUT_DICT
2021-04-10 02:22:05 +00:00
Do not build the Webster dictionary files.
2015-11-14 04:50:28 +00:00
.It Va WITH_DIRDEPS_BUILD
2016-04-14 22:10:37 +00:00
This is an experimental build system.
2015-11-14 04:50:28 +00:00
For details see
http://www.crufty.net/sjg/docs/freebsd-meta-mode.htm.
2016-04-14 22:10:37 +00:00
Build commands can be seen from the top-level with:
.Dl make show-valid-targets
2015-11-14 04:50:28 +00:00
The build is driven by dirdeps.mk using
.Va DIRDEPS
stored in
Makefile.depend files found in each directory.
.Pp
The build can be started from anywhere, and behaves the same.
The initial instance of
.Xr make 1
2015-11-14 04:50:28 +00:00
recursively reads
.Va DIRDEPS
from
.Pa Makefile.depend ,
2015-11-14 04:50:28 +00:00
computing a graph of tree dependencies from the current origin.
Setting
.Va NO_DIRDEPS
skips checking dirdep dependencies and will only build in the current
2016-04-12 03:55:33 +00:00
and child directories.
.Va NO_DIRDEPS_BELOW
skips building any dirdeps and only build the current directory.
2015-11-14 04:50:28 +00:00
.Pp
2016-04-14 22:10:37 +00:00
This also utilizes the
.Va WITH_META_MODE
logic for incremental builds.
2015-11-14 04:50:28 +00:00
.Pp
The build hides commands executed unless
2015-11-14 04:50:28 +00:00
.Va NO_SILENT
is defined.
.Pp
2016-04-14 22:10:37 +00:00
Note that there is currently no mass install feature for this.
.Pp
When set, it enforces these options:
2015-11-14 04:50:28 +00:00
.Pp
.Bl -item -compact
.It
.Va WITH_INSTALL_AS_USER
.El
.Pp
When set, these options are also in effect:
2015-11-14 04:50:28 +00:00
.Pp
.Bl -inset -compact
.It Va WITH_META_MODE
(unless
.Va WITHOUT_META_MODE
is set explicitly)
2015-11-14 04:50:28 +00:00
.It Va WITH_STAGING
(unless
.Va WITHOUT_STAGING
is set explicitly)
.It Va WITH_STAGING_MAN
(unless
.Va WITHOUT_STAGING_MAN
is set explicitly)
.It Va WITH_STAGING_PROG
(unless
.Va WITHOUT_STAGING_PROG
is set explicitly)
.It Va WITH_SYSROOT
(unless
.Va WITHOUT_SYSROOT
is set explicitly)
.El
.Pp
This must be set in the environment, make command line, or
.Pa /etc/src-env.conf ,
not
.Pa /etc/src.conf .
.It Va WITH_DIRDEPS_CACHE
Cache result of dirdeps.mk which can save significant time
for subsequent builds.
Depends on
2015-11-14 04:50:28 +00:00
.Va WITH_DIRDEPS_BUILD .
2015-09-17 20:48:42 +00:00
.Pp
2015-09-17 22:07:40 +00:00
This must be set in the environment, make command line, or
2015-09-17 20:48:42 +00:00
.Pa /etc/src-env.conf ,
not
.Pa /etc/src.conf .
.It Va WITHOUT_DMAGENT
2021-04-10 02:22:05 +00:00
Do not build dma Mail Transport Agent.
.It Va WITHOUT_DOCCOMPRESS
2021-04-10 02:22:05 +00:00
Do not install compressed system documentation.
Only the uncompressed version will be installed.
2015-08-02 00:56:16 +00:00
.It Va WITH_DTRACE_TESTS
2021-04-10 02:22:05 +00:00
Build and install the DTrace test suite in
2015-08-02 00:56:16 +00:00
.Pa /usr/tests/cddl/usr.sbin/dtrace .
This test suite is considered experimental on architectures other than
amd64/amd64 and running it may cause system instability.
.It Va WITHOUT_DYNAMICROOT
Set this if you do not want to link
.Pa /bin
and
.Pa /sbin
dynamically.
2015-01-25 04:56:43 +00:00
.It Va WITHOUT_EE
2021-04-10 02:22:05 +00:00
Do not build and install
2015-01-25 04:56:43 +00:00
.Xr edit 1 ,
.Xr ee 1 ,
and related programs.
.It Va WITHOUT_EFI
Set not to build
.Xr efivar 3
and
.Xr efivar 8 .
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
powerpc/powerpc and powerpc/powerpc64.
.It Va WITH_EFI
2021-04-10 02:22:05 +00:00
Build
.Xr efivar 3
and
.Xr efivar 8 .
.Pp
This is a default setting on
amd64/amd64, arm/armv6, arm/armv7, arm64/aarch64, i386/i386, riscv/riscv64 and riscv/riscv64sf.
2016-02-24 19:19:25 +00:00
.It Va WITHOUT_ELFTOOLCHAIN_BOOTSTRAP
2021-04-10 02:22:05 +00:00
Do not build ELF Tool Chain tools
2016-02-24 19:19:25 +00:00
(addr2line, nm, size, strings and strip)
as part of the bootstrap process.
.Bf -symbolic
An alternate bootstrap tool chain must be provided.
.Ef
.It Va WITHOUT_EXAMPLES
2021-04-10 02:22:05 +00:00
Avoid installing examples to
.Pa /usr/share/examples/ .
.It Va WITH_EXPERIMENTAL
2021-04-10 02:22:05 +00:00
Include experimental features in the build.
.It Va WITH_EXTRA_TCP_STACKS
2021-04-10 02:22:05 +00:00
Build extra TCP stack modules.
.It Va WITHOUT_FDT
2021-04-10 02:22:05 +00:00
Do not build Flattened Device Tree support as part of the base system.
This includes the device tree compiler (dtc) and libfdt support library.
2015-02-04 10:29:53 +00:00
.It Va WITHOUT_FILE
2021-04-10 02:22:05 +00:00
Do not build
2015-02-04 10:29:53 +00:00
.Xr file 1
and related programs.
.It Va WITHOUT_FINGER
2021-04-10 02:22:05 +00:00
Do not build or install
2015-02-04 10:29:53 +00:00
.Xr finger 1
and
.Xr fingerd 8 .
.It Va WITHOUT_FLOPPY
2021-04-10 02:22:05 +00:00
Do not build or install programs
for operating floppy disk driver.
2014-10-21 20:41:19 +00:00
.It Va WITHOUT_FORMAT_EXTENSIONS
2021-04-10 02:22:05 +00:00
Do not enable
2014-10-21 20:41:19 +00:00
.Fl fformat-extensions
when compiling the kernel.
Also disables all format checking.
.It Va WITHOUT_FORTH
2021-04-10 02:22:05 +00:00
Build bootloaders without Forth support.
.It Va WITHOUT_FP_LIBC
2021-04-10 02:22:05 +00:00
Build
.Nm libc
without floating-point support.
.It Va WITHOUT_FREEBSD_UPDATE
2021-04-10 02:22:05 +00:00
Do not build
.Xr freebsd-update 8 .
2015-02-04 10:29:53 +00:00
.It Va WITHOUT_FTP
2021-04-10 02:22:05 +00:00
Do not build or install
2015-02-04 10:29:53 +00:00
.Xr ftp 1
and
.Xr ftpd 8 .
.It Va WITHOUT_GAMES
2021-04-10 02:22:05 +00:00
Do not build games.
2020-09-15 16:38:44 +00:00
.It Va WITHOUT_GH_BC
2021-04-10 02:22:05 +00:00
Install the traditional FreeBSD
.Xr bc 1
2020-09-15 16:38:44 +00:00
and
.Xr dc 1
2021-04-10 02:22:05 +00:00
programs instead of the enhanced versions.
.It Va WITHOUT_GNU_DIFF
2021-04-10 02:22:05 +00:00
Do not build GNU
.Xr diff3 1 .
.It Va WITHOUT_GOOGLETEST
2021-04-10 02:22:05 +00:00
Neither build nor install
.Lb libgmock ,
.Lb libgtest ,
and dependent tests.
.It Va WITHOUT_GPIO
2021-04-10 02:22:05 +00:00
Do not build
.Xr gpioctl 8
as part of the base system.
.It Va WITHOUT_GSSAPI
2021-04-10 02:22:05 +00:00
Do not build libgssapi.
2015-01-26 07:24:18 +00:00
.It Va WITHOUT_HAST
2021-04-10 02:22:05 +00:00
Do not build
2015-01-26 07:24:18 +00:00
.Xr hastd 8
and related utilities.
.It Va WITH_HESIOD
2021-04-10 02:22:05 +00:00
Build Hesiod support.
.It Va WITHOUT_HTML
2021-04-10 02:22:05 +00:00
Do not build HTML docs.
2014-09-13 02:18:54 +00:00
.It Va WITHOUT_HYPERV
2021-04-10 02:22:05 +00:00
Do not build or install HyperV utilities.
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
arm/armv6, arm/armv7, arm64/aarch64, powerpc/powerpc, powerpc/powerpc64, riscv/riscv64 and riscv/riscv64sf.
.It Va WITH_HYPERV
2021-04-10 02:22:05 +00:00
Build or install HyperV utilities.
.Pp
This is a default setting on
amd64/amd64 and i386/i386.
.It Va WITHOUT_ICONV
2021-04-10 02:22:05 +00:00
Do not build iconv as part of libc.
.It Va WITHOUT_INCLUDES
2021-04-10 02:22:05 +00:00
Do not install header files.
This option used to be spelled
.Va NO_INCS .
.Bf -symbolic
The option does not work for build targets.
.Ef
.It Va WITHOUT_INET
2021-04-10 02:22:05 +00:00
Do not build programs and libraries related to IPv4 networking.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_INET_SUPPORT
.El
.It Va WITHOUT_INET6
2021-04-10 02:22:05 +00:00
Do not build
programs and libraries related to IPv6 networking.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_INET6_SUPPORT
.El
.It Va WITHOUT_INET6_SUPPORT
2021-04-10 02:22:05 +00:00
Build libraries, programs, and kernel modules without IPv6 support.
2015-02-04 10:29:53 +00:00
.It Va WITHOUT_INETD
2021-04-10 02:22:05 +00:00
Do not build
2015-02-04 10:29:53 +00:00
.Xr inetd 8 .
.It Va WITHOUT_INET_SUPPORT
2021-04-10 02:22:05 +00:00
Build libraries, programs, and kernel modules without IPv4 support.
.It Va WITH_INIT_ALL_PATTERN
2021-04-10 02:22:05 +00:00
Build the base system or kernel with stack variables initialized to
.Pq compiler defined
debugging patterns on function entry.
This option requires the clang compiler.
.It Va WITH_INIT_ALL_ZERO
2021-04-10 02:22:05 +00:00
Build the base system or kernel with stack variables initialized
to zero on function entry.
This option requires that the clang compiler be used.
.It Va WITHOUT_INSTALLLIB
Set this to not install optional libraries.
For example, when creating a
.Xr nanobsd 8
image.
2016-04-14 01:20:00 +00:00
.Bf -symbolic
The option does not work for build targets.
.Ef
.It Va WITH_INSTALL_AS_USER
2021-04-10 02:22:05 +00:00
Make install targets succeed for non-root users by installing
files with owner and group attributes set to that of the user running
the
.Xr make 1
command.
The user still must set the
.Va DESTDIR
variable to point to a directory where the user has write permissions.
.It Va WITHOUT_IPFILTER
2021-04-10 02:22:05 +00:00
Do not build IP Filter package.
.It Va WITHOUT_IPFW
2021-04-10 02:22:05 +00:00
Do not build IPFW tools.
.It Va WITHOUT_IPSEC_SUPPORT
2021-04-10 02:22:05 +00:00
Do not build the kernel with
.Xr ipsec 4
support.
This option is needed for
.Xr ipsec 4
and
.Xr tcpmd5 4 .
2015-01-25 04:56:43 +00:00
.It Va WITHOUT_ISCSI
2021-04-10 02:22:05 +00:00
Do not build
2018-05-13 23:04:35 +00:00
.Xr iscsid 8
2015-01-25 04:56:43 +00:00
and related utilities.
.It Va WITHOUT_JAIL
2021-04-10 02:22:05 +00:00
Do not build tools for the support of jails; e.g.,
.Xr jail 8 .
.It Va WITHOUT_KDUMP
2021-04-10 02:22:05 +00:00
Do not build
.Xr kdump 1
and
.Xr truss 1 .
.It Va WITHOUT_KERBEROS
Set this to not build Kerberos 5 (KTH Heimdal).
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITHOUT_GSSAPI
(unless
.Va WITH_GSSAPI
is set explicitly)
2018-06-27 17:18:12 +00:00
.It Va WITHOUT_KERBEROS_SUPPORT
(unless
.Va WITH_KERBEROS_SUPPORT
is set explicitly)
.El
.It Va WITHOUT_KERBEROS_SUPPORT
2021-04-10 02:22:05 +00:00
Build some programs without Kerberos support, like
.Xr ssh 1 ,
.Xr telnet 1 ,
.Xr sshd 8 ,
and
.Xr telnetd 8 .
.It Va WITH_KERNEL_RETPOLINE
2021-04-10 02:22:05 +00:00
Enable the "retpoline" mitigation for CVE-2017-5715 in the kernel
build.
2014-10-21 20:41:19 +00:00
.It Va WITHOUT_KERNEL_SYMBOLS
2021-07-27 21:28:32 +00:00
Do not install kernel debug symbol files.
.It Va WITHOUT_KVM
2021-04-10 02:22:05 +00:00
Do not build the
.Nm libkvm
library as a part of the base system.
.Bf -symbolic
The option has no effect yet.
.Ef
2018-06-27 17:18:12 +00:00
When set, these options are also in effect:
.Pp
2018-06-27 17:18:12 +00:00
.Bl -inset -compact
.It Va WITHOUT_KVM_SUPPORT
(unless
.Va WITH_KVM_SUPPORT
is set explicitly)
.El
.It Va WITHOUT_KVM_SUPPORT
2021-04-10 02:22:05 +00:00
Build some programs without optional
.Nm libkvm
support.
.It Va WITHOUT_LDNS
Setting this variable will prevent the LDNS library from being built.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_LDNS_UTILS
.It
.Va WITHOUT_UNBOUND
.El
.It Va WITHOUT_LDNS_UTILS
Setting this variable will prevent building the LDNS utilities
.Xr drill 1
and
.Xr host 1 .
.It Va WITHOUT_LEGACY_CONSOLE
2021-04-10 02:22:05 +00:00
Do not build programs that support a legacy PC console; e.g.,
.Xr kbdcontrol 1
and
.Xr vidcontrol 1 .
.It Va WITHOUT_LIB32
2021-04-10 02:22:05 +00:00
On 64-bit platforms, do not build 32-bit library set and a
.Nm ld-elf32.so.1
runtime linker.
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
arm/armv6, arm/armv7, arm64/aarch64, i386/i386, powerpc/powerpc, riscv/riscv64 and riscv/riscv64sf.
2016-05-20 19:25:57 +00:00
.It Va WITH_LIBSOFT
2021-04-10 02:22:05 +00:00
On armv6 only, enable soft float ABI compatibility libraries.
2016-05-20 19:25:57 +00:00
This option is for transitioning to the new hard float ABI.
.It Va WITHOUT_LLD
2021-04-10 02:22:05 +00:00
Do not build LLVM's lld linker.
2016-01-09 00:47:01 +00:00
.It Va WITHOUT_LLDB
2021-04-10 02:22:05 +00:00
Do not build the LLDB debugger.
2016-01-09 00:47:01 +00:00
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
arm/armv6, arm/armv7, powerpc/powerpc, powerpc/powerpc64, riscv/riscv64 and riscv/riscv64sf.
.It Va WITH_LLDB
2021-04-10 02:22:05 +00:00
Build the LLDB debugger.
2016-01-09 00:47:01 +00:00
.Pp
This is a default setting on
amd64/amd64, arm64/aarch64 and i386/i386.
.It Va WITHOUT_LLD_BOOTSTRAP
2021-04-10 02:22:05 +00:00
Do not build the LLD linker during the bootstrap phase of
the build.
To be able to build the system an alternate linker must be provided via XLD.
2017-01-28 02:25:33 +00:00
.It Va WITHOUT_LLD_IS_LD
Do not install a
.Pa /usr/bin/ld symlink
to
.Pa ld.lld .
The system will not have a usable tool chain unless a linker is provided
some other way.
.It Va WITHOUT_LLVM_ASSERTIONS
2021-04-10 02:22:05 +00:00
Disable debugging assertions in LLVM.
.It Va WITH_LLVM_BINUTILS
Install LLVM's binutils (ar, addr2line, nm, etc.) instead of ELF Tool Chain's.
.It Va WITHOUT_LLVM_COV
2021-04-10 02:22:05 +00:00
Do not build the
.Xr llvm-cov 1
tool.
.It Va WITHOUT_LLVM_CXXFILT
Install ELF Tool Chain's cxxfilt as c++filt, instead of LLVM's llvm-cxxfilt.
.It Va WITHOUT_LLVM_TARGET_AARCH64
2021-04-10 02:22:05 +00:00
Do not build LLVM target support for AArch64.
2018-06-27 17:18:12 +00:00
The
.Va LLVM_TARGET_ALL
option should be used rather than this in most cases.
.It Va WITHOUT_LLVM_TARGET_ALL
2021-04-10 02:22:05 +00:00
Only build the required LLVM target support.
2018-06-27 17:18:12 +00:00
This option is preferred to specific target support options.
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITHOUT_LLVM_TARGET_AARCH64
(unless
.Va WITH_LLVM_TARGET_AARCH64
is set explicitly)
.It Va WITHOUT_LLVM_TARGET_ARM
(unless
.Va WITH_LLVM_TARGET_ARM
is set explicitly)
.It Va WITHOUT_LLVM_TARGET_MIPS
(unless
.Va WITH_LLVM_TARGET_MIPS
is set explicitly)
.It Va WITHOUT_LLVM_TARGET_POWERPC
(unless
.Va WITH_LLVM_TARGET_POWERPC
is set explicitly)
.It Va WITHOUT_LLVM_TARGET_RISCV
(unless
.Va WITH_LLVM_TARGET_RISCV
is set explicitly)
2018-06-27 17:18:12 +00:00
.El
.It Va WITHOUT_LLVM_TARGET_ARM
2021-04-10 02:22:05 +00:00
Do not build LLVM target support for ARM.
2018-06-27 17:18:12 +00:00
The
.Va LLVM_TARGET_ALL
option should be used rather than this in most cases.
.It Va WITH_LLVM_TARGET_BPF
2021-04-10 02:22:05 +00:00
Build LLVM target support for BPF.
The
.Va LLVM_TARGET_ALL
option should be used rather than this in most cases.
.It Va WITHOUT_LLVM_TARGET_MIPS
2021-04-10 02:22:05 +00:00
Do not build LLVM target support for MIPS.
2018-06-27 17:18:12 +00:00
The
.Va LLVM_TARGET_ALL
option should be used rather than this in most cases.
.It Va WITHOUT_LLVM_TARGET_POWERPC
2021-04-10 02:22:05 +00:00
Do not build LLVM target support for PowerPC.
2018-06-27 17:18:12 +00:00
The
.Va LLVM_TARGET_ALL
option should be used rather than this in most cases.
.It Va WITHOUT_LLVM_TARGET_RISCV
2021-04-10 02:22:05 +00:00
Do not build LLVM target support for RISC-V.
The
.Va LLVM_TARGET_ALL
option should be used rather than this in most cases.
.It Va WITHOUT_LLVM_TARGET_X86
2021-04-10 02:22:05 +00:00
Do not build LLVM target support for X86.
2018-06-27 17:18:12 +00:00
The
.Va LLVM_TARGET_ALL
option should be used rather than this in most cases.
.It Va WITH_LOADER_EFI_SECUREBOOT
Enable building
.Xr loader 8
with support for verification based on certificates obtained from UEFI.
.Pp
.It Va WITH_LOADER_FIREWIRE
Enable firewire support in /boot/loader on x86.
This option is a nop on all other platforms.
.It Va WITHOUT_LOADER_GELI
Disable inclusion of GELI crypto support in the boot chain binaries.
.Pp
This is a default setting on
powerpc/powerpc and powerpc/powerpc64.
.It Va WITH_LOADER_GELI
2021-04-10 02:22:05 +00:00
Build GELI bootloader support.
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
amd64/amd64, arm/armv6, arm/armv7, arm64/aarch64, i386/i386, riscv/riscv64 and riscv/riscv64sf.
.It Va WITHOUT_LOADER_LUA
2021-04-10 02:22:05 +00:00
Do not build LUA bindings for the boot loader.
.Pp
This is a default setting on
powerpc/powerpc and powerpc/powerpc64.
.It Va WITH_LOADER_LUA
2021-04-10 02:22:05 +00:00
Build LUA bindings for the boot loader.
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
amd64/amd64, arm/armv6, arm/armv7, arm64/aarch64, i386/i386, riscv/riscv64 and riscv/riscv64sf.
2018-03-01 22:04:51 +00:00
.It Va WITHOUT_LOADER_OFW
Disable building of openfirmware bootloader components.
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
amd64/amd64, arm/armv6, arm/armv7, arm64/aarch64, i386/i386, riscv/riscv64 and riscv/riscv64sf.
2018-03-01 22:04:51 +00:00
.It Va WITH_LOADER_OFW
2021-04-10 02:22:05 +00:00
Build openfirmware bootloader components.
2018-03-01 22:04:51 +00:00
.Pp
This is a default setting on
powerpc/powerpc and powerpc/powerpc64.
2018-03-01 22:04:51 +00:00
.It Va WITHOUT_LOADER_UBOOT
Disable building of ubldr.
.Pp
This is a default setting on
amd64/amd64, arm64/aarch64, i386/i386, riscv/riscv64 and riscv/riscv64sf.
2018-03-01 22:04:51 +00:00
.It Va WITH_LOADER_UBOOT
2021-04-10 02:22:05 +00:00
Build ubldr.
2018-03-01 22:04:51 +00:00
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
arm/armv6, arm/armv7, powerpc/powerpc and powerpc/powerpc64.
2019-01-31 15:50:11 +00:00
.It Va WITH_LOADER_VERBOSE
2021-04-10 02:22:05 +00:00
Build with extra verbose debugging in the loader.
2019-01-31 15:50:11 +00:00
May explode already nearly too large loader over the limit.
Use with care.
.It Va WITH_LOADER_VERIEXEC
Enable building
.Xr loader 8
with support for verification similar to Verified Exec.
.Pp
Depends on
.Va WITH_BEARSSL .
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITH_LOADER_EFI_SECUREBOOT
(unless
.Va WITHOUT_LOADER_EFI_SECUREBOOT
is set explicitly)
.It Va WITH_LOADER_VERIEXEC_VECTX
(unless
.Va WITHOUT_LOADER_VERIEXEC_VECTX
is set explicitly)
.El
.It Va WITH_LOADER_VERIEXEC_PASS_MANIFEST
Enable building
.Xr loader 8
with support to pass a verified manifest to the kernel.
The kernel has to be built with a module to parse the manifest.
.Pp
Depends on
.Va WITH_LOADER_VERIEXEC .
2019-01-31 15:50:11 +00:00
.It Va WITHOUT_LOADER_ZFS
2021-04-10 02:22:05 +00:00
Do not build ZFS file system boot loader support.
.It Va WITHOUT_LOCALES
2021-04-10 02:22:05 +00:00
Do not build localization files; see
.Xr locale 1 .
.It Va WITHOUT_LOCATE
2021-04-10 02:22:05 +00:00
Do not build
.Xr locate 1
and related programs.
.It Va WITHOUT_LPR
2021-04-10 02:22:05 +00:00
Do not build
.Xr lpr 1
and related programs.
.It Va WITHOUT_LS_COLORS
2021-04-10 02:22:05 +00:00
Build
.Xr ls 1
without support for colors to distinguish file types.
.It Va WITHOUT_MAIL
2021-04-10 02:22:05 +00:00
Do not build any mail support (MUA or MTA).
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_DMAGENT
.It
.Va WITHOUT_MAILWRAPPER
.It
.Va WITHOUT_SENDMAIL
.El
.It Va WITHOUT_MAILWRAPPER
2021-04-10 02:22:05 +00:00
Do not build the
.Xr mailwrapper 8
MTA selector.
.It Va WITHOUT_MAKE
2021-04-10 02:22:05 +00:00
Do not install
.Xr make 1
and related support files.
.It Va WITHOUT_MAKE_CHECK_USE_SANDBOX
2021-04-10 02:22:05 +00:00
Do not execute
.Dq Li "make check"
in limited sandbox mode.
This option should be paired with
.Va WITH_INSTALL_AS_USER
if executed as an unprivileged user.
See
.Xr tests 7
for more details.
.It Va WITH_MALLOC_PRODUCTION
2021-04-10 02:22:05 +00:00
Disable assertions and statistics gathering in
.Xr malloc 3 .
It also defaults the A and J runtime options to off.
.It Va WITHOUT_MAN
2021-04-10 02:22:05 +00:00
Do not build manual pages.
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITHOUT_MAN_UTILS
(unless
.Va WITH_MAN_UTILS
is set explicitly)
.El
.It Va WITHOUT_MANCOMPRESS
2021-04-10 02:22:05 +00:00
Do not install compressed man pages.
Only the uncompressed versions will be installed.
.It Va WITH_MANSPLITPKG
2021-04-10 02:22:05 +00:00
Split man pages into their own packages during make package.
.It Va WITHOUT_MAN_UTILS
2021-04-10 02:22:05 +00:00
Do not build utilities for manual pages,
.Xr apropos 1 ,
.Xr makewhatis 1 ,
.Xr man 1 ,
.Xr whatis 1 ,
.Xr manctl 8 ,
and related support files.
.It Va WITH_META_MODE
Create
2016-04-14 22:10:37 +00:00
.Xr make 1
meta files when building, which can provide a reliable incremental build when
using
.Xr filemon 4 .
The meta file is created in OBJDIR as
2016-04-14 22:10:37 +00:00
.Pa target.meta .
These meta files track the command that was executed, its output, and the
current directory.
The
2016-04-12 03:55:33 +00:00
.Xr filemon 4
module is required unless
.Va NO_FILEMON
is defined.
When the module is loaded, any files used by the commands executed are
tracked as dependencies for the target in its meta file.
The target is considered out-of-date and rebuilt if any of these
conditions are true compared to the last build:
2016-04-14 22:10:37 +00:00
.Bl -bullet -compact
.It
The command to execute changes.
.It
The current working directory changes.
.It
2016-06-05 23:10:05 +00:00
The target's meta file is missing.
.It
The target's meta file is missing filemon data when filemon is loaded
and a previous run did not have it loaded.
2016-04-14 22:10:37 +00:00
.It
[requires
.Xr filemon 4 ]
Files read, executed or linked to are newer than the target.
.It
[requires
.Xr filemon 4 ]
Files read, written, executed or linked are missing.
.El
2016-04-12 03:55:33 +00:00
The meta files can also be useful for debugging.
.Pp
The build hides commands that are executed unless
2016-04-12 03:55:33 +00:00
.Va NO_SILENT
is defined.
Errors cause
.Xr make 1
to show some of its environment for further debugging.
2015-09-17 20:48:42 +00:00
.Pp
2016-04-14 22:10:37 +00:00
The build operates as it normally would otherwise.
This option originally invoked a different build system but that was renamed
to
.Va WITH_DIRDEPS_BUILD .
.Pp
2015-09-17 22:07:40 +00:00
This must be set in the environment, make command line, or
2015-09-17 20:48:42 +00:00
.Pa /etc/src-env.conf ,
not
.Pa /etc/src.conf .
2018-05-04 03:17:44 +00:00
.It Va WITHOUT_MLX5TOOL
2021-04-10 02:22:05 +00:00
Do not build
2018-05-04 03:17:44 +00:00
.Xr mlx5tool 8
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
arm/armv6, arm/armv7, powerpc/powerpc, riscv/riscv64 and riscv/riscv64sf.
2018-05-04 03:17:44 +00:00
.It Va WITH_MLX5TOOL
2021-04-10 02:22:05 +00:00
Build
2018-05-04 03:17:44 +00:00
.Xr mlx5tool 8
.Pp
This is a default setting on
amd64/amd64, arm64/aarch64, i386/i386 and powerpc/powerpc64.
.It Va WITHOUT_NETCAT
2021-04-10 02:22:05 +00:00
Do not build
.Xr nc 1
utility.
.It Va WITHOUT_NETGRAPH
2021-04-10 02:22:05 +00:00
Do not build applications to support
.Xr netgraph 4 .
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_ATM
.It
.Va WITHOUT_BLUETOOTH
2018-06-27 17:18:12 +00:00
.El
.Pp
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITHOUT_NETGRAPH_SUPPORT
(unless
.Va WITH_NETGRAPH_SUPPORT
is set explicitly)
.El
.It Va WITHOUT_NETGRAPH_SUPPORT
2021-04-10 02:22:05 +00:00
Build libraries, programs, and kernel modules without netgraph support.
.It Va WITHOUT_NIS
2021-04-10 02:22:05 +00:00
Do not build
.Xr NIS 8
support and related programs.
If set, you might need to adopt your
.Xr nsswitch.conf 5
and remove
.Sq nis
entries.
.It Va WITHOUT_NLS
2021-04-10 02:22:05 +00:00
Do not build NLS catalogs.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_NLS_CATALOGS
.El
.It Va WITHOUT_NLS_CATALOGS
2021-04-10 02:22:05 +00:00
Do not build NLS catalog support for
.Xr csh 1 .
.It Va WITHOUT_NS_CACHING
2021-04-10 02:22:05 +00:00
Disable name caching in the
.Pa nsswitch
subsystem.
The generic caching daemon,
.Xr nscd 8 ,
will not be built either if this option is set.
.It Va WITHOUT_NTP
2021-04-10 02:22:05 +00:00
Do not build
.Xr ntpd 8
and related programs.
.It Va WITHOUT_NVME
2021-04-10 02:22:05 +00:00
Do not build nvme related tools and kernel modules.
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
arm/armv6, arm/armv7, powerpc/powerpc, riscv/riscv64 and riscv/riscv64sf.
.It Va WITH_NVME
2021-04-10 02:22:05 +00:00
Build nvme related tools and kernel modules.
.Pp
This is a default setting on
amd64/amd64, arm64/aarch64, i386/i386 and powerpc/powerpc64.
2021-02-02 16:48:08 +00:00
.It Va WITHOUT_OFED
2021-04-10 02:22:05 +00:00
Disable the build of the
.Dq "OpenFabrics Enterprise Distribution"
2021-02-02 16:48:08 +00:00
Infiniband software stack, including kernel modules and userspace libraries.
.Pp
This is a default setting on
riscv/riscv64 and riscv/riscv64sf.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_OFED_EXTRA
.El
.It Va WITH_OFED_EXTRA
2021-04-10 02:22:05 +00:00
Build the non-essential components of the
.Dq "OpenFabrics Enterprise Distribution"
Infiniband software stack, mostly examples.
.It Va WITH_OPENLDAP
Enable building LDAP support for kerberos using an openldap client from ports.
.It Va WITHOUT_OPENMP
2021-04-10 02:22:05 +00:00
Do not build LLVM's OpenMP runtime.
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
arm/armv6, arm/armv7 and powerpc/powerpc.
.It Va WITH_OPENMP
2021-04-10 02:22:05 +00:00
Build LLVM's OpenMP runtime.
.Pp
This is a default setting on
amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64, riscv/riscv64 and riscv/riscv64sf.
.It Va WITHOUT_OPENSSH
2021-04-10 02:22:05 +00:00
Do not build OpenSSH.
.It Va WITHOUT_OPENSSL
2021-04-10 02:22:05 +00:00
Do not build OpenSSL.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_DMAGENT
.It
.Va WITHOUT_KERBEROS
.It
.Va WITHOUT_KERBEROS_SUPPORT
.It
.Va WITHOUT_LDNS
.It
.Va WITHOUT_LDNS_UTILS
.It
.Va WITHOUT_OPENSSH
.It
.Va WITHOUT_OPENSSL_KTLS
.It
.Va WITHOUT_PKGBOOTSTRAP
.It
.Va WITHOUT_UNBOUND
.It
.Va WITHOUT_ZFS
.El
.Pp
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITHOUT_GSSAPI
(unless
.Va WITH_GSSAPI
is set explicitly)
.El
.It Va WITHOUT_OPENSSL_KTLS
2021-04-10 02:22:05 +00:00
Do not include kernel TLS support in OpenSSL.
.Pp
This is a default setting on
2021-11-26 19:22:48 +00:00
arm/armv6, arm/armv7, i386/i386, powerpc/powerpc, powerpc/powerpc64, riscv/riscv64 and riscv/riscv64sf.
.It Va WITH_OPENSSL_KTLS
2021-04-10 02:22:05 +00:00
Include kernel TLS support in OpenSSL.
.Pp
This is a default setting on
amd64/amd64 and arm64/aarch64.
.It Va WITHOUT_PAM
2021-04-10 02:22:05 +00:00
Do not build PAM library and modules.
.Bf -symbolic
This option is deprecated and does nothing.
.Ef
2018-06-27 17:18:12 +00:00
When set, these options are also in effect:
.Pp
2018-06-27 17:18:12 +00:00
.Bl -inset -compact
.It Va WITHOUT_PAM_SUPPORT
(unless
.Va WITH_PAM_SUPPORT
is set explicitly)
.El
.It Va WITHOUT_PAM_SUPPORT
2021-04-10 02:22:05 +00:00
Build some programs without PAM support, particularly
.Xr ftpd 8
and
.Xr ppp 8 .
.It Va WITHOUT_PF
2021-04-10 02:22:05 +00:00
Do not build PF firewall package.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_AUTHPF
.El
.It Va WITHOUT_PIE
Do not build dynamically linked binaries as
2019-02-15 22:28:34 +00:00
Position-Independent Executable (PIE).
.It Va WITHOUT_PKGBOOTSTRAP
2021-04-10 02:22:05 +00:00
Do not build
.Xr pkg 7
bootstrap tool.
.It Va WITHOUT_PMC
2021-04-10 02:22:05 +00:00
Do not build
.Xr pmccontrol 8
and related programs.
.It Va WITHOUT_PORTSNAP
2021-04-10 02:22:05 +00:00
Do not build or install
.Xr portsnap 8
and related files.
.It Va WITHOUT_PPP
2021-04-10 02:22:05 +00:00
Do not build
.Xr ppp 8
and related programs.
.It Va WITH_PROFILE
2021-04-10 02:22:05 +00:00
Build profiled libraries for use with
.Xr gprof 8 .
This option is deprecated and is not present in
.Fx 14 .
.It Va WITHOUT_QUOTAS
2021-04-10 02:22:05 +00:00
Do not build
.Xr quota 1
and related programs.
2015-02-04 10:29:53 +00:00
.It Va WITHOUT_RADIUS_SUPPORT
2021-04-10 02:22:05 +00:00
Do not build radius support into various applications, like
2015-02-04 10:29:53 +00:00
.Xr pam_radius 8
and
.Xr ppp 8 .
.It Va WITH_RATELIMIT
2021-04-10 02:22:05 +00:00
Build the system with rate limit support.
.Pp
This makes
.Dv SO_MAX_PACING_RATE
effective in
.Xr getsockopt 2 ,
and
.Ar txrlimit
support in
.Xr ifconfig 8 ,
by proxy.
2015-02-04 10:29:53 +00:00
.It Va WITHOUT_RBOOTD
2021-04-10 02:22:05 +00:00
Do not build or install
2015-02-04 10:29:53 +00:00
.Xr rbootd 8 .
.It Va WITH_REPRODUCIBLE_BUILD
2021-04-10 02:22:05 +00:00
Exclude build metadata (such as the build time, user, or host)
from the kernel, boot loaders, and uname output, so that builds produce
bit-for-bit identical output.
.It Va WITHOUT_RESCUE
2021-04-10 02:22:05 +00:00
Do not build
.Xr rescue 8 .
.It Va WITH_RETPOLINE
2021-04-10 02:22:05 +00:00
Build the base system with the retpoline speculative execution
vulnerability mitigation for CVE-2017-5715.
.It Va WITHOUT_ROUTED
2021-04-10 02:22:05 +00:00
Do not build
.Xr routed 8
utility.
.It Va WITH_RPCBIND_WARMSTART_SUPPORT
2021-04-10 02:22:05 +00:00
Build
.Xr rpcbind 8
with warmstart support.
.It Va WITHOUT_SENDMAIL
2021-04-10 02:22:05 +00:00
Do not build
.Xr sendmail 8
and related programs.
.It Va WITHOUT_SERVICESDB
2021-04-10 02:22:05 +00:00
Do not install
.Pa /var/db/services.db .
.It Va WITHOUT_SETUID_LOGIN
Set this to disable the installation of
.Xr login 1
as a set-user-ID root program.
.It Va WITHOUT_SHAREDOCS
2021-04-10 02:22:05 +00:00
Do not build the
.Bx 4.4
legacy docs.
.It Va WITHOUT_SHARED_TOOLCHAIN
2021-04-10 02:22:05 +00:00
Build the toolchain binaries as statically linked executables.
The set includes
.Xr cc 1 ,
.Xr make 1
and necessary utilities like assembler, linker and library archive manager.
.It Va WITH_SORT_THREADS
2021-04-10 02:22:05 +00:00
Enable threads in
.Xr sort 1 .
.It Va WITHOUT_SOURCELESS
2021-04-10 02:22:05 +00:00
Do not build kernel modules that include sourceless code (either microcode or native code for host CPU).
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_SOURCELESS_HOST
.It
.Va WITHOUT_SOURCELESS_UCODE
.El
.It Va WITHOUT_SOURCELESS_HOST
2021-04-10 02:22:05 +00:00
Do not build kernel modules that include sourceless native code for host CPU.
.It Va WITHOUT_SOURCELESS_UCODE
2021-04-10 02:22:05 +00:00
Do not build kernel modules that include sourceless microcode.
.It Va WITHOUT_SSP
2021-04-10 02:22:05 +00:00
Do not build world with propolice stack smashing protection.
.It Va WITH_STAGING
Enable staging of files to a stage tree.
This can be best thought of as auto-install to
.Va DESTDIR
with some extra meta data to ensure dependencies can be tracked.
Depends on
2015-11-14 04:50:28 +00:00
.Va WITH_DIRDEPS_BUILD .
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITH_STAGING_MAN
(unless
.Va WITHOUT_STAGING_MAN
is set explicitly)
.It Va WITH_STAGING_PROG
(unless
.Va WITHOUT_STAGING_PROG
is set explicitly)
.El
2015-09-17 20:48:42 +00:00
.Pp
2015-09-17 22:07:40 +00:00
This must be set in the environment, make command line, or
2015-09-17 20:48:42 +00:00
.Pa /etc/src-env.conf ,
not
.Pa /etc/src.conf .
.It Va WITH_STAGING_MAN
Enable staging of man pages to stage tree.
.It Va WITH_STAGING_PROG
Enable staging of PROGs to stage tree.
.It Va WITH_STALE_STAGED
Check staged files are not stale.
.It Va WITHOUT_STATS
2021-04-10 02:22:05 +00:00
Neither build nor install
.Lb libstats
and dependent binaries.
.It Va WITHOUT_SYSCONS
2021-04-10 02:22:05 +00:00
Do not build
.Xr syscons 4
support files such as keyboard maps, fonts, and screen output maps.
.It Va WITH_SYSROOT
Enable use of sysroot during build.
Depends on
2015-11-14 04:50:28 +00:00
.Va WITH_DIRDEPS_BUILD .
2015-09-17 20:48:42 +00:00
.Pp
2015-09-17 22:07:40 +00:00
This must be set in the environment, make command line, or
2015-09-17 20:48:42 +00:00
.Pa /etc/src-env.conf ,
not
.Pa /etc/src.conf .
.It Va WITHOUT_SYSTEM_COMPILER
2021-04-10 02:22:05 +00:00
Do not opportunistically skip building a cross-compiler during the
2016-05-21 01:35:48 +00:00
bootstrap phase of the build.
Normally, if the currently installed compiler matches the planned bootstrap
compiler type and revision, then it will not be built.
2016-05-21 01:35:48 +00:00
This does not prevent a compiler from being built for installation though,
only for building one for the build itself.
The
.Va WITHOUT_CLANG
option controls that.
2018-06-20 16:15:03 +00:00
.It Va WITHOUT_SYSTEM_LINKER
2021-04-10 02:22:05 +00:00
Do not opportunistically skip building a cross-linker during the
2018-06-20 16:15:03 +00:00
bootstrap phase of the build.
Normally, if the currently installed linker matches the planned bootstrap
linker type and revision, then it will not be built.
This does not prevent a linker from being built for installation though,
only for building one for the build itself.
The
.Va WITHOUT_LLD
option controls that.
2018-06-20 16:15:03 +00:00
.Pp
This option is only relevant when
.Va WITH_LLD_BOOTSTRAP
is set.
2015-01-25 04:56:43 +00:00
.It Va WITHOUT_TALK
2021-04-10 02:22:05 +00:00
Do not build or install
2015-01-25 04:56:43 +00:00
.Xr talk 1
and
.Xr talkd 8 .
2015-02-04 10:29:53 +00:00
.It Va WITHOUT_TCP_WRAPPERS
2021-04-10 02:22:05 +00:00
Do not build or install
2015-02-04 10:29:53 +00:00
.Xr tcpd 8 ,
and related utilities.
.It Va WITHOUT_TCSH
2021-04-10 02:22:05 +00:00
Do not build and install
.Pa /bin/csh
(which is
.Xr tcsh 1 ) .
.It Va WITHOUT_TELNET
2021-04-10 02:22:05 +00:00
Do not build
.Xr telnet 1
and related programs.
.It Va WITHOUT_TESTS
2021-04-10 02:22:05 +00:00
Do not build nor install the
.Fx
Test Suite in
.Pa /usr/tests/ .
See
.Xr tests 7
for more details.
This also disables the build of all test-related dependencies, including ATF.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
2015-08-02 00:56:16 +00:00
.Va WITHOUT_DTRACE_TESTS
2018-06-27 17:18:12 +00:00
.El
.Pp
When set, these options are also in effect:
.Pp
.Bl -inset -compact
.It Va WITHOUT_GOOGLETEST
(unless
.Va WITH_GOOGLETEST
is set explicitly)
2018-06-27 17:18:12 +00:00
.It Va WITHOUT_TESTS_SUPPORT
(unless
.Va WITH_TESTS_SUPPORT
is set explicitly)
.El
.It Va WITHOUT_TESTS_SUPPORT
2021-04-10 02:22:05 +00:00
Disable the build of all test-related dependencies, including ATF.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_GOOGLETEST
.El
.It Va WITHOUT_TEXTPROC
2021-04-10 02:22:05 +00:00
Do not build
programs used for text processing.
2015-02-04 10:29:53 +00:00
.It Va WITHOUT_TFTP
2021-04-10 02:22:05 +00:00
Do not build or install
2015-02-04 10:29:53 +00:00
.Xr tftp 1
and
.Xr tftpd 8 .
.It Va WITHOUT_TOOLCHAIN
2021-04-10 02:22:05 +00:00
Do not install header or
programs used for program development,
compilers, debuggers etc.
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_CLANG
.It
.Va WITHOUT_CLANG_EXTRAS
.It
2020-06-24 17:31:21 +00:00
.Va WITHOUT_CLANG_FORMAT
.It
.Va WITHOUT_CLANG_FULL
.It
.Va WITHOUT_INCLUDES
2016-03-30 23:56:43 +00:00
.It
.Va WITHOUT_LLD
.It
2016-03-30 23:56:43 +00:00
.Va WITHOUT_LLDB
.It
.Va WITHOUT_LLVM_COV
.El
.It Va WITH_UBSAN
Build the base system with Undefined Behavior Sanitizer (UBSan) to detect
various kinds of undefined behavior at runtime.
Requires that Clang be used as the base system compiler
and that the runtime support library is available
.It Va WITHOUT_UNBOUND
2021-04-10 02:22:05 +00:00
Do not build
.Xr unbound 8
and related programs.
.It Va WITHOUT_UNIFIED_OBJDIR
2021-04-10 02:22:05 +00:00
Use the historical object directory format for
.Xr build 7
targets.
For native-builds and builds done directly in sub-directories the format of
.Pa ${MAKEOBJDIRPREFIX}/${.CURDIR}
is used,
while for cross-builds
.Pa ${MAKEOBJDIRPREFIX}/${TARGET}.${TARGET_ARCH}/${.CURDIR}
is used.
.Pp
This option is transitional and will be removed before the 12.0 release,
at which time
.va WITH_UNIFIED_OBJDIR
will be enabled permanently.
.Pp
This must be set in the environment, make command line, or
.Pa /etc/src-env.conf ,
not
.Pa /etc/src.conf .
.It Va WITHOUT_USB
2021-04-10 02:22:05 +00:00
Do not build USB-related programs and libraries.
.It Va WITHOUT_USB_GADGET_EXAMPLES
2021-04-10 02:22:05 +00:00
Do not build USB gadget kernel modules.
.It Va WITHOUT_UTMPX
2021-04-10 02:22:05 +00:00
Do not build user accounting tools such as
.Xr last 1 ,
.Xr users 1 ,
.Xr who 1 ,
.Xr ac 8 ,
.Xr lastlogin 8
and
.Xr utx 8 .
.It Va WITH_VERIEXEC
Enable building
.Xr veriexec 8
which loads the contents of verified manifests into the kernel
for use by
.Xr mac_veriexec 4
.Pp
Depends on
.Va WITH_BEARSSL .
.It Va WITHOUT_VI
2021-04-10 02:22:05 +00:00
Do not build and install vi, view, ex and related programs.
.It Va WITHOUT_VT
2021-04-10 02:22:05 +00:00
Do not build
.Xr vt 4
support files (fonts and keymaps).
.It Va WITHOUT_WARNS
Set this to not add warning flags to the compiler invocations.
Useful as a temporary workaround when code enters the tree
which triggers warnings in environments that differ from the
2014-12-27 10:28:20 +00:00
original developer.
.It Va WITHOUT_WERROR
Set this to not treat compiler warnings as errors.
Useful as a temporary workaround when working on fixing compiler warnings.
When set, warnings are still printed in the build log but do not fail the build.
.It Va WITHOUT_WIRELESS
2021-04-10 02:22:05 +00:00
Do not build programs used for 802.11 wireless networks; especially
.Xr wpa_supplicant 8
and
.Xr hostapd 8 .
2018-06-27 17:18:12 +00:00
When set, these options are also in effect:
.Pp
2018-06-27 17:18:12 +00:00
.Bl -inset -compact
.It Va WITHOUT_WIRELESS_SUPPORT
(unless
.Va WITH_WIRELESS_SUPPORT
is set explicitly)
.El
.It Va WITHOUT_WIRELESS_SUPPORT
2021-04-10 02:22:05 +00:00
Build libraries, programs, and kernel modules without
802.11 wireless support.
.It Va WITHOUT_WPA_SUPPLICANT_EAPOL
Build
.Xr wpa_supplicant 8
without support for the IEEE 802.1X protocol and without
support for EAP-PEAP, EAP-TLS, EAP-LEAP, and EAP-TTLS
protocols (usable only via 802.1X).
.It Va WITHOUT_ZFS
2021-04-10 02:22:05 +00:00
Do not build ZFS file system kernel module, libraries, and user commands.
.It Va WITHOUT_ZONEINFO
2021-04-10 02:22:05 +00:00
Do not build the timezone database.
2017-07-06 05:43:04 +00:00
When set, it enforces these options:
.Pp
.Bl -item -compact
.It
.Va WITHOUT_ZONEINFO_LEAPSECONDS_SUPPORT
.El
.It Va WITH_ZONEINFO_LEAPSECONDS_SUPPORT
2021-04-10 02:22:05 +00:00
Build leapsecond information in to the timezone database.
.El
.Sh FILES
.Bl -tag -compact -width Pa
.It Pa /etc/src.conf
2015-09-17 20:48:42 +00:00
.It Pa /etc/src-env.conf
.It Pa /usr/share/mk/bsd.own.mk
.El
.Sh SEE ALSO
.Xr make 1 ,
.Xr make.conf 5 ,
.Xr build 7 ,
.Xr ports 7
.Sh HISTORY
The
.Nm
file appeared in
.Fx 7.0 .
.Sh AUTHORS
This manual page was autogenerated by
.An tools/build/options/makeman .