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