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