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