xref: /freebsd/share/man/man5/make.conf.5 (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
1.\" Copyright (c) 2000
2.\"	Mike W. Meyer
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd July 29, 2004
28.Dt MAKE.CONF 5
29.Os
30.Sh NAME
31.Nm make.conf
32.Nd system build information
33.Sh DESCRIPTION
34The file
35.Nm
36contains settings that control the compilation of the
37.Fx
38sources
39and ported applications.
40The file
41.Nm
42is generally created by the system administrator when the values need
43to be changed from their defaults.
44.Pp
45The purpose of
46.Nm
47is not to run commands or perform compilation actions
48directly.
49Instead, it is included by the
50various makefiles in
51.Pa /usr/src ,
52.Pa /usr/ports
53and
54.Pa /usr/doc
55which conditionalize their
56internal actions according to the settings found there.
57.Pp
58The
59.Pa /etc/make.conf
60file is included from the appropriate
61.Pa Makefile
62which specifies the default settings for all the available options.
63Options need only be specified in
64.Pa /etc/make.conf
65when the system administrator wishes to override these defaults.
66.Pp
67The build procedures occur in four broad areas: the world, the kernel,
68documentations and ports.
69Variables set in
70.Nm
71may be applicable during builds in one, two, or all four of these
72areas.
73They may be specified for a particular build via the
74.Fl D
75option of
76.Xr make 1 .
77.Pp
78The following lists provide a name and short description for each
79variable you can use during the indicated builds.
80The values of
81variables flagged as
82.Vt bool
83are ignored; the variable being
84set at all (even to
85.Dq Li FALSE
86or
87.Dq Li NO )
88causes it to
89be treated as if it were set.
90.Pp
91The following list provides a name and short description for variables
92that are used for all builds, or are used by the
93.Pa makefiles
94for things other than builds.
95.Bl -tag -width Ar
96.It Va ALWAYS_CHECK_MAKE
97.Pq Vt bool
98Instructs the top-level makefile in the source tree (normally
99.Pa /usr/src )
100to always check if
101.Xr make 1
102is up-to-date.
103Normally this is only done for the world and buildworld targets to handle
104upgrades from older versions of
105.Fx .
106.It Va CFLAGS
107.Pq Vt str
108Controls the compiler setting when compiling C code.
109Optimization levels other than
110.Fl O
111and
112.Fl O2
113are not supported.
114.Va BDECFLAGS
115is provided as a set of
116.Xr gcc 1
117settings suggested by
118.An "Bruce Evans" Aq bde@FreeBSD.org
119for developing and testing changes.
120They can be used, if set, by:
121.Pp
122.Bd -literal -offset indent
123CFLAGS+=${BDECFLAGS}
124.Ed
125.It Va CPUTYPE
126.Pq Vt str
127Controls which processor should be targeted for generated
128code.
129This controls processor-specific optimizations in
130certain code (currently only OpenSSL) as well as modifying
131the value of
132.Va CFLAGS
133and
134.Va COPTFLAGS
135to contain the appropriate optimization directive to
136.Xr gcc 1 .
137The automatic setting of
138.Va CFLAGS
139and
140.Va COPTFLAGS
141may be overridden using the
142.Va NO_CPU_CFLAGS
143and
144.Va NO_CPU_COPTFLAGS
145variables, respectively.
146Refer to
147.Pa /usr/share/examples/etc/make.conf
148for a list of recognized
149.Va CPUTYPE
150options.
151.It Va NO_CPU_CFLAGS
152.Pq Vt str
153Setting this variable will prevent CPU specific compiler flags
154from being automatically added to
155.Va CFLAGS
156during compile time.
157.It Va NO_CPU_COPTFLAGS
158.Pq Vt str
159Setting this variable will prevent CPU specific compiler flags
160from being automatically added to
161.Va COPTFLAGS
162during compile time.
163.It Va CVS_UPDATE
164.Pq Vt bool
165Set this to use
166.Xr cvs 1
167to update your ports with
168.Dq Li "make update" .
169.It Va CXXFLAGS
170.Pq Vt str
171Controls the compiler settings when compiling C++ code.
172.Va CXXFLAGS
173is initially set to the value of
174.Va CFLAGS .
175If you want to
176add to the
177.Va CXXFLAGS
178value, use
179.Dq Li +=
180instead of
181.Dq Li = .
182.It Va INSTALL
183.Pq Vt str
184the default install command.
185To install only files for which the target differs or does not exist, use
186.Bd -literal -offset indent
187INSTALL="install -C"
188.Ed
189Note that some makefiles (including those in
190.Pa /usr/share/mk )
191may hardcode options for the supplied install command.
192.It Va LOCAL_DIRS
193.Pq Vt str
194List any directories that should be entered when doing
195make's in
196.Pa /usr/src
197in this variable.
198.It Va MAKE_SHELL
199.Pq Vt str
200Controls the shell used internally by
201.Xr make 1
202to process the command scripts in makefiles.
203.Xr sh 1 ,
204.Xr ksh 1 ,
205and
206.Xr csh 1
207all currently supported.
208.Pp
209.Dl "MAKE_SHELL?=sh"
210.It Va MTREE_FOLLOWS_SYMLINKS
211.Pq Vt str
212Set this to
213.Dq Fl L
214to cause
215.Xr mtree 8
216to follow symlinks.
217.It Va NO_DOCUPDATE
218.Pq Vt bool
219Set this to not update the doc tree during
220.Dq Li "make update" .
221.It Va NO_PORTSUPDATE
222.Pq Vt bool
223Set this to not update the ports tree during
224.Dq Li "make update" .
225.It Va SUP_UPDATE
226.Pq Vt bool
227Set this to use
228.Xr cvsup 1
229to update your ports with
230.Dq Li "make update" .
231.It Va SUP
232.Pq Vt str
233The location of the
234.Xr cvsup 1
235command for
236.Dq Li "make update" .
237.It Va SUPFLAGS
238.Pq Vt str
239The flag for the
240.Xr sup 1
241command when doing
242.Dq Li "make update" .
243This defaults to
244.Op Fl g L Ar 2 .
245.It Va SUPHOST
246.Pq Vt str
247The hostname of the sup server to use when doing
248.Dq Li "make update" .
249.It Va SUPFILE
250.Pq Vt str
251The first
252.Ar supfile
253to use when doing a
254.Dq Li "make update" .
255This defaults to
256.Pa /usr/share/examples/cvsup/standard\-supfile .
257.It Va SUPFILE1
258.Pq Vt str
259The second
260.Ar supfile
261to use when doing a
262.Dq Li "make update" .
263This defaults to
264.Pa /usr/share/examples/cvsup/secure\-supfile .
265.It Va SUPFILE2
266.Pq Vt str
267The third
268.Ar supfile
269to use when doing a
270.Dq Li "make update" .
271This defaults to
272.Pa /usr/share/examples/cvsup/secure\-supfile .
273.It Va PORTSSUPFILE
274.Pq Vt str
275The ports
276.Ar supfile
277to use when doing a
278.Dq Li "make update" .
279This defaults to
280.Pa /usr/share/examples/cvsup/ports\-supfile .
281.It Va DOCSUPFILE
282.Pq Vt str
283The documentation
284.Ar supfile
285to use when doing a
286.Dq Li "make update" .
287This defaults to
288.Pa /usr/share/examples/cvsup/doc\-supfile .
289.El
290.Pp
291The following list provides a name and short description for variables
292that are only used doing a kernel build:
293.Bl -tag -width Ar
294.It Va BOOT_COMCONSOLE_PORT
295.Pq Vt str
296The port address to use for the console if the boot blocks have
297been configured to use a serial console instead of the keyboard/video card.
298.It Va BOOT_COMCONSOLE_SPEED
299.Pq Vt int
300The baud rate to use for the console if the boot blocks have
301been configured to use a serial console instead of the keyboard/video card.
302.It Va BOOTWAIT
303.Pq Vt int
304Controls the amount of time the kernel waits for a console keypress
305before booting the default kernel.
306The value is approximately milliseconds.
307Keypresses are accepted by the BIOS before booting from disk,
308making it possible to give custom boot parameters even when this is
309set to 0.
310.It Va COPTFLAGS
311.Pq Vt str
312Controls the compiler settings when building the
313kernel.
314Optimization levels above
315.Oo Fl O ( O2 , No ...\& ) Oc
316are not guaranteed to work.
317.It Va KERNCONF
318.Pq Vt str
319Controls which kernel configurations will be
320built by
321.Dq Li "${MAKE} buildkernel"
322and installed by
323.Dq Li "${MAKE} installkernel" .
324For example,
325.Bd -literal -offset indent
326KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
327.Ed
328.Pp
329will build the kernels specified by the config files
330.Pa MINE , DEBUG , GENERIC ,
331and
332.Pa OTHERMACHINE ,
333and install the kernel specified by the config file
334.Pa MINE .
335It defaults to
336.Pa GENERIC .
337.It Va LOADER_TFTP_SUPPORT
338.Pq Vt bool
339While not a buildkernel-affected option, there is no better place for this.
340By default the
341.Xr pxeboot 8
342loader retrieves the kernel via NFS.
343Defining this and recompiling
344.Pa /usr/src/sys/boot
345will cause it to retrieve the kernel via TFTP.
346This allows
347.Xr pxeboot 8
348to load a custom BOOTP diskless kernel yet
349still mount the server's
350.Pa /
351rather than load the server's kernel.
352.It Va MODULES_OVERRIDE
353.Pq Vt str
354Set to a list of modules to build instead of all of them.
355.It Va NO_KERNELCONFIG
356.Pq Vt bool
357Set this to skip running
358.Xr config 8
359during
360.Dq Li "${MAKE} buildkernel" .
361.It Va NO_KERNELDEPEND
362.Pq Vt bool
363Set this to skip running
364.Dq Li "${MAKE} depend"
365during
366.Dq Li "${MAKE} buildkernel" .
367.It Va NO_MODULES
368.Pq Vt bool
369Set to not build modules with the kernel.
370.El
371.Pp
372The following list provides a name and short description for variables
373that are used during the world build:
374.Bl -tag -width Ar
375.It Va COMPAT1X
376.Pq Vt bool
377Set to install the
378.Fx
3791 compatibility libraries.
380.It Va COMPAT20
381.Pq Vt bool
382Set to install the
383.Fx 2.0
384compatibility libraries.
385.It Va COMPAT21
386.Pq Vt bool
387Set to install the
388.Fx 2.1
389compatibility libraries.
390.It Va COMPAT22
391.Pq Vt bool
392Set to install the
393.Fx 2.2
394compatibility libraries.
395.It Va COMPAT3X
396.Pq Vt bool
397Set to install the
398.Fx
3993
400compatibility libraries.
401.It Va COMPAT4X
402.Pq Vt bool
403Set to install the
404.Fx
4054
406compatibility libraries.
407.It Va MAKE_IDEA
408.Pq Vt bool
409Set to build the IDEA encryption code.
410This code is patented in the USA and many European countries.
411It is
412.Em "YOUR RESPONSIBILITY"
413to determine if you can legally use IDEA.
414.It Va NO_DYNAMICROOT
415.Pq Vt bool
416Set this if you do not want to link
417.Pa /bin
418and
419.Pa /sbin
420dynamically.
421.It Va NO_KERBEROS
422.Pq Vt bool
423Set this if you do not want to build Kerberos 5 (KTH Heimdal).
424.It Va ENABLE_SUID_K5SU
425.Pq Vt bool
426Set this if you wish to use the ksu utility.
427Otherwise, it will be
428installed without the set-user-ID bit set.
429.It Va ENABLE_SUID_NEWGRP
430.Pq Vt bool
431Set this to install
432.Xr newgrp 1
433with the set-user-ID bit set.
434Otherwise,
435.Xr newgrp 1
436will not be able to change users' groups.
437.It Va ENABLE_SUID_SSH
438.Pq Vt bool
439Set this to install
440.Xr ssh 1
441with the set-user-ID bit turned on.
442.It Va MODULES_WITH_WORLD
443.Pq Vt bool
444Set to build modules with the system instead of the kernel.
445.It Va NO_BLUETOOTH
446.Pq Vt bool
447Set to not build Bluetooth related kernel modules, programs and libraries.
448.It Va NO_CVS
449.Pq Vt bool
450Set to not build CVS.
451.It Va NO_CXX
452.Pq Vt bool
453Set to not build
454.Xr g++ 1
455and related libraries.
456.It Va NO_BIND
457.Pq Vt bool
458Set to not build BIND.
459.It Va NO_FORTRAN
460.Pq Vt bool
461Set to not build
462.Xr g77 1
463and related libraries.
464.It Va NO_GDB
465.Pq Vt bool
466Set to not build
467.Xr gdb 1 .
468.It Va NO_I4B
469.Pq Vt bool
470Set to not build isdn4bsd package.
471.It Va NO_IPFILTER
472.Pq Vt bool
473Set to not build IP Filter package.
474.It Va NO_TOOLCHAIN
475.Pq Vt bool
476Set to not build
477programs used for program development,
478compilers, debuggers etc.
479.It Va NOINET6
480.Pq Vt bool
481Set to not build
482programs and libraries related to IPv6 networking.
483.It Va NOATM
484.Pq Vt bool
485Set to not build
486programs and libraries related to ATM networking.
487.It Va NO_USB
488.Pq Vt bool
489Set to not build
490.Xr usbd 8
491and related programs.
492.It Va NO_LPR
493.Pq Vt bool
494Set to not build
495.Xr lpr 1
496and related programs.
497.It Va NO_ACPI
498.Pq Vt bool
499Set to not build
500.Xr acpiconf 8 ,
501.Xr acpidump 8
502and related programs.
503.It Va NO_VINUM
504.Pq Vt bool
505Set to not build
506.Xr vinum 8
507and related programs.
508.It Va NO_MAILWRAPPER
509.Pq Vt bool
510Set to not build the
511.Xr mailwrapper 8
512MTA selector.
513.It Va NOMAN
514.Pq Vt bool
515Set to not build manual pages.
516.It Va NO_OBJC
517.Pq Vt bool
518Set to not build Objective C support.
519.It Va NO_OPENSSH
520.Pq Vt bool
521Set to not build OpenSSH.
522.It Va NO_OPENSSL
523.Pq Vt bool
524Set to not build OpenSSL (implies
525.Va NO_KERBEROS
526and
527.Va NO_OPENSSH ) .
528.It Va NO_SENDMAIL
529.Pq Vt bool
530Set to not build
531.Xr sendmail 8
532and related programs.
533.It Va NO_SHAREDOCS
534.Pq Vt bool
535Set to not build the
536.Bx 4.4
537legacy docs.
538.It Va NO_TCSH
539.Pq Vt bool
540Set to not build and install
541.Pa /bin/csh
542(which is
543.Xr tcsh 1 ) .
544.It Va NOCLEAN
545.Pq Vt bool
546Set this to disable cleaning during
547.Dq Li "make buildworld" .
548This should not be set unless you know what you are doing.
549.It Va NOCLEANDIR
550.Pq Vt bool
551Set this to run
552.Dq Li "${MAKE} clean"
553instead of
554.Dq Li "${MAKE} cleandir" .
555.It Va NOCRYPT
556.Pq Vt bool
557Set to not build any crypto code.
558.It Va NOGAMES
559.Pq Vt bool
560Set to not build games.
561.It Va NOINFO
562.Pq Vt bool
563Set to not make or install
564.Xr info 5
565files.
566.It Va NOLIBC_R
567.Pq Vt bool
568Set to not build
569.Nm libc_r
570(reentrant version of
571.Nm libc ) .
572.It Va NOLIBPTHREAD
573.Pq Vt bool
574Set to not build the
575.Nm libpthread
576(M:N threading)
577library.
578.It Va NOLIBTHR
579.Pq Vt bool
580Set to not build the
581.Nm libthr
582(1:1 threading)
583library.
584.It Va NOMANCOMPRESS
585.Pq Vt bool
586Set to install man pages uncompressed.
587.It Va NOPROFILE
588.Pq Vt bool
589Set to avoid compiling profiled libraries.
590.It Va NOSHARE
591.Pq Vt bool
592Set to not build in the
593.Pa share
594subdir.
595.It Va PPP_NOSUID
596.Pq Vt bool
597Set to disable the installation of
598.Xr ppp 8
599as an suid root program.
600.It Va SENDMAIL_MC
601.Pq Vt str
602The default
603.Xr m4 1
604configuration file to use at install time.
605The value should include the full path to the
606.Pa .mc
607file, e.g.,
608.Pa /etc/mail/myconfig.mc .
609Use with caution as a make install will overwrite any existing
610.Pa /etc/mail/sendmail.cf .
611Note that
612.Va SENDMAIL_CF
613is now deprecated.
614.It Va SENDMAIL_SUBMIT_MC
615.Pq Vt str
616The default
617.Xr m4 1
618configuration file for mail submission
619to use at install time.
620The value should include the full path to the
621.Pa .mc
622file, e.g.,
623.Pa /etc/mail/mysubmit.mc .
624Use with caution as a make install will overwrite any existing
625.Pa /etc/mail/submit.cf .
626.It Va SENDMAIL_ADDITIONAL_MC
627.Pq Vt str
628Additional
629.Pa .mc
630files which should be built into
631.Pa .cf
632files at build time.
633The value should include the full path to the
634.Pa .mc
635file(s), e.g.,
636.Pa /etc/mail/foo.mc
637.Pa /etc/mail/bar.mc .
638.It Va SENDMAIL_CF_DIR
639.Pq Vt str
640Override the default location for the
641.Xr m4 1
642configuration files used to build a
643.Pa .cf
644file from a
645.Pa .mc
646file.
647.It Va SENDMAIL_M4_FLAGS
648.Pq Vt str
649Flags passed to
650.Xr m4 1
651when building a
652.Pa .cf
653file from a
654.Pa .mc
655file.
656.It Va SENDMAIL_CFLAGS
657.Pq Vt str
658Flags to pass to the compile command when building
659.Xr sendmail 8 .
660The
661.Va SENDMAIL_*
662flags can be used to provide SASL support with setting such as:
663.Bd -literal -offset indent
664SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
665SENDMAIL_LDFLAGS=-L/usr/local/lib
666SENDMAIL_LDADD=-lsasl
667.Ed
668.It Va SENDMAIL_LDFLAGS
669.Pq Vt str
670Flags to pass to the
671.Xr ld 1
672command when building
673.Xr sendmail 8 .
674.It Va SENDMAIL_LDADD
675.Pq Vt str
676Flags to add to the end of the
677.Xr ld 1
678command when building
679.Xr sendmail 8 .
680.It Va SENDMAIL_DPADD
681.Pq Vt str
682Extra dependencies to add when building
683.Xr sendmail 8 .
684.It Va SENDMAIL_SET_USER_ID
685.Pq Vt bool
686If set, install
687.Xr sendmail 8
688as a set-user-ID root binary instead of a set-group-ID binary
689and do not install
690.Pa /etc/mail/submit.{cf,mc} .
691Use of this flag is not recommended and the alternative advice in
692.Pa /etc/mail/README
693should be followed instead if at all possible.
694.It Va SENDMAIL_MAP_PERMS
695.Pq Vt str
696Mode to use when generating alias and map database files using
697.Pa /etc/mail/Makefile .
698The default value is 0640.
699.It Va TOP_TABLE_SIZE
700.Pq Vt int
701.Xr top 1
702uses a hash table for the user names.
703The size of this hash can be tuned to match the number of local users.
704The table size should be a prime number
705approximately twice as large as the number of lines in
706.Pa /etc/passwd .
707The default number is 20011.
708.It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
709.Pq Vt int
710Causes the system compiler to be built such that it forces high optimization
711levels to a lower one.
712.Xr gcc 1
713.Fl O2
714and above is known to trigger known optimizer bugs at various
715times \(em this is worse on the Alpha platform.
716The value assigned is the highest optimization value used.
717.El
718.Pp
719The following list provides a name and short description for variables
720that are used when building documentation.
721.Bl -tag -width Ar
722.It Va DISTDIR
723.Pq Vt str
724Where distfiles are kept.
725Normally, this is
726.Pa distfiles
727in
728.Va PORTSDIR .
729.It Va DOC_LANG
730.Pq Vt str
731The list of languages and encodings to build and install.
732.It Va PRINTERDEVICE
733.Pq Vt str
734The default format for system documentation, depends on your
735printer.
736This can be set to
737.Dq Li ascii
738for simple printers, or
739.Dq Li ps
740for postscript or graphics printers with a ghostscript
741filter, or both.
742.El
743.Sh FILES
744.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
745.It Pa /etc/make.conf
746.It Pa /usr/doc/Makefile
747.It Pa /usr/share/examples/etc/make.conf
748.It Pa /usr/src/Makefile
749.It Pa /usr/src/Makefile.inc1
750.El
751.Sh SEE ALSO
752.Xr gcc 1 ,
753.Xr install 1 ,
754.Xr make 1 ,
755.Xr ports 7 ,
756.Xr lpd 8 ,
757.Xr sendmail 8
758.Sh HISTORY
759The
760.Nm
761file appeared sometime before
762.Fx 4.0 .
763.Sh AUTHORS
764This
765manual page was written by
766.An Mike W. Meyer Aq mwm@mired.org .
767.Sh BUGS
768This manual page may occasionally be out of date with respect to
769the options currently available for use in
770.Nm .
771Please check the
772.Pa /usr/share/examples/etc/make.conf
773file for the latest options which are available.
774