xref: /freebsd/share/man/man5/src.conf.5 (revision 8847579c57d6aff2b3371c707dce7a2cee8389aa)
1.\" DO NOT EDIT-- this file is automatically generated.
2.\" from FreeBSD: src/tools/build/options/makeman,v 1.2 2006/03/21 09:08:45 ru Exp
3.\" $FreeBSD$
4.Dd April 13, 2006
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
41maybe 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
53sources, which are usually found 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 environment; see
66.Xr environ 7 .
67.Pp
68The values of variables are ignored; the variable being
69set at all (even to
70.Dq Li FALSE
71or
72.Dq Li NO )
73causes it to be treated as if it was set with no value.
74.Pp
75The following list provides a name and short description for variables
76that can be used for source builds.
77.Bl -tag -width indent
78.It Va WITHOUT_ACPI
79.\" from FreeBSD: src/tools/build/options/WITHOUT_ACPI,v 1.1 2006/03/21 07:50:49 ru Exp
80Set to not build
81.Xr acpiconf 8 ,
82.Xr acpidump 8
83and related programs.
84.It Va WITHOUT_ATM
85.\" from FreeBSD: src/tools/build/options/WITHOUT_ATM,v 1.1 2006/03/21 07:50:49 ru Exp
86Set to not build
87programs and libraries related to ATM networking.
88.It Va WITHOUT_AUDIT
89.\" from FreeBSD: src/tools/build/options/WITHOUT_AUDIT,v 1.1 2006/03/21 07:50:49 ru Exp
90Set to not build audit support into system programs.
91.It Va WITHOUT_AUTHPF
92.\" from FreeBSD: src/tools/build/options/WITHOUT_AUTHPF,v 1.1 2006/03/21 07:50:49 ru Exp
93Set to not build
94.Xr authpf 8 .
95.It Va WITHOUT_BIND
96.\" from FreeBSD: src/tools/build/options/WITHOUT_BIND,v 1.1 2006/03/21 07:50:49 ru Exp
97Setting this variable will prevent any part of BIND from being built.
98When set, it also enforces the following options:
99.Pp
100.Bl -item -compact
101.It
102.Va WITHOUT_BIND_DNSSEC
103.It
104.Va WITHOUT_BIND_ETC
105.It
106.Va WITHOUT_BIND_LIBS_LWRES
107.It
108.Va WITHOUT_BIND_MTREE
109.It
110.Va WITHOUT_BIND_NAMED
111.It
112.Va WITHOUT_BIND_UTILS
113.El
114.It Va WITHOUT_BIND_DNSSEC
115.\" from FreeBSD: src/tools/build/options/WITHOUT_BIND_DNSSEC,v 1.1 2006/03/21 07:50:49 ru Exp
116Set to avoid building or installing the DNSSEC related binaries,
117.Xr dnssec-keygen 8
118and
119.Xr dnssec-signzone 8 .
120.It Va WITHOUT_BIND_ETC
121.\" from FreeBSD: src/tools/build/options/WITHOUT_BIND_ETC,v 1.1 2006/03/21 07:50:49 ru Exp
122Set to avoid installing the default files to
123.Pa /var/named/etc/namedb .
124.It Va WITH_BIND_LIBS
125.\" from FreeBSD: src/tools/build/options/WITH_BIND_LIBS,v 1.1 2006/03/21 07:50:50 ru Exp
126Set to install BIND libraries and include files.
127.It Va WITHOUT_BIND_LIBS_LWRES
128.\" from FreeBSD: src/tools/build/options/WITHOUT_BIND_LIBS_LWRES,v 1.1 2006/03/21 07:50:49 ru Exp
129Set to avoid installing the lightweight resolver library in
130.Pa /usr/lib .
131.It Va WITHOUT_BIND_MTREE
132.\" from FreeBSD: src/tools/build/options/WITHOUT_BIND_MTREE,v 1.3 2006/04/13 10:37:29 ru Exp
133Set to avoid running
134.Xr mtree 8
135to create the chroot directory structure under
136.Pa /var/named ,
137and avoid creating an
138.Pa /etc/namedb
139symlink to the chroot directory.
140When set, it also enforces the following options:
141.Pp
142.Bl -item -compact
143.It
144.Va WITHOUT_BIND_ETC
145.El
146.It Va WITHOUT_BIND_NAMED
147.\" from FreeBSD: src/tools/build/options/WITHOUT_BIND_NAMED,v 1.1 2006/03/21 07:50:49 ru Exp
148Set to avoid building or installing
149.Xr named 8 ,
150.Xr named.reload 8 ,
151.Xr named-checkconf 8 ,
152.Xr named-checkzone 8 ,
153.Xr rndc 8 ,
154and
155.Xr rndc-confgen 8 .
156.It Va WITHOUT_BIND_UTILS
157.\" from FreeBSD: src/tools/build/options/WITHOUT_BIND_UTILS,v 1.1 2006/03/21 07:50:49 ru Exp
158Set to avoid building or installing the BIND userland utilities,
159.Xr dig 1 ,
160.Xr host 1 ,
161.Xr nslookup 1 ,
162and
163.Xr nsupdate 8 .
164.It Va WITHOUT_BLUETOOTH
165.\" from FreeBSD: src/tools/build/options/WITHOUT_BLUETOOTH,v 1.1 2006/03/21 07:50:49 ru Exp
166Set to not build Bluetooth related kernel modules, programs and libraries.
167.It Va WITHOUT_BOOT
168.\" from FreeBSD: src/tools/build/options/WITHOUT_BOOT,v 1.1 2006/03/21 07:50:49 ru Exp
169Set to not build the boot blocks and loader.
170.It Va WITHOUT_CALENDAR
171.\" from FreeBSD: src/tools/build/options/WITHOUT_CALENDAR,v 1.1 2006/03/21 07:50:49 ru Exp
172Set to not build
173.Xr calendar 1 .
174.It Va WITHOUT_CPP
175.\" from FreeBSD: src/tools/build/options/WITHOUT_CPP,v 1.1 2006/03/21 07:50:49 ru Exp
176Set to not build
177.Xr cpp 1 .
178.It Va WITHOUT_CRYPT
179.\" from FreeBSD: src/tools/build/options/WITHOUT_CRYPT,v 1.1 2006/03/21 07:50:49 ru Exp
180Set to not build any crypto code.
181When set, it also enforces the following options:
182.Pp
183.Bl -item -compact
184.It
185.Va WITHOUT_KERBEROS
186.It
187.Va WITHOUT_KERBEROS_SUPPORT
188.It
189.Va WITHOUT_OPENSSH
190.It
191.Va WITHOUT_OPENSSL
192.El
193.It Va WITHOUT_CVS
194.\" from FreeBSD: src/tools/build/options/WITHOUT_CVS,v 1.1 2006/03/21 07:50:49 ru Exp
195Set to not build CVS.
196.It Va WITHOUT_CXX
197.\" from FreeBSD: src/tools/build/options/WITHOUT_CXX,v 1.1 2006/03/21 07:50:49 ru Exp
198Set to not build
199.Xr g++ 1
200and related libraries.
201.It Va WITHOUT_DICT
202.\" from FreeBSD: src/tools/build/options/WITHOUT_DICT,v 1.1 2006/03/21 07:50:49 ru Exp
203Set to not build the Webster dictionary files.
204.It Va WITHOUT_DYNAMICROOT
205.\" from FreeBSD: src/tools/build/options/WITHOUT_DYNAMICROOT,v 1.1 2006/03/21 07:50:49 ru Exp
206Set this if you do not want to link
207.Pa /bin
208and
209.Pa /sbin
210dynamically.
211.It Va WITHOUT_EXAMPLES
212.\" from FreeBSD: src/tools/build/options/WITHOUT_EXAMPLES,v 1.2 2006/03/21 09:06:24 ru Exp
213Set to avoid installing examples to
214.Pa /usr/share/examples/ .
215.It Va WITHOUT_FORTH
216.\" from FreeBSD: src/tools/build/options/WITHOUT_FORTH,v 1.1 2006/03/21 07:50:49 ru Exp
217Set to build bootloaders without Forth support.
218.It Va WITHOUT_FORTRAN
219.\" from FreeBSD: src/tools/build/options/WITHOUT_FORTRAN,v 1.1 2006/03/21 07:50:49 ru Exp
220Set to not build
221.Xr g77 1
222and related libraries.
223.It Va WITHOUT_FP_LIBC
224.\" from FreeBSD: src/tools/build/options/WITHOUT_FP_LIBC,v 1.1 2006/03/21 07:50:49 ru Exp
225Set to build
226.Nm libc
227without floating-point support.
228.It Va WITHOUT_GAMES
229.\" from FreeBSD: src/tools/build/options/WITHOUT_GAMES,v 1.1 2006/03/21 07:50:49 ru Exp
230Set to not build games.
231.It Va WITHOUT_GCOV
232.\" from FreeBSD: src/tools/build/options/WITHOUT_GCOV,v 1.1 2006/03/21 07:50:49 ru Exp
233Set to not build the
234.Xr gcov 1
235tool.
236.It Va WITHOUT_GDB
237.\" from FreeBSD: src/tools/build/options/WITHOUT_GDB,v 1.1 2006/03/21 07:50:49 ru Exp
238Set to not build
239.Xr gdb 1 .
240When set, it also enforces the following options:
241.Pp
242.Bl -item -compact
243.It
244.Va WITHOUT_GNU_SUPPORT
245.El
246.It Va WITHOUT_GNU_SUPPORT
247.\" from FreeBSD: src/tools/build/options/WITHOUT_GNU_SUPPORT,v 1.1 2006/03/21 07:50:49 ru Exp
248Set to build some programs without optional GNU support.
249.It Va WITHOUT_GPIB
250.\" from FreeBSD: src/tools/build/options/WITHOUT_GPIB,v 1.1 2006/03/21 07:50:49 ru Exp
251Set to not build GPIB bus support.
252.It Va WITHOUT_GROFF
253.\" from FreeBSD: src/tools/build/options/WITHOUT_GROFF,v 1.1 2006/03/21 07:50:49 ru Exp
254Set to not build
255.Xr groff 1 .
256.It Va WITH_HESIOD
257.\" from FreeBSD: src/tools/build/options/WITH_HESIOD,v 1.1 2006/03/21 07:50:50 ru Exp
258Set to build Hesiod support.
259.It Va WITHOUT_HTML
260.\" from FreeBSD: src/tools/build/options/WITHOUT_HTML,v 1.1 2006/03/21 07:50:49 ru Exp
261Set to not build HTML docs.
262.It Va WITHOUT_I4B
263.\" from FreeBSD: src/tools/build/options/WITHOUT_I4B,v 1.1 2006/03/21 07:50:50 ru Exp
264Set to not build isdn4bsd package.
265.It Va WITH_IDEA
266.\" from FreeBSD: src/tools/build/options/WITH_IDEA,v 1.1 2006/03/21 07:50:50 ru Exp
267Set to build the IDEA encryption code.
268This code is patented in the USA and many European countries.
269It is
270.Em "YOUR RESPONSIBILITY"
271to determine if you can legally use IDEA.
272.It Va WITHOUT_INET6
273.\" from FreeBSD: src/tools/build/options/WITHOUT_INET6,v 1.1 2006/03/21 07:50:50 ru Exp
274Set to not build
275programs and libraries related to IPv6 networking.
276When set, it also enforces the following options:
277.Pp
278.Bl -item -compact
279.It
280.Va WITHOUT_INET6_SUPPORT
281.El
282.It Va WITHOUT_INET6_SUPPORT
283.\" from FreeBSD: src/tools/build/options/WITHOUT_INET6_SUPPORT,v 1.1 2006/03/21 07:50:50 ru Exp
284Set to build libraries, programs, and kernel modules without IPv6 support.
285.It Va WITHOUT_INFO
286.\" from FreeBSD: src/tools/build/options/WITHOUT_INFO,v 1.1 2006/03/21 07:50:50 ru Exp
287Set to not make or install
288.Xr info 5
289files.
290.It Va WITHOUT_IPFILTER
291.\" from FreeBSD: src/tools/build/options/WITHOUT_IPFILTER,v 1.1 2006/03/21 07:50:50 ru Exp
292Set to not build IP Filter package.
293.It Va WITHOUT_IPX
294.\" from FreeBSD: src/tools/build/options/WITHOUT_IPX,v 1.1 2006/03/21 07:50:50 ru Exp
295Set to not build programs and libraries related to IPX networking.
296When set, it also enforces the following options:
297.Pp
298.Bl -item -compact
299.It
300.Va WITHOUT_IPX_SUPPORT
301.It
302.Va WITHOUT_NCP
303.El
304.It Va WITHOUT_IPX_SUPPORT
305.\" from FreeBSD: src/tools/build/options/WITHOUT_IPX_SUPPORT,v 1.1 2006/03/21 07:50:50 ru Exp
306Set to build some programs without IPX support.
307.It Va WITHOUT_KERBEROS
308.\" from FreeBSD: src/tools/build/options/WITHOUT_KERBEROS,v 1.1 2006/03/21 07:50:50 ru Exp
309Set this if you do not want to build Kerberos 5 (KTH Heimdal).
310When set, it also enforces the following options:
311.Pp
312.Bl -item -compact
313.It
314.Va WITHOUT_KERBEROS_SUPPORT
315.El
316.It Va WITHOUT_KERBEROS_SUPPORT
317.\" from FreeBSD: src/tools/build/options/WITHOUT_KERBEROS_SUPPORT,v 1.1 2006/03/21 07:50:50 ru Exp
318Set to build some programs without Kerberos support, like
319.Xr cvs 1 ,
320.Xr ssh 1 ,
321.Xr telnet 1 ,
322.Xr sshd 8 ,
323and
324.Xr telnetd 8 .
325.It Va WITHOUT_LIB32
326.\" from FreeBSD: src/tools/build/options/WITHOUT_LIB32,v 1.1 2006/03/21 07:50:50 ru Exp
327On amd64, set to not build 32-bit library set and a
328.Nm ld-elf32.so.1
329runtime linker.
330.It Va WITHOUT_LIBC_R
331.\" from FreeBSD: src/tools/build/options/WITHOUT_LIBC_R,v 1.1 2006/03/21 07:50:50 ru Exp
332Set to not build
333.Nm libc_r
334(reentrant version of
335.Nm libc ) .
336.It Va WITHOUT_LIBPTHREAD
337.\" from FreeBSD: src/tools/build/options/WITHOUT_LIBPTHREAD,v 1.1 2006/03/21 07:50:50 ru Exp
338Set to not build the
339.Nm libpthread
340(M:N threading)
341library.
342.It Va WITHOUT_LIBTHR
343.\" from FreeBSD: src/tools/build/options/WITHOUT_LIBTHR,v 1.1 2006/03/21 07:50:50 ru Exp
344Set to not build the
345.Nm libthr
346(1:1 threading)
347library.
348.It Va WITHOUT_LOCALES
349.\" from FreeBSD: src/tools/build/options/WITHOUT_LOCALES,v 1.1 2006/03/21 07:50:50 ru Exp
350Set to not build localization files; see
351.Xr locale 1 .
352.It Va WITHOUT_LPR
353.\" from FreeBSD: src/tools/build/options/WITHOUT_LPR,v 1.1 2006/03/21 07:50:50 ru Exp
354Set to not build
355.Xr lpr 1
356and related programs.
357.It Va WITHOUT_MAILWRAPPER
358.\" from FreeBSD: src/tools/build/options/WITHOUT_MAILWRAPPER,v 1.1 2006/03/21 07:50:50 ru Exp
359Set to not build the
360.Xr mailwrapper 8
361MTA selector.
362.It Va WITHOUT_MAN
363.\" from FreeBSD: src/tools/build/options/WITHOUT_MAN,v 1.1 2006/03/21 07:50:50 ru Exp
364Set to not build manual pages.
365.It Va WITHOUT_NCP
366.\" from FreeBSD: src/tools/build/options/WITHOUT_NCP,v 1.1 2006/03/21 07:50:50 ru Exp
367Set to not build programs, libraries, and kernel modules
368related to NetWare Core protocol.
369.It Va WITHOUT_NETCAT
370.\" from FreeBSD: src/tools/build/options/WITHOUT_NETCAT,v 1.1 2006/03/21 07:50:50 ru Exp
371Set to not build
372.Xr nc 1
373utility.
374.It Va WITHOUT_NIS
375.\" from FreeBSD: src/tools/build/options/WITHOUT_NIS,v 1.1 2006/03/21 07:50:50 ru Exp
376Set to not build
377.Xr NIS 8
378support and related programs.
379If set, you might need to adopt your
380.Xr nsswitch.conf 5
381and remove
382.Sq nis
383entries.
384.It Va WITHOUT_NLS
385.\" from FreeBSD: src/tools/build/options/WITHOUT_NLS,v 1.1 2006/03/21 07:50:50 ru Exp
386Set to not build NLS catalogs.
387.It Va WITHOUT_NLS_CATALOGS
388.\" from FreeBSD: src/tools/build/options/WITHOUT_NLS_CATALOGS,v 1.1 2006/03/21 07:50:50 ru Exp
389Set to not build NLS catalog support for
390.Xr csh 1 .
391.It Va WITHOUT_OBJC
392.\" from FreeBSD: src/tools/build/options/WITHOUT_OBJC,v 1.1 2006/03/21 07:50:50 ru Exp
393Set to not build Objective C support.
394.It Va WITHOUT_OPENSSH
395.\" from FreeBSD: src/tools/build/options/WITHOUT_OPENSSH,v 1.1 2006/03/21 07:50:50 ru Exp
396Set to not build OpenSSH.
397.It Va WITHOUT_OPENSSL
398.\" from FreeBSD: src/tools/build/options/WITHOUT_OPENSSL,v 1.1 2006/03/21 07:50:50 ru Exp
399Set to not build OpenSSL.
400When set, it also enforces the following options:
401.Pp
402.Bl -item -compact
403.It
404.Va WITHOUT_KERBEROS
405.It
406.Va WITHOUT_KERBEROS_SUPPORT
407.It
408.Va WITHOUT_OPENSSH
409.El
410When set, it also enforces the following options:
411.Pp
412.Bl -item -compact
413.It
414.Va WITHOUT_PAM_SUPPORT
415.El
416.It Va WITHOUT_PAM_SUPPORT
417.\" from FreeBSD: src/tools/build/options/WITHOUT_PAM_SUPPORT,v 1.1 2006/03/21 07:50:50 ru Exp
418Set to build some programs without PAM support, particularly
419.Xr ftpd 8
420and
421.Xr ppp 8 .
422.It Va WITHOUT_PF
423.\" from FreeBSD: src/tools/build/options/WITHOUT_PF,v 1.1 2006/03/21 07:50:50 ru Exp
424Set to not build PF firewall package.
425When set, it also enforces the following options:
426.Pp
427.Bl -item -compact
428.It
429.Va WITHOUT_AUTHPF
430.El
431.It Va WITHOUT_PROFILE
432.\" from FreeBSD: src/tools/build/options/WITHOUT_PROFILE,v 1.1 2006/03/21 07:50:50 ru Exp
433Set to avoid compiling profiled libraries.
434.It Va WITHOUT_RCMDS
435.\" from FreeBSD: src/tools/build/options/WITHOUT_RCMDS,v 1.1 2006/03/21 07:50:50 ru Exp
436Disable building of the
437.Bx
438r-commands.
439This includes
440.Xr rlogin 1 ,
441.Xr rsh 1 ,
442etc.
443.It Va WITHOUT_RCS
444.\" from FreeBSD: src/tools/build/options/WITHOUT_RCS,v 1.1 2006/03/21 07:50:50 ru Exp
445Set to not build
446.Xr rcs 1
447and related utilities.
448.It Va WITHOUT_RESCUE
449.\" from FreeBSD: src/tools/build/options/WITHOUT_RESCUE,v 1.1 2006/03/21 07:50:50 ru Exp
450Set to not build
451.Xr rescue 8 .
452.It Va WITHOUT_SENDMAIL
453.\" from FreeBSD: src/tools/build/options/WITHOUT_SENDMAIL,v 1.1 2006/03/21 07:50:50 ru Exp
454Set to not build
455.Xr sendmail 8
456and related programs.
457.It Va WITHOUT_SETUID_LOGIN
458.\" from FreeBSD: src/tools/build/options/WITHOUT_SETUID_LOGIN,v 1.1 2006/03/21 07:50:50 ru Exp
459Set this to disable the installation of
460.Xr login 1
461as a set-user-ID root program.
462.It Va WITHOUT_SHAREDOCS
463.\" from FreeBSD: src/tools/build/options/WITHOUT_SHAREDOCS,v 1.1 2006/03/21 07:50:50 ru Exp
464Set to not build the
465.Bx 4.4
466legacy docs.
467.It Va WITHOUT_SYSCONS
468.\" from FreeBSD: src/tools/build/options/WITHOUT_SYSCONS,v 1.1 2006/03/21 07:50:50 ru Exp
469Set to not build
470.Xr syscons 4
471support files such as keyboard maps, fonts, and screen output maps.
472.It Va WITHOUT_TCSH
473.\" from FreeBSD: src/tools/build/options/WITHOUT_TCSH,v 1.1 2006/03/21 07:50:50 ru Exp
474Set to not build and install
475.Pa /bin/csh
476(which is
477.Xr tcsh 1 ) .
478.It Va WITHOUT_TOOLCHAIN
479.\" from FreeBSD: src/tools/build/options/WITHOUT_TOOLCHAIN,v 1.1 2006/03/21 07:50:50 ru Exp
480Set to not build
481programs used for program development,
482compilers, debuggers etc.
483When set, it also enforces the following options:
484.Pp
485.Bl -item -compact
486.It
487.Va WITHOUT_GDB
488.El
489.It Va WITHOUT_USB
490.\" from FreeBSD: src/tools/build/options/WITHOUT_USB,v 1.1 2006/03/21 07:50:50 ru Exp
491Set to not build USB-related programs and libraries.
492.It Va WITHOUT_WPA_SUPPLICANT_EAPOL
493.\" from FreeBSD: src/tools/build/options/WITHOUT_WPA_SUPPLICANT_EAPOL,v 1.1 2006/03/21 07:50:50 ru Exp
494Build
495.Xr wpa_supplicant 8
496without support for the IEEE 802.1X protocol and without
497support for EAP-PEAP, EAP-TLS, EAP-LEAP, and EAP-TTLS
498protocols (usable only via 802.1X).
499.El
500.Sh FILES
501.Bl -tag -compact
502.It Pa /etc/src.conf
503.It Pa /usr/share/mk/bsd.own.mk
504.El
505.Sh SEE ALSO
506.Xr make 1 ,
507.Xr make.conf 5 ,
508.Xr build 7 ,
509.Xr ports 7
510.Sh HISTORY
511The
512.Nm
513file appeared in
514.Fx 7.0 .
515.Sh AUTHORS
516This manual page was autogenerated.
517