xref: /dragonfly/share/man/man5/make.conf.5 (revision 878f9070)
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 September 16, 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 gcc41
121(default).
122.It Va CFLAGS
123.Pq Vt str
124Controls the compiler setting when compiling C code.
125Optimization levels above
126.Fl O
127.Pq Fl O2 , No ...
128are not supported.
129.Va BDECFLAGS
130is provided as a set of
131.Xr gcc 1
132settings suggested by
133.An "Bruce Evans" Aq bde@FreeBSD.org
134for developing and testing changes.
135They can be used, if set, by:
136.Bd -literal -offset indent
137CFLAGS+=${BDECFLAGS}
138.Ed
139.It Va NO_CPU_CFLAGS
140.Pq Vt str
141Setting this variable will prevent CPU specific compiler flags
142from being automatically added to
143.Va CFLAGS
144during compile time.
145.It Va CXXFLAGS
146.Pq Vt str
147Controls the compiler settings when compiling C++ code.
148.Va CXXFLAGS
149is initially set to the value of
150.Va CFLAGS .
151If you want to add to the
152.Va CXXFLAGS
153value, use
154.Dq Li +=
155instead of
156.Dq Li = .
157.It Va INSTALL
158.Pq Vt str
159the default install command.
160To have components compared before doing the install, use
161.Bd -literal -offset indent
162INSTALL="install -C"
163.Ed
164.It Va LOCAL_DIRS
165.Pq Vt str
166List any directories that should be entered when running make
167.Pa /usr/src
168in this variable.
169.It Va MAKE_SHELL
170.Pq Vt str
171Controls the shell used internally by
172.Xr make 1
173to process the command scripts in makefiles.
174.Xr sh 1 ,
175.Xr ksh 1 ,
176and
177.Xr csh 1
178all currently supported.
179.Bd -literal -offset indent
180MAKE_SHELL?=sh
181.Ed
182.It Va MODULES_OVERRIDE
183.Pq Vt str
184Set to a list of modules to build instead of all of them.
185.It Va MTREE_FOLLOWS_SYMLINKS
186.Pq Vt str
187Set this to
188.Dq Fl L
189to cause
190.Xr mtree 8
191to follow symlinks.
192.It Va STRIP
193.Pq Vt str
194Set this to the flag to pass the
195.Xr strip 1
196command.
197If set to a blank value, components will be installed with debugging
198symbols.
199.It Va WANT_HESIOD
200.Pq Vt bool
201Set this to build
202.Xr hesiod 3
203support into libc.
204.It Va NO_NS_CACHING
205.Pq Vt bool
206Set this to disable name caching in the nsswitch subsystem.
207The generic caching daemon,
208.Xr nscd 8 ,
209will not be built either if this option is set.
210.It Va NO_WERROR
211Set this if you don't want
212.Fl Werror
213to be added to
214.Va CWARNFLAGS .
215.It Va STATIC_LOCALES
216.Pq Vt str
217Set to a list of locales to build into statically-linked binaries.
218Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
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_SSH
309.Pq Vt bool
310Set this to install
311.Xr ssh 1
312with the setuid bit turned on.
313.It Va MODULES_WITH_WORLD
314.Pq Vt bool
315Set to build modules with the system instead of the kernel.
316.It Va NO_BIND
317.Pq Vt bool
318Set to not build BIND.
319.It Va NO_CRYPT
320.Pq Vt bool
321Set to not build crypto code.
322.It Va NO_CVS
323.Pq Vt bool
324Set to not build CVS.
325.It Va NO_GAMES
326.Pq Vt bool
327Set to not build games.
328.It Va NO_GCC44
329.Pq Vt bool
330Set to not build the newer version of GCC (4.4).
331.It Va NO_GDB
332.Pq Vt bool
333Set to not build
334.Xr gdb 1
335.It Va NO_I4B
336.Pq Vt bool
337Set to not build isdn4bsd package.
338.It Va NO_IPFILTER
339.Pq Vt bool
340Set to not build IP Filter package.
341.It Va NO_LIBC_R
342.Pq Vt bool
343Set to not build
344.Nm libc_r
345(reentrant version of
346.Nm libc ) .
347.It Va NO_LPR
348.Pq Vt bool
349Set to not build
350.Xr lpr 1
351and related programs.
352.It Va NO_MAILWRAPPER
353.Pq Vt bool
354Set to not build the
355.Xr mailwrapper 8
356MTA selector.
357.It Va NO_OBJC
358.Pq Vt bool
359Set to not build Objective C support.
360.It Va NO_OPENSSH
361.Pq Vt bool
362Set to not build OpenSSH.
363.It Va NO_OPENSSL
364.Pq Vt bool
365Set to not build OpenSSL (implies
366.Va NO_OPENSSH ) .
367.It Va NO_SENDMAIL
368.Pq Vt bool
369Set to not build
370.Xr sendmail 8
371and related programs.
372.It Va NO_SHARE
373.Pq Vt bool
374Set to not enter the share subdirectory.
375.It Va NO_X
376.Pq Vt bool
377Set to not compile in X\-Windows support (e.g.\&
378.Xr doscmd 1 ) .
379.It Va NOCLEAN
380.Pq Vt bool
381Set this to disable cleaning during
382.Dq Li "make buildworld" .
383This should not be set unless you know what you are doing.
384.It Va NOCLEANDIR
385.Pq Vt bool
386Set this to run
387.Dq Li "${MAKE} clean"
388instead of
389.Dq Li "${MAKE} cleandir" .
390.It Va NOFSCHG
391.Pq Vt bool
392Set to not install certain components with flag schg.
393This is useful in a jailed environment.
394.It Va NOINFO
395.Pq Vt bool
396Set to not make or install
397.Xr info 5
398files.
399.It Va NOINFOCOMPRESS
400.Pq Vt bool
401Set to not compress the info pages.
402.It Va NOMAN
403.Pq Vt bool
404Set to not build manual pages
405.It Va NOMANCOMPRESS
406.Pq Vt bool
407Set to not compress the manual pages.
408.It Va NOPROFILE
409.Pq Vt bool
410Set to avoid compiling profiled libraries.
411.It Va PPP_NOSUID
412.Pq Vt bool
413Set to disable the installation of
414.Xr ppp 8
415with the set-user-ID bit on.
416.It Va SENDMAIL_MC
417.Pq Vt str
418The default
419.Xr m4 1
420configuration file to use at install time.
421The value should include the full path to the
422.Pa .mc
423file, e.g.,
424.Pa /etc/mail/myconfig.mc .
425Use with caution as a make install will overwrite any existing
426.Pa /etc/mail/sendmail.cf .
427Note that
428.Va SENDMAIL_CF
429is now deprecated.
430.It Va SENDMAIL_SUBMIT_MC
431.Pq Vt str
432The default
433.Xr m4 1
434configuration file for mail submission
435to use at install time.
436The value should include the full path to the
437.Pa .mc
438file, e.g.,
439.Pa /etc/mail/mysubmit.mc .
440Use with caution as a make install will overwrite any existing
441.Pa /etc/mail/submit.cf .
442.It Va SENDMAIL_ADDITIONAL_MC
443.Pq Vt str
444Additional
445.Pa .mc
446files which should be built into
447.Pa .cf
448files at build time.
449The value should include the full path to the
450.Pa .mc
451file(s), e.g.,
452.Pa /etc/mail/foo.mc
453.Pa /etc/mail/bar.mc .
454.It Va SENDMAIL_CF_DIR
455.Pq Vt str
456Override the default location for the
457.Xr m4 1
458configuration files used to build a
459.Pa .cf
460file from a
461.Pa .mc
462file.
463.It Va SENDMAIL_M4_FLAGS
464.Pq Vt str
465Flags passed to
466.Xr m4 1
467when building a
468.Pa .cf
469file from a
470.Pa .mc
471file.
472.It Va SENDMAIL_CFLAGS
473.Pq Vt str
474Flags to pass to the compile command when building
475.Xr sendmail 8 .
476The
477.Va SENDMAIL_*
478flags can be used to provide SASL support with setting such as:
479.Bd -literal -offset indent
480SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
481SENDMAIL_LDFLAGS=-L/usr/local/lib
482SENDMAIL_LDADD=-lsasl
483.Ed
484.It Va SENDMAIL_LDFLAGS
485.Pq Vt str
486Flags to pass to the
487.Xr ld 1
488command when building
489.Xr sendmail 8 .
490.It Va SENDMAIL_LDADD
491.Pq Vt str
492Flags to add to the end of the
493.Xr ld 1
494command when building
495.Xr sendmail 8 .
496.It Va SENDMAIL_DPADD
497.Pq Vt str
498Extra dependencies to add when building
499.Xr sendmail 8 .
500.It Va SENDMAIL_SET_USER_ID
501.Pq Vt bool
502If set, install
503.Xr sendmail 8
504as a set-user-ID root binary instead of a set-group-ID binary
505and do not install
506.Pa /etc/mail/submit.{cf,mc} .
507Use of this flag is not recommended and the alternative advice in
508.Pa /etc/mail/README
509should be followed instead if at all possible.
510.It Va SENDMAIL_MAP_PERMS
511.Pq Vt str
512Mode to use when generating alias and map database files using
513.Pa /etc/mail/Makefile .
514The default value is 0640.
515.It Va THREAD_LIB
516.Pq Vt str
517Set to either
518.Li c_r
519or
520.Li thread_xu
521to configure the system's default threading library.
522The default is
523.Li thread_xu .
524.It Va TOP_TABLE_SIZE
525.Pq Vt int
526.Xr top 1
527uses a hash table for the user names.  The size of this hash can be tuned
528to match the number of local users.  The table size should be a prime number
529approximately twice as large as the number of lines in
530.Pa /etc/passwd .
531The default number is 20011.
532.It Va WANT_IDEA
533.Pq Vt bool
534Set to build the IDEA encryption code.
535This code is patented in the USA and many European countries.
536It is
537.Em "YOUR RESPONSIBILITY"
538to determine if you can legally use IDEA.
539.It Va WANT_INSTALLER
540.Pq Vt bool
541Set to build the installer.
542.El
543.Pp
544The following list provides a name and short description for variables
545that are used when building documentation.
546.Bl -tag -width Ar
547.It Va DOC_LANG
548.Pq Vt str
549The list of languages and encodings to build and install.
550.It Va PRINTERDEVICE
551.Pq Vt str
552The default format for system documentation, depends on your
553printer.
554This can be set to
555.Dq Li ascii
556for simple printers or
557.Dq Li ps
558for postscript or graphics printers with a ghostscript
559filter.
560.It Va GROFF_PAPER_SIZE
561.Pq Vt str
562The default paper size for
563.Xr groff 1
564(either
565.Dq letter
566or
567.Dq A4 ) .
568.El
569.Sh FILES
570.Bl -tag -width /etc/defaults/make.conf -compact
571.It Pa /etc/defaults/make.conf
572.It Pa /etc/make.conf
573.It Pa /usr/src/Makefile
574.It Pa /usr/src/Makefile.inc1
575.El
576.Sh SEE ALSO
577.Xr gcc 1 ,
578.Xr install 1 ,
579.Xr make 1 ,
580.Xr lpd 8 ,
581.Xr sendmail 8
582.Sh HISTORY
583The
584.Nm
585file appeared sometime before
586.Fx 4.0 .
587.Sh AUTHORS
588This manual page was written by
589.An Mike W. Meyer Aq mwm@mired.org .
590.Sh BUGS
591This manual page may occasionally be out of date with respect to
592the options currently available for use in
593.Nm .
594Please check the
595.Pa /etc/defaults/make.conf
596file for the latest options which are available.
597