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