xref: /freebsd/share/man/man5/src.conf.5 (revision 4f0a4502a1f33fef287ac558c98e5ef99a32216f)
1.\" DO NOT EDIT-- this file is automatically generated.
2.\" from FreeBSD: head/tools/build/options/makeman 292283 2015-12-15 18:42:30Z bdrewery
3.\" $FreeBSD$
4.Dd January 9, 2016
5.Dt SRC.CONF 5
6.Os
7.Sh NAME
8.Nm src.conf
9.Nd "source build options"
10.Sh DESCRIPTION
11The
12.Nm
13file contains settings that will apply to every build involving the
14.Fx
15source tree; see
16.Xr build 7 .
17.Pp
18The
19.Nm
20file uses the standard makefile syntax.
21However,
22.Nm
23should not specify any dependencies to
24.Xr make 1 .
25Instead,
26.Nm
27is to set
28.Xr make 1
29variables that control the aspects of how the system builds.
30.Pp
31The default location of
32.Nm
33is
34.Pa /etc/src.conf ,
35though an alternative location can be specified in the
36.Xr make 1
37variable
38.Va SRCCONF .
39Overriding the location of
40.Nm
41may be necessary if the system-wide settings are not suitable
42for a particular build.
43For instance, setting
44.Va SRCCONF
45to
46.Pa /dev/null
47effectively resets all build controls to their defaults.
48.Pp
49The only purpose of
50.Nm
51is to control the compilation of the
52.Fx
53source code, which is usually located in
54.Pa /usr/src .
55As a rule, the system administrator creates
56.Nm
57when the values of certain control variables need to be changed
58from their defaults.
59.Pp
60In addition, control variables can be specified
61for a particular build via the
62.Fl D
63option of
64.Xr make 1
65or in its environment; see
66.Xr environ 7 .
67.Pp
68The environment of
69.Xr make 1
70for the build can be controlled via the
71.Va SRC_ENV_CONF
72variable, which defaults to
73.Pa /etc/src-env.conf .
74Some examples that may only be set in this file are
75.Va WITH_DIRDEPS_BUILD ,
76and
77.Va WITH_META_MODE
78as they are environment-only variables.
79Note that
80.Va MAKEOBJDIRPREFIX
81may be set here only when using
82.Va WITH_DIRDEPS_BUILD .
83.Pp
84The values of variables are ignored regardless of their setting;
85even if they would be set to
86.Dq Li FALSE
87or
88.Dq Li NO .
89Just the existence of an option will cause
90it to be honoured by
91.Xr make 1 .
92.Pp
93The following list provides a name and short description for variables
94that can be used for source builds.
95.Bl -tag -width indent
96.It Va WITHOUT_ACCT
97.\" from FreeBSD: head/tools/build/options/WITHOUT_ACCT 223201 2011-06-17 20:47:44Z ed
98Set to not build process accounting tools such as
99.Xr accton 8
100and
101.Xr sa 8 .
102.It Va WITHOUT_ACPI
103.\" from FreeBSD: head/tools/build/options/WITHOUT_ACPI 156932 2006-03-21 07:50:50Z ru
104Set to not build
105.Xr acpiconf 8 ,
106.Xr acpidump 8
107and related programs.
108.It Va WITHOUT_AMD
109.\" from FreeBSD: head/tools/build/options/WITHOUT_AMD 183242 2008-09-21 22:02:26Z sam
110Set to not build
111.Xr amd 8 ,
112and related programs.
113.It Va WITHOUT_APM
114.\" from FreeBSD: head/tools/build/options/WITHOUT_APM 183242 2008-09-21 22:02:26Z sam
115Set to not build
116.Xr apm 8 ,
117.Xr apmd 8
118and related programs.
119.It Va WITHOUT_ASSERT_DEBUG
120.\" from FreeBSD: head/tools/build/options/WITHOUT_ASSERT_DEBUG 162215 2006-09-11 13:55:27Z ru
121Set to compile programs and libraries without the
122.Xr assert 3
123checks.
124.It Va WITHOUT_AT
125.\" from FreeBSD: head/tools/build/options/WITHOUT_AT 183242 2008-09-21 22:02:26Z sam
126Set to not build
127.Xr at 1
128and related utilities.
129.It Va WITHOUT_ATM
130.\" from FreeBSD: head/tools/build/options/WITHOUT_ATM 156932 2006-03-21 07:50:50Z ru
131Set to not build
132programs and libraries related to ATM networking.
133.It Va WITHOUT_AUDIT
134.\" from FreeBSD: head/tools/build/options/WITHOUT_AUDIT 156932 2006-03-21 07:50:50Z ru
135Set to not build audit support into system programs.
136.It Va WITHOUT_AUTHPF
137.\" from FreeBSD: head/tools/build/options/WITHOUT_AUTHPF 156932 2006-03-21 07:50:50Z ru
138Set to not build
139.Xr authpf 8 .
140.It Va WITHOUT_AUTOFS
141.\" from FreeBSD: head/tools/build/options/WITHOUT_AUTOFS 277728 2015-01-26 07:15:49Z ngie
142Set to not build
143.Xr autofs 4
144related programs, libraries, and kernel modules.
145.It Va WITH_AUTO_OBJ
146.\" from FreeBSD: head/tools/build/options/WITH_AUTO_OBJ 284708 2015-06-22 20:21:57Z sjg
147Enable automatic creation of objdirs.
148.Pp
149This must be set in the environment, make command line, or
150.Pa /etc/src-env.conf ,
151not
152.Pa /etc/src.conf .
153.It Va WITHOUT_BHYVE
154.\" from FreeBSD: head/tools/build/options/WITHOUT_BHYVE 277727 2015-01-26 06:44:48Z ngie
155Set to not build or install
156.Xr bhyve 8 ,
157associated utilities, and examples.
158.Pp
159This option only affects amd64/amd64.
160.It Va WITHOUT_BINUTILS
161.\" from FreeBSD: head/tools/build/options/WITHOUT_BINUTILS 286332 2015-08-05 18:30:00Z emaste
162Set to not build or install binutils (as, ld, objcopy, and objdump ) as part
163of the normal system build.
164The resulting system cannot build programs from source.
165.Pp
166It is a default setting on
167arm64/aarch64.
168.It Va WITHOUT_BINUTILS_BOOTSTRAP
169.\" from FreeBSD: head/tools/build/options/WITHOUT_BINUTILS_BOOTSTRAP 264660 2014-04-18 17:03:58Z imp
170Set to not build binutils (as, c++-filt, gconv,
171ld, nm, objcopy, objdump, readelf, size and strip)
172as part of the bootstrap process.
173.Bf -symbolic
174The option does not work for build targets unless some alternative
175toolchain is provided.
176.Ef
177.Pp
178It is a default setting on
179arm64/aarch64.
180.It Va WITHOUT_BLUETOOTH
181.\" from FreeBSD: head/tools/build/options/WITHOUT_BLUETOOTH 156932 2006-03-21 07:50:50Z ru
182Set to not build Bluetooth related kernel modules, programs and libraries.
183.It Va WITHOUT_BOOT
184.\" from FreeBSD: head/tools/build/options/WITHOUT_BOOT 156932 2006-03-21 07:50:50Z ru
185Set to not build the boot blocks and loader.
186.It Va WITHOUT_BOOTPARAMD
187.\" from FreeBSD: head/tools/build/options/WITHOUT_BOOTPARAMD 278192 2015-02-04 10:19:32Z ngie
188Set to not build or install
189.Xr bootparamd 8 .
190.It Va WITHOUT_BOOTPD
191.\" from FreeBSD: head/tools/build/options/WITHOUT_BOOTPD 278192 2015-02-04 10:19:32Z ngie
192Set to not build or install
193.Xr bootpd 8 .
194.It Va WITHOUT_BSDINSTALL
195.\" from FreeBSD: head/tools/build/options/WITHOUT_BSDINSTALL 277677 2015-01-25 04:43:13Z ngie
196Set to not build
197.Xr bsdinstall 8 ,
198.Xr sade 8 ,
199and related programs.
200.It Va WITHOUT_BSD_CPIO
201.\" from FreeBSD: head/tools/build/options/WITHOUT_BSD_CPIO 179813 2008-06-16 05:48:15Z dougb
202Set to not build the BSD licensed version of cpio based on
203.Xr libarchive 3 .
204.It Va WITH_BSD_GREP
205.\" from FreeBSD: head/tools/build/options/WITH_BSD_GREP 222273 2011-05-25 01:04:12Z obrien
206Install BSD-licensed grep as '[ef]grep' instead of GNU grep.
207.It Va WITHOUT_BSNMP
208.\" from FreeBSD: head/tools/build/options/WITHOUT_BSNMP 183306 2008-09-23 16:15:42Z sam
209Set to not build or install
210.Xr bsnmpd 1
211and related libraries and data files.
212.It Va WITHOUT_BZIP2
213.\" from FreeBSD: head/tools/build/options/WITHOUT_BZIP2 174550 2007-12-12 16:43:17Z ru
214Set to not build contributed bzip2 software as a part of the base system.
215.Bf -symbolic
216The option has no effect yet.
217.Ef
218When set, it also enforces the following options:
219.Pp
220.Bl -item -compact
221.It
222.Va WITHOUT_BZIP2_SUPPORT
223.El
224.It Va WITHOUT_BZIP2_SUPPORT
225.\" from FreeBSD: head/tools/build/options/WITHOUT_BZIP2_SUPPORT 166255 2007-01-26 10:19:08Z delphij
226Set to build some programs without optional bzip2 support.
227.It Va WITHOUT_CALENDAR
228.\" from FreeBSD: head/tools/build/options/WITHOUT_CALENDAR 156932 2006-03-21 07:50:50Z ru
229Set to not build
230.Xr calendar 1 .
231.It Va WITHOUT_CAPSICUM
232.\" from FreeBSD: head/tools/build/options/WITHOUT_CAPSICUM 229319 2012-01-02 21:57:58Z rwatson
233Set to not build Capsicum support into system programs.
234.It Va WITHOUT_CASPER
235.\" from FreeBSD: head/tools/build/options/WITHOUT_CASPER 258838 2013-12-02 08:21:28Z pjd
236Set to not build Casper program and related libraries.
237.It Va WITH_CCACHE_BUILD
238.\" from FreeBSD: head/tools/build/options/WITH_CCACHE_BUILD 290526 2015-11-08 00:50:18Z bdrewery
239Set to use
240.Xr ccache 1
241for the build.
242No configuration is required except to install the
243.Sy devel/ccache
244package.
245Using with
246.Xr distcc 1
247should set
248.Sy CCACHE_PREFIX=/usr/local/bin/distcc .
249The default cache directory of
250.Pa $HOME/.ccache
251will be used, which can be overridden by setting
252.Sy CCACHE_DIR .
253The
254.Sy CCACHE_COMPILERCHECK
255option defaults to
256.Sy content
257when using the in-tree bootstrap compiler,
258and
259.Sy mtime
260when using an external compiler.
261The
262.Sy CCACHE_CPP2
263option is used for Clang but not GCC.
264ccache works best when combined with the
265.Sy WITH_FAST_DEPEND
266option.
267.Pp
268Sharing a cache between multiple work directories requires using a layout
269similar to
270.Pa /some/prefix/src
271.Pa /some/prefix/obj
272and an environment such as:
273.Bd -literal -offset indent
274CCACHE_BASEDIR='${SRCTOP:H}' MAKEOBJDIRPREFIX='${SRCTOP:H}/obj'
275.Ed
276.Pp
277See
278.Xr ccache 1
279for more configuration options.
280.It Va WITHOUT_CCD
281.\" from FreeBSD: head/tools/build/options/WITHOUT_CCD 277678 2015-01-25 04:52:48Z ngie
282Set to not build
283.Xr geom_ccd 4
284and related utilities.
285.It Va WITHOUT_CDDL
286.\" from FreeBSD: head/tools/build/options/WITHOUT_CDDL 163861 2006-11-01 09:02:11Z jb
287Set to not build code licensed under Sun's CDDL.
288When set, it also enforces the following options:
289.Pp
290.Bl -item -compact
291.It
292.Va WITHOUT_CTF
293.It
294.Va WITHOUT_ZFS
295.El
296.It Va WITHOUT_CLANG
297.\" from FreeBSD: head/tools/build/options/WITHOUT_CLANG 264660 2014-04-18 17:03:58Z imp
298Set to not build the Clang C/C++ compiler during the regular phase of the build.
299.Pp
300It is a default setting on
301mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32 and sparc64/sparc64.
302When set, it also enforces the following options:
303.Pp
304.Bl -item -compact
305.It
306.Va WITHOUT_CLANG_EXTRAS
307.It
308.Va WITHOUT_CLANG_FULL
309.El
310.It Va WITH_CLANG
311.\" from FreeBSD: head/tools/build/options/WITH_CLANG 264660 2014-04-18 17:03:58Z imp
312Set to build the Clang C/C++ compiler during the normal phase of the build.
313.Pp
314It is a default setting on
315amd64/amd64, arm/arm, arm/armeb, arm/armv6, arm/armv6hf, arm64/aarch64, i386/i386, pc98/i386, powerpc/powerpc and powerpc/powerpc64.
316.It Va WITHOUT_CLANG_BOOTSTRAP
317.\" from FreeBSD: head/tools/build/options/WITHOUT_CLANG_BOOTSTRAP 273177 2014-10-16 18:28:11Z skreuzer
318Set to not build the Clang C/C++ compiler during the bootstrap phase of the build.
319You must enable either gcc or clang bootstrap to be able to build the system,
320unless an alternative compiler is provided via
321XCC.
322.Pp
323It is a default setting on
324mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32, powerpc/powerpc, powerpc/powerpc64 and sparc64/sparc64.
325.It Va WITH_CLANG_BOOTSTRAP
326.\" from FreeBSD: head/tools/build/options/WITH_CLANG_BOOTSTRAP 264660 2014-04-18 17:03:58Z imp
327Set to build the Clang C/C++ compiler during the bootstrap phase of the build.
328.Pp
329It is a default setting on
330amd64/amd64, arm/arm, arm/armeb, arm/armv6, arm/armv6hf, arm64/aarch64, i386/i386 and pc98/i386.
331.It Va WITH_CLANG_EXTRAS
332.\" from FreeBSD: head/tools/build/options/WITH_CLANG_EXTRAS 231057 2012-02-05 23:56:22Z dim
333Set to build additional clang and llvm tools, such as bugpoint.
334.It Va WITHOUT_CLANG_FULL
335.\" from FreeBSD: head/tools/build/options/WITHOUT_CLANG_FULL 246259 2013-02-02 22:28:29Z dim
336Set to avoid building the ARCMigrate, Rewriter and StaticAnalyzer components of
337the Clang C/C++ compiler.
338.Pp
339It is a default setting on
340mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32 and sparc64/sparc64.
341.It Va WITH_CLANG_FULL
342.\" from FreeBSD: head/tools/build/options/WITH_CLANG_FULL 246259 2013-02-02 22:28:29Z dim
343Set to build the ARCMigrate, Rewriter and StaticAnalyzer components of the
344Clang C/C++ compiler.
345.Pp
346It is a default setting on
347amd64/amd64, arm/arm, arm/armeb, arm/armv6, arm/armv6hf, arm64/aarch64, i386/i386, pc98/i386, powerpc/powerpc and powerpc/powerpc64.
348.It Va WITHOUT_CLANG_IS_CC
349.\" from FreeBSD: head/tools/build/options/WITHOUT_CLANG_IS_CC 242629 2012-11-05 21:53:23Z brooks
350Set to install the GCC compiler as
351.Pa /usr/bin/cc ,
352.Pa /usr/bin/c++
353and
354.Pa /usr/bin/cpp .
355.Pp
356It is a default setting on
357mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32, powerpc/powerpc, powerpc/powerpc64 and sparc64/sparc64.
358.It Va WITH_CLANG_IS_CC
359.\" from FreeBSD: head/tools/build/options/WITH_CLANG_IS_CC 235342 2012-05-12 16:12:36Z gjb
360Set to install the Clang C/C++ compiler as
361.Pa /usr/bin/cc ,
362.Pa /usr/bin/c++
363and
364.Pa /usr/bin/cpp .
365.Pp
366It is a default setting on
367amd64/amd64, arm/arm, arm/armeb, arm/armv6, arm/armv6hf, arm64/aarch64, i386/i386 and pc98/i386.
368.It Va WITHOUT_CPP
369.\" from FreeBSD: head/tools/build/options/WITHOUT_CPP 156932 2006-03-21 07:50:50Z ru
370Set to not build
371.Xr cpp 1 .
372.It Va WITHOUT_CROSS_COMPILER
373.\" from FreeBSD: head/tools/build/options/WITHOUT_CROSS_COMPILER 275138 2014-11-26 20:43:09Z gjb
374Set to not build any cross compiler in the cross-tools stage of buildworld.
375If you are compiling a different version of
376.Fx
377than what is installed on the system, you will need to provide an alternate
378compiler with XCC to ensure success.
379If you are compiling with an identical version of
380.Fx
381to the host, this option may be safely used.
382This option may also be safe when the host version of
383.Fx
384is close to the sources being built, but all bets are off if there have
385been any changes to the toolchain between the versions.
386When set, it also enforces the following options:
387.Pp
388.Bl -item -compact
389.It
390.Va WITHOUT_BINUTILS_BOOTSTRAP
391.It
392.Va WITHOUT_CLANG_BOOTSTRAP
393.It
394.Va WITHOUT_ELFTOOLCHAIN_BOOTSTRAP
395.It
396.Va WITHOUT_GCC_BOOTSTRAP
397.El
398.It Va WITHOUT_CRYPT
399.\" from FreeBSD: head/tools/build/options/WITHOUT_CRYPT 156932 2006-03-21 07:50:50Z ru
400Set to not build any crypto code.
401When set, it also enforces the following options:
402.Pp
403.Bl -item -compact
404.It
405.Va WITHOUT_KERBEROS
406.It
407.Va WITHOUT_KERBEROS_SUPPORT
408.It
409.Va WITHOUT_OPENSSH
410.It
411.Va WITHOUT_OPENSSL
412.El
413.Pp
414When set, the following options are also in effect:
415.Pp
416.Bl -inset -compact
417.It Va WITHOUT_GSSAPI
418(unless
419.Va WITH_GSSAPI
420is set explicitly)
421.El
422.It Va WITH_CTF
423.\" from FreeBSD: head/tools/build/options/WITH_CTF 228159 2011-11-30 18:22:44Z fjoe
424Set to compile with CTF (Compact C Type Format) data.
425CTF data encapsulates a reduced form of debugging information
426similar to DWARF and the venerable stabs and is required for DTrace.
427.It Va WITHOUT_CTM
428.\" from FreeBSD: head/tools/build/options/WITHOUT_CTM 183242 2008-09-21 22:02:26Z sam
429Set to not build
430.Xr ctm 1
431and related utilities.
432.It Va WITHOUT_CUSE
433.\" from FreeBSD: head/tools/build/options/WITHOUT_CUSE 270171 2014-08-19 15:40:26Z hselasky
434Set to not build CUSE-related programs and libraries.
435.It Va WITHOUT_CXX
436.\" from FreeBSD: head/tools/build/options/WITHOUT_CXX 281053 2015-04-03 23:55:04Z bdrewery
437Set to not build
438.Xr c++ 1
439and related libraries.
440It will also prevent building of
441.Xr gperf 1
442and
443.Xr devd 8 .
444When set, it also enforces the following options:
445.Pp
446.Bl -item -compact
447.It
448.Va WITHOUT_CLANG
449.It
450.Va WITHOUT_CLANG_EXTRAS
451.It
452.Va WITHOUT_CLANG_FULL
453.It
454.Va WITHOUT_GNUCXX
455.It
456.Va WITHOUT_GROFF
457.El
458.It Va WITHOUT_DEBUG_FILES
459.\" from FreeBSD: head/tools/build/options/WITHOUT_DEBUG_FILES 290059 2015-10-27 20:49:56Z emaste
460Set to avoid building or installing standalone debug files for each
461executable binary and shared library.
462.It Va WITHOUT_DICT
463.\" from FreeBSD: head/tools/build/options/WITHOUT_DICT 156932 2006-03-21 07:50:50Z ru
464Set to not build the Webster dictionary files.
465.It Va WITH_DIRDEPS_BUILD
466.\" from FreeBSD: head/tools/build/options/WITH_DIRDEPS_BUILD 290816 2015-11-14 03:24:48Z sjg
467Enable building in meta mode.
468This is an experimental build feature.
469For details see
470http://www.crufty.net/sjg/docs/freebsd-meta-mode.htm.
471.Pp
472The build is driven by dirdeps.mk using
473.Va DIRDEPS
474stored in
475Makefile.depend files found in each directory.
476.Pp
477The build can be started from anywhere, and behaves the same.
478The initial instance of
479.Xr make 1
480recursively reads
481.Va DIRDEPS
482from Makefile.depend
483computing a graph of tree dependencies from the current origin.
484Setting
485.Va NO_DIRDEPS
486will skip checking dirdep dependencies and will only build in the current
487directory.
488.Pp
489As each target is made
490.Xr make 1
491produces a meta file which is used to capture (and compare)
492the command line,
493as well as any command output.
494If
495.Xr filemon 4
496is available the meta file will also capture a record of files
497used to produce the target by tracking syscalls.
498.Pp
499The build will hide commands ran unless
500.Va NO_SILENT
501is defined.
502.Pp
503When set, it also enforces the following options:
504.Pp
505.Bl -item -compact
506.It
507.Va WITH_INSTALL_AS_USER
508.El
509.Pp
510When set, the following options are also in effect:
511.Pp
512.Bl -inset -compact
513.It Va WITH_AUTO_OBJ
514(unless
515.Va WITHOUT_AUTO_OBJ
516is set explicitly)
517.It Va WITH_META_MODE
518(unless
519.Va WITHOUT_META_MODE
520is set explicitly)
521.It Va WITH_STAGING
522(unless
523.Va WITHOUT_STAGING
524is set explicitly)
525.It Va WITH_STAGING_MAN
526(unless
527.Va WITHOUT_STAGING_MAN
528is set explicitly)
529.It Va WITH_STAGING_PROG
530(unless
531.Va WITHOUT_STAGING_PROG
532is set explicitly)
533.It Va WITH_SYSROOT
534(unless
535.Va WITHOUT_SYSROOT
536is set explicitly)
537.El
538.Pp
539This must be set in the environment, make command line, or
540.Pa /etc/src-env.conf ,
541not
542.Pa /etc/src.conf .
543.It Va WITH_DIRDEPS_CACHE
544.\" from FreeBSD: head/tools/build/options/WITH_DIRDEPS_CACHE 290816 2015-11-14 03:24:48Z sjg
545Cache result of dirdeps.mk which can save significant time
546for subsequent builds.
547Depends on
548.Va WITH_DIRDEPS_BUILD .
549.Pp
550This must be set in the environment, make command line, or
551.Pa /etc/src-env.conf ,
552not
553.Pa /etc/src.conf .
554.It Va WITHOUT_DMAGENT
555.\" from FreeBSD: head/tools/build/options/WITHOUT_DMAGENT 262335 2014-02-22 13:05:23Z bapt
556Set to not build dma Mail Transport Agent
557.It Va WITHOUT_DOCCOMPRESS
558.\" from FreeBSD: head/tools/build/options/WITHOUT_DOCCOMPRESS 266752 2014-05-27 15:52:27Z gjb
559Set to not to install compressed system documentation.
560Only the uncompressed version will be installed.
561.It Va WITH_DTRACE_TESTS
562.\" from FreeBSD: head/tools/build/options/WITH_DTRACE_TESTS 286174 2015-08-02 00:37:33Z markj
563Set to build and install the DTrace test suite in
564.Pa /usr/tests/cddl/usr.sbin/dtrace .
565This test suite is considered experimental on architectures other than
566amd64/amd64 and running it may cause system instability.
567.It Va WITHOUT_DYNAMICROOT
568.\" from FreeBSD: head/tools/build/options/WITHOUT_DYNAMICROOT 156932 2006-03-21 07:50:50Z ru
569Set this if you do not want to link
570.Pa /bin
571and
572.Pa /sbin
573dynamically.
574.It Va WITHOUT_ED_CRYPTO
575.\" from FreeBSD: head/tools/build/options/WITHOUT_ED_CRYPTO 235660 2012-05-19 20:05:27Z marcel
576Set to build
577.Xr ed 1
578without support for encryption/decryption.
579.It Va WITHOUT_EE
580.\" from FreeBSD: head/tools/build/options/WITHOUT_EE 277663 2015-01-25 00:03:44Z ngie
581Set to not build and install
582.Xr edit 1 ,
583.Xr ee 1 ,
584and related programs.
585.It Va WITH_EISA
586.\" from FreeBSD: head/tools/build/options/WITH_EISA 264654 2014-04-18 16:53:06Z imp
587Set to build EISA kernel modules.
588.It Va WITHOUT_ELFCOPY_AS_OBJCOPY
589.\" from FreeBSD: head/tools/build/options/WITHOUT_ELFCOPY_AS_OBJCOPY 286030 2015-07-29 18:45:38Z emaste
590Set to build and install
591.Xr objcopy 1
592from GNU Binutils, instead of the one from ELF Tool Chain.
593.Pp
594It is a default setting on
595amd64/amd64, arm/arm, arm/armeb, arm/armv6, arm/armv6hf, i386/i386, mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32, pc98/i386, powerpc/powerpc, powerpc/powerpc64 and sparc64/sparc64.
596.It Va WITH_ELFCOPY_AS_OBJCOPY
597.\" from FreeBSD: head/tools/build/options/WITH_ELFCOPY_AS_OBJCOPY 286030 2015-07-29 18:45:38Z emaste
598Set to build and install ELF Tool Chain's elfcopy as
599.Xr objcopy 1 ,
600instead of the one from GNU Binutils.
601.Pp
602It is a default setting on
603arm64/aarch64.
604.It Va WITHOUT_EXAMPLES
605.\" from FreeBSD: head/tools/build/options/WITHOUT_EXAMPLES 156938 2006-03-21 09:06:24Z ru
606Set to avoid installing examples to
607.Pa /usr/share/examples/ .
608.It Va WITH_FAST_DEPEND
609.\" from FreeBSD: head/tools/build/options/WITH_FAST_DEPEND 290433 2015-11-06 04:45:29Z bdrewery
610Set to generate
611.Sy .depend
612files in the build during compilation instead of the
613historial
614.Xr mkdep 1
615call during the "make depend" phase.
616.It Va WITHOUT_FDT
617.\" from FreeBSD: head/tools/build/options/WITHOUT_FDT 221539 2011-05-06 19:10:27Z ru
618Set to not build Flattened Device Tree support as part of the base system.
619This includes the device tree compiler (dtc) and libfdt support library.
620.It Va WITHOUT_FILE
621.\" from FreeBSD: head/tools/build/options/WITHOUT_FILE 278193 2015-02-04 10:24:40Z ngie
622Set to not build
623.Xr file 1
624and related programs.
625.It Va WITHOUT_FINGER
626.\" from FreeBSD: head/tools/build/options/WITHOUT_FINGER 278192 2015-02-04 10:19:32Z ngie
627Set to not build or install
628.Xr finger 1
629and
630.Xr fingerd 8 .
631.It Va WITHOUT_FLOPPY
632.\" from FreeBSD: head/tools/build/options/WITHOUT_FLOPPY 221540 2011-05-06 19:13:03Z ru
633Set to not build or install programs
634for operating floppy disk driver.
635.It Va WITHOUT_FMTREE
636.\" from FreeBSD: head/tools/build/options/WITHOUT_FMTREE 261299 2014-01-30 21:37:43Z brooks
637Set to not build and install
638.Pa /usr/sbin/fmtree .
639.It Va WITHOUT_FORMAT_EXTENSIONS
640.\" from FreeBSD: head/tools/build/options/WITHOUT_FORMAT_EXTENSIONS 250658 2013-05-15 13:04:10Z brooks
641Set to not enable
642.Fl fformat-extensions
643when compiling the kernel.
644Also disables all format checking.
645.It Va WITHOUT_FORTH
646.\" from FreeBSD: head/tools/build/options/WITHOUT_FORTH 156932 2006-03-21 07:50:50Z ru
647Set to build bootloaders without Forth support.
648.It Va WITHOUT_FP_LIBC
649.\" from FreeBSD: head/tools/build/options/WITHOUT_FP_LIBC 156932 2006-03-21 07:50:50Z ru
650Set to build
651.Nm libc
652without floating-point support.
653.It Va WITHOUT_FREEBSD_UPDATE
654.\" from FreeBSD: head/tools/build/options/WITHOUT_FREEBSD_UPDATE 183242 2008-09-21 22:02:26Z sam
655Set to not build
656.Xr freebsd-update 8 .
657.It Va WITHOUT_FTP
658.\" from FreeBSD: head/tools/build/options/WITHOUT_FTP 278192 2015-02-04 10:19:32Z ngie
659Set to not build or install
660.Xr ftp 1
661and
662.Xr ftpd 8 .
663.It Va WITHOUT_GAMES
664.\" from FreeBSD: head/tools/build/options/WITHOUT_GAMES 156932 2006-03-21 07:50:50Z ru
665Set to not build games.
666.It Va WITHOUT_GCC
667.\" from FreeBSD: head/tools/build/options/WITHOUT_GCC 264660 2014-04-18 17:03:58Z imp
668Set to not build and install gcc and g++ as part of the normal build process.
669.Pp
670It is a default setting on
671amd64/amd64, arm/arm, arm/armeb, arm/armv6, arm/armv6hf, arm64/aarch64, i386/i386 and pc98/i386.
672.It Va WITH_GCC
673.\" from FreeBSD: head/tools/build/options/WITH_GCC 255326 2013-09-06 20:49:48Z zeising
674Set to build and install gcc and g++.
675.Pp
676It is a default setting on
677mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32, powerpc/powerpc, powerpc/powerpc64 and sparc64/sparc64.
678.It Va WITHOUT_GCC_BOOTSTRAP
679.\" from FreeBSD: head/tools/build/options/WITHOUT_GCC_BOOTSTRAP 273177 2014-10-16 18:28:11Z skreuzer
680Set to not build gcc and g++ as part of the bootstrap process.
681You must enable either gcc or clang bootstrap to be able to build the system,
682unless an alternative compiler is provided via
683XCC.
684.Pp
685It is a default setting on
686amd64/amd64, arm/arm, arm/armeb, arm/armv6, arm/armv6hf, arm64/aarch64, i386/i386 and pc98/i386.
687.It Va WITH_GCC_BOOTSTRAP
688.\" from FreeBSD: head/tools/build/options/WITH_GCC_BOOTSTRAP 264660 2014-04-18 17:03:58Z imp
689Set to build gcc and g++ as part of the bootstrap process.
690.Pp
691It is a default setting on
692mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32, powerpc/powerpc, powerpc/powerpc64 and sparc64/sparc64.
693.It Va WITHOUT_GCOV
694.\" from FreeBSD: head/tools/build/options/WITHOUT_GCOV 156932 2006-03-21 07:50:50Z ru
695Set to not build the
696.Xr gcov 1
697tool.
698.It Va WITHOUT_GDB
699.\" from FreeBSD: head/tools/build/options/WITHOUT_GDB 156932 2006-03-21 07:50:50Z ru
700Set to not build
701.Xr gdb 1 .
702.Pp
703It is a default setting on
704arm64/aarch64.
705.It Va WITHOUT_GNU
706.\" from FreeBSD: head/tools/build/options/WITHOUT_GNU 174550 2007-12-12 16:43:17Z ru
707Set to not build contributed GNU software as a part of the base system.
708This option can be useful if the system built must not contain any code
709covered by the GNU Public License due to legal reasons.
710.Bf -symbolic
711The option has no effect yet.
712.Ef
713When set, it also enforces the following options:
714.Pp
715.Bl -item -compact
716.It
717.Va WITHOUT_GNU_SUPPORT
718.El
719.It Va WITHOUT_GNUCXX
720.\" from FreeBSD: head/tools/build/options/WITHOUT_GNUCXX 255321 2013-09-06 20:08:03Z theraven
721Do not build the GNU C++ stack (g++, libstdc++).
722This is the default on platforms where clang is the system compiler.
723.Pp
724It is a default setting on
725amd64/amd64, arm/arm, arm/armeb, arm/armv6, arm/armv6hf, arm64/aarch64, i386/i386 and pc98/i386.
726.It Va WITH_GNUCXX
727.\" from FreeBSD: head/tools/build/options/WITH_GNUCXX 255321 2013-09-06 20:08:03Z theraven
728Build the GNU C++ stack (g++, libstdc++).
729This is the default on platforms where gcc is the system compiler.
730.Pp
731It is a default setting on
732mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32, powerpc/powerpc, powerpc/powerpc64 and sparc64/sparc64.
733.It Va WITHOUT_GNU_GREP_COMPAT
734.\" from FreeBSD: head/tools/build/options/WITHOUT_GNU_GREP_COMPAT 273421 2014-10-21 20:44:33Z emaste
735Set this option to omit the gnu extensions to grep from being included in
736BSD grep.
737.It Va WITHOUT_GNU_SUPPORT
738.\" from FreeBSD: head/tools/build/options/WITHOUT_GNU_SUPPORT 156932 2006-03-21 07:50:50Z ru
739Set to build some programs without optional GNU support.
740.It Va WITHOUT_GPIO
741.\" from FreeBSD: head/tools/build/options/WITHOUT_GPIO 228081 2011-11-28 17:54:34Z dim
742Set to not build
743.Xr gpioctl 8
744as part of the base system.
745.It Va WITHOUT_GPL_DTC
746.\" from FreeBSD: head/tools/build/options/WITHOUT_GPL_DTC 264515 2014-04-15 20:41:55Z imp
747Set to build the BSD licensed version of the device tree compiler, instead of the
748GPL'd one from elinux.org.
749.It Va WITHOUT_GROFF
750.\" from FreeBSD: head/tools/build/options/WITHOUT_GROFF 218941 2011-02-22 08:13:49Z uqs
751Set to not build
752.Xr groff 1
753and
754.Xr vgrind 1 .
755You should consider installing the textproc/groff port to not break
756.Xr man 1 .
757.It Va WITHOUT_GSSAPI
758.\" from FreeBSD: head/tools/build/options/WITHOUT_GSSAPI 174548 2007-12-12 16:39:32Z ru
759Set to not build libgssapi.
760.It Va WITHOUT_HAST
761.\" from FreeBSD: head/tools/build/options/WITHOUT_HAST 277725 2015-01-26 06:27:07Z ngie
762Set to not build
763.Xr hastd 8
764and related utilities.
765.It Va WITH_HESIOD
766.\" from FreeBSD: head/tools/build/options/WITH_HESIOD 156932 2006-03-21 07:50:50Z ru
767Set to build Hesiod support.
768.It Va WITHOUT_HTML
769.\" from FreeBSD: head/tools/build/options/WITHOUT_HTML 156932 2006-03-21 07:50:50Z ru
770Set to not build HTML docs.
771.It Va WITHOUT_HYPERV
772.\" from FreeBSD: head/tools/build/options/WITHOUT_HYPERV 271493 2014-09-13 02:15:31Z delphij
773Set to not build or install HyperV utilities.
774.It Va WITHOUT_ICONV
775.\" from FreeBSD: head/tools/build/options/WITHOUT_ICONV 254919 2013-08-26 17:15:56Z antoine
776Set to not build iconv as part of libc.
777.It Va WITHOUT_INCLUDES
778.\" from FreeBSD: head/tools/build/options/WITHOUT_INCLUDES 275138 2014-11-26 20:43:09Z gjb
779Set to not install header files.
780This option used to be spelled
781.Va NO_INCS .
782.Bf -symbolic
783The option does not work for build targets.
784.Ef
785.It Va WITHOUT_INET
786.\" from FreeBSD: head/tools/build/options/WITHOUT_INET 221266 2011-04-30 17:58:28Z bz
787Set to not build programs and libraries related to IPv4 networking.
788When set, it also enforces the following options:
789.Pp
790.Bl -item -compact
791.It
792.Va WITHOUT_INET_SUPPORT
793.El
794.It Va WITHOUT_INET6
795.\" from FreeBSD: head/tools/build/options/WITHOUT_INET6 156932 2006-03-21 07:50:50Z ru
796Set to not build
797programs and libraries related to IPv6 networking.
798When set, it also enforces the following options:
799.Pp
800.Bl -item -compact
801.It
802.Va WITHOUT_INET6_SUPPORT
803.El
804.It Va WITHOUT_INET6_SUPPORT
805.\" from FreeBSD: head/tools/build/options/WITHOUT_INET6_SUPPORT 156932 2006-03-21 07:50:50Z ru
806Set to build libraries, programs, and kernel modules without IPv6 support.
807.It Va WITHOUT_INETD
808.\" from FreeBSD: head/tools/build/options/WITHOUT_INETD 278192 2015-02-04 10:19:32Z ngie
809Set to not build
810.Xr inetd 8 .
811.It Va WITHOUT_INET_SUPPORT
812.\" from FreeBSD: head/tools/build/options/WITHOUT_INET_SUPPORT 221266 2011-04-30 17:58:28Z bz
813Set to build libraries, programs, and kernel modules without IPv4 support.
814.It Va WITHOUT_INSTALLLIB
815.\" from FreeBSD: head/tools/build/options/WITHOUT_INSTALLLIB 174497 2007-12-09 21:56:21Z dougb
816Set this if you do not want to install optional libraries.
817For example when creating a
818.Xr nanobsd 8
819image.
820.It Va WITH_INSTALL_AS_USER
821.\" from FreeBSD: head/tools/build/options/WITH_INSTALL_AS_USER 238021 2012-07-02 20:24:01Z marcel
822Set to make install targets succeed for non-root users by installing
823files with owner and group attributes set to that of the user running
824the
825.Xr make 1
826command.
827The user still has to set the
828.Va DESTDIR
829variable to point to a directory where the user has write permissions.
830.It Va WITHOUT_IPFILTER
831.\" from FreeBSD: head/tools/build/options/WITHOUT_IPFILTER 156932 2006-03-21 07:50:50Z ru
832Set to not build IP Filter package.
833.It Va WITHOUT_IPFW
834.\" from FreeBSD: head/tools/build/options/WITHOUT_IPFW 183242 2008-09-21 22:02:26Z sam
835Set to not build IPFW tools.
836.It Va WITHOUT_ISCSI
837.\" from FreeBSD: head/tools/build/options/WITHOUT_ISCSI 277675 2015-01-25 04:20:11Z ngie
838Set to not build
839.Xr iscid 8
840and related utilities.
841.It Va WITHOUT_JAIL
842.\" from FreeBSD: head/tools/build/options/WITHOUT_JAIL 249966 2013-04-27 04:09:09Z eadler
843Set to not build tools for the support of jails; e.g.,
844.Xr jail 8 .
845.It Va WITHOUT_KDUMP
846.\" from FreeBSD: head/tools/build/options/WITHOUT_KDUMP 240690 2012-09-19 11:38:37Z zeising
847Set to not build
848.Xr kdump 1
849and
850.Xr truss 1 .
851.It Va WITHOUT_KERBEROS
852.\" from FreeBSD: head/tools/build/options/WITHOUT_KERBEROS 174549 2007-12-12 16:42:03Z ru
853Set this if you do not want to build Kerberos 5 (KTH Heimdal).
854When set, it also enforces the following options:
855.Pp
856.Bl -item -compact
857.It
858.Va WITHOUT_KERBEROS_SUPPORT
859.El
860.Pp
861When set, the following options are also in effect:
862.Pp
863.Bl -inset -compact
864.It Va WITHOUT_GSSAPI
865(unless
866.Va WITH_GSSAPI
867is set explicitly)
868.El
869.It Va WITHOUT_KERBEROS_SUPPORT
870.\" from FreeBSD: head/tools/build/options/WITHOUT_KERBEROS_SUPPORT 251794 2013-06-15 20:29:07Z eadler
871Set to build some programs without Kerberos support, like
872.Xr ssh 1 ,
873.Xr telnet 1 ,
874.Xr sshd 8 ,
875and
876.Xr telnetd 8 .
877.It Va WITHOUT_KERNEL_SYMBOLS
878.\" from FreeBSD: head/tools/build/options/WITHOUT_KERNEL_SYMBOLS 222189 2011-05-22 18:23:17Z imp
879Set to not install kernel symbol files.
880.Bf -symbolic
881This option is recommended for those people who have small root partitions.
882.Ef
883.It Va WITHOUT_KVM
884.\" from FreeBSD: head/tools/build/options/WITHOUT_KVM 174550 2007-12-12 16:43:17Z ru
885Set to not build the
886.Nm libkvm
887library as a part of the base system.
888.Bf -symbolic
889The option has no effect yet.
890.Ef
891When set, it also enforces the following options:
892.Pp
893.Bl -item -compact
894.It
895.Va WITHOUT_KVM_SUPPORT
896.El
897.It Va WITHOUT_KVM_SUPPORT
898.\" from FreeBSD: head/tools/build/options/WITHOUT_KVM_SUPPORT 170644 2007-06-13 02:08:04Z sepotvin
899Set to build some programs without optional
900.Nm libkvm
901support.
902.It Va WITHOUT_LDNS
903.\" from FreeBSD: head/tools/build/options/WITHOUT_LDNS 255591 2013-09-15 13:11:13Z des
904Setting this variable will prevent the LDNS library from being built.
905When set, it also enforces the following options:
906.Pp
907.Bl -item -compact
908.It
909.Va WITHOUT_LDNS_UTILS
910.It
911.Va WITHOUT_UNBOUND
912.El
913.It Va WITHOUT_LDNS_UTILS
914.\" from FreeBSD: head/tools/build/options/WITHOUT_LDNS_UTILS 255850 2013-09-24 14:33:31Z des
915Setting this variable will prevent building the LDNS utilities
916.Xr drill 1
917and
918.Xr host 1 .
919.It Va WITHOUT_LEGACY_CONSOLE
920.\" from FreeBSD: head/tools/build/options/WITHOUT_LEGACY_CONSOLE 249966 2013-04-27 04:09:09Z eadler
921Set to not build programs that support a legacy PC console; e.g.,
922.Xr kbdcontrol 8
923and
924.Xr vidcontrol 8 .
925.It Va WITHOUT_LIB32
926.\" from FreeBSD: head/tools/build/options/WITHOUT_LIB32 274664 2014-11-18 17:06:48Z imp
927On 64-bit platforms, set to not build 32-bit library set and a
928.Nm ld-elf32.so.1
929runtime linker.
930.It Va WITHOUT_LIBCPLUSPLUS
931.\" from FreeBSD: head/tools/build/options/WITHOUT_LIBCPLUSPLUS 246262 2013-02-02 22:42:46Z dim
932Set to avoid building libcxxrt and libc++.
933.It Va WITHOUT_LIBPTHREAD
934.\" from FreeBSD: head/tools/build/options/WITHOUT_LIBPTHREAD 188848 2009-02-20 11:09:55Z mtm
935Set to not build the
936.Nm libpthread
937providing library,
938.Nm libthr .
939When set, it also enforces the following options:
940.Pp
941.Bl -item -compact
942.It
943.Va WITHOUT_LIBTHR
944.El
945.It Va WITHOUT_LIBTHR
946.\" from FreeBSD: head/tools/build/options/WITHOUT_LIBTHR 156932 2006-03-21 07:50:50Z ru
947Set to not build the
948.Nm libthr
949(1:1 threading)
950library.
951.It Va WITHOUT_LLDB
952.\" from FreeBSD: head/tools/build/options/WITHOUT_LLDB 289275 2015-10-14 00:23:31Z emaste
953Set to not build the LLDB debugger.
954.Pp
955It is a default setting on
956arm/arm, arm/armeb, arm/armv6, arm/armv6hf, i386/i386, mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32, pc98/i386, powerpc/powerpc, powerpc/powerpc64 and sparc64/sparc64.
957.It Va WITH_LLDB
958.\" from FreeBSD: head/tools/build/options/WITH_LLDB 255722 2013-09-20 01:52:02Z emaste
959Set to build the LLDB debugger.
960.Pp
961It is a default setting on
962amd64/amd64 and arm64/aarch64.
963.It Va WITHOUT_LLVM_LIBUNWIND
964.\" from FreeBSD: head/tools/build/options/WITHOUT_LLVM_LIBUNWIND 293450 2016-01-09 00:42:07Z emaste
965Set to use GCC's stack unwinder (instead of LLVM's libunwind).
966.Pp
967It is a default setting on
968amd64/amd64, arm/arm, arm/armeb, arm/armv6, arm/armv6hf, i386/i386, mips/mipsel, mips/mips, mips/mips64el, mips/mips64, mips/mipsn32, pc98/i386, powerpc/powerpc, powerpc/powerpc64 and sparc64/sparc64.
969.It Va WITH_LLVM_LIBUNWIND
970.\" from FreeBSD: head/tools/build/options/WITH_LLVM_LIBUNWIND 293450 2016-01-09 00:42:07Z emaste
971Set to use LLVM's libunwind stack unwinder (instead of GCC's unwinder).
972.Pp
973It is a default setting on
974arm64/aarch64.
975.It Va WITHOUT_LOCALES
976.\" from FreeBSD: head/tools/build/options/WITHOUT_LOCALES 156932 2006-03-21 07:50:50Z ru
977Set to not build localization files; see
978.Xr locale 1 .
979.It Va WITHOUT_LOCATE
980.\" from FreeBSD: head/tools/build/options/WITHOUT_LOCATE 183242 2008-09-21 22:02:26Z sam
981Set to not build
982.Xr locate 1
983and related programs.
984.It Va WITHOUT_LPR
985.\" from FreeBSD: head/tools/build/options/WITHOUT_LPR 156932 2006-03-21 07:50:50Z ru
986Set to not build
987.Xr lpr 1
988and related programs.
989.It Va WITHOUT_LS_COLORS
990.\" from FreeBSD: head/tools/build/options/WITHOUT_LS_COLORS 235660 2012-05-19 20:05:27Z marcel
991Set to build
992.Xr ls 1
993without support for colors to distinguish file types.
994.It Va WITHOUT_LZMA_SUPPORT
995.\" from FreeBSD: head/tools/build/options/WITHOUT_LZMA_SUPPORT 245171 2013-01-08 18:37:12Z obrien
996Set to build some programs without optional lzma compression support.
997.It Va WITHOUT_MAIL
998.\" from FreeBSD: head/tools/build/options/WITHOUT_MAIL 183242 2008-09-21 22:02:26Z sam
999Set to not build any mail support (MUA or MTA).
1000When set, it also enforces the following options:
1001.Pp
1002.Bl -item -compact
1003.It
1004.Va WITHOUT_DMAGENT
1005.It
1006.Va WITHOUT_MAILWRAPPER
1007.It
1008.Va WITHOUT_SENDMAIL
1009.El
1010.It Va WITHOUT_MAILWRAPPER
1011.\" from FreeBSD: head/tools/build/options/WITHOUT_MAILWRAPPER 156932 2006-03-21 07:50:50Z ru
1012Set to not build the
1013.Xr mailwrapper 8
1014MTA selector.
1015.It Va WITHOUT_MAKE
1016.\" from FreeBSD: head/tools/build/options/WITHOUT_MAKE 183242 2008-09-21 22:02:26Z sam
1017Set to not install
1018.Xr make 1
1019and related support files.
1020.It Va WITHOUT_MAN
1021.\" from FreeBSD: head/tools/build/options/WITHOUT_MAN 156932 2006-03-21 07:50:50Z ru
1022Set to not build manual pages.
1023When set, the following options are also in effect:
1024.Pp
1025.Bl -inset -compact
1026.It Va WITHOUT_MAN_UTILS
1027(unless
1028.Va WITH_MAN_UTILS
1029is set explicitly)
1030.El
1031.It Va WITHOUT_MANCOMPRESS
1032.\" from FreeBSD: head/tools/build/options/WITHOUT_MANCOMPRESS 266752 2014-05-27 15:52:27Z gjb
1033Set to not to install compressed man pages.
1034Only the uncompressed versions will be installed.
1035.It Va WITHOUT_MANDOCDB
1036.\" from FreeBSD: head/tools/build/options/WITHOUT_MANDOCDB 283777 2015-05-30 17:41:37Z bapt
1037Use the
1038.Xr mandoc 1
1039version of
1040.Xr makewhatis 8
1041database and utilities.
1042.It Va WITHOUT_MAN_UTILS
1043.\" from FreeBSD: head/tools/build/options/WITHOUT_MAN_UTILS 208322 2010-05-20 00:07:21Z jkim
1044Set to not build utilities for manual pages,
1045.Xr apropos 1 ,
1046.Xr catman 1 ,
1047.Xr makewhatis 1 ,
1048.Xr man 1 ,
1049.Xr whatis 1 ,
1050.Xr manctl 8 ,
1051and related support files.
1052.It Va WITH_META_MODE
1053.\" from FreeBSD: head/tools/build/options/WITH_META_MODE 290816 2015-11-14 03:24:48Z sjg
1054Create meta files when not doing DIRDEPS_BUILD.
1055The meta files can be useful for debugging.
1056.Pp
1057This must be set in the environment, make command line, or
1058.Pa /etc/src-env.conf ,
1059not
1060.Pa /etc/src.conf .
1061.It Va WITH_NAND
1062.\" from FreeBSD: head/tools/build/options/WITH_NAND 235537 2012-05-17 10:11:18Z gber
1063Set to build the NAND Flash components.
1064.It Va WITHOUT_NDIS
1065.\" from FreeBSD: head/tools/build/options/WITHOUT_NDIS 183242 2008-09-21 22:02:26Z sam
1066Set to not build programs and libraries
1067related to NDIS emulation support.
1068.It Va WITHOUT_NETCAT
1069.\" from FreeBSD: head/tools/build/options/WITHOUT_NETCAT 156932 2006-03-21 07:50:50Z ru
1070Set to not build
1071.Xr nc 1
1072utility.
1073.It Va WITHOUT_NETGRAPH
1074.\" from FreeBSD: head/tools/build/options/WITHOUT_NETGRAPH 183242 2008-09-21 22:02:26Z sam
1075Set to not build applications to support
1076.Xr netgraph 4 .
1077When set, it also enforces the following options:
1078.Pp
1079.Bl -item -compact
1080.It
1081.Va WITHOUT_ATM
1082.It
1083.Va WITHOUT_BLUETOOTH
1084.It
1085.Va WITHOUT_NETGRAPH_SUPPORT
1086.El
1087.It Va WITHOUT_NETGRAPH_SUPPORT
1088.\" from FreeBSD: head/tools/build/options/WITHOUT_NETGRAPH_SUPPORT 183305 2008-09-23 16:11:15Z sam
1089Set to build libraries, programs, and kernel modules without netgraph support.
1090.It Va WITHOUT_NIS
1091.\" from FreeBSD: head/tools/build/options/WITHOUT_NIS 156932 2006-03-21 07:50:50Z ru
1092Set to not build
1093.Xr NIS 8
1094support and related programs.
1095If set, you might need to adopt your
1096.Xr nsswitch.conf 5
1097and remove
1098.Sq nis
1099entries.
1100.It Va WITHOUT_NLS
1101.\" from FreeBSD: head/tools/build/options/WITHOUT_NLS 156932 2006-03-21 07:50:50Z ru
1102Set to not build NLS catalogs.
1103.It Va WITHOUT_NLS_CATALOGS
1104.\" from FreeBSD: head/tools/build/options/WITHOUT_NLS_CATALOGS 156932 2006-03-21 07:50:50Z ru
1105Set to not build NLS catalog support for
1106.Xr csh 1 .
1107.It Va WITHOUT_NS_CACHING
1108.\" from FreeBSD: head/tools/build/options/WITHOUT_NS_CACHING 172803 2007-10-19 14:01:25Z ru
1109Set to disable name caching in the
1110.Pa nsswitch
1111subsystem.
1112The generic caching daemon,
1113.Xr nscd 8 ,
1114will not be built either if this option is set.
1115.It Va WITHOUT_NTP
1116.\" from FreeBSD: head/tools/build/options/WITHOUT_NTP 183242 2008-09-21 22:02:26Z sam
1117Set to not build
1118.Xr ntpd 8
1119and related programs.
1120.It Va WITH_OFED
1121.\" from FreeBSD: head/tools/build/options/WITH_OFED 228081 2011-11-28 17:54:34Z dim
1122Set to build the
1123.Dq "OpenFabrics Enterprise Distribution"
1124Infiniband software stack.
1125.It Va WITH_OPENLDAP
1126.\" from FreeBSD: head/tools/build/options/WITH_OPENLDAP 264902 2014-04-24 23:17:31Z imp
1127Enable building openldap support for kerberos.
1128.It Va WITHOUT_OPENSSH
1129.\" from FreeBSD: head/tools/build/options/WITHOUT_OPENSSH 156932 2006-03-21 07:50:50Z ru
1130Set to not build OpenSSH.
1131.It Va WITHOUT_OPENSSL
1132.\" from FreeBSD: head/tools/build/options/WITHOUT_OPENSSL 156932 2006-03-21 07:50:50Z ru
1133Set to not build OpenSSL.
1134When set, it also enforces the following options:
1135.Pp
1136.Bl -item -compact
1137.It
1138.Va WITHOUT_KERBEROS
1139.It
1140.Va WITHOUT_KERBEROS_SUPPORT
1141.It
1142.Va WITHOUT_OPENSSH
1143.El
1144.Pp
1145When set, the following options are also in effect:
1146.Pp
1147.Bl -inset -compact
1148.It Va WITHOUT_GSSAPI
1149(unless
1150.Va WITH_GSSAPI
1151is set explicitly)
1152.El
1153.It Va WITHOUT_PAM
1154.\" from FreeBSD: head/tools/build/options/WITHOUT_PAM 174550 2007-12-12 16:43:17Z ru
1155Set to not build PAM library and modules.
1156.Bf -symbolic
1157This option is deprecated and does nothing.
1158.Ef
1159When set, it also enforces the following options:
1160.Pp
1161.Bl -item -compact
1162.It
1163.Va WITHOUT_PAM_SUPPORT
1164.El
1165.It Va WITHOUT_PAM_SUPPORT
1166.\" from FreeBSD: head/tools/build/options/WITHOUT_PAM_SUPPORT 156932 2006-03-21 07:50:50Z ru
1167Set to build some programs without PAM support, particularly
1168.Xr ftpd 8
1169and
1170.Xr ppp 8 .
1171.It Va WITHOUT_PC_SYSINSTALL
1172.\" from FreeBSD: head/tools/build/options/WITHOUT_PC_SYSINSTALL 245606 2013-01-18 15:57:09Z eadler
1173Set to not build
1174.Xr pc-sysinstall 8
1175and related programs.
1176.It Va WITHOUT_PF
1177.\" from FreeBSD: head/tools/build/options/WITHOUT_PF 156932 2006-03-21 07:50:50Z ru
1178Set to not build PF firewall package.
1179When set, it also enforces the following options:
1180.Pp
1181.Bl -item -compact
1182.It
1183.Va WITHOUT_AUTHPF
1184.El
1185.It Va WITHOUT_PKGBOOTSTRAP
1186.\" from FreeBSD: head/tools/build/options/WITHOUT_PKGBOOTSTRAP 258924 2013-12-04 15:58:42Z bdrewery
1187Set to not build
1188.Xr pkg 7
1189bootstrap tool.
1190.It Va WITHOUT_PMC
1191.\" from FreeBSD: head/tools/build/options/WITHOUT_PMC 183242 2008-09-21 22:02:26Z sam
1192Set to not build
1193.Xr pmccontrol 8
1194and related programs.
1195.It Va WITHOUT_PORTSNAP
1196.\" from FreeBSD: head/tools/build/options/WITHOUT_PORTSNAP 183242 2008-09-21 22:02:26Z sam
1197Set to not build or install
1198.Xr portsnap 8
1199and related files.
1200.It Va WITHOUT_PPP
1201.\" from FreeBSD: head/tools/build/options/WITHOUT_PPP 183242 2008-09-21 22:02:26Z sam
1202Set to not build
1203.Xr ppp 8
1204and related programs.
1205.It Va WITHOUT_PROFILE
1206.\" from FreeBSD: head/tools/build/options/WITHOUT_PROFILE 228196 2011-12-02 09:09:54Z fjoe
1207Set to avoid compiling profiled libraries.
1208.It Va WITHOUT_QUOTAS
1209.\" from FreeBSD: head/tools/build/options/WITHOUT_QUOTAS 183242 2008-09-21 22:02:26Z sam
1210Set to not build
1211.Xr quota 8
1212and related programs.
1213.It Va WITHOUT_RADIUS_SUPPORT
1214.\" from FreeBSD: head/tools/build/options/WITHOUT_RADIUS_SUPPORT 278182 2015-02-04 06:53:45Z ngie
1215Set to not build radius support into various applications, like
1216.Xr pam_radius 8
1217and
1218.Xr ppp 8 .
1219.It Va WITHOUT_RBOOTD
1220.\" from FreeBSD: head/tools/build/options/WITHOUT_RBOOTD 278192 2015-02-04 10:19:32Z ngie
1221Set to not build or install
1222.Xr rbootd 8 .
1223.It Va WITHOUT_RCMDS
1224.\" from FreeBSD: head/tools/build/options/WITHOUT_RCMDS 156932 2006-03-21 07:50:50Z ru
1225Disable building of the
1226.Bx
1227r-commands.
1228This includes
1229.Xr rlogin 1 ,
1230.Xr rsh 1 ,
1231etc.
1232.It Va WITHOUT_RCS
1233.\" from FreeBSD: head/tools/build/options/WITHOUT_RCS 275138 2014-11-26 20:43:09Z gjb
1234Set to not build
1235.Xr rcs 1 ,
1236.Xr etcupdate 8 ,
1237and related utilities.
1238.It Va WITHOUT_RESCUE
1239.\" from FreeBSD: head/tools/build/options/WITHOUT_RESCUE 156932 2006-03-21 07:50:50Z ru
1240Set to not build
1241.Xr rescue 8 .
1242.It Va WITHOUT_ROUTED
1243.\" from FreeBSD: head/tools/build/options/WITHOUT_ROUTED 183242 2008-09-21 22:02:26Z sam
1244Set to not build
1245.Xr routed 8
1246utility.
1247.It Va WITHOUT_SENDMAIL
1248.\" from FreeBSD: head/tools/build/options/WITHOUT_SENDMAIL 156932 2006-03-21 07:50:50Z ru
1249Set to not build
1250.Xr sendmail 8
1251and related programs.
1252.It Va WITHOUT_SETUID_LOGIN
1253.\" from FreeBSD: head/tools/build/options/WITHOUT_SETUID_LOGIN 156932 2006-03-21 07:50:50Z ru
1254Set this to disable the installation of
1255.Xr login 1
1256as a set-user-ID root program.
1257.It Va WITHOUT_SHAREDOCS
1258.\" from FreeBSD: head/tools/build/options/WITHOUT_SHAREDOCS 156932 2006-03-21 07:50:50Z ru
1259Set to not build the
1260.Bx 4.4
1261legacy docs.
1262.It Va WITH_SHARED_TOOLCHAIN
1263.\" from FreeBSD: head/tools/build/options/WITH_SHARED_TOOLCHAIN 235342 2012-05-12 16:12:36Z gjb
1264Set to build the toolchain binaries shared.
1265The set includes
1266.Xr cc 1 ,
1267.Xr make 1
1268and necessary utilities like assembler, linker and library archive manager.
1269.It Va WITH_SORT_THREADS
1270.\" from FreeBSD: head/tools/build/options/WITH_SORT_THREADS 264158 2014-04-05 18:00:45Z imp
1271Set to enable threads in
1272.Xr sort 1 .
1273.It Va WITHOUT_SOURCELESS
1274.\" from FreeBSD: head/tools/build/options/WITHOUT_SOURCELESS 230972 2012-02-04 00:54:43Z rmh
1275Set to not build kernel modules that include sourceless code (either microcode or native code for host CPU).
1276When set, it also enforces the following options:
1277.Pp
1278.Bl -item -compact
1279.It
1280.Va WITHOUT_SOURCELESS_HOST
1281.It
1282.Va WITHOUT_SOURCELESS_UCODE
1283.El
1284.It Va WITHOUT_SOURCELESS_HOST
1285.\" from FreeBSD: head/tools/build/options/WITHOUT_SOURCELESS_HOST 230972 2012-02-04 00:54:43Z rmh
1286Set to not build kernel modules that include sourceless native code for host CPU.
1287.It Va WITHOUT_SOURCELESS_UCODE
1288.\" from FreeBSD: head/tools/build/options/WITHOUT_SOURCELESS_UCODE 230972 2012-02-04 00:54:43Z rmh
1289Set to not build kernel modules that include sourceless microcode.
1290.It Va WITHOUT_SSP
1291.\" from FreeBSD: head/tools/build/options/WITHOUT_SSP 180012 2008-06-25 21:33:28Z ru
1292Set to not build world with propolice stack smashing protection.
1293.It Va WITH_STAGING
1294.\" from FreeBSD: head/tools/build/options/WITH_STAGING 290816 2015-11-14 03:24:48Z sjg
1295Enable staging of files to a stage tree.
1296This can be best thought of as auto-install to
1297.Va DESTDIR
1298with some extra meta data to ensure dependencies can be tracked.
1299Depends on
1300.Va WITH_DIRDEPS_BUILD .
1301When set, the following options are also in effect:
1302.Pp
1303.Bl -inset -compact
1304.It Va WITH_STAGING_MAN
1305(unless
1306.Va WITHOUT_STAGING_MAN
1307is set explicitly)
1308.It Va WITH_STAGING_PROG
1309(unless
1310.Va WITHOUT_STAGING_PROG
1311is set explicitly)
1312.El
1313.Pp
1314This must be set in the environment, make command line, or
1315.Pa /etc/src-env.conf ,
1316not
1317.Pa /etc/src.conf .
1318.It Va WITH_STAGING_MAN
1319.\" from FreeBSD: head/tools/build/options/WITH_STAGING_MAN 284708 2015-06-22 20:21:57Z sjg
1320Enable staging of MAN pages to stage tree.
1321.It Va WITH_STAGING_PROG
1322.\" from FreeBSD: head/tools/build/options/WITH_STAGING_PROG 284708 2015-06-22 20:21:57Z sjg
1323Enable staging of PROGs to stage tree.
1324.It Va WITH_STALE_STAGED
1325.\" from FreeBSD: head/tools/build/options/WITH_STALE_STAGED 284708 2015-06-22 20:21:57Z sjg
1326Check staged files are not stale.
1327.It Va WITH_SVN
1328.\" from FreeBSD: head/tools/build/options/WITH_SVN 252561 2013-07-03 12:36:47Z zeising
1329Set to install
1330.Xr svnlite 1
1331as
1332.Xr svn 1 .
1333.It Va WITHOUT_SVNLITE
1334.\" from FreeBSD: head/tools/build/options/WITHOUT_SVNLITE 252561 2013-07-03 12:36:47Z zeising
1335Set to not build
1336.Xr svnlite 1
1337and related programs.
1338.It Va WITHOUT_SYMVER
1339.\" from FreeBSD: head/tools/build/options/WITHOUT_SYMVER 169649 2007-05-17 05:03:24Z deischen
1340Set to disable symbol versioning when building shared libraries.
1341.It Va WITHOUT_SYSCONS
1342.\" from FreeBSD: head/tools/build/options/WITHOUT_SYSCONS 156932 2006-03-21 07:50:50Z ru
1343Set to not build
1344.Xr syscons 4
1345support files such as keyboard maps, fonts, and screen output maps.
1346.It Va WITH_SYSROOT
1347.\" from FreeBSD: head/tools/build/options/WITH_SYSROOT 290816 2015-11-14 03:24:48Z sjg
1348Enable use of sysroot during build.
1349Depends on
1350.Va WITH_DIRDEPS_BUILD .
1351.Pp
1352This must be set in the environment, make command line, or
1353.Pa /etc/src-env.conf ,
1354not
1355.Pa /etc/src.conf .
1356.It Va WITHOUT_TALK
1357.\" from FreeBSD: head/tools/build/options/WITHOUT_TALK 277676 2015-01-25 04:37:44Z ngie
1358Set to not build or install
1359.Xr talk 1
1360and
1361.Xr talkd 8 .
1362.It Va WITHOUT_TCP_WRAPPERS
1363.\" from FreeBSD: head/tools/build/options/WITHOUT_TCP_WRAPPERS 278192 2015-02-04 10:19:32Z ngie
1364Set to not build or install
1365.Xr tcpd 8 ,
1366and related utilities.
1367.It Va WITHOUT_TCSH
1368.\" from FreeBSD: head/tools/build/options/WITHOUT_TCSH 156932 2006-03-21 07:50:50Z ru
1369Set to not build and install
1370.Pa /bin/csh
1371(which is
1372.Xr tcsh 1 ) .
1373.It Va WITHOUT_TELNET
1374.\" from FreeBSD: head/tools/build/options/WITHOUT_TELNET 183242 2008-09-21 22:02:26Z sam
1375Set to not build
1376.Xr telnet 8
1377and related programs.
1378.It Va WITHOUT_TESTS
1379.\" from FreeBSD: head/tools/build/options/WITHOUT_TESTS 268778 2014-07-16 21:40:11Z jmmv
1380Set to not build nor install the
1381.Fx
1382Test Suite in
1383.Pa /usr/tests/ .
1384See
1385.Xr tests 7
1386for more details.
1387This also disables the build of all test-related dependencies, including ATF.
1388When set, it also enforces the following options:
1389.Pp
1390.Bl -item -compact
1391.It
1392.Va WITHOUT_DTRACE_TESTS
1393.It
1394.Va WITHOUT_TESTS_SUPPORT
1395.El
1396.It Va WITHOUT_TESTS_SUPPORT
1397.\" from FreeBSD: head/tools/build/options/WITHOUT_TESTS_SUPPORT 274665 2014-11-18 17:06:50Z imp
1398Set to disables the build of all test-related dependencies, including ATF.
1399.It Va WITHOUT_TEXTPROC
1400.\" from FreeBSD: head/tools/build/options/WITHOUT_TEXTPROC 183242 2008-09-21 22:02:26Z sam
1401Set to not build
1402programs used for text processing.
1403When set, it also enforces the following options:
1404.Pp
1405.Bl -item -compact
1406.It
1407.Va WITHOUT_GROFF
1408.El
1409.It Va WITHOUT_TFTP
1410.\" from FreeBSD: head/tools/build/options/WITHOUT_TFTP 278192 2015-02-04 10:19:32Z ngie
1411Set to not build or install
1412.Xr tftp 1
1413and
1414.Xr tftpd 8 .
1415.It Va WITHOUT_TIMED
1416.\" from FreeBSD: head/tools/build/options/WITHOUT_TIMED 278192 2015-02-04 10:19:32Z ngie
1417Set to not build or install
1418.Xr timed 8 .
1419.It Va WITHOUT_TOOLCHAIN
1420.\" from FreeBSD: head/tools/build/options/WITHOUT_TOOLCHAIN 273172 2014-10-16 15:55:13Z brooks
1421Set to not install header or
1422programs used for program development,
1423compilers, debuggers etc.
1424.Bf -symbolic
1425The option does not work for build targets.
1426.Ef
1427When set, it also enforces the following options:
1428.Pp
1429.Bl -item -compact
1430.It
1431.Va WITHOUT_BINUTILS
1432.It
1433.Va WITHOUT_CLANG
1434.It
1435.Va WITHOUT_CLANG_EXTRAS
1436.It
1437.Va WITHOUT_CLANG_FULL
1438.It
1439.Va WITHOUT_GCC
1440.It
1441.Va WITHOUT_GDB
1442.It
1443.Va WITHOUT_INCLUDES
1444.El
1445.It Va WITHOUT_UNBOUND
1446.\" from FreeBSD: head/tools/build/options/WITHOUT_UNBOUND 255597 2013-09-15 14:51:23Z des
1447Set to not build
1448.Xr unbound 8
1449and related programs.
1450.It Va WITHOUT_USB
1451.\" from FreeBSD: head/tools/build/options/WITHOUT_USB 156932 2006-03-21 07:50:50Z ru
1452Set to not build USB-related programs and libraries.
1453.It Va WITHOUT_USB_GADGET_EXAMPLES
1454.\" from FreeBSD: head/tools/build/options/WITHOUT_USB_GADGET_EXAMPLES 274665 2014-11-18 17:06:50Z imp
1455Set to build USB gadget kernel modules.
1456.It Va WITHOUT_UTMPX
1457.\" from FreeBSD: head/tools/build/options/WITHOUT_UTMPX 231530 2012-02-11 20:28:42Z ed
1458Set to not build user accounting tools such as
1459.Xr last 1 ,
1460.Xr users 1 ,
1461.Xr who 1 ,
1462.Xr ac 8 ,
1463.Xr lastlogin 8
1464and
1465.Xr utx 8 .
1466.It Va WITHOUT_VI
1467.\" from FreeBSD: head/tools/build/options/WITHOUT_VI 264903 2014-04-24 23:17:40Z imp
1468Set to not build and install vi, view, ex and related programs.
1469.It Va WITHOUT_VT
1470.\" from FreeBSD: head/tools/build/options/WITHOUT_VT 268022 2014-06-30 00:20:12Z emaste
1471Set to not build
1472.Xr vt 4
1473support files (fonts and keymaps).
1474.It Va WITHOUT_WARNS
1475.\" from FreeBSD: head/tools/build/options/WITHOUT_WARNS 276559 2015-01-02 18:57:58Z bapt
1476Set this to not add warning flags to the compiler invocations.
1477Useful as a temporary workaround when code enters the tree
1478which triggers warnings in environments that differ from the
1479original developer.
1480.It Va WITHOUT_WIRELESS
1481.\" from FreeBSD: head/tools/build/options/WITHOUT_WIRELESS 183242 2008-09-21 22:02:26Z sam
1482Set to not build programs used for 802.11 wireless networks; especially
1483.Xr wpa_supplicant 8
1484and
1485.Xr hostapd 8 .
1486When set, it also enforces the following options:
1487.Pp
1488.Bl -item -compact
1489.It
1490.Va WITHOUT_WIRELESS_SUPPORT
1491.El
1492.It Va WITHOUT_WIRELESS_SUPPORT
1493.\" from FreeBSD: head/tools/build/options/WITHOUT_WIRELESS_SUPPORT 183305 2008-09-23 16:11:15Z sam
1494Set to build libraries, programs, and kernel modules without
1495802.11 wireless support.
1496.It Va WITHOUT_WPA_SUPPLICANT_EAPOL
1497.\" from FreeBSD: head/tools/build/options/WITHOUT_WPA_SUPPLICANT_EAPOL 156932 2006-03-21 07:50:50Z ru
1498Build
1499.Xr wpa_supplicant 8
1500without support for the IEEE 802.1X protocol and without
1501support for EAP-PEAP, EAP-TLS, EAP-LEAP, and EAP-TTLS
1502protocols (usable only via 802.1X).
1503.It Va WITHOUT_ZFS
1504.\" from FreeBSD: head/tools/build/options/WITHOUT_ZFS 168409 2007-04-06 02:13:30Z pjd
1505Set to not build ZFS file system.
1506.It Va WITHOUT_ZONEINFO
1507.\" from FreeBSD: head/tools/build/options/WITHOUT_ZONEINFO 235342 2012-05-12 16:12:36Z gjb
1508Set to not build the timezone database.
1509.El
1510.Sh FILES
1511.Bl -tag -compact -width Pa
1512.It Pa /etc/src.conf
1513.It Pa /etc/src-env.conf
1514.It Pa /usr/share/mk/bsd.own.mk
1515.El
1516.Sh SEE ALSO
1517.Xr make 1 ,
1518.Xr make.conf 5 ,
1519.Xr build 7 ,
1520.Xr ports 7
1521.Sh HISTORY
1522The
1523.Nm
1524file appeared in
1525.Fx 7.0 .
1526.Sh AUTHORS
1527This manual page was autogenerated.
1528