xref: /dflybsd-src/share/man/man5/make.conf.5 (revision 8a7bdfea07aa1bda83a085f45f079e52a1328bd3)
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: src/share/man/man5/make.conf.5,v 1.12.2.30 2003/05/18 17:05:55 brueffer Exp $
26.\" $DragonFly: src/share/man/man5/make.conf.5,v 1.32 2008/05/02 02:05:06 swildner Exp $
27.\"
28.Dd December 24, 2007
29.Dt MAKE.CONF 5
30.Os
31.Sh NAME
32.Nm make.conf
33.Nd system build information
34.Sh DESCRIPTION
35The file
36.Nm
37contains settings that control the compilation of the
38.Dx
39sources.
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 various makefiles in
50.Pa /usr/src
51which conditionalize their internal actions according to the settings
52found there.
53.Pp
54The
55.Pa /etc/make.conf
56file is included from the appropriate
57.Pa Makefile
58which specifies the default settings for all the available options.
59Options need only be specified in
60.Pa /etc/make.conf
61when the system administrator wishes to override these defaults.
62.Pp
63The build procedures occur in three areas: world, kernel, and
64documentation.
65Variables set in
66.Nm
67may be applicable during builds in one, two, or all of these areas.
68They may be specified for a particular build via the
69.Fl D
70option of
71.Xr make 1 .
72.Pp
73The following lists provide a name and short description for each
74variable you can use during the indicated builds.
75The values of variables flagged as
76.Vt bool
77are ignored; the variable being set at all (even to
78.Dq Li FALSE
79or
80.Dq Li NO )
81causes it to be treated as if it were set.
82.Pp
83The following list provides a name and short description for variables
84that are used for all builds, or are used by the
85.Pa makefiles
86for things other than builds.
87.Bl -tag -width Ar
88.It Va CPUTYPE
89.Pq Vt str
90Controls which processor should be targeted for generated code.
91This controls processor-specific optimizations in certain code
92(currently only OpenSSL) as well as modifying the value of
93.Va CFLAGS
94and
95.Va COPTFLAGS
96to contain the appropriate optimization directive to
97.Xr gcc 1 .
98The automatic setting of
99.Va CFLAGS
100and
101.Va COPTFLAGS
102may be overridden using the
103.Va NO_CPU_CFLAGS
104and
105.Va NO_CPU_COPTFLAGS
106variables, respectively.  Refer to
107.Pa /usr/share/examples/etc/defaults/make.conf
108for a list of recognized
109.Va CPUTYPE
110options.
111.It Va CCVER
112.Pq Vt str
113Controls which GCC version to use by default.
114It should be set as
115.Li CCVER?=
116so as not to interfere with overrides from userland.
117We currently recommend that an override NOT be set in
118.Pa /etc/make.conf .
119Currently accepted values are
120.Dq gcc34
121(old version)
122and
123.Dq gcc41
124(default).
125.It Va CFLAGS
126.Pq Vt str
127Controls the compiler setting when compiling C code.
128Optimization levels above
129.Fl O
130.Pq Fl O2 , No ...
131are not supported.
132.Va BDECFLAGS
133is provided as a set of
134.Xr gcc 1
135settings suggested by
136.An "Bruce Evans" Aq bde@FreeBSD.org
137for developing and testing changes.
138They can be used, if set, by:
139.Bd -literal -offset indent
140CFLAGS+=${BDECFLAGS}
141.Ed
142.It Va NO_CPU_CFLAGS
143.Pq Vt str
144Setting this variable will prevent CPU specific compiler flags
145from being automatically added to
146.Va CFLAGS
147during compile time.
148.It Va CXXFLAGS
149.Pq Vt str
150Controls the compiler settings when compiling C++ code.
151.Va CXXFLAGS
152is initially set to the value of
153.Va CFLAGS .
154If you want to add to the
155.Va CXXFLAGS
156value, use
157.Dq Li +=
158instead of
159.Dq Li = .
160.It Va INSTALL
161.Pq Vt str
162the default install command.
163To have components compared before doing the install, use
164.Bd -literal -offset indent
165INSTALL="install -C"
166.Ed
167.It Va LOCAL_DIRS
168.Pq Vt str
169List any directories that should be entered when running make
170.Pa /usr/src
171in this variable.
172.It Va MAKE_SHELL
173.Pq Vt str
174Controls the shell used internally by
175.Xr make 1
176to process the command scripts in makefiles.
177.Xr sh 1 ,
178.Xr ksh 1 ,
179and
180.Xr csh 1
181all currently supported.
182.Bd -literal -offset indent
183MAKE_SHELL?=sh
184.Ed
185.It Va MODULES_OVERRIDE
186.Pq Vt str
187Set to a list of modules to build instead of all of them.
188.It Va MTREE_FOLLOWS_SYMLINKS
189.Pq Vt str
190Set this to
191.Dq Fl L
192to cause
193.Xr mtree 8
194to follow symlinks.
195.It Va NO_DOCUPDATE
196.Pq Vt bool
197Set this to not update the doc tree during
198.Dq Li "make update" .
199.It Va STRIP
200.Pq Vt str
201Set this to the flag to pass the
202.Xr strip 1
203command.
204If set to a blank value, components will be installed with debugging
205symbols.
206.It Va SUP_UPDATE
207.Pq Vt bool
208Set this to use
209.Xr cvsup 1
210to update your ports with
211.Dq Li "make update" .
212.It Va SUP
213.Pq Vt str
214The location of the
215.Xr cvsup 1
216command for
217.Dq Li "make update" .
218.It Va SUPFLAGS
219.Pq Vt str
220The flag for the
221.Xr sup 1
222command when doing
223.Dq Li "make update" .
224This defaults to
225.Dq Fl g L Ar 2 .
226.It Va SUPHOST
227.Pq Vt str
228The hostname of the sup server to use when doing
229.Dq Li "make update" .
230.It Va SUPFILE
231.Pq Vt str
232The first
233.Ar supfile
234to use when doing a
235.Dq Li "make update" .
236This defaults to
237.Pa /usr/share/examples/cvsup/standard\-supfile .
238.It Va SUPFILE1
239.Pq Vt str
240The second
241.Ar supfile
242to use when doing a
243.Dq Li "make update" .
244This defaults to
245.Pa /usr/share/examples/cvsup/secure\-supfile .
246.It Va SUPFILE2
247.Pq Vt str
248The third
249.Ar supfile
250to use when doing a
251.Dq Li "make update" .
252This defaults to
253.Pa /usr/share/examples/cvsup/secure\-supfile .
254.It Va DOCSUPFILE
255.Pq Vt str
256The documentation
257.Ar supfile
258to use when doing a
259.Dq Li "make update" .
260This defaults to
261.Pa /usr/share/examples/cvsup/doc\-supfile .
262.It Va WARNS_WERROR
263Causes
264.Fl Werror
265to be added to
266.Va CFLAGS
267when WARNS is in effect.
268.El
269.Pp
270The following list provides a name and short description for variables
271that are only used doing a kernel build:
272.Bl -tag -width Ar
273.It Va BOOT_COMCONSOLE_PORT
274.Pq Vt str
275The port address to use for the console if the boot blocks have
276been configured to use a serial console instead of the keyboard/video card.
277.It Va BOOT_COMCONSOLE_SPEED
278.Pq Vt int
279The baud rate to use for the console if the boot blocks have
280been configured to use a serial console instead of the keyboard/video card.
281.It Va COPTFLAGS
282.Pq Vt str
283Controls the compiler settings when building the
284kernel.
285Optimization levels above
286.Fl O
287.Pq Fl O2 , No ...
288are not guaranteed to work.
289.It Va KERNCONF
290.Pq Vt str
291Controls which kernel configurations will be
292built by
293.Dq Li "${MAKE} buildkernel"
294and installed by
295.Dq Li "${MAKE} installkernel" .
296For example,
297.Bd -literal -offset indent
298KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
299.Ed
300.Pp
301will build the kernels specified by the config files
302.Pa MINE , DEBUG , GENERIC ,
303and
304.Pa OTHERMACHINE ,
305and install the kernel specified by the config file
306.Pa MINE .
307It defaults to
308.Pa GENERIC .
309.It Va LOADER_TFTP_SUPPORT
310.Pq Vt bool
311While not a buildkernel-affected option, there is no better place for this.
312By default the
313.Xr pxeboot 8
314loader retrieves the kernel via NFS.
315Defining this and recompiling
316.Pa /usr/src/sys/boot
317will cause it to retrieve the kernel via TFTP.
318This allows pxeboot to load a custom BOOTP diskless kernel yet
319still mount the server's
320.Pa /
321rather than load the server's kernel.
322.It Va NO_CPU_COPTFLAGS
323.Pq Vt str
324Setting this variable will prevent CPU specific compiler flags
325from being automatically added to
326.Va COPTFLAGS
327during compile time.
328.It Va NO_KERNELCLEAN
329.Pq Vt bool
330Set this to skip the clean target when using
331.Dq Li "${MAKE} buildkernel" .
332.It Va NO_KERNELCONFIG
333.Pq Vt bool
334Set this to skip running
335.Xr config 8
336during
337.Dq Li "${MAKE} buildkernel" .
338.It Va NO_KERNELDEPEND
339.Pq Vt bool
340Set this to skip running
341.Dq Li "${MAKE} depend"
342during
343.Dq Li "${MAKE} buildkernel" .
344.It Va NO_KERNEL_OLD_STRIP
345.Pq Vt bool
346Set this to skip stripping debugging symbols from old kernel and modules
347(kernel.old, modules.old) during
348.Dq Li "${MAKE} installkernel" .
349.It Va NO_MODULES
350.Pq Vt bool
351Set to not build modules with the kernel.
352.El
353.Pp
354The following list provides a name and short description for variables
355that are used during the world build:
356.Bl -tag -width Ar
357.It Va ENABLE_SUID_K5SU
358.Pq Vt bool
359Set this if you wish to use the k5su utility.
360Otherwise, it will be installed without the set-user-ID bit set.
361This is only relevant if
362.Va WANT_KERBEROS
363is defined.
364.It Va ENABLE_SUID_SSH
365.Pq Vt bool
366Set this to install
367.Xr ssh 1
368with the setuid bit turned on.
369.It Va MODULES_WITH_WORLD
370.Pq Vt bool
371Set to build modules with the system instead of the kernel.
372.It Va NO_BIND
373.Pq Vt bool
374Set to not build BIND.
375.It Va NO_CRYPT
376.Pq Vt bool
377Set to not build crypto code.
378.It Va NO_CVS
379.Pq Vt bool
380Set to not build CVS.
381.It Va NO_FORTRAN
382.Pq Vt bool
383Set to not build
384.Xr g77 1
385and related libraries.
386.It Va NO_GAMES
387.Pq Vt bool
388Set to not build games.
389.It Va NO_GCC34
390.Pq Vt bool
391Set to not build the older version of GCC (3.4).
392.It Va NO_GDB
393.Pq Vt bool
394Set to not build
395.Xr gdb 1
396.It Va NO_I4B
397.Pq Vt bool
398Set to not build isdn4bsd package.
399.It Va NO_IPFILTER
400.Pq Vt bool
401Set to not build IP Filter package.
402.It Va NO_LIBC_R
403.Pq Vt bool
404Set to not build
405.Nm libc_r
406(reentrant version of
407.Nm libc ) .
408.It Va NO_LPR
409.Pq Vt bool
410Set to not build
411.Xr lpr 1
412and related programs.
413.It Va NO_MAILWRAPPER
414.Pq Vt bool
415Set to not build the
416.Xr mailwrapper 8
417MTA selector.
418.It Va NO_MAKEDEV
419.Pq Vt bool
420Set to avoid running
421.Dq Li "MAKEDEV all"
422on
423.Pa /dev
424during install.
425.It Va NO_OBJC
426.Pq Vt bool
427Set to not build Objective C support.
428.It Va NO_OPENSSH
429.Pq Vt bool
430Set to not build OpenSSH.
431.It Va NO_OPENSSL
432.Pq Vt bool
433Set to not build OpenSSL (implies
434.Va NO_OPENSSH ) .
435.It Va NO_SENDMAIL
436.Pq Vt bool
437Set to not build
438.Xr sendmail 8
439and related programs.
440.It Va NO_SHARE
441.Pq Vt bool
442Set to not enter the share subdirectory.
443.It Va NO_X
444.Pq Vt bool
445Set to not compile in X\-Windows support (e.g.\&
446.Xr doscmd 1 ) .
447.It Va NOCLEAN
448.Pq Vt bool
449Set this to disable cleaning during
450.Dq Li "make buildworld" .
451This should not be set unless you know what you are doing.
452.It Va NOCLEANDIR
453.Pq Vt bool
454Set this to run
455.Dq Li "${MAKE} clean"
456instead of
457.Dq Li "${MAKE} cleandir" .
458.It Va NOFSCHG
459.Pq Vt bool
460Set to not install certain components with flag schg.
461This is useful in a jailed environment.
462.It Va NOINFO
463.Pq Vt bool
464Set to not make or install
465.Xr info 5
466files.
467.It Va NOINFOCOMPRESS
468.Pq Vt bool
469Set to not compress the info pages.
470.It Va NOMAN
471.Pq Vt bool
472Set to not build manual pages
473.It Va NOMANCOMPRESS
474.Pq Vt bool
475Set to not compress the manual pages.
476.It Va NOPROFILE
477.Pq Vt bool
478Set to avoid compiling profiled libraries.
479.It Va PPP_NOSUID
480.Pq Vt bool
481Set to disable the installation of
482.Xr ppp 8
483with the set-user-ID bit on.
484.It Va SENDMAIL_MC
485.Pq Vt str
486The default
487.Xr m4 1
488configuration file to use at install time.
489The value should include the full path to the
490.Pa .mc
491file, e.g.,
492.Pa /etc/mail/myconfig.mc .
493Use with caution as a make install will overwrite any existing
494.Pa /etc/mail/sendmail.cf .
495Note that
496.Va SENDMAIL_CF
497is now deprecated.
498.It Va SENDMAIL_SUBMIT_MC
499.Pq Vt str
500The default
501.Xr m4 1
502configuration file for mail submission
503to use at install time.
504The value should include the full path to the
505.Pa .mc
506file, e.g.,
507.Pa /etc/mail/mysubmit.mc .
508Use with caution as a make install will overwrite any existing
509.Pa /etc/mail/submit.cf .
510.It Va SENDMAIL_ADDITIONAL_MC
511.Pq Vt str
512Additional
513.Pa .mc
514files which should be built into
515.Pa .cf
516files at build time.
517The value should include the full path to the
518.Pa .mc
519file(s), e.g.,
520.Pa /etc/mail/foo.mc
521.Pa /etc/mail/bar.mc .
522.It Va SENDMAIL_CF_DIR
523.Pq Vt str
524Override the default location for the
525.Xr m4 1
526configuration files used to build a
527.Pa .cf
528file from a
529.Pa .mc
530file.
531.It Va SENDMAIL_M4_FLAGS
532.Pq Vt str
533Flags passed to
534.Xr m4 1
535when building a
536.Pa .cf
537file from a
538.Pa .mc
539file.
540.It Va SENDMAIL_CFLAGS
541.Pq Vt str
542Flags to pass to the compile command when building
543.Xr sendmail 8 .
544The
545.Va SENDMAIL_*
546flags can be used to provide SASL support with setting such as:
547.Bd -literal -offset indent
548SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
549SENDMAIL_LDFLAGS=-L/usr/local/lib
550SENDMAIL_LDADD=-lsasl
551.Ed
552.It Va SENDMAIL_LDFLAGS
553.Pq Vt str
554Flags to pass to the
555.Xr ld 1
556command when building
557.Xr sendmail 8 .
558.It Va SENDMAIL_LDADD
559.Pq Vt str
560Flags to add to the end of the
561.Xr ld 1
562command when building
563.Xr sendmail 8 .
564.It Va SENDMAIL_DPADD
565.Pq Vt str
566Extra dependencies to add when building
567.Xr sendmail 8 .
568.It Va SENDMAIL_SET_USER_ID
569.Pq Vt bool
570If set, install
571.Xr sendmail 8
572as a set-user-ID root binary instead of a set-group-ID binary
573and do not install
574.Pa /etc/mail/submit.{cf,mc} .
575Use of this flag is not recommended and the alternative advice in
576.Pa /etc/mail/README
577should be followed instead if at all possible.
578.It Va SENDMAIL_MAP_PERMS
579.Pq Vt str
580Mode to use when generating alias and map database files using
581.Pa /etc/mail/Makefile .
582The default value is 0640.
583.It Va THREAD_LIB
584.Pq Vt str
585Set to either
586.Li c_r
587or
588.Li thread_xu
589to configure the system's default threading library.
590The default is
591.Li thread_xu .
592.It Va TOP_TABLE_SIZE
593.Pq Vt int
594.Xr top 1
595uses a hash table for the user names.  The size of this hash can be tuned
596to match the number of local users.  The table size should be a prime number
597approximately twice as large as the number of lines in
598.Pa /etc/passwd .
599The default number is 20011.
600.It Va WANT_IDEA
601.Pq Vt bool
602Set to build the IDEA encryption code.
603This code is patented in the USA and many European countries.
604It is
605.Em "YOUR RESPONSIBILITY"
606to determine if you can legally use IDEA.
607.It Va WANT_KERBEROS
608.Pq Vt bool
609Set this to build Kerberos5 (KTH Heimdal).
610.Em WARNING !
611This is still experimental code.
612.El
613.Pp
614The following list provides a name and short description for variables
615that are used when building documentation.
616.Bl -tag -width Ar
617.It Va DOC_LANG
618.Pq Vt str
619The list of languages and encodings to build and install.
620.It Va PRINTERDEVICE
621.Pq Vt str
622The default format for system documentation, depends on your
623printer.
624This can be set to
625.Dq Li ascii
626for simple printers or
627.Dq Li ps
628for postscript or graphics printers with a ghostscript
629filter.
630.It Va GROFF_PAPER_SIZE
631.Pq Vt str
632The default paper size for
633.Xr groff 1
634(either
635.Dq letter
636or
637.Dq A4 ) .
638.El
639.Sh FILES
640.Bl -tag -width /etc/defaults/make.conf -compact
641.It Pa /etc/defaults/make.conf
642.It Pa /etc/make.conf
643.It Pa /usr/src/Makefile
644.It Pa /usr/src/Makefile.inc1
645.El
646.Sh SEE ALSO
647.Xr gcc 1 ,
648.Xr install 1 ,
649.Xr make 1 ,
650.Xr lpd 8 ,
651.Xr sendmail 8
652.Sh HISTORY
653The
654.Nm
655file appeared sometime before
656.Fx 4.0 .
657.Sh AUTHORS
658This manual page was written by
659.An Mike W. Meyer Aq mwm@mired.org .
660.Sh BUGS
661This manual page may occasionally be out of date with respect to
662the options currently available for use in
663.Nm .
664Please check the
665.Pa /etc/defaults/make.conf
666file for the latest options which are available.
667