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