xref: /freebsd/share/man/man5/src.conf.5 (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
1.\" DO NOT EDIT-- this file is @generated by tools/build/options/makeman.
2.Dd November 22, 2024
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, powerpc/powerpc64le and riscv/riscv64.
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 and arm64/aarch64.
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 WITH_LLVM_BINUTILS
937Install LLVM's binutils (without an llvm- prefix),
938instead of ELF Tool Chain's tools.
939This includes
940.Xr addr2line 1 ,
941.Xr ar 1 ,
942.Xr nm 1 ,
943.Xr objcopy 1 ,
944.Xr ranlib 1 ,
945.Xr readelf 1 ,
946.Xr size 1 ,
947and
948.Xr strip 1 .
949Regardless of this setting, LLVM tools are used for
950.Xr c++filt 1
951and
952.Xr objdump 1 .
953.Xr strings 1
954is always provided by ELF Tool Chain.
955.It Va WITHOUT_LLVM_COV
956Do not build the
957.Xr llvm-cov 1
958tool.
959.It Va WITHOUT_LLVM_CXXFILT
960Install ELF Tool Chain's cxxfilt as c++filt, instead of LLVM's llvm-cxxfilt.
961.It Va WITH_LLVM_FULL_DEBUGINFO
962Generate full debug information for LLVM libraries and tools, which uses
963more disk space and build resources, but allows for easier debugging.
964.It Va WITHOUT_LLVM_TARGET_AARCH64
965Do not build LLVM target support for AArch64.
966The
967.Va LLVM_TARGET_ALL
968option should be used rather than this in most cases.
969.It Va WITHOUT_LLVM_TARGET_ALL
970Only build the required LLVM target support.
971This option is preferred to specific target support options.
972When set, these options are also in effect:
973.Pp
974.Bl -inset -compact
975.It Va WITHOUT_LLVM_TARGET_AARCH64
976(unless
977.Va WITH_LLVM_TARGET_AARCH64
978is set explicitly)
979.It Va WITHOUT_LLVM_TARGET_ARM
980(unless
981.Va WITH_LLVM_TARGET_ARM
982is set explicitly)
983.It Va WITHOUT_LLVM_TARGET_POWERPC
984(unless
985.Va WITH_LLVM_TARGET_POWERPC
986is set explicitly)
987.It Va WITHOUT_LLVM_TARGET_RISCV
988(unless
989.Va WITH_LLVM_TARGET_RISCV
990is set explicitly)
991.El
992.It Va WITHOUT_LLVM_TARGET_ARM
993Do not build LLVM target support for ARM.
994The
995.Va LLVM_TARGET_ALL
996option should be used rather than this in most cases.
997.It Va WITH_LLVM_TARGET_BPF
998Build LLVM target support for BPF.
999The
1000.Va LLVM_TARGET_ALL
1001option should be used rather than this in most cases.
1002.It Va WITH_LLVM_TARGET_MIPS
1003Build LLVM target support for MIPS.
1004The
1005.Va LLVM_TARGET_ALL
1006option should be used rather than this in most cases.
1007.It Va WITHOUT_LLVM_TARGET_POWERPC
1008Do not build LLVM target support for PowerPC.
1009The
1010.Va LLVM_TARGET_ALL
1011option should be used rather than this in most cases.
1012.It Va WITHOUT_LLVM_TARGET_RISCV
1013Do not build LLVM target support for RISC-V.
1014The
1015.Va LLVM_TARGET_ALL
1016option should be used rather than this in most cases.
1017.It Va WITHOUT_LLVM_TARGET_X86
1018Do not build LLVM target support for X86.
1019The
1020.Va LLVM_TARGET_ALL
1021option should be used rather than this in most cases.
1022.It Va WITHOUT_LOADER_BIOS_TEXTONLY
1023Include graphics, font and video mode support in the i386 and amd64 BIOS
1024boot loader.
1025.It Va WITH_LOADER_EFI_SECUREBOOT
1026Enable building
1027.Xr loader 8
1028with support for verification based on certificates obtained from UEFI.
1029.It Va WITHOUT_LOADER_GELI
1030Disable inclusion of GELI crypto support in the boot chain binaries.
1031.Pp
1032This is a default setting on
1033powerpc/powerpc, powerpc/powerpc64 and powerpc/powerpc64le.
1034.It Va WITH_LOADER_GELI
1035Build GELI bootloader support.
1036.Pp
1037This is a default setting on
1038amd64/amd64, arm/armv7, arm64/aarch64, i386/i386 and riscv/riscv64.
1039.It Va WITHOUT_LOADER_IA32
1040Do not build the 32-bit UEFI loader.
1041.Pp
1042This is a default setting on
1043arm/armv7, arm64/aarch64, i386/i386, powerpc/powerpc, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
1044.It Va WITH_LOADER_IA32
1045Build the 32-bit UEFI loader.
1046.Pp
1047This is a default setting on
1048amd64/amd64.
1049.It Va WITHOUT_LOADER_KBOOT
1050Do not build kboot, a linuxboot environment loader
1051.Pp
1052This is a default setting on
1053arm/armv7, i386/i386, powerpc/powerpc, powerpc/powerpc64le and riscv/riscv64.
1054.It Va WITH_LOADER_KBOOT
1055Build kboot, a linuxboot environment loader
1056.Pp
1057This is a default setting on
1058amd64/amd64, arm64/aarch64 and powerpc/powerpc64.
1059.It Va WITHOUT_LOADER_LUA
1060Do not build LUA bindings for the boot loader.
1061.Pp
1062This is a default setting on
1063powerpc/powerpc, powerpc/powerpc64 and powerpc/powerpc64le.
1064.It Va WITH_LOADER_LUA
1065Build LUA bindings for the boot loader.
1066.Pp
1067This is a default setting on
1068amd64/amd64, arm/armv7, arm64/aarch64, i386/i386 and riscv/riscv64.
1069.It Va WITHOUT_LOADER_OFW
1070Disable building of openfirmware bootloader components.
1071.Pp
1072This is a default setting on
1073amd64/amd64, arm/armv7, arm64/aarch64, i386/i386 and riscv/riscv64.
1074.It Va WITH_LOADER_OFW
1075Build openfirmware bootloader components.
1076.Pp
1077This is a default setting on
1078powerpc/powerpc, powerpc/powerpc64 and powerpc/powerpc64le.
1079.It Va WITHOUT_LOADER_PXEBOOT
1080Do not build pxeboot on i386/amd64.
1081When the pxeboot is too large, or unneeded, it may be disabled with this option.
1082See
1083.Va WITH_LOADER_PXEBOOT
1084for how to adjust the defaults when you need both a larger
1085.Pa /boot/loader
1086and
1087.Pa /boot/pxeboot
1088.Pp
1089This option only has an effect on x86.
1090.It Va WITHOUT_LOADER_UBOOT
1091Disable building of ubldr.
1092.Pp
1093This is a default setting on
1094amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64le and riscv/riscv64.
1095.It Va WITH_LOADER_UBOOT
1096Build ubldr.
1097.Pp
1098This is a default setting on
1099arm/armv7, powerpc/powerpc and powerpc/powerpc64.
1100.It Va WITH_LOADER_VERBOSE
1101Build with extra verbose debugging in the loader.
1102May explode already nearly too large loader over the limit.
1103Use with care.
1104.It Va WITH_LOADER_VERIEXEC
1105Enable building
1106.Xr loader 8
1107with support for verification similar to Verified Exec.
1108.Pp
1109Depends on
1110.Va WITH_BEARSSL .
1111May require a larger
1112.Va LOADERSIZE .
1113When set, these options are also in effect:
1114.Pp
1115.Bl -inset -compact
1116.It Va WITH_LOADER_EFI_SECUREBOOT
1117(unless
1118.Va WITHOUT_LOADER_EFI_SECUREBOOT
1119is set explicitly)
1120.It Va WITH_LOADER_VERIEXEC_VECTX
1121(unless
1122.Va WITHOUT_LOADER_VERIEXEC_VECTX
1123is set explicitly)
1124.El
1125.It Va WITH_LOADER_VERIEXEC_PASS_MANIFEST
1126Enable building
1127.Xr loader 8
1128with support to pass a verified manifest to the kernel.
1129The kernel has to be built with a module to parse the manifest.
1130.Pp
1131Depends on
1132.Va WITH_LOADER_VERIEXEC .
1133.It Va WITH_LOADER_VERIEXEC_VECTX
1134Enable building
1135.Xr loader 8
1136with support for hashing and verifying kernel and modules as a side effect
1137of loading.
1138.Pp
1139Depends on
1140.Va WITH_LOADER_VERIEXEC .
1141.It Va WITHOUT_LOADER_ZFS
1142Do not build ZFS file system boot loader support.
1143.It Va WITHOUT_LOCALES
1144Do not build localization files; see
1145.Xr locale 1 .
1146.It Va WITHOUT_LOCATE
1147Do not build
1148.Xr locate 1
1149and related programs.
1150.It Va WITHOUT_LPR
1151Do not build
1152.Xr lpr 1
1153and related programs.
1154.It Va WITHOUT_LS_COLORS
1155Build
1156.Xr ls 1
1157without support for colors to distinguish file types.
1158.It Va WITHOUT_MACHDEP_OPTIMIZATIONS
1159Prefer machine-independent non-assembler code in libc and libm.
1160.It Va WITHOUT_MAIL
1161Do not build any mail support (MUA or MTA).
1162When set, it enforces these options:
1163.Pp
1164.Bl -item -compact
1165.It
1166.Va WITHOUT_DMAGENT
1167.It
1168.Va WITHOUT_MAILWRAPPER
1169.It
1170.Va WITHOUT_SENDMAIL
1171.El
1172.It Va WITHOUT_MAILWRAPPER
1173Do not build the
1174.Xr mailwrapper 8
1175MTA selector.
1176.It Va WITHOUT_MAKE
1177Do not install
1178.Xr make 1
1179and related support files.
1180.It Va WITHOUT_MAKE_CHECK_USE_SANDBOX
1181Do not execute
1182.Dq Li "make check"
1183in limited sandbox mode.
1184This option should be paired with
1185.Va WITH_INSTALL_AS_USER
1186if executed as an unprivileged user.
1187See
1188.Xr tests 7
1189for more details.
1190.It Va WITH_MALLOC_PRODUCTION
1191Disable assertions and statistics gathering in
1192.Xr malloc 3 .
1193It also defaults the A and J runtime options to off.
1194.It Va WITHOUT_MAN
1195Do not build manual pages.
1196When set, these options are also in effect:
1197.Pp
1198.Bl -inset -compact
1199.It Va WITHOUT_MAN_UTILS
1200(unless
1201.Va WITH_MAN_UTILS
1202is set explicitly)
1203.El
1204.It Va WITHOUT_MANCOMPRESS
1205Do not install compressed man pages.
1206Only the uncompressed versions will be installed.
1207.It Va WITHOUT_MANSPLITPKG
1208Do not split man pages into their own packages during make package.
1209.It Va WITHOUT_MAN_UTILS
1210Do not build utilities for manual pages,
1211.Xr apropos 1 ,
1212.Xr makewhatis 1 ,
1213.Xr man 1 ,
1214.Xr whatis 1 ,
1215.Xr manctl 8 ,
1216and related support files.
1217.It Va WITH_META_ERROR_TARGET
1218Enable the META_MODE .ERROR target.
1219.Pp
1220This target will copy the meta file of a failed target
1221to
1222.Va ERROR_LOGDIR
1223(default is
1224.Ql ${SRCTOP:H}/error )
1225to help with failure analysis.
1226Depends on
1227.Va WITH_META_MODE .
1228This default when
1229.Va WITH_DIRDEPS_BUILD
1230is set.
1231.Pp
1232This must be set in the environment, make command line, or
1233.Pa /etc/src-env.conf ,
1234not
1235.Pa /etc/src.conf .
1236.It Va WITH_META_MODE
1237Create
1238.Xr make 1
1239meta files when building, which can provide a reliable incremental build when
1240using
1241.Xr filemon 4 .
1242The meta file is created in OBJDIR as
1243.Pa target.meta .
1244These meta files track the command that was executed, its output, and the
1245current directory.
1246The
1247.Xr filemon 4
1248module is required unless
1249.Va NO_FILEMON
1250is defined.
1251When the module is loaded, any files used by the commands executed are
1252tracked as dependencies for the target in its meta file.
1253The target is considered out-of-date and rebuilt if any of these
1254conditions are true compared to the last build:
1255.Bl -bullet -compact
1256.It
1257The command to execute changes.
1258.It
1259The current working directory changes.
1260.It
1261The target's meta file is missing.
1262.It
1263The target's meta file is missing filemon data when filemon is loaded
1264and a previous run did not have it loaded.
1265.It
1266[requires
1267.Xr filemon 4 ]
1268Files read, executed or linked to are newer than the target.
1269.It
1270[requires
1271.Xr filemon 4 ]
1272Files read, written, executed or linked are missing.
1273.El
1274The meta files can also be useful for debugging.
1275.Pp
1276The build hides commands that are executed unless
1277.Va NO_SILENT
1278is defined.
1279Errors cause
1280.Xr make 1
1281to show some of its environment for further debugging.
1282.Pp
1283The build operates as it normally would otherwise.
1284This option originally invoked a different build system but that was renamed
1285to
1286.Va WITH_DIRDEPS_BUILD .
1287.Pp
1288This must be set in the environment, make command line, or
1289.Pa /etc/src-env.conf ,
1290not
1291.Pa /etc/src.conf .
1292.It Va WITHOUT_MLX5TOOL
1293Do not build
1294.Xr mlx5tool 8
1295.Pp
1296This is a default setting on
1297arm/armv7, powerpc/powerpc and riscv/riscv64.
1298.It Va WITH_MLX5TOOL
1299Build
1300.Xr mlx5tool 8
1301.Pp
1302This is a default setting on
1303amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64 and powerpc/powerpc64le.
1304.It Va WITHOUT_NETCAT
1305Do not build
1306.Xr nc 1
1307utility.
1308.It Va WITHOUT_NETGRAPH
1309Do not build applications to support
1310.Xr netgraph 4 .
1311When set, it enforces these options:
1312.Pp
1313.Bl -item -compact
1314.It
1315.Va WITHOUT_BLUETOOTH
1316.El
1317.Pp
1318When set, these options are also in effect:
1319.Pp
1320.Bl -inset -compact
1321.It Va WITHOUT_NETGRAPH_SUPPORT
1322(unless
1323.Va WITH_NETGRAPH_SUPPORT
1324is set explicitly)
1325.El
1326.It Va WITHOUT_NETGRAPH_SUPPORT
1327Build libraries, programs, and kernel modules without netgraph support.
1328.It Va WITHOUT_NETLINK
1329Do not build
1330.Xr genl 1
1331utility.
1332.It Va WITHOUT_NETLINK_SUPPORT
1333Make libraries and programs use rtsock and
1334.Xr sysctl 3
1335interfaces instead of
1336.Xr snl 3 .
1337.It Va WITHOUT_NIS
1338Do not build
1339.Xr NIS 8
1340support and related programs.
1341If set, you might need to adopt your
1342.Xr nsswitch.conf 5
1343and remove
1344.Sq nis
1345entries.
1346.It Va WITHOUT_NLS
1347Do not build NLS catalogs.
1348When set, it enforces these options:
1349.Pp
1350.Bl -item -compact
1351.It
1352.Va WITHOUT_NLS_CATALOGS
1353.El
1354.It Va WITHOUT_NLS_CATALOGS
1355Do not build NLS catalog support for
1356.Xr csh 1 .
1357.It Va WITHOUT_NS_CACHING
1358Disable name caching in the
1359.Pa nsswitch
1360subsystem.
1361The generic caching daemon,
1362.Xr nscd 8 ,
1363will not be built either if this option is set.
1364.It Va WITHOUT_NTP
1365Do not build
1366.Xr ntpd 8
1367and related programs.
1368.It Va WITHOUT_NUAGEINIT
1369Do not install the limited cloud init support scripts.
1370.It Va WITHOUT_OFED
1371Do not build the
1372.Dq "OpenFabrics Enterprise Distribution"
1373InfiniBand software stack, including kernel modules and userspace libraries.
1374.Pp
1375This is a default setting on
1376arm/armv7.
1377When set, it enforces these options:
1378.Pp
1379.Bl -item -compact
1380.It
1381.Va WITHOUT_OFED_EXTRA
1382.El
1383.It Va WITH_OFED
1384Build the
1385.Dq "OpenFabrics Enterprise Distribution"
1386InfiniBand software stack, including kernel modules and userspace libraries.
1387.Pp
1388This is a default setting on
1389amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
1390.It Va WITH_OFED_EXTRA
1391Build the non-essential components of the
1392.Dq "OpenFabrics Enterprise Distribution"
1393Infiniband software stack, mostly examples.
1394.It Va WITH_OPENLDAP
1395Enable building LDAP support for kerberos using an openldap client from ports.
1396.It Va WITHOUT_OPENMP
1397Do not build LLVM's OpenMP runtime.
1398.Pp
1399This is a default setting on
1400arm/armv7 and powerpc/powerpc.
1401.It Va WITH_OPENMP
1402Build LLVM's OpenMP runtime.
1403.Pp
1404This is a default setting on
1405amd64/amd64, arm64/aarch64, i386/i386, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
1406.It Va WITHOUT_OPENSSH
1407Do not build OpenSSH.
1408.It Va WITHOUT_OPENSSL
1409Do not build OpenSSL.
1410When set, it enforces these options:
1411.Pp
1412.Bl -item -compact
1413.It
1414.Va WITHOUT_DMAGENT
1415.It
1416.Va WITHOUT_KERBEROS
1417.It
1418.Va WITHOUT_KERBEROS_SUPPORT
1419.It
1420.Va WITHOUT_LDNS
1421.It
1422.Va WITHOUT_LDNS_UTILS
1423.It
1424.Va WITHOUT_LOADER_ZFS
1425.It
1426.Va WITHOUT_OPENSSH
1427.It
1428.Va WITHOUT_OPENSSL_KTLS
1429.It
1430.Va WITHOUT_PKGBOOTSTRAP
1431.It
1432.Va WITHOUT_UNBOUND
1433.It
1434.Va WITHOUT_ZFS
1435.It
1436.Va WITHOUT_ZFS_TESTS
1437.El
1438.Pp
1439When set, these options are also in effect:
1440.Pp
1441.Bl -inset -compact
1442.It Va WITHOUT_GSSAPI
1443(unless
1444.Va WITH_GSSAPI
1445is set explicitly)
1446.El
1447.It Va WITHOUT_OPENSSL_KTLS
1448Do not include kernel TLS support in OpenSSL.
1449.Pp
1450This is a default setting on
1451arm/armv7, i386/i386, powerpc/powerpc and riscv/riscv64.
1452.It Va WITH_OPENSSL_KTLS
1453Include kernel TLS support in OpenSSL.
1454.Pp
1455This is a default setting on
1456amd64/amd64, arm64/aarch64, powerpc/powerpc64 and powerpc/powerpc64le.
1457.It Va WITHOUT_PAM
1458Do not build PAM library and modules.
1459.Bf -symbolic
1460This option is deprecated and does nothing.
1461.Ef
1462When set, these options are also in effect:
1463.Pp
1464.Bl -inset -compact
1465.It Va WITHOUT_PAM_SUPPORT
1466(unless
1467.Va WITH_PAM_SUPPORT
1468is set explicitly)
1469.El
1470.It Va WITHOUT_PAM_SUPPORT
1471Build some programs without PAM support, particularly
1472.Xr ftpd 8
1473and
1474.Xr ppp 8 .
1475.It Va WITHOUT_PF
1476Do not build PF firewall package.
1477When set, it enforces these options:
1478.Pp
1479.Bl -item -compact
1480.It
1481.Va WITHOUT_AUTHPF
1482.El
1483.It Va WITHOUT_PIE
1484Do not build dynamically linked binaries as
1485Position-Independent Executable (PIE).
1486.Pp
1487This is a default setting on
1488arm/armv7, i386/i386 and powerpc/powerpc.
1489.It Va WITH_PIE
1490Build dynamically linked binaries as
1491Position-Independent Executable (PIE).
1492.Pp
1493This is a default setting on
1494amd64/amd64, arm64/aarch64, powerpc/powerpc64, powerpc/powerpc64le and riscv/riscv64.
1495.It Va WITHOUT_PKGBOOTSTRAP
1496Do not build
1497.Xr pkg 7
1498bootstrap tool.
1499.It Va WITHOUT_PMC
1500Do not build
1501.Xr pmccontrol 8
1502and related programs.
1503.It Va WITHOUT_PPP
1504Do not build
1505.Xr ppp 8
1506and related programs.
1507.It Va WITHOUT_PTHREADS_ASSERTIONS
1508Disable debugging assertions in pthreads library.
1509.It Va WITHOUT_QUOTAS
1510Do not build
1511.Xr quota 1
1512and related programs.
1513.It Va WITHOUT_RADIUS_SUPPORT
1514Do not build radius support into various applications, like
1515.Xr pam_radius 8
1516and
1517.Xr ppp 8 .
1518.It Va WITH_RATELIMIT
1519Build the system with rate limit support.
1520.Pp
1521This makes
1522.Dv SO_MAX_PACING_RATE
1523effective in
1524.Xr getsockopt 2 ,
1525and
1526.Ar txrlimit
1527support in
1528.Xr ifconfig 8 ,
1529by proxy.
1530.It Va WITHOUT_RBOOTD
1531Do not build or install
1532.Xr rbootd 8 .
1533.It Va WITHOUT_RELRO
1534Do not apply the Relocation Read-Only (RELRO) vulnerability mitigation.
1535See also the
1536.Va BIND_NOW
1537option.
1538.It Va WITH_REPRODUCIBLE_BUILD
1539Exclude build metadata (such as the build time, user, or host)
1540from the kernel, boot loaders, and uname output, so that builds produce
1541bit-for-bit identical output.
1542.It Va WITHOUT_RESCUE
1543Do not build
1544.Xr rescue 8 .
1545.It Va WITH_RETPOLINE
1546Build the base system with the retpoline speculative execution
1547vulnerability mitigation for CVE-2017-5715.
1548.It Va WITHOUT_ROUTED
1549Do not build
1550.Xr routed 8
1551utility.
1552.It Va WITH_RPCBIND_WARMSTART_SUPPORT
1553Build
1554.Xr rpcbind 8
1555with warmstart support.
1556.It Va WITHOUT_SCTP_SUPPORT
1557Disable support in the kernel for the
1558.Xr sctp 4
1559Stream Control Transmission Protocol
1560loadable kernel module.
1561.It Va WITHOUT_SENDMAIL
1562Do not build
1563.Xr sendmail 8
1564and related programs.
1565.It Va WITHOUT_SERVICESDB
1566Do not install
1567.Pa /var/db/services.db .
1568.It Va WITHOUT_SETUID_LOGIN
1569Set this to disable the installation of
1570.Xr login 1
1571as a set-user-ID root program.
1572.It Va WITHOUT_SHAREDOCS
1573Do not build the
1574.Bx 4.4
1575legacy docs.
1576.It Va WITH_SORT_THREADS
1577Enable threads in
1578.Xr sort 1 .
1579.It Va WITHOUT_SOURCELESS
1580Do not build kernel modules that include sourceless code (either microcode or native code for host CPU).
1581When set, it enforces these options:
1582.Pp
1583.Bl -item -compact
1584.It
1585.Va WITHOUT_SOURCELESS_HOST
1586.It
1587.Va WITHOUT_SOURCELESS_UCODE
1588.El
1589.It Va WITHOUT_SOURCELESS_HOST
1590Do not build kernel modules that include sourceless native code for host CPU.
1591.It Va WITHOUT_SOURCELESS_UCODE
1592Do not build kernel modules that include sourceless microcode.
1593.It Va WITHOUT_SPLIT_KERNEL_DEBUG
1594Do not build standalone kernel debug files.
1595Debug data (if enabled by the kernel configuration file)
1596will be included in the kernel and modules.
1597When set, it enforces these options:
1598.Pp
1599.Bl -item -compact
1600.It
1601.Va WITHOUT_KERNEL_SYMBOLS
1602.El
1603.It Va WITHOUT_SSP
1604Do not build world with stack smashing protection.
1605See
1606.Xr security 7
1607for more information.
1608.It Va WITH_STAGING
1609Enable staging of files to a stage tree.
1610This can be best thought of as auto-install to
1611.Va DESTDIR
1612with some extra meta data to ensure dependencies can be tracked.
1613Depends on
1614.Va WITH_DIRDEPS_BUILD .
1615When set, these options are also in effect:
1616.Pp
1617.Bl -inset -compact
1618.It Va WITH_STAGING_MAN
1619(unless
1620.Va WITHOUT_STAGING_MAN
1621is set explicitly)
1622.It Va WITH_STAGING_PROG
1623(unless
1624.Va WITHOUT_STAGING_PROG
1625is set explicitly)
1626.El
1627.Pp
1628This must be set in the environment, make command line, or
1629.Pa /etc/src-env.conf ,
1630not
1631.Pa /etc/src.conf .
1632.It Va WITH_STAGING_MAN
1633Enable staging of man pages to stage tree.
1634.It Va WITH_STAGING_PROG
1635Enable staging of PROGs to stage tree.
1636.It Va WITH_STALE_STAGED
1637Check staged files are not stale.
1638.It Va WITHOUT_STATS
1639Neither build nor install
1640.Lb libstats
1641and dependent binaries.
1642.It Va WITHOUT_SYSCONS
1643Do not build
1644.Xr syscons 4
1645support files such as keyboard maps, fonts, and screen output maps.
1646.It Va WITH_SYSROOT
1647Enable use of sysroot during build.
1648Depends on
1649.Va WITH_DIRDEPS_BUILD .
1650.Pp
1651This must be set in the environment, make command line, or
1652.Pa /etc/src-env.conf ,
1653not
1654.Pa /etc/src.conf .
1655.It Va WITHOUT_SYSTEM_COMPILER
1656Do not opportunistically skip building a cross-compiler during the
1657bootstrap phase of the build.
1658Normally, if the currently installed compiler matches the planned bootstrap
1659compiler type and revision, then it will not be built.
1660This does not prevent a compiler from being built for installation though,
1661only for building one for the build itself.
1662The
1663.Va WITHOUT_CLANG
1664option controls that.
1665.It Va WITHOUT_SYSTEM_LINKER
1666Do not opportunistically skip building a cross-linker during the
1667bootstrap phase of the build.
1668Normally, if the currently installed linker matches the planned bootstrap
1669linker type and revision, then it will not be built.
1670This does not prevent a linker from being built for installation though,
1671only for building one for the build itself.
1672The
1673.Va WITHOUT_LLD
1674option controls that.
1675.Pp
1676This option is only relevant when
1677.Va WITH_LLD_BOOTSTRAP
1678is set.
1679.It Va WITHOUT_TALK
1680Do not build or install
1681.Xr talk 1
1682and
1683.Xr talkd 8 .
1684.It Va WITHOUT_TCP_WRAPPERS
1685Do not build or install
1686.Xr tcpd 8 ,
1687and related utilities.
1688.It Va WITHOUT_TCSH
1689Do not build and install
1690.Pa /bin/csh
1691(which is
1692.Xr tcsh 1 ) .
1693.It Va WITHOUT_TELNET
1694Do not build
1695.Xr telnet 1
1696and related programs.
1697.It Va WITHOUT_TESTS
1698Do not build nor install the
1699.Fx
1700Test Suite in
1701.Pa /usr/tests/ .
1702See
1703.Xr tests 7
1704for more details.
1705This also disables the build of all test-related dependencies, including ATF.
1706When set, it enforces these options:
1707.Pp
1708.Bl -item -compact
1709.It
1710.Va WITHOUT_DTRACE_TESTS
1711.It
1712.Va WITHOUT_ZFS_TESTS
1713.El
1714.Pp
1715When set, these options are also in effect:
1716.Pp
1717.Bl -inset -compact
1718.It Va WITHOUT_GOOGLETEST
1719(unless
1720.Va WITH_GOOGLETEST
1721is set explicitly)
1722.It Va WITHOUT_TESTS_SUPPORT
1723(unless
1724.Va WITH_TESTS_SUPPORT
1725is set explicitly)
1726.El
1727.It Va WITHOUT_TESTS_SUPPORT
1728Disable the build of all test-related dependencies, including ATF.
1729When set, it enforces these options:
1730.Pp
1731.Bl -item -compact
1732.It
1733.Va WITHOUT_GOOGLETEST
1734.El
1735.It Va WITHOUT_TEXTPROC
1736Do not build
1737programs used for text processing.
1738.It Va WITHOUT_TFTP
1739Do not build or install
1740.Xr tftp 1
1741and
1742.Xr tftpd 8 .
1743.It Va WITHOUT_TOOLCHAIN
1744Do not install
1745programs used for program development,
1746compilers, debuggers etc.
1747When set, it enforces these options:
1748.Pp
1749.Bl -item -compact
1750.It
1751.Va WITHOUT_CLANG
1752.It
1753.Va WITHOUT_CLANG_EXTRAS
1754.It
1755.Va WITHOUT_CLANG_FORMAT
1756.It
1757.Va WITHOUT_CLANG_FULL
1758.It
1759.Va WITHOUT_LLD
1760.It
1761.Va WITHOUT_LLDB
1762.It
1763.Va WITHOUT_LLVM_COV
1764.El
1765.It Va WITH_UBSAN
1766Build the base system with Undefined Behavior Sanitizer (UBSan) to detect
1767various kinds of undefined behavior at runtime.
1768Requires that Clang be used as the base system compiler
1769and that the runtime support library is available
1770.It Va WITHOUT_UNBOUND
1771Do not build
1772.Xr unbound 8
1773and related programs.
1774.It Va WITH_UNDEFINED_VERSION
1775Link libraries with --undefined-version which permits version maps to
1776contain symbols that are not present in the library.
1777If this is necessary to build a particular configuration, a bug is
1778present and the configuration should be reported.
1779.It Va WITHOUT_UNIFIED_OBJDIR
1780Use the historical object directory format for
1781.Xr build 7
1782targets.
1783For native-builds and builds done directly in sub-directories the format of
1784.Pa ${MAKEOBJDIRPREFIX}/${.CURDIR}
1785is used,
1786while for cross-builds
1787.Pa ${MAKEOBJDIRPREFIX}/${TARGET}.${TARGET_ARCH}/${.CURDIR}
1788is used.
1789.Pp
1790This option is transitional and will be removed in a future version of
1791.Fx ,
1792at which time
1793.Va WITH_UNIFIED_OBJDIR
1794will be enabled permanently.
1795.Pp
1796This must be set in the environment, make command line, or
1797.Pa /etc/src-env.conf ,
1798not
1799.Pa /etc/src.conf .
1800.It Va WITHOUT_USB
1801Do not build USB-related programs and libraries.
1802.It Va WITHOUT_USB_GADGET_EXAMPLES
1803Do not build USB gadget kernel modules.
1804.It Va WITHOUT_UTMPX
1805Do not build user accounting tools such as
1806.Xr last 1 ,
1807.Xr users 1 ,
1808.Xr who 1 ,
1809.Xr ac 8 ,
1810.Xr lastlogin 8
1811and
1812.Xr utx 8 .
1813.It Va WITH_VERIEXEC
1814Enable building
1815.Xr veriexec 8
1816which loads the contents of verified manifests into the kernel
1817for use by
1818.Xr mac_veriexec 4
1819.Pp
1820Depends on
1821.Va WITH_BEARSSL .
1822.It Va WITHOUT_VI
1823Do not build and install vi, view, ex and related programs.
1824.It Va WITHOUT_VT
1825Do not build
1826.Xr vt 4
1827support files (fonts and keymaps).
1828.It Va WITHOUT_WARNS
1829Set this to not add warning flags to the compiler invocations.
1830Useful as a temporary workaround when code enters the tree
1831which triggers warnings in environments that differ from the
1832original developer.
1833.It Va WITHOUT_WERROR
1834Set this to not treat compiler warnings as errors.
1835Useful as a temporary workaround when working on fixing compiler warnings.
1836When set, warnings are still printed in the build log but do not fail the build.
1837.It Va WITHOUT_WIRELESS
1838Do not build programs used for 802.11 wireless networks; especially
1839.Xr wpa_supplicant 8
1840and
1841.Xr hostapd 8 .
1842When set, these options are also in effect:
1843.Pp
1844.Bl -inset -compact
1845.It Va WITHOUT_WIRELESS_SUPPORT
1846(unless
1847.Va WITH_WIRELESS_SUPPORT
1848is set explicitly)
1849.El
1850.It Va WITHOUT_WIRELESS_SUPPORT
1851Build libraries, programs, and kernel modules without
1852802.11 wireless support.
1853.It Va WITHOUT_WPA_SUPPLICANT_EAPOL
1854Build
1855.Xr wpa_supplicant 8
1856without support for the IEEE 802.1X protocol and without
1857support for EAP-PEAP, EAP-TLS, EAP-LEAP, and EAP-TTLS
1858protocols (usable only via 802.1X).
1859.It Va WITHOUT_ZFS
1860Do not build the ZFS file system kernel module, libraries such as
1861.Xr libbe 3 ,
1862and user commands such as
1863.Xr zpool 8
1864or
1865.Xr zfs 8 .
1866Also disable ZFS support in utilities and libraries which implement
1867ZFS-specific functionality.
1868When set, it enforces these options:
1869.Pp
1870.Bl -item -compact
1871.It
1872.Va WITHOUT_ZFS_TESTS
1873.El
1874.It Va WITHOUT_ZFS_TESTS
1875Do not build and install the legacy ZFS test suite.
1876.It Va WITHOUT_ZONEINFO
1877Do not build the timezone database.
1878When set, it enforces these options:
1879.Pp
1880.Bl -item -compact
1881.It
1882.Va WITHOUT_ZONEINFO_LEAPSECONDS_SUPPORT
1883.El
1884.It Va WITH_ZONEINFO_LEAPSECONDS_SUPPORT
1885Build leapsecond information in to the timezone database.
1886.El
1887.Pp
1888The following options accept a single value from a list of valid values.
1889.Bl -tag -width indent
1890.It Va INIT_ALL
1891Control default initialization of stack variables in C and C++ code.
1892Options other than
1893.Li none
1894require the Clang compiler or GCC 12.0 or later.
1895The default value is
1896.Li none .
1897Valid values are:
1898.Bl -tag -width indent
1899.It Li none
1900Do not initialize stack variables (standard C/C++ behavior).
1901.It Li pattern
1902Build the base system or kernel with stack variables initialized to
1903.Pq compiler defined
1904debugging patterns on function entry.
1905.It Li zero
1906Build the base system or kernel with stack variables initialized
1907to zero on function entry.
1908This value is converted to
1909.Li none
1910for amd64 kernel builds due to incompatability with ifunc memset.
1911.El
1912.It Va LIBC_MALLOC
1913Specify the
1914.Xr malloc 3
1915implementation used by libc.
1916The default value is
1917.Li jemalloc .
1918Valid values are:
1919.Bl -tag -width indent
1920.It Li jemalloc
1921.El
1922.Pp
1923Other implementations are expected in the future in both
1924.Fx
1925and downstream consumers.
1926.El
1927.Sh FILES
1928.Bl -tag -compact -width Pa
1929.It Pa /etc/src.conf
1930.It Pa /etc/src-env.conf
1931.It Pa /usr/share/mk/bsd.own.mk
1932.El
1933.Sh SEE ALSO
1934.Xr make 1 ,
1935.Xr make.conf 5 ,
1936.Xr build 7 ,
1937.Xr ports 7
1938.Sh HISTORY
1939The
1940.Nm
1941file appeared in
1942.Fx 7.0 .
1943.Sh AUTHORS
1944This manual page was autogenerated by
1945.An tools/build/options/makeman .
1946