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