enable WARNS_WERROR by default
[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 $
6dd73847 26.\" $DragonFly: src/share/man/man5/make.conf.5,v 1.38 2008/11/03 00:25:45 pavalos Exp $
984263bc 27.\"
48dff0ad 28.Dd August 11, 2009
984263bc
MD
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
9bb2a92d 38.Dx
cecff5c1 39sources.
984263bc
MD
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.
cecff5c1 49Instead, it is included by the various makefiles in
0cd7b3a7 50.Pa /usr/src
cecff5c1
MD
51which conditionalize their internal actions according to the settings
52found there.
984263bc
MD
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
cecff5c1
MD
63The build procedures occur in three areas: world, kernel, and
64documentation.
984263bc
MD
65Variables set in
66.Nm
cecff5c1 67may be applicable during builds in one, two, or all of these areas.
984263bc
MD
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.
cecff5c1 75The values of variables flagged as
984263bc 76.Vt bool
cecff5c1 77are ignored; the variable being set at all (even to
984263bc
MD
78.Dq Li FALSE
79or
80.Dq Li NO )
cecff5c1 81causes it to be treated as if it were set.
984263bc
MD
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
984263bc
MD
88.It Va CPUTYPE
89.Pq Vt str
cecff5c1
MD
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
984263bc
MD
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
0cd7b3a7 107.Pa /usr/share/examples/etc/defaults/make.conf
984263bc
MD
108for a list of recognized
109.Va CPUTYPE
110options.
cecff5c1
MD
111.It Va CCVER
112.Pq Vt str
05664f8a
PA
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
cecff5c1 118.Pa /etc/make.conf .
7879b9ff 119Currently accepted values are
7879b9ff 120.Dq gcc41
05664f8a 121(default).
cecff5c1
MD
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:
cecff5c1
MD
136.Bd -literal -offset indent
137CFLAGS+=${BDECFLAGS}
138.Ed
984263bc
MD
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.
984263bc
MD
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 .
cecff5c1 151If you want to add to the
984263bc
MD
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.
cecff5c1 160To have components compared before doing the install, use
984263bc
MD
161.Bd -literal -offset indent
162INSTALL="install -C"
163.Ed
164.It Va LOCAL_DIRS
165.Pq Vt str
cecff5c1 166List any directories that should be entered when running make
984263bc
MD
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
cecff5c1
MD
182.It Va MODULES_OVERRIDE
183.Pq Vt str
184Set to a list of modules to build instead of all of them.
984263bc
MD
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.
cecff5c1
MD
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.
dcdd01ca
SW
199.It Va WARNS_WERROR
200Causes
201.Fl Werror
202to be added to
203.Va CWARNFLAGS
204when WARNS is in effect.
18c2eecf
SS
205.Va WARNS_WERROR
206is enabled by default.
207Set
208.Va NO_WERROR
209to disable
210.Fl Werror .
ed5d5720
PA
211.It Va WANT_HESIOD
212.Pq Vt bool
213Set this to build
214.Xr hesiod 3
215support into libc.
216.It Va NO_NS_CACHING
217.Pq Vt bool
218Set this to disable name caching in the nsswitch subsystem.
219The generic caching daemon,
220.Xr nscd 8 ,
221will not be built either if this option is set.
18c2eecf
SS
222.It Va NO_WERROR
223Set this if you don't want
224.Fl Werror
225to be added to
226.Va CWARNFLAGS .
227See also
228.Va WARNS_WERROR .
003525a9
AP
229.It Va STATIC_LOCALES
230.Pq Vt str
231Set to a list of locales to build into statically-linked binaries.
24b4fe1f 232Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
984263bc
MD
233.El
234.Pp
235The following list provides a name and short description for variables
236that are only used doing a kernel build:
237.Bl -tag -width Ar
238.It Va BOOT_COMCONSOLE_PORT
239.Pq Vt str
240The port address to use for the console if the boot blocks have
241been configured to use a serial console instead of the keyboard/video card.
242.It Va BOOT_COMCONSOLE_SPEED
243.Pq Vt int
244The baud rate to use for the console if the boot blocks have
245been configured to use a serial console instead of the keyboard/video card.
984263bc
MD
246.It Va COPTFLAGS
247.Pq Vt str
248Controls the compiler settings when building the
249kernel.
250Optimization levels above
7879b9ff
SW
251.Fl O
252.Pq Fl O2 , No ...
984263bc
MD
253are not guaranteed to work.
254.It Va KERNCONF
255.Pq Vt str
256Controls which kernel configurations will be
257built by
258.Dq Li "${MAKE} buildkernel"
259and installed by
260.Dq Li "${MAKE} installkernel" .
261For example,
262.Bd -literal -offset indent
263KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
264.Ed
265.Pp
266will build the kernels specified by the config files
267.Pa MINE , DEBUG , GENERIC ,
268and
269.Pa OTHERMACHINE ,
270and install the kernel specified by the config file
271.Pa MINE .
272It defaults to
273.Pa GENERIC .
274.It Va LOADER_TFTP_SUPPORT
275.Pq Vt bool
276While not a buildkernel-affected option, there is no better place for this.
277By default the
278.Xr pxeboot 8
279loader retrieves the kernel via NFS.
280Defining this and recompiling
281.Pa /usr/src/sys/boot
282will cause it to retrieve the kernel via TFTP.
283This allows pxeboot to load a custom BOOTP diskless kernel yet
284still mount the server's
285.Pa /
286rather than load the server's kernel.
cecff5c1 287.It Va NO_CPU_COPTFLAGS
984263bc 288.Pq Vt str
cecff5c1
MD
289Setting this variable will prevent CPU specific compiler flags
290from being automatically added to
291.Va COPTFLAGS
292during compile time.
293.It Va NO_KERNELCLEAN
294.Pq Vt bool
295Set this to skip the clean target when using
296.Dq Li "${MAKE} buildkernel" .
984263bc
MD
297.It Va NO_KERNELCONFIG
298.Pq Vt bool
299Set this to skip running
300.Xr config 8
301during
302.Dq Li "${MAKE} buildkernel" .
303.It Va NO_KERNELDEPEND
304.Pq Vt bool
305Set this to skip running
306.Dq Li "${MAKE} depend"
307during
308.Dq Li "${MAKE} buildkernel" .
9200f41c
SS
309.It Va NO_KERNEL_OLD_STRIP
310.Pq Vt bool
311Set this to skip stripping debugging symbols from old kernel and modules
312(kernel.old, modules.old) during
313.Dq Li "${MAKE} installkernel" .
984263bc
MD
314.It Va NO_MODULES
315.Pq Vt bool
316Set to not build modules with the kernel.
317.El
318.Pp
319The following list provides a name and short description for variables
320that are used during the world build:
321.Bl -tag -width Ar
984263bc
MD
322.It Va ENABLE_SUID_SSH
323.Pq Vt bool
324Set this to install
325.Xr ssh 1
326with the setuid bit turned on.
327.It Va MODULES_WITH_WORLD
328.Pq Vt bool
329Set to build modules with the system instead of the kernel.
984263bc
MD
330.It Va NO_BIND
331.Pq Vt bool
332Set to not build BIND.
cecff5c1
MD
333.It Va NO_CRYPT
334.Pq Vt bool
335Set to not build crypto code.
336.It Va NO_CVS
337.Pq Vt bool
338Set to not build CVS.
cecff5c1
MD
339.It Va NO_GAMES
340.Pq Vt bool
341Set to not build games.
48dff0ad
SW
342.It Va NO_GCC44
343.Pq Vt bool
344Set to not build the newer version of GCC (4.4).
984263bc
MD
345.It Va NO_GDB
346.Pq Vt bool
347Set to not build
348.Xr gdb 1
349.It Va NO_I4B
350.Pq Vt bool
351Set to not build isdn4bsd package.
352.It Va NO_IPFILTER
353.Pq Vt bool
354Set to not build IP Filter package.
cecff5c1
MD
355.It Va NO_LIBC_R
356.Pq Vt bool
357Set to not build
358.Nm libc_r
359(reentrant version of
360.Nm libc ) .
984263bc
MD
361.It Va NO_LPR
362.Pq Vt bool
363Set to not build
364.Xr lpr 1
365and related programs.
366.It Va NO_MAILWRAPPER
367.Pq Vt bool
368Set to not build the
369.Xr mailwrapper 8
370MTA selector.
984263bc
MD
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.
cecff5c1
MD
386.It Va NO_SHARE
387.Pq Vt bool
388Set to not enter the share subdirectory.
984263bc
MD
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" .
cecff5c1 404.It Va NOFSCHG
984263bc 405.Pq Vt bool
566002a4 406Set to not install certain components with flag schg.
cecff5c1 407This is useful in a jailed environment.
984263bc
MD
408.It Va NOINFO
409.Pq Vt bool
410Set to not make or install
411.Xr info 5
412files.
cecff5c1 413.It Va NOINFOCOMPRESS
984263bc 414.Pq Vt bool
cecff5c1
MD
415Set to not compress the info pages.
416.It Va NOMAN
984263bc 417.Pq Vt bool
cecff5c1
MD
418Set to not build manual pages
419.It Va NOMANCOMPRESS
984263bc 420.Pq Vt bool
cecff5c1 421Set to not compress the manual pages.
984263bc
MD
422.It Va NOPROFILE
423.Pq Vt bool
424Set to avoid compiling profiled libraries.
984263bc
MD
425.It Va PPP_NOSUID
426.Pq Vt bool
427Set to disable the installation of
428.Xr ppp 8
cecff5c1 429with the set-user-ID bit on.
984263bc
MD
430.It Va SENDMAIL_MC
431.Pq Vt str
3181538d
GNS
432The default
433.Xr m4 1
434configuration file to use at install time.
984263bc
MD
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.
984263bc
MD
444.It Va SENDMAIL_SUBMIT_MC
445.Pq Vt str
3181538d
GNS
446The default
447.Xr m4 1
448configuration file for mail submission
984263bc
MD
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 .
984263bc
MD
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 .
3181538d
GNS
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.
984263bc
MD
477.It Va SENDMAIL_M4_FLAGS
478.Pq Vt str
3181538d
GNS
479Flags passed to
480.Xr m4 1
481when building a
984263bc
MD
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
3181538d 523should be followed instead if at all possible.
984263bc
MD
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.
587bc464
SW
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 .
984263bc
MD
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.
3e84a8c5 546.It Va WANT_IDEA
cecff5c1
MD
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.
7ebbae99
SW
553.It Va WANT_INSTALLER
554.Pq Vt bool
555Set to build the installer.
984263bc
MD
556.El
557.Pp
558The following list provides a name and short description for variables
559that are used when building documentation.
560.Bl -tag -width Ar
984263bc
MD
561.It Va DOC_LANG
562.Pq Vt str
563The list of languages and encodings to build and install.
564.It Va PRINTERDEVICE
565.Pq Vt str
566The default format for system documentation, depends on your
567printer.
568This can be set to
569.Dq Li ascii
570for simple printers or
571.Dq Li ps
572for postscript or graphics printers with a ghostscript
573filter.
42a03791
SW
574.It Va GROFF_PAPER_SIZE
575.Pq Vt str
576The default paper size for
577.Xr groff 1
578(either
579.Dq letter
580or
581.Dq A4 ) .
984263bc 582.El
984263bc
MD
583.Sh FILES
584.Bl -tag -width /etc/defaults/make.conf -compact
585.It Pa /etc/defaults/make.conf
586.It Pa /etc/make.conf
984263bc
MD
587.It Pa /usr/src/Makefile
588.It Pa /usr/src/Makefile.inc1
984263bc
MD
589.El
590.Sh SEE ALSO
591.Xr gcc 1 ,
592.Xr install 1 ,
593.Xr make 1 ,
984263bc
MD
594.Xr lpd 8 ,
595.Xr sendmail 8
596.Sh HISTORY
597The
598.Nm
599file appeared sometime before
600.Fx 4.0 .
601.Sh AUTHORS
cecff5c1 602This manual page was written by
984263bc
MD
603.An Mike W. Meyer Aq mwm@mired.org .
604.Sh BUGS
605This manual page may occasionally be out of date with respect to
606the options currently available for use in
607.Nm .
608Please check the
609.Pa /etc/defaults/make.conf
610file for the latest options which are available.