xref: /dragonfly/share/man/man5/make.conf.5 (revision 6ca88057)
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 October 28, 2015
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 gcc47
122and
123.Dq gcc50
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 gcc50
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, default) and
139.Dq ld.bfd
140(classic GNU ld linker).
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 binutils224
152and
153.Dq binutils225
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 binutils225
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 Mt 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 NO_BACKUP
216.Pq Vt str
217Inhibit automatic backup of world binaries as port of
218.Dq installworld
219.Xr make 1
220target.
221Default is unset.
222.It Va WORLD_BACKUP
223.Pq Vt str
224defines where system binaries will be backed up for the
225.Dq backupworld
226.Xr make 1
227target.
228The default is
229.Dq /var/backups/world_backup .
230.It Va AUTO_BACKUP
231.Pq Vt str
232defines where system binaries will be backed up automatically
233as part of the
234.Dq installworld
235.Xr make 1
236target.
237The default is
238.Dq Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR .
239.It Va LOCAL_DIRS
240.Pq Vt str
241List of directories that should be entered when running
242.Xr make 1
243in
244.Pa /usr/src .
245.It Va MAKE_SHELL
246.Pq Vt str
247Controls the shell used internally by
248.Xr make 1
249to process the command scripts in makefiles.
250.Xr sh 1 ,
251.Xr ksh 1 ,
252and
253.Xr csh 1
254all currently supported.
255.Bd -literal -offset indent
256MAKE_SHELL?=sh
257.Ed
258.It Va MODULES_OVERRIDE
259.Pq Vt str
260Set to a list of modules to build instead of all of them.
261.It Va MTREE_FOLLOWS_SYMLINKS
262.Pq Vt str
263Set this to
264.Dq Fl L
265to cause
266.Xr mtree 8
267to follow symlinks.
268.It Va STRIP
269.Pq Vt str
270Set this to the flag to pass to the
271.Xr strip 1
272command.
273If set to a blank value, debug symbols will not be removed.
274.Va STRIP
275is automatically set to a blank value if
276.Va DEBUG_FLAGS
277is set.
278.It Va WANT_HESIOD
279.Pq Vt bool
280Set this to build
281.Xr hesiod 3
282support into libc.
283.It Va NO_NS_CACHING
284.Pq Vt bool
285Set this to disable name caching in the nsswitch subsystem.
286The generic caching daemon,
287.Xr nscd 8 ,
288will not be built either if this option is set.
289.It Va NO_WERROR
290Set this if you don't want
291.Fl Werror
292to be added to
293.Va CWARNFLAGS
294or used in the kernel build.
295.It Va STATIC_LOCALES
296.Pq Vt str
297Set to a list of locales to build into statically-linked binaries.
298Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
299.El
300.Pp
301The following list provides a name and short description for variables
302that are only used doing a kernel build:
303.Bl -tag -width Ar
304.It Va BOOT_COMCONSOLE_PORT
305.Pq Vt str
306The port address to use for the console if the boot blocks have
307been configured to use a serial console instead of the keyboard/video card.
308.It Va BOOT_COMCONSOLE_SPEED
309.Pq Vt int
310The baud rate to use for the console if the boot blocks have
311been configured to use a serial console instead of the keyboard/video card.
312.It Va COPTFLAGS
313.Pq Vt str
314Controls the compiler settings when building the
315kernel.
316Optimization levels above
317.Fl O
318.Pq Fl O2 , No ...
319are not guaranteed to work.
320.It Va KERNCONF
321.Pq Vt str
322Controls which kernel configurations will be
323built by
324.Dq Li "${MAKE} buildkernel"
325and installed by
326.Dq Li "${MAKE} installkernel" .
327For example,
328.Bd -literal -offset indent
329KERNCONF=MINE DEBUG X86_64_GENERIC OTHERMACHINE
330.Ed
331.Pp
332will build the kernels specified by the config files
333.Pa MINE , DEBUG , X86_64_GENERIC ,
334and
335.Pa OTHERMACHINE ,
336and install the kernel specified by the config file
337.Pa MINE .
338It defaults to
339.Pa X86_64_GENERIC .
340.It Va NO_CPU_COPTFLAGS
341.Pq Vt str
342Setting this variable will prevent CPU specific compiler flags
343from being automatically added to
344.Va COPTFLAGS
345during compile time.
346.It Va NO_KERNELCLEAN
347.Pq Vt bool
348Set this to skip the clean target when using
349.Dq Li "${MAKE} buildkernel" .
350.It Va NO_KERNELCONFIG
351.Pq Vt bool
352Set this to skip running
353.Xr config 8
354during
355.Dq Li "${MAKE} buildkernel" .
356.It Va NO_KERNELDEPEND
357.Pq Vt bool
358Set this to skip running
359.Dq Li "${MAKE} depend"
360during
361.Dq Li "${MAKE} buildkernel" .
362.It Va NO_KERNEL_OLD_STRIP
363.Pq Vt bool
364Set this to skip stripping debugging symbols from old kernel and modules
365(kernel.old, modules.old) during
366.Dq Li "${MAKE} installkernel" .
367.It Va NO_MODULES
368.Pq Vt bool
369Set to not build modules with the kernel.
370.El
371.Pp
372The following list provides a name and short description for variables
373that are used during the world build:
374.Bl -tag -width Ar
375.It Va ENABLE_SUID_SSH
376.Pq Vt bool
377Set this to install
378.Xr ssh 1
379with the setuid bit turned on.
380.It Va MODULES_WITH_WORLD
381.Pq Vt bool
382Set to build modules with the system instead of the kernel.
383.It Va NO_ALTBINUTILS
384.Pq Vt bool
385Set to not build the alternative (non-default) set of binutils.
386.It Va NO_ALTCOMPILER
387.Pq Vt bool
388Set to not build the designated secondary compiler (GCC 4.7).
389.It Va NO_CRYPT
390.Pq Vt bool
391Set to not build crypto code.
392.It Va NO_CVS
393.Pq Vt bool
394Set to not build CVS.
395.It Va NO_GAMES
396.Pq Vt bool
397Set to not build games.
398.It Va NO_GDB
399.Pq Vt bool
400Set to not build
401.Xr gdb 1
402.It Va NO_LIBC_R
403.Pq Vt bool
404Set to not build
405.Nm libc_r
406(reentrant version of
407.Nm libc ) .
408.It Va NO_LPR
409.Pq Vt bool
410Set to not build
411.Xr lpr 1
412and related programs.
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_SHARE
421.Pq Vt bool
422Set to not enter the share subdirectory.
423.It Va NOCLEAN
424.Pq Vt bool
425Set this to disable cleaning during
426.Dq Li "make buildworld" .
427This should not be set unless you know what you are doing.
428.It Va NOCLEANDIR
429.Pq Vt bool
430Set this to run
431.Dq Li "${MAKE} clean"
432instead of
433.Dq Li "${MAKE} cleandir" .
434.It Va NOFSCHG
435.Pq Vt bool
436Set to not install certain components with flag schg.
437This is useful in a jailed environment.
438.It Va NOMAN
439.Pq Vt bool
440Set to not build manual pages
441.It Va NOMANCOMPRESS
442.Pq Vt bool
443Set to not compress the manual pages.
444.It Va NOPROFILE
445.Pq Vt bool
446Set to avoid compiling profiled libraries.
447.It Va PPP_NOSUID
448.Pq Vt bool
449Set to disable the installation of
450.Xr ppp 8
451with the set-user-ID bit on.
452.It Va XAUTH_PATH
453.Pq Vt str
454The path to the xauth program used by OpenSSH client.
455.It Va SENDMAIL_MC
456.Pq Vt str
457The default
458.Xr m4 1
459configuration file to use at install time.
460The value should include the full path to the
461.Pa .mc
462file, e.g.,
463.Pa /etc/mail/myconfig.mc .
464Use with caution as a make install will overwrite any existing
465.Pa /etc/mail/sendmail.cf .
466.It Va SENDMAIL_SUBMIT_MC
467.Pq Vt str
468The default
469.Xr m4 1
470configuration file for mail submission
471to use at install time.
472The value should include the full path to the
473.Pa .mc
474file, e.g.,
475.Pa /etc/mail/mysubmit.mc .
476Use with caution as a make install will overwrite any existing
477.Pa /etc/mail/submit.cf .
478.It Va SENDMAIL_CF_DIR
479.Pq Vt str
480Override the default location for the
481.Xr m4 1
482configuration files used to build a
483.Pa .cf
484file from a
485.Pa .mc
486file.
487The default is
488.Pa /usr/local/share/sendmail/cf .
489.It Va SENDMAIL_M4_FLAGS
490.Pq Vt str
491Flags passed to
492.Xr m4 1
493when building a
494.Pa .cf
495file from a
496.Pa .mc
497file.
498.It Va SENDMAIL_MAP_PERMS
499.Pq Vt str
500Mode to use when generating alias and map database files using
501.Pa /etc/mail/Makefile .
502The default value is 0640.
503.It Va THREAD_LIB
504.Pq Vt str
505Set to either
506.Li c_r
507or
508.Li thread_xu
509to configure the system's default threading library.
510The default is
511.Li thread_xu .
512.It Va WANT_IDEA
513.Pq Vt bool
514Set to build the IDEA encryption code.
515This code is patented in the USA and many European countries.
516It is
517.Em "YOUR RESPONSIBILITY"
518to determine if you can legally use IDEA.
519.It Va WANT_INSTALLER
520.Pq Vt bool
521Set to build the installer.
522.It Va WANT_NETGRAPH7
523.Pq Vt bool
524Set to build a newer, experimental
525.Xr netgraph 4
526userland.
527It has to be accompanied by
528.Dv NETGRAPH7*
529options in the kernel.
530.El
531.Pp
532The following list provides a name and short description for variables
533that are used when building documentation.
534.Bl -tag -width Ar
535.It Va PRINTERDEVICE
536.Pq Vt str
537The default format for system documentation, depends on your
538printer.
539This can be set to
540.Dq Li ascii
541for simple printers or
542.Dq Li ps
543for postscript or graphics printers with a ghostscript
544filter.
545.It Va GROFF_PAPER_SIZE
546.Pq Vt str
547The default paper size for
548.Xr groff 1
549(either
550.Dq letter
551or
552.Dq A4 ) .
553.El
554.Sh FILES
555.Bl -tag -width /etc/defaults/make.conf -compact
556.It Pa /etc/defaults/make.conf
557.It Pa /etc/make.conf
558.It Pa /usr/src/Makefile
559.It Pa /usr/src/Makefile.inc1
560.El
561.Sh SEE ALSO
562.Xr gcc 1 ,
563.Xr install 1 ,
564.Xr make 1 ,
565.Xr lpd 8
566.Sh HISTORY
567The
568.Nm
569file appeared sometime before
570.Fx 4.0 .
571.Sh AUTHORS
572This manual page was written by
573.An Mike W. Meyer Aq Mt mwm@mired.org .
574