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