xref: /freebsd/share/man/man5/src.conf.5 (revision abcdc1b9)
1.\" DO NOT EDIT-- this file is @generated by tools/build/options/makeman.
2.Dd September 7, 2023
3.Dt SRC.CONF 5
4.Os
5.Sh NAME
6.Nm src.conf
7.Nd "source build options"
8.Sh DESCRIPTION
9The
10.Nm
11file contains variables that control what components will be generated during
12the build process of the
13.Fx
14source tree; see
15.Xr build 7 .
16.Pp
17The
18.Nm
19file uses the standard makefile syntax.
20However,
21.Nm
22should not specify any dependencies to
23.Xr make 1 .
24Instead,
25.Nm
26is to set
27.Xr make 1
28variables that control the aspects of how the system builds.
29.Pp
30The default location of
31.Nm
32is
33.Pa /etc/src.conf ,
34though an alternative location can be specified in the
35.Xr make 1
36variable
37.Va SRCCONF .
38Overriding the location of
39.Nm
40may be necessary if the system-wide settings are not suitable
41for a particular build.
42For instance, setting
43.Va SRCCONF
44to
45.Pa /dev/null
46effectively resets all build controls to their defaults.
47.Pp
48The only purpose of
49.Nm
50is to control the compilation of the
51.Fx
52source code, which is usually located in
53.Pa /usr/src .
54As a rule, the system administrator creates
55.Nm
56when the values of certain control variables need to be changed
57from their defaults.
58.Pp
59In addition, control variables can be specified
60for a particular build via the
61.Fl D
62option of
63.Xr make 1
64or in its environment; see
65.Xr environ 7 .
66.Pp
67The environment of
68.Xr make 1
69for the build can be controlled via the
70.Va SRC_ENV_CONF
71variable, which defaults to
72.Pa /etc/src-env.conf .
73Some examples that may only be set in this file are
74.Va WITH_DIRDEPS_BUILD ,
75and
76.Va WITH_META_MODE ,
77and
78.Va MAKEOBJDIRPREFIX
79as they are environment-only variables.
80.Pp
81The values of
82.Va WITH_
83and
84.Va WITHOUT_
85variables are ignored regardless of their setting;
86even if they would be set to
87.Dq Li FALSE
88or
89.Dq Li NO .
90The presence of an option causes
91it to be honored by
92.Xr make 1 .
93.Pp
94This list provides a name and short description for variables
95that can be used for source builds.
96.Bl -tag -width indent
97.It Va WITHOUT_ACCT
98Do not build process accounting tools such as
99.Xr accton 8
100and
101.Xr sa 8 .
102.It Va WITHOUT_ACPI
103Do not build
104.Xr acpiconf 8 ,
105.Xr acpidump 8
106and related programs.
107.It Va WITHOUT_APM
108Do not build
109.Xr apm 8 ,
110.Xr apmd 8
111and related programs.
112.It Va WITH_ASAN
113Build the base system with Address Sanitizer (ASan) to detect
114memory corruption bugs such as buffer overflows or use-after-free.
115Requires that Clang be used as the base system compiler
116and that the runtime support library is available.
117When set, it enforces these options:
118.Pp
119.Bl -item -compact
120.It
121.Va WITH_LLVM_BINUTILS
122.It
123.Va WITH_LLVM_CXXFILT
124.El
125.It Va WITHOUT_ASSERT_DEBUG
126Compile programs and libraries without the
127.Xr assert 3
128checks.
129.It Va WITHOUT_AT
130Do not build
131.Xr at 1
132and related utilities.
133.It Va WITHOUT_AUDIT
134Do not build audit support into system programs.
135.It Va WITHOUT_AUTHPF
136Do not build
137.Xr authpf 8 .
138.It Va WITHOUT_AUTOFS
139Do not build
140.Xr autofs 5
141related programs, libraries, and kernel modules.
142.It Va WITHOUT_AUTO_OBJ
143Disable automatic creation of objdirs.
144This is enabled by default if the wanted OBJDIR is writable by the current user.
145.Pp
146This must be set in the environment, make command line, or
147.Pa /etc/src-env.conf ,
148not
149.Pa /etc/src.conf .
150.It Va WITH_BEARSSL
151Build the BearSSL library.
152.Pp
153BearSSL is a tiny SSL library suitable for embedded environments.
154For details see
155.Lk https://www.BearSSL.org/
156.Pp
157This library is currently only used to perform
158signature verification and related operations
159for Verified Exec and
160.Xr loader 8 .
161When set, these options are also in effect:
162.Pp
163.Bl -inset -compact
164.It Va WITH_LOADER_EFI_SECUREBOOT
165(unless
166.Va WITHOUT_LOADER_EFI_SECUREBOOT
167is set explicitly)
168.It Va WITH_LOADER_VERIEXEC
169(unless
170.Va WITHOUT_LOADER_VERIEXEC
171is set explicitly)
172.It Va WITH_LOADER_VERIEXEC_VECTX
173(unless
174.Va WITHOUT_LOADER_VERIEXEC_VECTX
175is set explicitly)
176.It Va WITH_VERIEXEC
177(unless
178.Va WITHOUT_VERIEXEC
179is set explicitly)
180.El
181.It Va WITHOUT_BHYVE
182Do not build or install
183.Xr bhyve 8 ,
184associated utilities, and examples.
185.Pp
186This option only affects amd64/amd64.
187.It Va WITH_BHYVE_SNAPSHOT
188Include support for save and restore (snapshots) in
189.Xr bhyve 8
190and
191.Xr bhyvectl 8 .
192.Pp
193This option only affects amd64/amd64.
194.It Va WITH_BIND_NOW
195Build all binaries with the
196.Dv DF_BIND_NOW
197flag set to indicate that the run-time loader should perform all relocation
198processing at process startup rather than on demand.
199The combination of the
200.Va BIND_NOW
201and
202.Va RELRO
203options provide "full" Relocation Read-Only (RELRO) support.
204With full RELRO the entire GOT is made read-only after performing relocation at
205startup, avoiding GOT overwrite attacks.
206.It Va WITHOUT_BLACKLIST
207Set this if you do not want to build
208.Xr blacklistd 8
209and
210.Xr blacklistctl 8 .
211When set, these options are also in effect:
212.Pp
213.Bl -inset -compact
214.It Va WITHOUT_BLACKLIST_SUPPORT
215(unless
216.Va WITH_BLACKLIST_SUPPORT
217is set explicitly)
218.El
219.It Va WITHOUT_BLACKLIST_SUPPORT
220Build some programs without
221.Xr libblacklist 3
222support, like
223.Xr fingerd 8 ,
224.Xr ftpd 8 ,
225and
226.Xr sshd 8 .
227.It Va WITHOUT_BLUETOOTH
228Do not build Bluetooth related kernel modules, programs and libraries.
229.It Va WITHOUT_BOOT
230Do not build the boot blocks and loader.
231.It Va WITHOUT_BOOTPARAMD
232Do not build or install
233.Xr bootparamd 8 .
234.It Va WITHOUT_BOOTPD
235Do not build or install
236.Xr bootpd 8 .
237.It Va WITHOUT_BSDINSTALL
238Do not build
239.Xr bsdinstall 8 ,
240.Xr sade 8 ,
241and related programs.
242.It Va WITHOUT_BSD_CPIO
243Do not build the BSD licensed version of cpio based on
244.Xr libarchive 3 .
245.It Va WITHOUT_BSNMP
246Do not build or install
247.Xr bsnmpd 1
248and related libraries and data files.
249.It Va WITHOUT_BZIP2
250Do not build contributed bzip2 software as a part of the base system.
251.Bf -symbolic
252The option has no effect yet.
253.Ef
254When set, these options are also in effect:
255.Pp
256.Bl -inset -compact
257.It Va WITHOUT_BZIP2_SUPPORT
258(unless
259.Va WITH_BZIP2_SUPPORT
260is set explicitly)
261.El
262.It Va WITHOUT_BZIP2_SUPPORT
263Build some programs without optional bzip2 support.
264.It Va WITHOUT_CALENDAR
265Do not build
266.Xr calendar 1 .
267.It Va WITHOUT_CAPSICUM
268This option has no effect.
269.It Va WITHOUT_CAROOT
270Do not add the trusted certificates from the Mozilla NSS bundle to
271base.
272.It Va WITHOUT_CASPER
273This option has no effect.
274.It Va WITH_CCACHE_BUILD
275Use
276.Xr ccache 1
277for the build.
278No configuration is required except to install the
279.Sy devel/ccache
280package.
281When using with
282.Xr distcc 1 ,
283set
284.Sy CCACHE_PREFIX=/usr/local/bin/distcc .
285The default cache directory of
286.Pa $HOME/.ccache
287will be used, which can be overridden by setting
288.Sy CCACHE_DIR .
289The
290.Sy CCACHE_COMPILERCHECK
291option defaults to
292.Sy content
293when using the in-tree bootstrap compiler,
294and
295.Sy mtime
296when using an external compiler.
297The
298.Sy CCACHE_CPP2
299option is used for Clang but not GCC.
300.Pp
301Sharing a cache between multiple work directories requires using a layout
302similar to
303.Pa /some/prefix/src
304.Pa /some/prefix/obj
305and an environment such as:
306.Bd -literal -offset indent
307CCACHE_BASEDIR='${SRCTOP:H}' MAKEOBJDIRPREFIX='${SRCTOP:H}/obj'
308.Ed
309.Pp
310See
311.Xr ccache 1
312for more configuration options.
313.It Va WITHOUT_CCD
314Do not build
315.Xr geom_ccd 4
316and related utilities.
317.It Va WITHOUT_CDDL
318Do not build code licensed under Sun's CDDL.
319When set, it enforces these options:
320.Pp
321.Bl -item -compact
322.It
323.Va WITHOUT_CTF
324.It
325.Va WITHOUT_DTRACE
326.It
327.Va WITHOUT_LOADER_ZFS
328.It
329.Va WITHOUT_ZFS
330.El
331.It Va WITHOUT_CLANG
332Do not build the Clang C/C++ compiler during the regular phase of the build.
333When set, it enforces these options:
334.Pp
335.Bl -item -compact
336.It
337.Va WITHOUT_CLANG_EXTRAS
338.It
339.Va WITHOUT_CLANG_FORMAT
340.It
341.Va WITHOUT_CLANG_FULL
342.It
343.Va WITHOUT_LLVM_COV
344.El
345.Pp
346When set, these options are also in effect:
347.Pp
348.Bl -inset -compact
349.It Va WITHOUT_LLVM_TARGET_AARCH64
350(unless
351.Va WITH_LLVM_TARGET_AARCH64
352is set explicitly)
353.It Va WITHOUT_LLVM_TARGET_ALL
354(unless
355.Va WITH_LLVM_TARGET_ALL
356is set explicitly)
357.It Va WITHOUT_LLVM_TARGET_ARM
358(unless
359.Va WITH_LLVM_TARGET_ARM
360is set explicitly)
361.It Va WITHOUT_LLVM_TARGET_POWERPC
362(unless
363.Va WITH_LLVM_TARGET_POWERPC
364is set explicitly)
365.It Va WITHOUT_LLVM_TARGET_RISCV
366(unless
367.Va WITH_LLVM_TARGET_RISCV
368is set explicitly)
369.El
370.It Va WITHOUT_CLANG_BOOTSTRAP
371Do not build the Clang C/C++ compiler during the bootstrap phase of
372the build.
373To be able to build the system, either gcc or clang bootstrap must be
374enabled unless an alternate compiler is provided via XCC.
375.It Va WITH_CLANG_EXTRAS
376Build additional clang and llvm tools, such as bugpoint and
377clang-format.
378.It Va WITH_CLANG_FORMAT
379Build clang-format.
380.It Va WITHOUT_CLANG_FULL
381Avoid building the ARCMigrate, Rewriter and StaticAnalyzer components of
382the Clang C/C++ compiler.
383.It Va WITHOUT_CLEAN
384Do not clean before building world and/or kernel.
385.It Va WITHOUT_CPP
386Do not build
387.Xr cpp 1 .
388.It Va WITHOUT_CROSS_COMPILER
389Do not build any cross compiler in the cross-tools stage of buildworld.
390When compiling a different version of
391.Fx
392than what is installed on the system, provide an alternate
393compiler with XCC to ensure success.
394When compiling with an identical version of
395.Fx
396to the host, this option may be safely used.
397This option may also be safe when the host version of
398.Fx
399is close to the sources being built, but all bets are off if there have
400been any changes to the toolchain between the versions.
401When set, it enforces these options:
402.Pp
403.Bl -item -compact
404.It
405.Va WITHOUT_CLANG_BOOTSTRAP
406.It
407.Va WITHOUT_ELFTOOLCHAIN_BOOTSTRAP
408.It
409.Va WITHOUT_LLD_BOOTSTRAP
410.El
411.It Va WITHOUT_CRYPT
412Do not build any crypto code.
413When set, it enforces these options:
414.Pp
415.Bl -item -compact
416.It
417.Va WITHOUT_DMAGENT
418.It
419.Va WITHOUT_KERBEROS
420.It
421.Va WITHOUT_KERBEROS_SUPPORT
422.It
423.Va WITHOUT_LDNS
424.It
425.Va WITHOUT_LDNS_UTILS
426.It
427.Va WITHOUT_LOADER_ZFS
428.It
429.Va WITHOUT_OPENSSH
430.It
431.Va WITHOUT_OPENSSL
432.It
433.Va WITHOUT_OPENSSL_KTLS
434.It
435.Va WITHOUT_PKGBOOTSTRAP
436.It
437.Va WITHOUT_UNBOUND
438.It
439.Va WITHOUT_ZFS
440.El
441.Pp
442When set, these options are also in effect:
443.Pp
444.Bl -inset -compact
445.It Va WITHOUT_GSSAPI
446(unless
447.Va WITH_GSSAPI
448is set explicitly)
449.El
450.It Va WITH_CTF
451Compile with CTF (Compact C Type Format) data.
452CTF data encapsulates a reduced form of debugging information
453similar to DWARF and the venerable stabs and is required for DTrace.
454.It Va WITHOUT_CUSE
455Do not build CUSE-related programs and libraries.
456.It Va WITHOUT_CXGBETOOL
457Do not build
458.Xr cxgbetool 8
459.Pp
460This is a default setting on
461arm/armv7, powerpc/powerpc and riscv/riscv64.
462.It Va WITH_CXGBETOOL
463Build
464.Xr cxgbetool 8
465.Pp
466This is a default setting on
467amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64 and powerpc/powerpc64le.
468.It Va WITHOUT_DEBUG_FILES
469Avoid building or installing standalone debug files for each
470executable binary and shared library.
471.It Va WITH_DETECT_TZ_CHANGES
472Make the time handling code detect changes to the timezone files.
473.It Va WITHOUT_DIALOG
474Do not build
475.Xr dialog 1 ,
476.Xr dialog 3 ,
477.Xr dpv 1 ,
478and
479.Xr dpv 3 .
480When set, it enforces these options:
481.Pp
482.Bl -item -compact
483.It
484.Va WITHOUT_BSDINSTALL
485.El
486.It Va WITHOUT_DICT
487Do not build the Webster dictionary files.
488.It Va WITH_DIRDEPS_BUILD
489This is an alternate build system.
490For details see
491https://www.crufty.net/sjg/docs/freebsd-meta-mode.htm.
492Build commands can be seen from the top-level with:
493.Dl make show-valid-targets
494The build is driven by dirdeps.mk using
495.Va DIRDEPS
496stored in
497Makefile.depend files found in each directory.
498.Pp
499The build can be started from anywhere, and behaves the same.
500The initial instance of
501.Xr make 1
502recursively reads
503.Va DIRDEPS
504from
505.Pa Makefile.depend ,
506computing a graph of tree dependencies from the current origin.
507Setting
508.Va NO_DIRDEPS
509skips checking dirdep dependencies and will only build in the current
510and child directories.
511.Va NO_DIRDEPS_BELOW
512skips building any dirdeps and only build the current directory.
513.Pp
514This also utilizes the
515.Va WITH_META_MODE
516logic for incremental builds.
517.Pp
518The build hides commands executed unless
519.Va NO_SILENT
520is defined.
521.Pp
522Note that there is currently no mass install feature for this.
523This build is designed for producing packages, that can then be installed
524on a target system.
525.Pp
526The implementation in
527.Fx
528is incomplete.
529Completion would require leaf directories for building each kernel
530and package so that their dependencies can be tracked.
531When set, it enforces these options:
532.Pp
533.Bl -item -compact
534.It
535.Va WITH_INSTALL_AS_USER
536.El
537.Pp
538When set, these options are also in effect:
539.Pp
540.Bl -inset -compact
541.It Va WITH_META_ERROR_TARGET
542(unless
543.Va WITHOUT_META_ERROR_TARGET
544is set explicitly)
545.It Va WITH_META_MODE
546(unless
547.Va WITHOUT_META_MODE
548is set explicitly)
549.It Va WITH_STAGING
550(unless
551.Va WITHOUT_STAGING
552is set explicitly)
553.It Va WITH_STAGING_MAN
554(unless
555.Va WITHOUT_STAGING_MAN
556is set explicitly)
557.It Va WITH_STAGING_PROG
558(unless
559.Va WITHOUT_STAGING_PROG
560is set explicitly)
561.It Va WITH_SYSROOT
562(unless
563.Va WITHOUT_SYSROOT
564is set explicitly)
565.El
566.Pp
567This must be set in the environment, make command line, or
568.Pa /etc/src-env.conf ,
569not
570.Pa /etc/src.conf .
571.It Va WITH_DIRDEPS_CACHE
572Cache result of dirdeps.mk which can save significant time
573for subsequent builds.
574Depends on
575.Va WITH_DIRDEPS_BUILD .
576.Pp
577This must be set in the environment, make command line, or
578.Pa /etc/src-env.conf ,
579not
580.Pa /etc/src.conf .
581.It Va WITH_DISK_IMAGE_TOOLS_BOOTSTRAP
582Build
583.Xr etdump 1 ,
584.Xr makefs 8
585and
586.Xr mkimg 1
587as bootstrap tools.
588.It Va WITHOUT_DMAGENT
589Do not build dma Mail Transport Agent.
590.It Va WITHOUT_DOCCOMPRESS
591Do not install compressed system documentation.
592Only the uncompressed version will be installed.
593.It Va WITHOUT_DTRACE
594Do not build DTrace framework kernel modules, libraries, and user commands.
595When set, it enforces these options:
596.Pp
597.Bl -item -compact
598.It
599.Va WITHOUT_CTF
600.El
601.It Va WITH_DTRACE_ASAN
602Compile userspace DTrace code (libdtrace, dtrace(1), lockstat(1), plockstat(1))
603with address and undefined behavior sanitizers.
604Requires that Clang be used as the base system compiler
605and that the runtime support library is available.
606.It Va WITH_DTRACE_TESTS
607Build and install the DTrace test suite in
608.Pa /usr/tests/cddl/usr.sbin/dtrace .
609This test suite is considered experimental on architectures other than
610amd64/amd64 and running it may cause system instability.
611.It Va WITHOUT_DYNAMICROOT
612Set this if you do not want to link
613.Pa /bin
614and
615.Pa /sbin
616dynamically.
617.It Va WITHOUT_EE
618Do not build and install
619.Xr edit 1 ,
620.Xr ee 1 ,
621and related programs.
622.It Va WITHOUT_EFI
623Set not to build
624.Xr efivar 3
625and
626.Xr efivar 8 .
627.Pp
628This is a default setting on
629i386/i386, powerpc/powerpc, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
630.It Va WITH_EFI
631Build
632.Xr efivar 3
633and
634.Xr efivar 8 .
635.Pp
636This is a default setting on
637amd64/amd64, arm/armv7 and arm64/aarch64.
638.It Va WITHOUT_ELFTOOLCHAIN_BOOTSTRAP
639Do not build ELF Tool Chain tools
640(addr2line, nm, size, strings and strip)
641as part of the bootstrap process.
642.Bf -symbolic
643An alternate bootstrap tool chain must be provided.
644.Ef
645.It Va WITHOUT_EXAMPLES
646Avoid installing examples to
647.Pa /usr/share/examples/ .
648.It Va WITH_EXPERIMENTAL
649Include experimental features in the build.
650.It Va WITH_EXTRA_TCP_STACKS
651Build extra TCP stack modules.
652.It Va WITHOUT_FDT
653Do not build Flattened Device Tree support as part of the base system.
654This includes the device tree compiler (dtc) and libfdt support library.
655.Pp
656This is a default setting on
657amd64/amd64 and i386/i386.
658.It Va WITH_FDT
659Build Flattened Device Tree support as part of the base system.
660This includes the device tree compiler (dtc) and libfdt support library.
661.Pp
662This is a default setting on
663arm/armv7, arm64/aarch64, powerpc/powerpc, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
664.It Va WITHOUT_FILE
665Do not build
666.Xr file 1
667and related programs.
668.It Va WITHOUT_FINGER
669Do not build or install
670.Xr finger 1
671and
672.Xr fingerd 8 .
673.It Va WITHOUT_FLOPPY
674Do not build or install programs
675for operating floppy disk driver.
676.It Va WITHOUT_FORMAT_EXTENSIONS
677Do not enable
678.Fl fformat-extensions
679when compiling the kernel.
680Also disables all format checking.
681.It Va WITHOUT_FORTH
682Build bootloaders without Forth support.
683.It Va WITHOUT_FP_LIBC
684Build
685.Nm libc
686without floating-point support.
687.It Va WITHOUT_FREEBSD_UPDATE
688Do not build
689.Xr freebsd-update 8 .
690.It Va WITHOUT_FTP
691Do not build or install
692.Xr ftp 1
693and
694.Xr ftpd 8 .
695.It Va WITHOUT_GAMES
696Do not build games.
697.It Va WITHOUT_GH_BC
698Install the traditional FreeBSD
699.Xr bc 1
700and
701.Xr dc 1
702programs instead of the enhanced versions.
703.It Va WITHOUT_GNU_DIFF
704Do not build GNU
705.Xr diff3 1 .
706.It Va WITHOUT_GOOGLETEST
707Neither build nor install
708.Lb libgmock ,
709.Lb libgtest ,
710and dependent tests.
711.It Va WITHOUT_GPIO
712Do not build
713.Xr gpioctl 8
714as part of the base system.
715.It Va WITHOUT_GSSAPI
716Do not build libgssapi.
717.It Va WITHOUT_HAST
718Do not build
719.Xr hastd 8
720and related utilities.
721.It Va WITH_HESIOD
722Build Hesiod support.
723.It Va WITHOUT_HTML
724Do not build HTML docs.
725.It Va WITHOUT_HYPERV
726Do not build or install HyperV utilities.
727.Pp
728This is a default setting on
729arm/armv7, powerpc/powerpc, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
730.It Va WITH_HYPERV
731Build or install HyperV utilities.
732.Pp
733This is a default setting on
734amd64/amd64, arm64/aarch64 and i386/i386.
735.It Va WITHOUT_ICONV
736Do not build iconv as part of libc.
737.It Va WITHOUT_INCLUDES
738Do not install header files.
739This option used to be spelled
740.Va NO_INCS .
741.Bf -symbolic
742The option does not work for build targets.
743.Ef
744.It Va WITHOUT_INET
745Do not build programs and libraries related to IPv4 networking.
746When set, it enforces these options:
747.Pp
748.Bl -item -compact
749.It
750.Va WITHOUT_INET_SUPPORT
751.El
752.It Va WITHOUT_INET6
753Do not build
754programs and libraries related to IPv6 networking.
755When set, it enforces these options:
756.Pp
757.Bl -item -compact
758.It
759.Va WITHOUT_INET6_SUPPORT
760.El
761.It Va WITHOUT_INET6_SUPPORT
762Build libraries, programs, and kernel modules without IPv6 support.
763.It Va WITHOUT_INETD
764Do not build
765.Xr inetd 8 .
766.It Va WITHOUT_INET_SUPPORT
767Build libraries, programs, and kernel modules without IPv4 support.
768.It Va WITHOUT_INSTALLLIB
769Set this to not install optional libraries.
770For example, when creating a
771.Xr nanobsd 8
772image.
773.Bf -symbolic
774The option does not work for build targets.
775.Ef
776.It Va WITH_INSTALL_AS_USER
777Make install targets succeed for non-root users by installing
778files with owner and group attributes set to that of the user running
779the
780.Xr make 1
781command.
782The user still must set the
783.Va DESTDIR
784variable to point to a directory where the user has write permissions.
785.It Va WITHOUT_IPFILTER
786Do not build IP Filter package.
787.It Va WITHOUT_IPFW
788Do not build IPFW tools.
789.It Va WITHOUT_IPSEC_SUPPORT
790Do not build the kernel with
791.Xr ipsec 4
792support.
793This option is needed for
794.Xr ipsec 4
795and
796.Xr tcpmd5 4 .
797.It Va WITHOUT_ISCSI
798Do not build
799.Xr iscsid 8
800and related utilities.
801.It Va WITHOUT_JAIL
802Do not build tools for the support of jails; e.g.,
803.Xr jail 8 .
804.It Va WITHOUT_KDUMP
805Do not build
806.Xr kdump 1
807and
808.Xr truss 1 .
809.It Va WITHOUT_KERBEROS
810Set this to not build Kerberos 5 (KTH Heimdal).
811When set, these options are also in effect:
812.Pp
813.Bl -inset -compact
814.It Va WITHOUT_GSSAPI
815(unless
816.Va WITH_GSSAPI
817is set explicitly)
818.It Va WITHOUT_KERBEROS_SUPPORT
819(unless
820.Va WITH_KERBEROS_SUPPORT
821is set explicitly)
822.El
823.It Va WITHOUT_KERBEROS_SUPPORT
824Build some programs without Kerberos support, like
825.Xr ssh 1 ,
826.Xr telnet 1 ,
827and
828.Xr sshd 8 .
829.It Va WITH_KERNEL_RETPOLINE
830Enable the "retpoline" mitigation for CVE-2017-5715 in the kernel
831build.
832.It Va WITHOUT_KERNEL_SYMBOLS
833Do not install standalone kernel debug symbol files.
834This option has no effect at build time.
835.It Va WITHOUT_KVM
836Do not build the
837.Nm libkvm
838library as a part of the base system.
839.Bf -symbolic
840The option has no effect yet.
841.Ef
842When set, these options are also in effect:
843.Pp
844.Bl -inset -compact
845.It Va WITHOUT_KVM_SUPPORT
846(unless
847.Va WITH_KVM_SUPPORT
848is set explicitly)
849.El
850.It Va WITHOUT_KVM_SUPPORT
851Build some programs without optional
852.Nm libkvm
853support.
854.It Va WITHOUT_LDNS
855Setting this variable will prevent the LDNS library from being built.
856When set, it enforces these options:
857.Pp
858.Bl -item -compact
859.It
860.Va WITHOUT_LDNS_UTILS
861.It
862.Va WITHOUT_UNBOUND
863.El
864.It Va WITHOUT_LDNS_UTILS
865Setting this variable will prevent building the LDNS utilities
866.Xr drill 1
867and
868.Xr host 1 .
869.It Va WITHOUT_LEGACY_CONSOLE
870Do not build programs that support a legacy PC console; e.g.,
871.Xr kbdcontrol 1
872and
873.Xr vidcontrol 1 .
874.It Va WITHOUT_LIB32
875On 64-bit platforms, do not build 32-bit library set and a
876.Nm ld-elf32.so.1
877runtime linker.
878.Pp
879This is a default setting on
880arm/armv7, i386/i386, powerpc/powerpc, powerpc/powerpc64le and riscv/riscv64.
881.It Va WITH_LIB32
882On 64-bit platforms, build the 32-bit library set and a
883.Nm ld-elf32.so.1
884runtime linker.
885.Pp
886This is a default setting on
887amd64/amd64, arm64/aarch64 and powerpc/powerpc64.
888.It Va WITHOUT_LLD
889Do not build LLVM's lld linker.
890.It Va WITHOUT_LLDB
891Do not build the LLDB debugger.
892.Pp
893This is a default setting on
894arm/armv7 and riscv/riscv64.
895.It Va WITH_LLDB
896Build the LLDB debugger.
897.Pp
898This is a default setting on
899amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc, powerpc/powerpc64 and powerpc/powerpc64le.
900.It Va WITHOUT_LLD_BOOTSTRAP
901Do not build the LLD linker during the bootstrap phase of
902the build.
903To be able to build the system an alternate linker must be provided via XLD.
904.It Va WITHOUT_LLD_IS_LD
905Do not install a
906.Pa /usr/bin/ld symlink
907to
908.Pa ld.lld .
909The system will not have a usable tool chain unless a linker is provided
910some other way.
911.It Va WITHOUT_LLVM_ASSERTIONS
912Disable debugging assertions in LLVM.
913.It Va WITH_LLVM_BINUTILS
914Install LLVM's binutils (without an llvm- prefix),
915instead of ELF Tool Chain's tools.
916This includes
917.Xr addr2line 1 ,
918.Xr ar 1 ,
919.Xr nm 1 ,
920.Xr objcopy 1 ,
921.Xr ranlib 1 ,
922.Xr readelf 1 ,
923.Xr size 1 ,
924and
925.Xr strip 1 .
926Regardless of this setting, LLVM tools are used for
927.Xr c++filt 1
928and
929.Xr objdump 1 .
930.Xr strings 1
931is always provided by ELF Tool Chain.
932.It Va WITHOUT_LLVM_COV
933Do not build the
934.Xr llvm-cov 1
935tool.
936.It Va WITHOUT_LLVM_CXXFILT
937Install ELF Tool Chain's cxxfilt as c++filt, instead of LLVM's llvm-cxxfilt.
938.It Va WITHOUT_LLVM_TARGET_AARCH64
939Do not build LLVM target support for AArch64.
940The
941.Va LLVM_TARGET_ALL
942option should be used rather than this in most cases.
943.It Va WITHOUT_LLVM_TARGET_ALL
944Only build the required LLVM target support.
945This option is preferred to specific target support options.
946When set, these options are also in effect:
947.Pp
948.Bl -inset -compact
949.It Va WITHOUT_LLVM_TARGET_AARCH64
950(unless
951.Va WITH_LLVM_TARGET_AARCH64
952is set explicitly)
953.It Va WITHOUT_LLVM_TARGET_ARM
954(unless
955.Va WITH_LLVM_TARGET_ARM
956is set explicitly)
957.It Va WITHOUT_LLVM_TARGET_POWERPC
958(unless
959.Va WITH_LLVM_TARGET_POWERPC
960is set explicitly)
961.It Va WITHOUT_LLVM_TARGET_RISCV
962(unless
963.Va WITH_LLVM_TARGET_RISCV
964is set explicitly)
965.El
966.It Va WITHOUT_LLVM_TARGET_ARM
967Do not build LLVM target support for ARM.
968The
969.Va LLVM_TARGET_ALL
970option should be used rather than this in most cases.
971.It Va WITH_LLVM_TARGET_BPF
972Build LLVM target support for BPF.
973The
974.Va LLVM_TARGET_ALL
975option should be used rather than this in most cases.
976.It Va WITH_LLVM_TARGET_MIPS
977Build LLVM target support for MIPS.
978The
979.Va LLVM_TARGET_ALL
980option should be used rather than this in most cases.
981.It Va WITHOUT_LLVM_TARGET_POWERPC
982Do not build LLVM target support for PowerPC.
983The
984.Va LLVM_TARGET_ALL
985option should be used rather than this in most cases.
986.It Va WITHOUT_LLVM_TARGET_RISCV
987Do not build LLVM target support for RISC-V.
988The
989.Va LLVM_TARGET_ALL
990option should be used rather than this in most cases.
991.It Va WITHOUT_LLVM_TARGET_X86
992Do not build LLVM target support for X86.
993The
994.Va LLVM_TARGET_ALL
995option should be used rather than this in most cases.
996.It Va WITH_LOADER_EFI_SECUREBOOT
997Enable building
998.Xr loader 8
999with support for verification based on certificates obtained from UEFI.
1000.It Va WITHOUT_LOADER_GELI
1001Disable inclusion of GELI crypto support in the boot chain binaries.
1002.Pp
1003This is a default setting on
1004powerpc/powerpc, powerpc/powerpc64 and powerpc/powerpc64le.
1005.It Va WITH_LOADER_GELI
1006Build GELI bootloader support.
1007.Pp
1008This is a default setting on
1009amd64/amd64, arm/armv7, arm64/aarch64, i386/i386 and riscv/riscv64.
1010.It Va WITHOUT_LOADER_KBOOT
1011Do not build kboot, a linuxboot environment loader
1012.Pp
1013This is a default setting on
1014arm/armv7, i386/i386, powerpc/powerpc, powerpc/powerpc64le and riscv/riscv64.
1015.It Va WITH_LOADER_KBOOT
1016Build kboot, a linuxboot environment loader
1017.Pp
1018This is a default setting on
1019amd64/amd64, arm64/aarch64 and powerpc/powerpc64.
1020.It Va WITHOUT_LOADER_LUA
1021Do not build LUA bindings for the boot loader.
1022.Pp
1023This is a default setting on
1024powerpc/powerpc, powerpc/powerpc64 and powerpc/powerpc64le.
1025.It Va WITH_LOADER_LUA
1026Build LUA bindings for the boot loader.
1027.Pp
1028This is a default setting on
1029amd64/amd64, arm/armv7, arm64/aarch64, i386/i386 and riscv/riscv64.
1030.It Va WITHOUT_LOADER_OFW
1031Disable building of openfirmware bootloader components.
1032.Pp
1033This is a default setting on
1034amd64/amd64, arm/armv7, arm64/aarch64, i386/i386 and riscv/riscv64.
1035.It Va WITH_LOADER_OFW
1036Build openfirmware bootloader components.
1037.Pp
1038This is a default setting on
1039powerpc/powerpc, powerpc/powerpc64 and powerpc/powerpc64le.
1040.It Va WITHOUT_LOADER_UBOOT
1041Disable building of ubldr.
1042.Pp
1043This is a default setting on
1044amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64le and riscv/riscv64.
1045.It Va WITH_LOADER_UBOOT
1046Build ubldr.
1047.Pp
1048This is a default setting on
1049arm/armv7, powerpc/powerpc and powerpc/powerpc64.
1050.It Va WITH_LOADER_VERBOSE
1051Build with extra verbose debugging in the loader.
1052May explode already nearly too large loader over the limit.
1053Use with care.
1054.It Va WITH_LOADER_VERIEXEC
1055Enable building
1056.Xr loader 8
1057with support for verification similar to Verified Exec.
1058.Pp
1059Depends on
1060.Va WITH_BEARSSL .
1061When set, these options are also in effect:
1062.Pp
1063.Bl -inset -compact
1064.It Va WITH_LOADER_EFI_SECUREBOOT
1065(unless
1066.Va WITHOUT_LOADER_EFI_SECUREBOOT
1067is set explicitly)
1068.It Va WITH_LOADER_VERIEXEC_VECTX
1069(unless
1070.Va WITHOUT_LOADER_VERIEXEC_VECTX
1071is set explicitly)
1072.El
1073.It Va WITH_LOADER_VERIEXEC_PASS_MANIFEST
1074Enable building
1075.Xr loader 8
1076with support to pass a verified manifest to the kernel.
1077The kernel has to be built with a module to parse the manifest.
1078.Pp
1079Depends on
1080.Va WITH_LOADER_VERIEXEC .
1081.It Va WITH_LOADER_VERIEXEC_VECTX
1082Enable building
1083.Xr loader 8
1084with support for hashing and verifying kernel and modules as a side effect
1085of loading.
1086.Pp
1087Depends on
1088.Va WITH_LOADER_VERIEXEC .
1089.It Va WITHOUT_LOADER_ZFS
1090Do not build ZFS file system boot loader support.
1091.It Va WITHOUT_LOCALES
1092Do not build localization files; see
1093.Xr locale 1 .
1094.It Va WITHOUT_LOCATE
1095Do not build
1096.Xr locate 1
1097and related programs.
1098.It Va WITHOUT_LPR
1099Do not build
1100.Xr lpr 1
1101and related programs.
1102.It Va WITHOUT_LS_COLORS
1103Build
1104.Xr ls 1
1105without support for colors to distinguish file types.
1106.It Va WITHOUT_MACHDEP_OPTIMIZATIONS
1107Prefer machine-independent non-assembler code in libc and libm.
1108.It Va WITHOUT_MAIL
1109Do not build any mail support (MUA or MTA).
1110When set, it enforces these options:
1111.Pp
1112.Bl -item -compact
1113.It
1114.Va WITHOUT_DMAGENT
1115.It
1116.Va WITHOUT_MAILWRAPPER
1117.It
1118.Va WITHOUT_SENDMAIL
1119.El
1120.It Va WITHOUT_MAILWRAPPER
1121Do not build the
1122.Xr mailwrapper 8
1123MTA selector.
1124.It Va WITHOUT_MAKE
1125Do not install
1126.Xr make 1
1127and related support files.
1128.It Va WITHOUT_MAKE_CHECK_USE_SANDBOX
1129Do not execute
1130.Dq Li "make check"
1131in limited sandbox mode.
1132This option should be paired with
1133.Va WITH_INSTALL_AS_USER
1134if executed as an unprivileged user.
1135See
1136.Xr tests 7
1137for more details.
1138.It Va WITH_MALLOC_PRODUCTION
1139Disable assertions and statistics gathering in
1140.Xr malloc 3 .
1141It also defaults the A and J runtime options to off.
1142.It Va WITHOUT_MAN
1143Do not build manual pages.
1144When set, these options are also in effect:
1145.Pp
1146.Bl -inset -compact
1147.It Va WITHOUT_MAN_UTILS
1148(unless
1149.Va WITH_MAN_UTILS
1150is set explicitly)
1151.El
1152.It Va WITHOUT_MANCOMPRESS
1153Do not install compressed man pages.
1154Only the uncompressed versions will be installed.
1155.It Va WITHOUT_MANSPLITPKG
1156Do not split man pages into their own packages during make package.
1157.It Va WITHOUT_MAN_UTILS
1158Do not build utilities for manual pages,
1159.Xr apropos 1 ,
1160.Xr makewhatis 1 ,
1161.Xr man 1 ,
1162.Xr whatis 1 ,
1163.Xr manctl 8 ,
1164and related support files.
1165.It Va WITH_META_ERROR_TARGET
1166Enable the META_MODE .ERROR target.
1167.Pp
1168This target will copy the meta file of a failed target
1169to
1170.Va ERROR_LOGDIR
1171(default is
1172.Ql ${SRCTOP:H}/error )
1173to help with failure analysis.
1174Depends on
1175.Va WITH_META_MODE .
1176This default when
1177.Va WITH_DIRDEPS_BUILD
1178is set.
1179.Pp
1180This must be set in the environment, make command line, or
1181.Pa /etc/src-env.conf ,
1182not
1183.Pa /etc/src.conf .
1184.It Va WITH_META_MODE
1185Create
1186.Xr make 1
1187meta files when building, which can provide a reliable incremental build when
1188using
1189.Xr filemon 4 .
1190The meta file is created in OBJDIR as
1191.Pa target.meta .
1192These meta files track the command that was executed, its output, and the
1193current directory.
1194The
1195.Xr filemon 4
1196module is required unless
1197.Va NO_FILEMON
1198is defined.
1199When the module is loaded, any files used by the commands executed are
1200tracked as dependencies for the target in its meta file.
1201The target is considered out-of-date and rebuilt if any of these
1202conditions are true compared to the last build:
1203.Bl -bullet -compact
1204.It
1205The command to execute changes.
1206.It
1207The current working directory changes.
1208.It
1209The target's meta file is missing.
1210.It
1211The target's meta file is missing filemon data when filemon is loaded
1212and a previous run did not have it loaded.
1213.It
1214[requires
1215.Xr filemon 4 ]
1216Files read, executed or linked to are newer than the target.
1217.It
1218[requires
1219.Xr filemon 4 ]
1220Files read, written, executed or linked are missing.
1221.El
1222The meta files can also be useful for debugging.
1223.Pp
1224The build hides commands that are executed unless
1225.Va NO_SILENT
1226is defined.
1227Errors cause
1228.Xr make 1
1229to show some of its environment for further debugging.
1230.Pp
1231The build operates as it normally would otherwise.
1232This option originally invoked a different build system but that was renamed
1233to
1234.Va WITH_DIRDEPS_BUILD .
1235.Pp
1236This must be set in the environment, make command line, or
1237.Pa /etc/src-env.conf ,
1238not
1239.Pa /etc/src.conf .
1240.It Va WITHOUT_MLX5TOOL
1241Do not build
1242.Xr mlx5tool 8
1243.Pp
1244This is a default setting on
1245arm/armv7, powerpc/powerpc and riscv/riscv64.
1246.It Va WITH_MLX5TOOL
1247Build
1248.Xr mlx5tool 8
1249.Pp
1250This is a default setting on
1251amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64 and powerpc/powerpc64le.
1252.It Va WITHOUT_NETCAT
1253Do not build
1254.Xr nc 1
1255utility.
1256.It Va WITHOUT_NETGRAPH
1257Do not build applications to support
1258.Xr netgraph 4 .
1259When set, it enforces these options:
1260.Pp
1261.Bl -item -compact
1262.It
1263.Va WITHOUT_BLUETOOTH
1264.El
1265.Pp
1266When set, these options are also in effect:
1267.Pp
1268.Bl -inset -compact
1269.It Va WITHOUT_NETGRAPH_SUPPORT
1270(unless
1271.Va WITH_NETGRAPH_SUPPORT
1272is set explicitly)
1273.El
1274.It Va WITHOUT_NETGRAPH_SUPPORT
1275Build libraries, programs, and kernel modules without netgraph support.
1276.It Va WITHOUT_NETLINK
1277Do not build
1278.Xr genl 1
1279utility.
1280.It Va WITHOUT_NETLINK_SUPPORT
1281Make libraries and programs use rtsock and
1282.Xr sysctl 3
1283interfaces instead of
1284.Xr snl 3 .
1285.It Va WITHOUT_NIS
1286Do not build
1287.Xr NIS 8
1288support and related programs.
1289If set, you might need to adopt your
1290.Xr nsswitch.conf 5
1291and remove
1292.Sq nis
1293entries.
1294.It Va WITHOUT_NLS
1295Do not build NLS catalogs.
1296When set, it enforces these options:
1297.Pp
1298.Bl -item -compact
1299.It
1300.Va WITHOUT_NLS_CATALOGS
1301.El
1302.It Va WITHOUT_NLS_CATALOGS
1303Do not build NLS catalog support for
1304.Xr csh 1 .
1305.It Va WITHOUT_NS_CACHING
1306Disable name caching in the
1307.Pa nsswitch
1308subsystem.
1309The generic caching daemon,
1310.Xr nscd 8 ,
1311will not be built either if this option is set.
1312.It Va WITHOUT_NTP
1313Do not build
1314.Xr ntpd 8
1315and related programs.
1316.It Va WITHOUT_NVME
1317Do not build nvme related tools and kernel modules.
1318.Pp
1319This is a default setting on
1320arm/armv7, powerpc/powerpc and riscv/riscv64.
1321.It Va WITH_NVME
1322Build nvme related tools and kernel modules.
1323.Pp
1324This is a default setting on
1325amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64 and powerpc/powerpc64le.
1326.It Va WITHOUT_OFED
1327Do not build the
1328.Dq "OpenFabrics Enterprise Distribution"
1329InfiniBand software stack, including kernel modules and userspace libraries.
1330.Pp
1331This is a default setting on
1332arm/armv7.
1333When set, it enforces these options:
1334.Pp
1335.Bl -item -compact
1336.It
1337.Va WITHOUT_OFED_EXTRA
1338.El
1339.It Va WITH_OFED
1340Build the
1341.Dq "OpenFabrics Enterprise Distribution"
1342InfiniBand software stack, including kernel modules and userspace libraries.
1343.Pp
1344This is a default setting on
1345amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
1346.It Va WITH_OFED_EXTRA
1347Build the non-essential components of the
1348.Dq "OpenFabrics Enterprise Distribution"
1349Infiniband software stack, mostly examples.
1350.It Va WITH_OPENLDAP
1351Enable building LDAP support for kerberos using an openldap client from ports.
1352.It Va WITHOUT_OPENMP
1353Do not build LLVM's OpenMP runtime.
1354.Pp
1355This is a default setting on
1356arm/armv7 and powerpc/powerpc.
1357.It Va WITH_OPENMP
1358Build LLVM's OpenMP runtime.
1359.Pp
1360This is a default setting on
1361amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
1362.It Va WITHOUT_OPENSSH
1363Do not build OpenSSH.
1364.It Va WITHOUT_OPENSSL
1365Do not build OpenSSL.
1366When set, it enforces these options:
1367.Pp
1368.Bl -item -compact
1369.It
1370.Va WITHOUT_DMAGENT
1371.It
1372.Va WITHOUT_KERBEROS
1373.It
1374.Va WITHOUT_KERBEROS_SUPPORT
1375.It
1376.Va WITHOUT_LDNS
1377.It
1378.Va WITHOUT_LDNS_UTILS
1379.It
1380.Va WITHOUT_LOADER_ZFS
1381.It
1382.Va WITHOUT_OPENSSH
1383.It
1384.Va WITHOUT_OPENSSL_KTLS
1385.It
1386.Va WITHOUT_PKGBOOTSTRAP
1387.It
1388.Va WITHOUT_UNBOUND
1389.It
1390.Va WITHOUT_ZFS
1391.El
1392.Pp
1393When set, these options are also in effect:
1394.Pp
1395.Bl -inset -compact
1396.It Va WITHOUT_GSSAPI
1397(unless
1398.Va WITH_GSSAPI
1399is set explicitly)
1400.El
1401.It Va WITHOUT_OPENSSL_KTLS
1402Do not include kernel TLS support in OpenSSL.
1403.Pp
1404This is a default setting on
1405arm/armv7, i386/i386, powerpc/powerpc and riscv/riscv64.
1406.It Va WITH_OPENSSL_KTLS
1407Include kernel TLS support in OpenSSL.
1408.Pp
1409This is a default setting on
1410amd64/amd64, arm64/aarch64, powerpc/powerpc64 and powerpc/powerpc64le.
1411.It Va WITHOUT_PAM
1412Do not build PAM library and modules.
1413.Bf -symbolic
1414This option is deprecated and does nothing.
1415.Ef
1416When set, these options are also in effect:
1417.Pp
1418.Bl -inset -compact
1419.It Va WITHOUT_PAM_SUPPORT
1420(unless
1421.Va WITH_PAM_SUPPORT
1422is set explicitly)
1423.El
1424.It Va WITHOUT_PAM_SUPPORT
1425Build some programs without PAM support, particularly
1426.Xr ftpd 8
1427and
1428.Xr ppp 8 .
1429.It Va WITHOUT_PF
1430Do not build PF firewall package.
1431When set, it enforces these options:
1432.Pp
1433.Bl -item -compact
1434.It
1435.Va WITHOUT_AUTHPF
1436.El
1437.It Va WITHOUT_PIE
1438Do not build dynamically linked binaries as
1439Position-Independent Executable (PIE).
1440.Pp
1441This is a default setting on
1442arm/armv7, i386/i386 and powerpc/powerpc.
1443.It Va WITH_PIE
1444Build dynamically linked binaries as
1445Position-Independent Executable (PIE).
1446.Pp
1447This is a default setting on
1448amd64/amd64, arm64/aarch64, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
1449.It Va WITHOUT_PKGBOOTSTRAP
1450Do not build
1451.Xr pkg 7
1452bootstrap tool.
1453.It Va WITHOUT_PMC
1454Do not build
1455.Xr pmccontrol 8
1456and related programs.
1457.It Va WITHOUT_PPP
1458Do not build
1459.Xr ppp 8
1460and related programs.
1461.It Va WITH_PROFILE
1462Build profiled libraries for use with
1463.Xr gprof 8 .
1464This option is deprecated and may not be present in a future version of
1465.Fx .
1466.It Va WITHOUT_PTHREADS_ASSERTIONS
1467Disable debugging assertions in pthreads library.
1468.It Va WITHOUT_QUOTAS
1469Do not build
1470.Xr quota 1
1471and related programs.
1472.It Va WITHOUT_RADIUS_SUPPORT
1473Do not build radius support into various applications, like
1474.Xr pam_radius 8
1475and
1476.Xr ppp 8 .
1477.It Va WITH_RATELIMIT
1478Build the system with rate limit support.
1479.Pp
1480This makes
1481.Dv SO_MAX_PACING_RATE
1482effective in
1483.Xr getsockopt 2 ,
1484and
1485.Ar txrlimit
1486support in
1487.Xr ifconfig 8 ,
1488by proxy.
1489.It Va WITHOUT_RBOOTD
1490Do not build or install
1491.Xr rbootd 8 .
1492.It Va WITHOUT_RELRO
1493Do not apply the Relocation Read-Only (RELRO) vulnerability mitigation.
1494See also the
1495.Va BIND_NOW
1496option.
1497.It Va WITH_REPRODUCIBLE_BUILD
1498Exclude build metadata (such as the build time, user, or host)
1499from the kernel, boot loaders, and uname output, so that builds produce
1500bit-for-bit identical output.
1501.It Va WITHOUT_RESCUE
1502Do not build
1503.Xr rescue 8 .
1504.It Va WITH_RETPOLINE
1505Build the base system with the retpoline speculative execution
1506vulnerability mitigation for CVE-2017-5715.
1507.It Va WITHOUT_ROUTED
1508Do not build
1509.Xr routed 8
1510utility.
1511.It Va WITH_RPCBIND_WARMSTART_SUPPORT
1512Build
1513.Xr rpcbind 8
1514with warmstart support.
1515.It Va WITHOUT_SCTP_SUPPORT
1516Disable support in the kernel for the
1517.Xr sctp 4
1518Stream Control Transmission Protocol
1519loadable kernel module.
1520.It Va WITHOUT_SENDMAIL
1521Do not build
1522.Xr sendmail 8
1523and related programs.
1524.It Va WITHOUT_SERVICESDB
1525Do not install
1526.Pa /var/db/services.db .
1527.It Va WITHOUT_SETUID_LOGIN
1528Set this to disable the installation of
1529.Xr login 1
1530as a set-user-ID root program.
1531.It Va WITHOUT_SHAREDOCS
1532Do not build the
1533.Bx 4.4
1534legacy docs.
1535.It Va WITH_SORT_THREADS
1536Enable threads in
1537.Xr sort 1 .
1538.It Va WITHOUT_SOURCELESS
1539Do not build kernel modules that include sourceless code (either microcode or native code for host CPU).
1540When set, it enforces these options:
1541.Pp
1542.Bl -item -compact
1543.It
1544.Va WITHOUT_SOURCELESS_HOST
1545.It
1546.Va WITHOUT_SOURCELESS_UCODE
1547.El
1548.It Va WITHOUT_SOURCELESS_HOST
1549Do not build kernel modules that include sourceless native code for host CPU.
1550.It Va WITHOUT_SOURCELESS_UCODE
1551Do not build kernel modules that include sourceless microcode.
1552.It Va WITHOUT_SPLIT_KERNEL_DEBUG
1553Do not build standalone kernel debug files.
1554Debug data (if enabled by the kernel configuration file)
1555will be included in the kernel and modules.
1556When set, it enforces these options:
1557.Pp
1558.Bl -item -compact
1559.It
1560.Va WITHOUT_KERNEL_SYMBOLS
1561.El
1562.It Va WITHOUT_SSP
1563Do not build world with stack smashing protection.
1564.It Va WITH_STAGING
1565Enable staging of files to a stage tree.
1566This can be best thought of as auto-install to
1567.Va DESTDIR
1568with some extra meta data to ensure dependencies can be tracked.
1569Depends on
1570.Va WITH_DIRDEPS_BUILD .
1571When set, these options are also in effect:
1572.Pp
1573.Bl -inset -compact
1574.It Va WITH_STAGING_MAN
1575(unless
1576.Va WITHOUT_STAGING_MAN
1577is set explicitly)
1578.It Va WITH_STAGING_PROG
1579(unless
1580.Va WITHOUT_STAGING_PROG
1581is set explicitly)
1582.El
1583.Pp
1584This must be set in the environment, make command line, or
1585.Pa /etc/src-env.conf ,
1586not
1587.Pa /etc/src.conf .
1588.It Va WITH_STAGING_MAN
1589Enable staging of man pages to stage tree.
1590.It Va WITH_STAGING_PROG
1591Enable staging of PROGs to stage tree.
1592.It Va WITH_STALE_STAGED
1593Check staged files are not stale.
1594.It Va WITHOUT_STATS
1595Neither build nor install
1596.Lb libstats
1597and dependent binaries.
1598.It Va WITHOUT_SYSCONS
1599Do not build
1600.Xr syscons 4
1601support files such as keyboard maps, fonts, and screen output maps.
1602.It Va WITH_SYSROOT
1603Enable use of sysroot during build.
1604Depends on
1605.Va WITH_DIRDEPS_BUILD .
1606.Pp
1607This must be set in the environment, make command line, or
1608.Pa /etc/src-env.conf ,
1609not
1610.Pa /etc/src.conf .
1611.It Va WITHOUT_SYSTEM_COMPILER
1612Do not opportunistically skip building a cross-compiler during the
1613bootstrap phase of the build.
1614Normally, if the currently installed compiler matches the planned bootstrap
1615compiler type and revision, then it will not be built.
1616This does not prevent a compiler from being built for installation though,
1617only for building one for the build itself.
1618The
1619.Va WITHOUT_CLANG
1620option controls that.
1621.It Va WITHOUT_SYSTEM_LINKER
1622Do not opportunistically skip building a cross-linker during the
1623bootstrap phase of the build.
1624Normally, if the currently installed linker matches the planned bootstrap
1625linker type and revision, then it will not be built.
1626This does not prevent a linker from being built for installation though,
1627only for building one for the build itself.
1628The
1629.Va WITHOUT_LLD
1630option controls that.
1631.Pp
1632This option is only relevant when
1633.Va WITH_LLD_BOOTSTRAP
1634is set.
1635.It Va WITHOUT_TALK
1636Do not build or install
1637.Xr talk 1
1638and
1639.Xr talkd 8 .
1640.It Va WITHOUT_TCP_WRAPPERS
1641Do not build or install
1642.Xr tcpd 8 ,
1643and related utilities.
1644.It Va WITHOUT_TCSH
1645Do not build and install
1646.Pa /bin/csh
1647(which is
1648.Xr tcsh 1 ) .
1649.It Va WITHOUT_TELNET
1650Do not build
1651.Xr telnet 1
1652and related programs.
1653.It Va WITHOUT_TESTS
1654Do not build nor install the
1655.Fx
1656Test Suite in
1657.Pa /usr/tests/ .
1658See
1659.Xr tests 7
1660for more details.
1661This also disables the build of all test-related dependencies, including ATF.
1662When set, it enforces these options:
1663.Pp
1664.Bl -item -compact
1665.It
1666.Va WITHOUT_DTRACE_TESTS
1667.El
1668.Pp
1669When set, these options are also in effect:
1670.Pp
1671.Bl -inset -compact
1672.It Va WITHOUT_GOOGLETEST
1673(unless
1674.Va WITH_GOOGLETEST
1675is set explicitly)
1676.It Va WITHOUT_TESTS_SUPPORT
1677(unless
1678.Va WITH_TESTS_SUPPORT
1679is set explicitly)
1680.El
1681.It Va WITHOUT_TESTS_SUPPORT
1682Disable the build of all test-related dependencies, including ATF.
1683When set, it enforces these options:
1684.Pp
1685.Bl -item -compact
1686.It
1687.Va WITHOUT_GOOGLETEST
1688.El
1689.It Va WITHOUT_TEXTPROC
1690Do not build
1691programs used for text processing.
1692.It Va WITHOUT_TFTP
1693Do not build or install
1694.Xr tftp 1
1695and
1696.Xr tftpd 8 .
1697.It Va WITHOUT_TOOLCHAIN
1698Do not install
1699programs used for program development,
1700compilers, debuggers etc.
1701When set, it enforces these options:
1702.Pp
1703.Bl -item -compact
1704.It
1705.Va WITHOUT_CLANG
1706.It
1707.Va WITHOUT_CLANG_EXTRAS
1708.It
1709.Va WITHOUT_CLANG_FORMAT
1710.It
1711.Va WITHOUT_CLANG_FULL
1712.It
1713.Va WITHOUT_LLD
1714.It
1715.Va WITHOUT_LLDB
1716.It
1717.Va WITHOUT_LLVM_COV
1718.El
1719.It Va WITH_UBSAN
1720Build the base system with Undefined Behavior Sanitizer (UBSan) to detect
1721various kinds of undefined behavior at runtime.
1722Requires that Clang be used as the base system compiler
1723and that the runtime support library is available
1724.It Va WITHOUT_UNBOUND
1725Do not build
1726.Xr unbound 8
1727and related programs.
1728.It Va WITHOUT_UNIFIED_OBJDIR
1729Use the historical object directory format for
1730.Xr build 7
1731targets.
1732For native-builds and builds done directly in sub-directories the format of
1733.Pa ${MAKEOBJDIRPREFIX}/${.CURDIR}
1734is used,
1735while for cross-builds
1736.Pa ${MAKEOBJDIRPREFIX}/${TARGET}.${TARGET_ARCH}/${.CURDIR}
1737is used.
1738.Pp
1739This option is transitional and will be removed in a future version of
1740.Fx ,
1741at which time
1742.Va WITH_UNIFIED_OBJDIR
1743will be enabled permanently.
1744.Pp
1745This must be set in the environment, make command line, or
1746.Pa /etc/src-env.conf ,
1747not
1748.Pa /etc/src.conf .
1749.It Va WITHOUT_USB
1750Do not build USB-related programs and libraries.
1751.It Va WITHOUT_USB_GADGET_EXAMPLES
1752Do not build USB gadget kernel modules.
1753.It Va WITHOUT_UTMPX
1754Do not build user accounting tools such as
1755.Xr last 1 ,
1756.Xr users 1 ,
1757.Xr who 1 ,
1758.Xr ac 8 ,
1759.Xr lastlogin 8
1760and
1761.Xr utx 8 .
1762.It Va WITH_VERIEXEC
1763Enable building
1764.Xr veriexec 8
1765which loads the contents of verified manifests into the kernel
1766for use by
1767.Xr mac_veriexec 4
1768.Pp
1769Depends on
1770.Va WITH_BEARSSL .
1771.It Va WITHOUT_VI
1772Do not build and install vi, view, ex and related programs.
1773.It Va WITHOUT_VT
1774Do not build
1775.Xr vt 4
1776support files (fonts and keymaps).
1777.It Va WITHOUT_WARNS
1778Set this to not add warning flags to the compiler invocations.
1779Useful as a temporary workaround when code enters the tree
1780which triggers warnings in environments that differ from the
1781original developer.
1782.It Va WITHOUT_WERROR
1783Set this to not treat compiler warnings as errors.
1784Useful as a temporary workaround when working on fixing compiler warnings.
1785When set, warnings are still printed in the build log but do not fail the build.
1786.It Va WITHOUT_WIRELESS
1787Do not build programs used for 802.11 wireless networks; especially
1788.Xr wpa_supplicant 8
1789and
1790.Xr hostapd 8 .
1791When set, these options are also in effect:
1792.Pp
1793.Bl -inset -compact
1794.It Va WITHOUT_WIRELESS_SUPPORT
1795(unless
1796.Va WITH_WIRELESS_SUPPORT
1797is set explicitly)
1798.El
1799.It Va WITHOUT_WIRELESS_SUPPORT
1800Build libraries, programs, and kernel modules without
1801802.11 wireless support.
1802.It Va WITHOUT_WPA_SUPPLICANT_EAPOL
1803Build
1804.Xr wpa_supplicant 8
1805without support for the IEEE 802.1X protocol and without
1806support for EAP-PEAP, EAP-TLS, EAP-LEAP, and EAP-TTLS
1807protocols (usable only via 802.1X).
1808.It Va WITHOUT_ZFS
1809Do not build the ZFS file system kernel module, libraries such as
1810.Xr libbe 3 ,
1811and user commands such as
1812.Xr zpool 8
1813or
1814.Xr zfs 8 .
1815Also disable ZFS support in utilities and libraries which implement
1816ZFS-specific functionality.
1817.It Va WITHOUT_ZONEINFO
1818Do not build the timezone database.
1819When set, it enforces these options:
1820.Pp
1821.Bl -item -compact
1822.It
1823.Va WITHOUT_ZONEINFO_LEAPSECONDS_SUPPORT
1824.El
1825.It Va WITH_ZONEINFO_LEAPSECONDS_SUPPORT
1826Build leapsecond information in to the timezone database.
1827.El
1828.Pp
1829The following options accept a single value from a list of valid values.
1830.Bl -tag -width indent
1831.It Va INIT_ALL
1832Control default initialization of stack variables in C and C++ code.
1833Options other than
1834.Li none
1835require the Clang compiler or GCC 12.0 or later.
1836The default value is
1837.Li none .
1838Valid values are:
1839.Bl -tag -width indent
1840.It Li none
1841Do not initialize stack variables (standard C/C++ behavior).
1842.It Li pattern
1843Build the base system or kernel with stack variables initialized to
1844.Pq compiler defined
1845debugging patterns on function entry.
1846.It Li zero
1847Build the base system or kernel with stack variables initialized
1848to zero on function entry.
1849This value is converted to
1850.Li none
1851for amd64 kernel builds due to incompatability with ifunc memset.
1852.El
1853.It Va LIBC_MALLOC
1854Specify the
1855.Xr malloc 3
1856implementation used by libc.
1857The default value is
1858.Li jemalloc .
1859Valid values are:
1860.Bl -tag -width indent
1861.It Li jemalloc
1862.El
1863.Pp
1864Other implementations are expected in the future in both
1865.Fx
1866and downstream consumers.
1867.El
1868.Sh FILES
1869.Bl -tag -compact -width Pa
1870.It Pa /etc/src.conf
1871.It Pa /etc/src-env.conf
1872.It Pa /usr/share/mk/bsd.own.mk
1873.El
1874.Sh SEE ALSO
1875.Xr make 1 ,
1876.Xr make.conf 5 ,
1877.Xr build 7 ,
1878.Xr ports 7
1879.Sh HISTORY
1880The
1881.Nm
1882file appeared in
1883.Fx 7.0 .
1884.Sh AUTHORS
1885This manual page was autogenerated by
1886.An tools/build/options/makeman .
1887