Makefile.inc: Rework automatic backup (bug 2527)
[dragonfly.git] / share / man / man5 / make.conf.5
CommitLineData
984263bc
MD
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.\"
2decc9b9 27.Dd April 16, 2013
984263bc
MD
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
9bb2a92d 37.Dx
cecff5c1 38sources.
984263bc
MD
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.
cecff5c1 48Instead, it is included by the various makefiles in
0cd7b3a7 49.Pa /usr/src
cecff5c1
MD
50which conditionalize their internal actions according to the settings
51found there.
984263bc
MD
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
cecff5c1
MD
62The build procedures occur in three areas: world, kernel, and
63documentation.
984263bc
MD
64Variables set in
65.Nm
cecff5c1 66may be applicable during builds in one, two, or all of these areas.
984263bc
MD
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.
cecff5c1 74The values of variables flagged as
984263bc 75.Vt bool
cecff5c1 76are ignored; the variable being set at all (even to
984263bc
MD
77.Dq Li FALSE
78or
79.Dq Li NO )
cecff5c1 80causes it to be treated as if it were set.
984263bc
MD
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
984263bc
MD
87.It Va CPUTYPE
88.Pq Vt str
cecff5c1
MD
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
984263bc
MD
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
0cd7b3a7 106.Pa /usr/share/examples/etc/defaults/make.conf
984263bc
MD
107for a list of recognized
108.Va CPUTYPE
109options.
cecff5c1
MD
110.It Va CCVER
111.Pq Vt str
05664f8a
PA
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
cecff5c1 117.Pa /etc/make.conf .
e20d3103
SW
118Currently accepted values for compilers which are part of
119.Dx
120are
30c91f0c 121.Dq gcc44
c06d54ec
SW
122and
123.Dq gcc47
30c91f0c 124(default).
e20d3103
SW
125All other values will handled according to the settings in
126.Xr compilers.conf 5 .
7bee86c0
JM
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.
e20d3103
SW
147.It Va BINUTILSVER
148.Pq Vt str
149Controls which binutils to use by default.
150Currently accepted values are
1c05bfaa 151.Dq binutils221
e685772e
JM
152and
153.Dq binutils222
b1242318 154(default).
7bee86c0
JM
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.
cecff5c1
MD
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:
cecff5c1
MD
175.Bd -literal -offset indent
176CFLAGS+=${BDECFLAGS}
177.Ed
e20d3103
SW
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.
984263bc
MD
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.
984263bc
MD
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 .
cecff5c1 202If you want to add to the
984263bc
MD
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.
cecff5c1 211To have components compared before doing the install, use
984263bc
MD
212.Bd -literal -offset indent
213INSTALL="install -C"
214.Ed
2decc9b9
JM
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.
7bee86c0
JM
222.It Va WORLD_BACKUP
223.Pq Vt str
224defines where system binaries will be backed up for the
2decc9b9
JM
225.Dq backupworld
226.Xr make 1
227target.
228The default is
61443441 229.Dq /var/backups/world_backup .
2decc9b9
JM
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 .
984263bc
MD
239.It Va LOCAL_DIRS
240.Pq Vt str
2decc9b9
JM
241List of directories that should be entered when running
242.Xr make 1
243in
244.Pa /usr/src .
984263bc
MD
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
cecff5c1
MD
258.It Va MODULES_OVERRIDE
259.Pq Vt str
260Set to a list of modules to build instead of all of them.
984263bc
MD
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.
cecff5c1
MD
268.It Va STRIP
269.Pq Vt str
e20d3103 270Set this to the flag to pass to the
cecff5c1
MD
271.Xr strip 1
272command.
e20d3103
SW
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.
ed5d5720
PA
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.
18c2eecf
SS
289.It Va NO_WERROR
290Set this if you don't want
291.Fl Werror
292to be added to
74facaa5
SW
293.Va CWARNFLAGS
294or used in the kernel build.
003525a9
AP
295.It Va STATIC_LOCALES
296.Pq Vt str
297Set to a list of locales to build into statically-linked binaries.
24b4fe1f 298Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
984263bc
MD
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.
984263bc
MD
312.It Va COPTFLAGS
313.Pq Vt str
314Controls the compiler settings when building the
315kernel.
316Optimization levels above
7879b9ff
SW
317.Fl O
318.Pq Fl O2 , No ...
984263bc
MD
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 GENERIC OTHERMACHINE
330.Ed
331.Pp
332will build the kernels specified by the config files
333.Pa MINE , DEBUG , GENERIC ,
334and
335.Pa OTHERMACHINE ,
336and install the kernel specified by the config file
337.Pa MINE .
338It defaults to
339.Pa GENERIC .
cecff5c1 340.It Va NO_CPU_COPTFLAGS
984263bc 341.Pq Vt str
cecff5c1
MD
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" .
984263bc
MD
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" .
9200f41c
SS
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" .
984263bc
MD
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
984263bc
MD
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.
1feb8780
SW
383.It Va NO_BINUTILS221
384.Pq Vt bool
385Set to not build the older version of binutils (2.21).
cecff5c1
MD
386.It Va NO_CRYPT
387.Pq Vt bool
388Set to not build crypto code.
389.It Va NO_CVS
390.Pq Vt bool
391Set to not build CVS.
cecff5c1
MD
392.It Va NO_GAMES
393.Pq Vt bool
394Set to not build games.
c06d54ec 395.It Va NO_GCC44
48dff0ad 396.Pq Vt bool
c06d54ec 397Set to not build the older version of GCC (4.4).
984263bc
MD
398.It Va NO_GDB
399.Pq Vt bool
400Set to not build
401.Xr gdb 1
cecff5c1
MD
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 ) .
984263bc
MD
408.It Va NO_LPR
409.Pq Vt bool
410Set to not build
411.Xr lpr 1
412and related programs.
413.It Va NO_MAILWRAPPER
414.Pq Vt bool
415Set to not build the
416.Xr mailwrapper 8
417MTA selector.
984263bc
MD
418.It Va NO_OBJC
419.Pq Vt bool
420Set to not build Objective C support.
421.It Va NO_OPENSSH
422.Pq Vt bool
423Set to not build OpenSSH.
424.It Va NO_OPENSSL
425.Pq Vt bool
426Set to not build OpenSSL (implies
427.Va NO_OPENSSH ) .
428.It Va NO_SENDMAIL
429.Pq Vt bool
430Set to not build
431.Xr sendmail 8
432and related programs.
cecff5c1
MD
433.It Va NO_SHARE
434.Pq Vt bool
435Set to not enter the share subdirectory.
984263bc
MD
436.It Va NOCLEAN
437.Pq Vt bool
438Set this to disable cleaning during
439.Dq Li "make buildworld" .
440This should not be set unless you know what you are doing.
441.It Va NOCLEANDIR
442.Pq Vt bool
443Set this to run
444.Dq Li "${MAKE} clean"
445instead of
446.Dq Li "${MAKE} cleandir" .
cecff5c1 447.It Va NOFSCHG
984263bc 448.Pq Vt bool
566002a4 449Set to not install certain components with flag schg.
cecff5c1 450This is useful in a jailed environment.
984263bc
MD
451.It Va NOINFO
452.Pq Vt bool
453Set to not make or install
454.Xr info 5
455files.
cecff5c1 456.It Va NOINFOCOMPRESS
984263bc 457.Pq Vt bool
cecff5c1
MD
458Set to not compress the info pages.
459.It Va NOMAN
984263bc 460.Pq Vt bool
cecff5c1
MD
461Set to not build manual pages
462.It Va NOMANCOMPRESS
984263bc 463.Pq Vt bool
cecff5c1 464Set to not compress the manual pages.
984263bc
MD
465.It Va NOPROFILE
466.Pq Vt bool
467Set to avoid compiling profiled libraries.
984263bc
MD
468.It Va PPP_NOSUID
469.Pq Vt bool
470Set to disable the installation of
471.Xr ppp 8
cecff5c1 472with the set-user-ID bit on.
984263bc
MD
473.It Va SENDMAIL_MC
474.Pq Vt str
3181538d
GNS
475The default
476.Xr m4 1
477configuration file to use at install time.
984263bc
MD
478The value should include the full path to the
479.Pa .mc
480file, e.g.,
481.Pa /etc/mail/myconfig.mc .
482Use with caution as a make install will overwrite any existing
483.Pa /etc/mail/sendmail.cf .
484Note that
485.Va SENDMAIL_CF
486is now deprecated.
984263bc
MD
487.It Va SENDMAIL_SUBMIT_MC
488.Pq Vt str
3181538d
GNS
489The default
490.Xr m4 1
491configuration file for mail submission
984263bc
MD
492to use at install time.
493The value should include the full path to the
494.Pa .mc
495file, e.g.,
496.Pa /etc/mail/mysubmit.mc .
497Use with caution as a make install will overwrite any existing
498.Pa /etc/mail/submit.cf .
984263bc
MD
499.It Va SENDMAIL_ADDITIONAL_MC
500.Pq Vt str
501Additional
502.Pa .mc
503files which should be built into
504.Pa .cf
505files at build time.
506The value should include the full path to the
507.Pa .mc
508file(s), e.g.,
509.Pa /etc/mail/foo.mc
510.Pa /etc/mail/bar.mc .
3181538d
GNS
511.It Va SENDMAIL_CF_DIR
512.Pq Vt str
513Override the default location for the
514.Xr m4 1
515configuration files used to build a
516.Pa .cf
517file from a
518.Pa .mc
519file.
984263bc
MD
520.It Va SENDMAIL_M4_FLAGS
521.Pq Vt str
3181538d
GNS
522Flags passed to
523.Xr m4 1
524when building a
984263bc
MD
525.Pa .cf
526file from a
527.Pa .mc
528file.
529.It Va SENDMAIL_CFLAGS
530.Pq Vt str
531Flags to pass to the compile command when building
532.Xr sendmail 8 .
533The
534.Va SENDMAIL_*
535flags can be used to provide SASL support with setting such as:
536.Bd -literal -offset indent
537SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
538SENDMAIL_LDFLAGS=-L/usr/local/lib
539SENDMAIL_LDADD=-lsasl
540.Ed
541.It Va SENDMAIL_LDFLAGS
542.Pq Vt str
543Flags to pass to the
544.Xr ld 1
545command when building
546.Xr sendmail 8 .
547.It Va SENDMAIL_LDADD
548.Pq Vt str
549Flags to add to the end of the
550.Xr ld 1
551command when building
552.Xr sendmail 8 .
553.It Va SENDMAIL_DPADD
554.Pq Vt str
555Extra dependencies to add when building
556.Xr sendmail 8 .
557.It Va SENDMAIL_SET_USER_ID
558.Pq Vt bool
559If set, install
560.Xr sendmail 8
561as a set-user-ID root binary instead of a set-group-ID binary
562and do not install
563.Pa /etc/mail/submit.{cf,mc} .
564Use of this flag is not recommended and the alternative advice in
565.Pa /etc/mail/README
3181538d 566should be followed instead if at all possible.
984263bc
MD
567.It Va SENDMAIL_MAP_PERMS
568.Pq Vt str
569Mode to use when generating alias and map database files using
570.Pa /etc/mail/Makefile .
571The default value is 0640.
587bc464
SW
572.It Va THREAD_LIB
573.Pq Vt str
574Set to either
575.Li c_r
576or
577.Li thread_xu
578to configure the system's default threading library.
579The default is
580.Li thread_xu .
3e84a8c5 581.It Va WANT_IDEA
cecff5c1
MD
582.Pq Vt bool
583Set to build the IDEA encryption code.
584This code is patented in the USA and many European countries.
585It is
586.Em "YOUR RESPONSIBILITY"
587to determine if you can legally use IDEA.
7ebbae99
SW
588.It Va WANT_INSTALLER
589.Pq Vt bool
590Set to build the installer.
9e603efc
SW
591.It Va WANT_NETGRAPH7
592.Pq Vt bool
593Set to build a newer, experimental
594.Xr netgraph 4
595userland.
596It has to be accompanied by
597.Dv NETGRAPH7*
598options in the kernel.
d884d710
SW
599.It Va WANT_USB4BSD
600.Pq Vt bool
601Set to build a newer, experimental
602.Xr usb 4
603userland.
984263bc
MD
604.El
605.Pp
606The following list provides a name and short description for variables
607that are used when building documentation.
608.Bl -tag -width Ar
984263bc
MD
609.It Va DOC_LANG
610.Pq Vt str
611The list of languages and encodings to build and install.
612.It Va PRINTERDEVICE
613.Pq Vt str
614The default format for system documentation, depends on your
615printer.
616This can be set to
617.Dq Li ascii
618for simple printers or
619.Dq Li ps
620for postscript or graphics printers with a ghostscript
621filter.
42a03791
SW
622.It Va GROFF_PAPER_SIZE
623.Pq Vt str
624The default paper size for
625.Xr groff 1
626(either
627.Dq letter
628or
629.Dq A4 ) .
984263bc 630.El
984263bc
MD
631.Sh FILES
632.Bl -tag -width /etc/defaults/make.conf -compact
633.It Pa /etc/defaults/make.conf
634.It Pa /etc/make.conf
984263bc
MD
635.It Pa /usr/src/Makefile
636.It Pa /usr/src/Makefile.inc1
984263bc
MD
637.El
638.Sh SEE ALSO
639.Xr gcc 1 ,
640.Xr install 1 ,
641.Xr make 1 ,
984263bc
MD
642.Xr lpd 8 ,
643.Xr sendmail 8
644.Sh HISTORY
645The
646.Nm
647file appeared sometime before
648.Fx 4.0 .
649.Sh AUTHORS
cecff5c1 650This manual page was written by
984263bc 651.An Mike W. Meyer Aq mwm@mired.org .