xref: /dragonfly/share/man/man5/make.conf.5 (revision cecb9aae)
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 February 17, 2013
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 gcc44
122and
123.Dq gcc47
124(default).
125All other values will handled according to the settings in
126.Xr compilers.conf 5 .
127.It Va WORLD_CCVER
128.Pq Vt str
129Controls which version of GCC builds the base system, including
130the kernel.
131.Dq gcc47
132is the default value.
133.It Va LDVER
134.Pq Vt str
135Controls which linker to use by default.  Currently accepted
136values are
137.Dq ld.gold
138(GNU Gold linker) and
139.Dq ld.bfd
140(default).
141.It Va WORLD_LDVER
142.Pq Vt str
143Controls which linker builds the base system, including
144the kernel.
145.Dq ld.bfd
146is the default value.
147.It Va BINUTILSVER
148.Pq Vt str
149Controls which binutils to use by default.
150Currently accepted values are
151.Dq binutils221
152and
153.Dq binutils222
154(default).
155.It Va WORLD_BINUTILSVER
156.Pq Vt str
157Controls which version of binutils builds the base system, including
158the kernel.
159.Dq binutils222
160is the default value.
161.It Va CFLAGS
162.Pq Vt str
163Controls the compiler setting when compiling C code.
164Optimization levels above
165.Fl O
166.Pq Fl O2 , No ...
167are not supported.
168.Va BDECFLAGS
169is provided as a set of
170.Xr gcc 1
171settings suggested by
172.An "Bruce Evans" Aq bde@FreeBSD.org
173for developing and testing changes.
174They can be used, if set, by:
175.Bd -literal -offset indent
176CFLAGS+=${BDECFLAGS}
177.Ed
178.It Va DEBUG_FLAGS
179.Pq Vt str
180Similar to
181.Va CFLAGS
182but it will cause
183.Va STRIP
184to be set to a blank value, if set.
185Typically,
186.Va DEBUG_FLAGS
187is set to
188.Fl g
189for compiling with debug symbols.
190.It Va NO_CPU_CFLAGS
191.Pq Vt str
192Setting this variable will prevent CPU specific compiler flags
193from being automatically added to
194.Va CFLAGS
195during compile time.
196.It Va CXXFLAGS
197.Pq Vt str
198Controls the compiler settings when compiling C++ code.
199.Va CXXFLAGS
200is initially set to the value of
201.Va CFLAGS .
202If you want to add to the
203.Va CXXFLAGS
204value, use
205.Dq Li +=
206instead of
207.Dq Li = .
208.It Va INSTALL
209.Pq Vt str
210the default install command.
211To have components compared before doing the install, use
212.Bd -literal -offset indent
213INSTALL="install -C"
214.Ed
215.It Va WORLD_BACKUP
216.Pq Vt str
217defines where system binaries will be backed up for the
218.Dq make backupworld
219target.  The default value is
220.Dq /var/backups/world_backup .
221.It Va LOCAL_DIRS
222.Pq Vt str
223List any directories that should be entered when running make
224.Pa /usr/src
225in this variable.
226.It Va MAKE_SHELL
227.Pq Vt str
228Controls the shell used internally by
229.Xr make 1
230to process the command scripts in makefiles.
231.Xr sh 1 ,
232.Xr ksh 1 ,
233and
234.Xr csh 1
235all currently supported.
236.Bd -literal -offset indent
237MAKE_SHELL?=sh
238.Ed
239.It Va MODULES_OVERRIDE
240.Pq Vt str
241Set to a list of modules to build instead of all of them.
242.It Va MTREE_FOLLOWS_SYMLINKS
243.Pq Vt str
244Set this to
245.Dq Fl L
246to cause
247.Xr mtree 8
248to follow symlinks.
249.It Va STRIP
250.Pq Vt str
251Set this to the flag to pass to the
252.Xr strip 1
253command.
254If set to a blank value, debug symbols will not be removed.
255.Va STRIP
256is automatically set to a blank value if
257.Va DEBUG_FLAGS
258is set.
259.It Va WANT_HESIOD
260.Pq Vt bool
261Set this to build
262.Xr hesiod 3
263support into libc.
264.It Va NO_NS_CACHING
265.Pq Vt bool
266Set this to disable name caching in the nsswitch subsystem.
267The generic caching daemon,
268.Xr nscd 8 ,
269will not be built either if this option is set.
270.It Va NO_WERROR
271Set this if you don't want
272.Fl Werror
273to be added to
274.Va CWARNFLAGS
275or used in the kernel build.
276.It Va STATIC_LOCALES
277.Pq Vt str
278Set to a list of locales to build into statically-linked binaries.
279Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
280.El
281.Pp
282The following list provides a name and short description for variables
283that are only used doing a kernel build:
284.Bl -tag -width Ar
285.It Va BOOT_COMCONSOLE_PORT
286.Pq Vt str
287The port address to use for the console if the boot blocks have
288been configured to use a serial console instead of the keyboard/video card.
289.It Va BOOT_COMCONSOLE_SPEED
290.Pq Vt int
291The baud rate to use for the console if the boot blocks have
292been configured to use a serial console instead of the keyboard/video card.
293.It Va COPTFLAGS
294.Pq Vt str
295Controls the compiler settings when building the
296kernel.
297Optimization levels above
298.Fl O
299.Pq Fl O2 , No ...
300are not guaranteed to work.
301.It Va KERNCONF
302.Pq Vt str
303Controls which kernel configurations will be
304built by
305.Dq Li "${MAKE} buildkernel"
306and installed by
307.Dq Li "${MAKE} installkernel" .
308For example,
309.Bd -literal -offset indent
310KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
311.Ed
312.Pp
313will build the kernels specified by the config files
314.Pa MINE , DEBUG , GENERIC ,
315and
316.Pa OTHERMACHINE ,
317and install the kernel specified by the config file
318.Pa MINE .
319It defaults to
320.Pa GENERIC .
321.It Va NO_CPU_COPTFLAGS
322.Pq Vt str
323Setting this variable will prevent CPU specific compiler flags
324from being automatically added to
325.Va COPTFLAGS
326during compile time.
327.It Va NO_KERNELCLEAN
328.Pq Vt bool
329Set this to skip the clean target when using
330.Dq Li "${MAKE} buildkernel" .
331.It Va NO_KERNELCONFIG
332.Pq Vt bool
333Set this to skip running
334.Xr config 8
335during
336.Dq Li "${MAKE} buildkernel" .
337.It Va NO_KERNELDEPEND
338.Pq Vt bool
339Set this to skip running
340.Dq Li "${MAKE} depend"
341during
342.Dq Li "${MAKE} buildkernel" .
343.It Va NO_KERNEL_OLD_STRIP
344.Pq Vt bool
345Set this to skip stripping debugging symbols from old kernel and modules
346(kernel.old, modules.old) during
347.Dq Li "${MAKE} installkernel" .
348.It Va NO_MODULES
349.Pq Vt bool
350Set to not build modules with the kernel.
351.El
352.Pp
353The following list provides a name and short description for variables
354that are used during the world build:
355.Bl -tag -width Ar
356.It Va ENABLE_SUID_SSH
357.Pq Vt bool
358Set this to install
359.Xr ssh 1
360with the setuid bit turned on.
361.It Va MODULES_WITH_WORLD
362.Pq Vt bool
363Set to build modules with the system instead of the kernel.
364.It Va NO_BINUTILS221
365.Pq Vt bool
366Set to not build the older version of binutils (2.21).
367.It Va NO_CRYPT
368.Pq Vt bool
369Set to not build crypto code.
370.It Va NO_CVS
371.Pq Vt bool
372Set to not build CVS.
373.It Va NO_GAMES
374.Pq Vt bool
375Set to not build games.
376.It Va NO_GCC44
377.Pq Vt bool
378Set to not build the older version of GCC (4.4).
379.It Va NO_GDB
380.Pq Vt bool
381Set to not build
382.Xr gdb 1
383.It Va NO_LIBC_R
384.Pq Vt bool
385Set to not build
386.Nm libc_r
387(reentrant version of
388.Nm libc ) .
389.It Va NO_LPR
390.Pq Vt bool
391Set to not build
392.Xr lpr 1
393and related programs.
394.It Va NO_MAILWRAPPER
395.Pq Vt bool
396Set to not build the
397.Xr mailwrapper 8
398MTA selector.
399.It Va NO_OBJC
400.Pq Vt bool
401Set to not build Objective C support.
402.It Va NO_OPENSSH
403.Pq Vt bool
404Set to not build OpenSSH.
405.It Va NO_OPENSSL
406.Pq Vt bool
407Set to not build OpenSSL (implies
408.Va NO_OPENSSH ) .
409.It Va NO_SENDMAIL
410.Pq Vt bool
411Set to not build
412.Xr sendmail 8
413and related programs.
414.It Va NO_SHARE
415.Pq Vt bool
416Set to not enter the share subdirectory.
417.It Va NOCLEAN
418.Pq Vt bool
419Set this to disable cleaning during
420.Dq Li "make buildworld" .
421This should not be set unless you know what you are doing.
422.It Va NOCLEANDIR
423.Pq Vt bool
424Set this to run
425.Dq Li "${MAKE} clean"
426instead of
427.Dq Li "${MAKE} cleandir" .
428.It Va NOFSCHG
429.Pq Vt bool
430Set to not install certain components with flag schg.
431This is useful in a jailed environment.
432.It Va NOINFO
433.Pq Vt bool
434Set to not make or install
435.Xr info 5
436files.
437.It Va NOINFOCOMPRESS
438.Pq Vt bool
439Set to not compress the info pages.
440.It Va NOMAN
441.Pq Vt bool
442Set to not build manual pages
443.It Va NOMANCOMPRESS
444.Pq Vt bool
445Set to not compress the manual pages.
446.It Va NOPROFILE
447.Pq Vt bool
448Set to avoid compiling profiled libraries.
449.It Va PPP_NOSUID
450.Pq Vt bool
451Set to disable the installation of
452.Xr ppp 8
453with the set-user-ID bit on.
454.It Va SENDMAIL_MC
455.Pq Vt str
456The default
457.Xr m4 1
458configuration file to use at install time.
459The value should include the full path to the
460.Pa .mc
461file, e.g.,
462.Pa /etc/mail/myconfig.mc .
463Use with caution as a make install will overwrite any existing
464.Pa /etc/mail/sendmail.cf .
465Note that
466.Va SENDMAIL_CF
467is now deprecated.
468.It Va SENDMAIL_SUBMIT_MC
469.Pq Vt str
470The default
471.Xr m4 1
472configuration file for mail submission
473to use at install time.
474The value should include the full path to the
475.Pa .mc
476file, e.g.,
477.Pa /etc/mail/mysubmit.mc .
478Use with caution as a make install will overwrite any existing
479.Pa /etc/mail/submit.cf .
480.It Va SENDMAIL_ADDITIONAL_MC
481.Pq Vt str
482Additional
483.Pa .mc
484files which should be built into
485.Pa .cf
486files at build time.
487The value should include the full path to the
488.Pa .mc
489file(s), e.g.,
490.Pa /etc/mail/foo.mc
491.Pa /etc/mail/bar.mc .
492.It Va SENDMAIL_CF_DIR
493.Pq Vt str
494Override the default location for the
495.Xr m4 1
496configuration files used to build a
497.Pa .cf
498file from a
499.Pa .mc
500file.
501.It Va SENDMAIL_M4_FLAGS
502.Pq Vt str
503Flags passed to
504.Xr m4 1
505when building a
506.Pa .cf
507file from a
508.Pa .mc
509file.
510.It Va SENDMAIL_CFLAGS
511.Pq Vt str
512Flags to pass to the compile command when building
513.Xr sendmail 8 .
514The
515.Va SENDMAIL_*
516flags can be used to provide SASL support with setting such as:
517.Bd -literal -offset indent
518SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
519SENDMAIL_LDFLAGS=-L/usr/local/lib
520SENDMAIL_LDADD=-lsasl
521.Ed
522.It Va SENDMAIL_LDFLAGS
523.Pq Vt str
524Flags to pass to the
525.Xr ld 1
526command when building
527.Xr sendmail 8 .
528.It Va SENDMAIL_LDADD
529.Pq Vt str
530Flags to add to the end of the
531.Xr ld 1
532command when building
533.Xr sendmail 8 .
534.It Va SENDMAIL_DPADD
535.Pq Vt str
536Extra dependencies to add when building
537.Xr sendmail 8 .
538.It Va SENDMAIL_SET_USER_ID
539.Pq Vt bool
540If set, install
541.Xr sendmail 8
542as a set-user-ID root binary instead of a set-group-ID binary
543and do not install
544.Pa /etc/mail/submit.{cf,mc} .
545Use of this flag is not recommended and the alternative advice in
546.Pa /etc/mail/README
547should be followed instead if at all possible.
548.It Va SENDMAIL_MAP_PERMS
549.Pq Vt str
550Mode to use when generating alias and map database files using
551.Pa /etc/mail/Makefile .
552The default value is 0640.
553.It Va THREAD_LIB
554.Pq Vt str
555Set to either
556.Li c_r
557or
558.Li thread_xu
559to configure the system's default threading library.
560The default is
561.Li thread_xu .
562.It Va WANT_IDEA
563.Pq Vt bool
564Set to build the IDEA encryption code.
565This code is patented in the USA and many European countries.
566It is
567.Em "YOUR RESPONSIBILITY"
568to determine if you can legally use IDEA.
569.It Va WANT_INSTALLER
570.Pq Vt bool
571Set to build the installer.
572.It Va WANT_NETGRAPH7
573.Pq Vt bool
574Set to build a newer, experimental
575.Xr netgraph 4
576userland.
577It has to be accompanied by
578.Dv NETGRAPH7*
579options in the kernel.
580.It Va WANT_USB4BSD
581.Pq Vt bool
582Set to build a newer, experimental
583.Xr usb 4
584userland.
585.El
586.Pp
587The following list provides a name and short description for variables
588that are used when building documentation.
589.Bl -tag -width Ar
590.It Va DOC_LANG
591.Pq Vt str
592The list of languages and encodings to build and install.
593.It Va PRINTERDEVICE
594.Pq Vt str
595The default format for system documentation, depends on your
596printer.
597This can be set to
598.Dq Li ascii
599for simple printers or
600.Dq Li ps
601for postscript or graphics printers with a ghostscript
602filter.
603.It Va GROFF_PAPER_SIZE
604.Pq Vt str
605The default paper size for
606.Xr groff 1
607(either
608.Dq letter
609or
610.Dq A4 ) .
611.El
612.Sh FILES
613.Bl -tag -width /etc/defaults/make.conf -compact
614.It Pa /etc/defaults/make.conf
615.It Pa /etc/make.conf
616.It Pa /usr/src/Makefile
617.It Pa /usr/src/Makefile.inc1
618.El
619.Sh SEE ALSO
620.Xr gcc 1 ,
621.Xr install 1 ,
622.Xr make 1 ,
623.Xr lpd 8 ,
624.Xr sendmail 8
625.Sh HISTORY
626The
627.Nm
628file appeared sometime before
629.Fx 4.0 .
630.Sh AUTHORS
631This manual page was written by
632.An Mike W. Meyer Aq mwm@mired.org .
633