xref: /dflybsd-src/share/man/man5/make.conf.5 (revision 6938d9ab5938f24b49d1757b7426edfe267ce063)
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.\"
27.Dd December 15, 2011
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.Dx
38sources.
39The file
40.Nm
41is generally created by the system administrator when the values need
42to be changed from their defaults.
43.Pp
44The purpose of
45.Nm
46is not to run commands or perform compilation actions
47directly.
48Instead, it is included by the various makefiles in
49.Pa /usr/src
50which conditionalize their internal actions according to the settings
51found there.
52.Pp
53The
54.Pa /etc/make.conf
55file is included from the appropriate
56.Pa Makefile
57which specifies the default settings for all the available options.
58Options need only be specified in
59.Pa /etc/make.conf
60when the system administrator wishes to override these defaults.
61.Pp
62The build procedures occur in three areas: world, kernel, and
63documentation.
64Variables set in
65.Nm
66may be applicable during builds in one, two, or all of these areas.
67They may be specified for a particular build via the
68.Fl D
69option of
70.Xr make 1 .
71.Pp
72The following lists provide a name and short description for each
73variable you can use during the indicated builds.
74The values of variables flagged as
75.Vt bool
76are ignored; the variable being set at all (even to
77.Dq Li FALSE
78or
79.Dq Li NO )
80causes it to be treated as if it were set.
81.Pp
82The following list provides a name and short description for variables
83that are used for all builds, or are used by the
84.Pa makefiles
85for things other than builds.
86.Bl -tag -width Ar
87.It Va CPUTYPE
88.Pq Vt str
89Controls which processor should be targeted for generated code.
90This controls processor-specific optimizations in certain code
91(currently only OpenSSL) as well as modifying the value of
92.Va CFLAGS
93and
94.Va COPTFLAGS
95to contain the appropriate optimization directive to
96.Xr gcc 1 .
97The automatic setting of
98.Va CFLAGS
99and
100.Va COPTFLAGS
101may be overridden using the
102.Va NO_CPU_CFLAGS
103and
104.Va NO_CPU_COPTFLAGS
105variables, respectively.  Refer to
106.Pa /usr/share/examples/etc/defaults/make.conf
107for a list of recognized
108.Va CPUTYPE
109options.
110.It Va CCVER
111.Pq Vt str
112Controls which GCC version to use by default.
113It should be set as
114.Li CCVER?=
115so as not to interfere with overrides from userland.
116We currently recommend that an override NOT be set in
117.Pa /etc/make.conf .
118Currently accepted values for compilers which are part of
119.Dx
120are
121.Dq gcc41
122and
123.Dq gcc44
124(default).
125All other values will handled according to the settings in
126.Xr compilers.conf 5 .
127.It Va BINUTILSVER
128.Pq Vt str
129Controls which binutils to use by default.
130Currently accepted values are
131.Dq binutils221
132and
133.Dq binutils222
134(default).
135.It Va CFLAGS
136.Pq Vt str
137Controls the compiler setting when compiling C code.
138Optimization levels above
139.Fl O
140.Pq Fl O2 , No ...
141are not supported.
142.Va BDECFLAGS
143is provided as a set of
144.Xr gcc 1
145settings suggested by
146.An "Bruce Evans" Aq bde@FreeBSD.org
147for developing and testing changes.
148They can be used, if set, by:
149.Bd -literal -offset indent
150CFLAGS+=${BDECFLAGS}
151.Ed
152.It Va DEBUG_FLAGS
153.Pq Vt str
154Similar to
155.Va CFLAGS
156but it will cause
157.Va STRIP
158to be set to a blank value, if set.
159Typically,
160.Va DEBUG_FLAGS
161is set to
162.Fl g
163for compiling with debug symbols.
164.It Va NO_CPU_CFLAGS
165.Pq Vt str
166Setting this variable will prevent CPU specific compiler flags
167from being automatically added to
168.Va CFLAGS
169during compile time.
170.It Va CXXFLAGS
171.Pq Vt str
172Controls the compiler settings when compiling C++ code.
173.Va CXXFLAGS
174is initially set to the value of
175.Va CFLAGS .
176If you want to add 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 have components compared before doing the install, use
186.Bd -literal -offset indent
187INSTALL="install -C"
188.Ed
189.It Va LOCAL_DIRS
190.Pq Vt str
191List any directories that should be entered when running make
192.Pa /usr/src
193in this variable.
194.It Va MAKE_SHELL
195.Pq Vt str
196Controls the shell used internally by
197.Xr make 1
198to process the command scripts in makefiles.
199.Xr sh 1 ,
200.Xr ksh 1 ,
201and
202.Xr csh 1
203all currently supported.
204.Bd -literal -offset indent
205MAKE_SHELL?=sh
206.Ed
207.It Va MODULES_OVERRIDE
208.Pq Vt str
209Set to a list of modules to build instead of all of them.
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 STRIP
218.Pq Vt str
219Set this to the flag to pass to the
220.Xr strip 1
221command.
222If set to a blank value, debug symbols will not be removed.
223.Va STRIP
224is automatically set to a blank value if
225.Va DEBUG_FLAGS
226is set.
227.It Va WANT_HESIOD
228.Pq Vt bool
229Set this to build
230.Xr hesiod 3
231support into libc.
232.It Va NO_NS_CACHING
233.Pq Vt bool
234Set this to disable name caching in the nsswitch subsystem.
235The generic caching daemon,
236.Xr nscd 8 ,
237will not be built either if this option is set.
238.It Va NO_WERROR
239Set this if you don't want
240.Fl Werror
241to be added to
242.Va CWARNFLAGS
243or used in the kernel build.
244.It Va STATIC_LOCALES
245.Pq Vt str
246Set to a list of locales to build into statically-linked binaries.
247Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
248.El
249.Pp
250The following list provides a name and short description for variables
251that are only used doing a kernel build:
252.Bl -tag -width Ar
253.It Va BOOT_COMCONSOLE_PORT
254.Pq Vt str
255The port address to use for the console if the boot blocks have
256been configured to use a serial console instead of the keyboard/video card.
257.It Va BOOT_COMCONSOLE_SPEED
258.Pq Vt int
259The baud rate to use for the console if the boot blocks have
260been configured to use a serial console instead of the keyboard/video card.
261.It Va COPTFLAGS
262.Pq Vt str
263Controls the compiler settings when building the
264kernel.
265Optimization levels above
266.Fl O
267.Pq Fl O2 , No ...
268are not guaranteed to work.
269.It Va KERNCONF
270.Pq Vt str
271Controls which kernel configurations will be
272built by
273.Dq Li "${MAKE} buildkernel"
274and installed by
275.Dq Li "${MAKE} installkernel" .
276For example,
277.Bd -literal -offset indent
278KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
279.Ed
280.Pp
281will build the kernels specified by the config files
282.Pa MINE , DEBUG , GENERIC ,
283and
284.Pa OTHERMACHINE ,
285and install the kernel specified by the config file
286.Pa MINE .
287It defaults to
288.Pa GENERIC .
289.It Va NO_CPU_COPTFLAGS
290.Pq Vt str
291Setting this variable will prevent CPU specific compiler flags
292from being automatically added to
293.Va COPTFLAGS
294during compile time.
295.It Va NO_KERNELCLEAN
296.Pq Vt bool
297Set this to skip the clean target when using
298.Dq Li "${MAKE} buildkernel" .
299.It Va NO_KERNELCONFIG
300.Pq Vt bool
301Set this to skip running
302.Xr config 8
303during
304.Dq Li "${MAKE} buildkernel" .
305.It Va NO_KERNELDEPEND
306.Pq Vt bool
307Set this to skip running
308.Dq Li "${MAKE} depend"
309during
310.Dq Li "${MAKE} buildkernel" .
311.It Va NO_KERNEL_OLD_STRIP
312.Pq Vt bool
313Set this to skip stripping debugging symbols from old kernel and modules
314(kernel.old, modules.old) during
315.Dq Li "${MAKE} installkernel" .
316.It Va NO_MODULES
317.Pq Vt bool
318Set to not build modules with the kernel.
319.El
320.Pp
321The following list provides a name and short description for variables
322that are used during the world build:
323.Bl -tag -width Ar
324.It Va ENABLE_SUID_SSH
325.Pq Vt bool
326Set this to install
327.Xr ssh 1
328with the setuid bit turned on.
329.It Va MODULES_WITH_WORLD
330.Pq Vt bool
331Set to build modules with the system instead of the kernel.
332.It Va NO_BINUTILS221
333.Pq Vt bool
334Set to not build the older version of binutils (2.21).
335.It Va NO_CRYPT
336.Pq Vt bool
337Set to not build crypto code.
338.It Va NO_CVS
339.Pq Vt bool
340Set to not build CVS.
341.It Va NO_GAMES
342.Pq Vt bool
343Set to not build games.
344.It Va NO_GCC41
345.Pq Vt bool
346Set to not build the older version of GCC (4.1).
347.It Va NO_GDB
348.Pq Vt bool
349Set to not build
350.Xr gdb 1
351.It Va NO_LIBC_R
352.Pq Vt bool
353Set to not build
354.Nm libc_r
355(reentrant version of
356.Nm libc ) .
357.It Va NO_LPR
358.Pq Vt bool
359Set to not build
360.Xr lpr 1
361and related programs.
362.It Va NO_MAILWRAPPER
363.Pq Vt bool
364Set to not build the
365.Xr mailwrapper 8
366MTA selector.
367.It Va NO_OBJC
368.Pq Vt bool
369Set to not build Objective C support.
370.It Va NO_OPENSSH
371.Pq Vt bool
372Set to not build OpenSSH.
373.It Va NO_OPENSSL
374.Pq Vt bool
375Set to not build OpenSSL (implies
376.Va NO_OPENSSH ) .
377.It Va NO_SENDMAIL
378.Pq Vt bool
379Set to not build
380.Xr sendmail 8
381and related programs.
382.It Va NO_SHARE
383.Pq Vt bool
384Set to not enter the share subdirectory.
385.It Va NO_X
386.Pq Vt bool
387Set to not compile in X\-Windows support (e.g.\&
388.Xr doscmd 1 ) .
389.It Va NOCLEAN
390.Pq Vt bool
391Set this to disable cleaning during
392.Dq Li "make buildworld" .
393This should not be set unless you know what you are doing.
394.It Va NOCLEANDIR
395.Pq Vt bool
396Set this to run
397.Dq Li "${MAKE} clean"
398instead of
399.Dq Li "${MAKE} cleandir" .
400.It Va NOFSCHG
401.Pq Vt bool
402Set to not install certain components with flag schg.
403This is useful in a jailed environment.
404.It Va NOINFO
405.Pq Vt bool
406Set to not make or install
407.Xr info 5
408files.
409.It Va NOINFOCOMPRESS
410.Pq Vt bool
411Set to not compress the info pages.
412.It Va NOMAN
413.Pq Vt bool
414Set to not build manual pages
415.It Va NOMANCOMPRESS
416.Pq Vt bool
417Set to not compress the manual pages.
418.It Va NOPROFILE
419.Pq Vt bool
420Set to avoid compiling profiled libraries.
421.It Va PPP_NOSUID
422.Pq Vt bool
423Set to disable the installation of
424.Xr ppp 8
425with the set-user-ID bit on.
426.It Va SENDMAIL_MC
427.Pq Vt str
428The default
429.Xr m4 1
430configuration file to use at install time.
431The value should include the full path to the
432.Pa .mc
433file, e.g.,
434.Pa /etc/mail/myconfig.mc .
435Use with caution as a make install will overwrite any existing
436.Pa /etc/mail/sendmail.cf .
437Note that
438.Va SENDMAIL_CF
439is now deprecated.
440.It Va SENDMAIL_SUBMIT_MC
441.Pq Vt str
442The default
443.Xr m4 1
444configuration file for mail submission
445to use at install time.
446The value should include the full path to the
447.Pa .mc
448file, e.g.,
449.Pa /etc/mail/mysubmit.mc .
450Use with caution as a make install will overwrite any existing
451.Pa /etc/mail/submit.cf .
452.It Va SENDMAIL_ADDITIONAL_MC
453.Pq Vt str
454Additional
455.Pa .mc
456files which should be built into
457.Pa .cf
458files at build time.
459The value should include the full path to the
460.Pa .mc
461file(s), e.g.,
462.Pa /etc/mail/foo.mc
463.Pa /etc/mail/bar.mc .
464.It Va SENDMAIL_CF_DIR
465.Pq Vt str
466Override the default location for the
467.Xr m4 1
468configuration files used to build a
469.Pa .cf
470file from a
471.Pa .mc
472file.
473.It Va SENDMAIL_M4_FLAGS
474.Pq Vt str
475Flags passed to
476.Xr m4 1
477when building a
478.Pa .cf
479file from a
480.Pa .mc
481file.
482.It Va SENDMAIL_CFLAGS
483.Pq Vt str
484Flags to pass to the compile command when building
485.Xr sendmail 8 .
486The
487.Va SENDMAIL_*
488flags can be used to provide SASL support with setting such as:
489.Bd -literal -offset indent
490SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
491SENDMAIL_LDFLAGS=-L/usr/local/lib
492SENDMAIL_LDADD=-lsasl
493.Ed
494.It Va SENDMAIL_LDFLAGS
495.Pq Vt str
496Flags to pass to the
497.Xr ld 1
498command when building
499.Xr sendmail 8 .
500.It Va SENDMAIL_LDADD
501.Pq Vt str
502Flags to add to the end of the
503.Xr ld 1
504command when building
505.Xr sendmail 8 .
506.It Va SENDMAIL_DPADD
507.Pq Vt str
508Extra dependencies to add when building
509.Xr sendmail 8 .
510.It Va SENDMAIL_SET_USER_ID
511.Pq Vt bool
512If set, install
513.Xr sendmail 8
514as a set-user-ID root binary instead of a set-group-ID binary
515and do not install
516.Pa /etc/mail/submit.{cf,mc} .
517Use of this flag is not recommended and the alternative advice in
518.Pa /etc/mail/README
519should be followed instead if at all possible.
520.It Va SENDMAIL_MAP_PERMS
521.Pq Vt str
522Mode to use when generating alias and map database files using
523.Pa /etc/mail/Makefile .
524The default value is 0640.
525.It Va THREAD_LIB
526.Pq Vt str
527Set to either
528.Li c_r
529or
530.Li thread_xu
531to configure the system's default threading library.
532The default is
533.Li thread_xu .
534.It Va WANT_IDEA
535.Pq Vt bool
536Set to build the IDEA encryption code.
537This code is patented in the USA and many European countries.
538It is
539.Em "YOUR RESPONSIBILITY"
540to determine if you can legally use IDEA.
541.It Va WANT_INSTALLER
542.Pq Vt bool
543Set to build the installer.
544.El
545.Pp
546The following list provides a name and short description for variables
547that are used when building documentation.
548.Bl -tag -width Ar
549.It Va DOC_LANG
550.Pq Vt str
551The list of languages and encodings to build and install.
552.It Va PRINTERDEVICE
553.Pq Vt str
554The default format for system documentation, depends on your
555printer.
556This can be set to
557.Dq Li ascii
558for simple printers or
559.Dq Li ps
560for postscript or graphics printers with a ghostscript
561filter.
562.It Va GROFF_PAPER_SIZE
563.Pq Vt str
564The default paper size for
565.Xr groff 1
566(either
567.Dq letter
568or
569.Dq A4 ) .
570.El
571.Sh FILES
572.Bl -tag -width /etc/defaults/make.conf -compact
573.It Pa /etc/defaults/make.conf
574.It Pa /etc/make.conf
575.It Pa /usr/src/Makefile
576.It Pa /usr/src/Makefile.inc1
577.El
578.Sh SEE ALSO
579.Xr gcc 1 ,
580.Xr install 1 ,
581.Xr make 1 ,
582.Xr lpd 8 ,
583.Xr sendmail 8
584.Sh HISTORY
585The
586.Nm
587file appeared sometime before
588.Fx 4.0 .
589.Sh AUTHORS
590This manual page was written by
591.An Mike W. Meyer Aq mwm@mired.org .
592