enable WARNS_WERROR by default
[dragonfly.git] / share / man / man5 / make.conf.5
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 August 11, 2009
29 .Dt MAKE.CONF 5
30 .Os
31 .Sh NAME
32 .Nm make.conf
33 .Nd system build information
34 .Sh DESCRIPTION
35 The file
36 .Nm
37 contains settings that control the compilation of the
38 .Dx
39 sources.
40 The file
41 .Nm
42 is generally created by the system administrator when the values need
43 to be changed from their defaults.
44 .Pp
45 The purpose of
46 .Nm
47 is not to run commands or perform compilation actions
48 directly.
49 Instead, it is included by the various makefiles in
50 .Pa /usr/src
51 which conditionalize their internal actions according to the settings
52 found there.
53 .Pp
54 The
55 .Pa /etc/make.conf
56 file is included from the appropriate
57 .Pa Makefile
58 which specifies the default settings for all the available options.
59 Options need only be specified in
60 .Pa /etc/make.conf
61 when the system administrator wishes to override these defaults.
62 .Pp
63 The build procedures occur in three areas: world, kernel, and
64 documentation.
65 Variables set in
66 .Nm
67 may be applicable during builds in one, two, or all of these areas.
68 They may be specified for a particular build via the
69 .Fl D
70 option of
71 .Xr make 1 .
72 .Pp
73 The following lists provide a name and short description for each
74 variable you can use during the indicated builds.
75 The values of variables flagged as
76 .Vt bool
77 are ignored; the variable being set at all (even to
78 .Dq Li FALSE
79 or
80 .Dq Li NO )
81 causes it to be treated as if it were set.
82 .Pp
83 The following list provides a name and short description for variables
84 that are used for all builds, or are used by the
85 .Pa makefiles
86 for things other than builds.
87 .Bl -tag -width Ar
88 .It Va CPUTYPE
89 .Pq Vt str
90 Controls which processor should be targeted for generated code.
91 This controls processor-specific optimizations in certain code
92 (currently only OpenSSL) as well as modifying the value of
93 .Va CFLAGS
94 and
95 .Va COPTFLAGS
96 to contain the appropriate optimization directive to
97 .Xr gcc 1 .
98 The automatic setting of
99 .Va CFLAGS
100 and
101 .Va COPTFLAGS
102 may be overridden using the
103 .Va NO_CPU_CFLAGS
104 and
105 .Va NO_CPU_COPTFLAGS
106 variables, respectively.  Refer to
107 .Pa /usr/share/examples/etc/defaults/make.conf
108 for a list of recognized
109 .Va CPUTYPE
110 options.
111 .It Va CCVER
112 .Pq Vt str
113 Controls which GCC version to use by default.
114 It should be set as
115 .Li CCVER?=
116 so as not to interfere with overrides from userland.
117 We currently recommend that an override NOT be set in
118 .Pa /etc/make.conf .
119 Currently accepted values are
120 .Dq gcc41
121 (default).
122 .It Va CFLAGS
123 .Pq Vt str
124 Controls the compiler setting when compiling C code.
125 Optimization levels above
126 .Fl O
127 .Pq Fl O2 , No ...
128 are not supported.
129 .Va BDECFLAGS
130 is provided as a set of
131 .Xr gcc 1
132 settings suggested by
133 .An "Bruce Evans" Aq bde@FreeBSD.org
134 for developing and testing changes.
135 They can be used, if set, by:
136 .Bd -literal -offset indent
137 CFLAGS+=${BDECFLAGS}
138 .Ed
139 .It Va NO_CPU_CFLAGS
140 .Pq Vt str
141 Setting this variable will prevent CPU specific compiler flags
142 from being automatically added to
143 .Va CFLAGS
144 during compile time.
145 .It Va CXXFLAGS
146 .Pq Vt str
147 Controls the compiler settings when compiling C++ code.
148 .Va CXXFLAGS
149 is initially set to the value of
150 .Va CFLAGS .
151 If you want to add to the
152 .Va CXXFLAGS
153 value, use
154 .Dq Li +=
155 instead of
156 .Dq Li = .
157 .It Va INSTALL
158 .Pq Vt str
159 the default install command.
160 To have components compared before doing the install, use
161 .Bd -literal -offset indent
162 INSTALL="install -C"
163 .Ed
164 .It Va LOCAL_DIRS
165 .Pq Vt str
166 List any directories that should be entered when running make
167 .Pa /usr/src
168 in this variable.
169 .It Va MAKE_SHELL
170 .Pq Vt str
171 Controls the shell used internally by
172 .Xr make 1
173 to process the command scripts in makefiles.
174 .Xr sh 1 ,
175 .Xr ksh 1 ,
176 and
177 .Xr csh 1
178 all currently supported.
179 .Bd -literal -offset indent
180 MAKE_SHELL?=sh
181 .Ed
182 .It Va MODULES_OVERRIDE
183 .Pq Vt str
184 Set to a list of modules to build instead of all of them.
185 .It Va MTREE_FOLLOWS_SYMLINKS
186 .Pq Vt str
187 Set this to
188 .Dq Fl L
189 to cause
190 .Xr mtree 8
191 to follow symlinks.
192 .It Va STRIP
193 .Pq Vt str
194 Set this to the flag to pass the
195 .Xr strip 1
196 command.
197 If set to a blank value, components will be installed with debugging
198 symbols.
199 .It Va WARNS_WERROR
200 Causes
201 .Fl Werror
202 to be added to
203 .Va CWARNFLAGS
204 when WARNS is in effect.
205 .Va WARNS_WERROR
206 is enabled by default.
207 Set
208 .Va NO_WERROR
209 to disable
210 .Fl Werror .
211 .It Va WANT_HESIOD
212 .Pq Vt bool
213 Set this to build
214 .Xr hesiod 3
215 support into libc.
216 .It Va NO_NS_CACHING
217 .Pq Vt bool
218 Set this to disable name caching in the nsswitch subsystem.
219 The generic caching daemon,
220 .Xr nscd 8 ,
221 will not be built either if this option is set.
222 .It Va NO_WERROR
223 Set this if you don't want
224 .Fl Werror
225 to be added to
226 .Va CWARNFLAGS .
227 See also
228 .Va WARNS_WERROR .
229 .It Va STATIC_LOCALES
230 .Pq Vt str
231 Set to a list of locales to build into statically-linked binaries.
232 Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
233 .El
234 .Pp
235 The following list provides a name and short description for variables
236 that are only used doing a kernel build:
237 .Bl -tag -width Ar
238 .It Va BOOT_COMCONSOLE_PORT
239 .Pq Vt str
240 The port address to use for the console if the boot blocks have
241 been configured to use a serial console instead of the keyboard/video card.
242 .It Va BOOT_COMCONSOLE_SPEED
243 .Pq Vt int
244 The baud rate to use for the console if the boot blocks have
245 been configured to use a serial console instead of the keyboard/video card.
246 .It Va COPTFLAGS
247 .Pq Vt str
248 Controls the compiler settings when building the
249 kernel.
250 Optimization levels above
251 .Fl O
252 .Pq Fl O2 , No ...
253 are not guaranteed to work.
254 .It Va KERNCONF
255 .Pq Vt str
256 Controls which kernel configurations will be
257 built by
258 .Dq Li "${MAKE} buildkernel"
259 and installed by
260 .Dq Li "${MAKE} installkernel" .
261 For example,
262 .Bd -literal -offset indent
263 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
264 .Ed
265 .Pp
266 will build the kernels specified by the config files
267 .Pa MINE , DEBUG , GENERIC ,
268 and
269 .Pa OTHERMACHINE ,
270 and install the kernel specified by the config file
271 .Pa MINE .
272 It defaults to
273 .Pa GENERIC .
274 .It Va LOADER_TFTP_SUPPORT
275 .Pq Vt bool
276 While not a buildkernel-affected option, there is no better place for this.
277 By default the
278 .Xr pxeboot 8
279 loader retrieves the kernel via NFS.
280 Defining this and recompiling
281 .Pa /usr/src/sys/boot
282 will cause it to retrieve the kernel via TFTP.
283 This allows pxeboot to load a custom BOOTP diskless kernel yet
284 still mount the server's
285 .Pa /
286 rather than load the server's kernel.
287 .It Va NO_CPU_COPTFLAGS
288 .Pq Vt str
289 Setting this variable will prevent CPU specific compiler flags
290 from being automatically added to
291 .Va COPTFLAGS
292 during compile time.
293 .It Va NO_KERNELCLEAN
294 .Pq Vt bool
295 Set this to skip the clean target when using
296 .Dq Li "${MAKE} buildkernel" .
297 .It Va NO_KERNELCONFIG
298 .Pq Vt bool
299 Set this to skip running
300 .Xr config 8
301 during
302 .Dq Li "${MAKE} buildkernel" .
303 .It Va NO_KERNELDEPEND
304 .Pq Vt bool
305 Set this to skip running
306 .Dq Li "${MAKE} depend"
307 during
308 .Dq Li "${MAKE} buildkernel" .
309 .It Va NO_KERNEL_OLD_STRIP
310 .Pq Vt bool
311 Set this to skip stripping debugging symbols from old kernel and modules
312 (kernel.old, modules.old) during
313 .Dq Li "${MAKE} installkernel" .
314 .It Va NO_MODULES
315 .Pq Vt bool
316 Set to not build modules with the kernel.
317 .El
318 .Pp
319 The following list provides a name and short description for variables
320 that are used during the world build:
321 .Bl -tag -width Ar
322 .It Va ENABLE_SUID_SSH
323 .Pq Vt bool
324 Set this to install
325 .Xr ssh 1
326 with the setuid bit turned on.
327 .It Va MODULES_WITH_WORLD
328 .Pq Vt bool
329 Set to build modules with the system instead of the kernel.
330 .It Va NO_BIND
331 .Pq Vt bool
332 Set to not build BIND.
333 .It Va NO_CRYPT
334 .Pq Vt bool
335 Set to not build crypto code.
336 .It Va NO_CVS
337 .Pq Vt bool
338 Set to not build CVS.
339 .It Va NO_GAMES
340 .Pq Vt bool
341 Set to not build games.
342 .It Va NO_GCC44
343 .Pq Vt bool
344 Set to not build the newer version of GCC (4.4).
345 .It Va NO_GDB
346 .Pq Vt bool
347 Set to not build
348 .Xr gdb 1
349 .It Va NO_I4B
350 .Pq Vt bool
351 Set to not build isdn4bsd package.
352 .It Va NO_IPFILTER
353 .Pq Vt bool
354 Set to not build IP Filter package.
355 .It Va NO_LIBC_R
356 .Pq Vt bool
357 Set to not build
358 .Nm libc_r
359 (reentrant version of
360 .Nm libc ) .
361 .It Va NO_LPR
362 .Pq Vt bool
363 Set to not build
364 .Xr lpr 1
365 and related programs.
366 .It Va NO_MAILWRAPPER
367 .Pq Vt bool
368 Set to not build the
369 .Xr mailwrapper 8
370 MTA selector.
371 .It Va NO_OBJC
372 .Pq Vt bool
373 Set to not build Objective C support.
374 .It Va NO_OPENSSH
375 .Pq Vt bool
376 Set to not build OpenSSH.
377 .It Va NO_OPENSSL
378 .Pq Vt bool
379 Set to not build OpenSSL (implies
380 .Va NO_OPENSSH ) .
381 .It Va NO_SENDMAIL
382 .Pq Vt bool
383 Set to not build
384 .Xr sendmail 8
385 and related programs.
386 .It Va NO_SHARE
387 .Pq Vt bool
388 Set to not enter the share subdirectory.
389 .It Va NO_X
390 .Pq Vt bool
391 Set to not compile in X\-Windows support (e.g.\&
392 .Xr doscmd 1 ) .
393 .It Va NOCLEAN
394 .Pq Vt bool
395 Set this to disable cleaning during
396 .Dq Li "make buildworld" .
397 This should not be set unless you know what you are doing.
398 .It Va NOCLEANDIR
399 .Pq Vt bool
400 Set this to run
401 .Dq Li "${MAKE} clean"
402 instead of
403 .Dq Li "${MAKE} cleandir" .
404 .It Va NOFSCHG
405 .Pq Vt bool
406 Set to not install certain components with flag schg.
407 This is useful in a jailed environment.
408 .It Va NOINFO
409 .Pq Vt bool
410 Set to not make or install
411 .Xr info 5
412 files.
413 .It Va NOINFOCOMPRESS
414 .Pq Vt bool
415 Set to not compress the info pages.
416 .It Va NOMAN
417 .Pq Vt bool
418 Set to not build manual pages
419 .It Va NOMANCOMPRESS
420 .Pq Vt bool
421 Set to not compress the manual pages.
422 .It Va NOPROFILE
423 .Pq Vt bool
424 Set to avoid compiling profiled libraries.
425 .It Va PPP_NOSUID
426 .Pq Vt bool
427 Set to disable the installation of
428 .Xr ppp 8
429 with the set-user-ID bit on.
430 .It Va SENDMAIL_MC
431 .Pq Vt str
432 The default
433 .Xr m4 1
434 configuration file to use at install time.
435 The value should include the full path to the
436 .Pa .mc
437 file, e.g.,
438 .Pa /etc/mail/myconfig.mc .
439 Use with caution as a make install will overwrite any existing
440 .Pa /etc/mail/sendmail.cf .
441 Note that
442 .Va SENDMAIL_CF
443 is now deprecated.
444 .It Va SENDMAIL_SUBMIT_MC
445 .Pq Vt str
446 The default
447 .Xr m4 1
448 configuration file for mail submission
449 to use at install time.
450 The value should include the full path to the
451 .Pa .mc
452 file, e.g.,
453 .Pa /etc/mail/mysubmit.mc .
454 Use 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
458 Additional
459 .Pa .mc
460 files which should be built into
461 .Pa .cf
462 files at build time.
463 The value should include the full path to the
464 .Pa .mc
465 file(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
470 Override the default location for the
471 .Xr m4 1
472 configuration files used to build a
473 .Pa .cf
474 file from a
475 .Pa .mc
476 file.
477 .It Va SENDMAIL_M4_FLAGS
478 .Pq Vt str
479 Flags passed to
480 .Xr m4 1
481 when building a
482 .Pa .cf
483 file from a
484 .Pa .mc
485 file.
486 .It Va SENDMAIL_CFLAGS
487 .Pq Vt str
488 Flags to pass to the compile command when building
489 .Xr sendmail 8 .
490 The
491 .Va SENDMAIL_*
492 flags can be used to provide SASL support with setting such as:
493 .Bd -literal -offset indent
494 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
495 SENDMAIL_LDFLAGS=-L/usr/local/lib
496 SENDMAIL_LDADD=-lsasl
497 .Ed
498 .It Va SENDMAIL_LDFLAGS
499 .Pq Vt str
500 Flags to pass to the
501 .Xr ld 1
502 command when building
503 .Xr sendmail 8 .
504 .It Va SENDMAIL_LDADD
505 .Pq Vt str
506 Flags to add to the end of the
507 .Xr ld 1
508 command when building
509 .Xr sendmail 8 .
510 .It Va SENDMAIL_DPADD
511 .Pq Vt str
512 Extra dependencies to add when building
513 .Xr sendmail 8 .
514 .It Va SENDMAIL_SET_USER_ID
515 .Pq Vt bool
516 If set, install
517 .Xr sendmail 8
518 as a set-user-ID root binary instead of a set-group-ID binary
519 and do not install
520 .Pa /etc/mail/submit.{cf,mc} .
521 Use of this flag is not recommended and the alternative advice in
522 .Pa /etc/mail/README
523 should be followed instead if at all possible.
524 .It Va SENDMAIL_MAP_PERMS
525 .Pq Vt str
526 Mode to use when generating alias and map database files using
527 .Pa /etc/mail/Makefile .
528 The default value is 0640.
529 .It Va THREAD_LIB
530 .Pq Vt str
531 Set to either
532 .Li c_r
533 or
534 .Li thread_xu
535 to configure the system's default threading library.
536 The default is
537 .Li thread_xu .
538 .It Va TOP_TABLE_SIZE
539 .Pq Vt int
540 .Xr top 1
541 uses a hash table for the user names.  The size of this hash can be tuned
542 to match the number of local users.  The table size should be a prime number
543 approximately twice as large as the number of lines in
544 .Pa /etc/passwd .
545 The default number is 20011.
546 .It Va WANT_IDEA
547 .Pq Vt bool
548 Set to build the IDEA encryption code.
549 This code is patented in the USA and many European countries.
550 It is
551 .Em "YOUR RESPONSIBILITY"
552 to determine if you can legally use IDEA.
553 .It Va WANT_INSTALLER
554 .Pq Vt bool
555 Set to build the installer.
556 .El
557 .Pp
558 The following list provides a name and short description for variables
559 that are used when building documentation.
560 .Bl -tag -width Ar
561 .It Va DOC_LANG
562 .Pq Vt str
563 The list of languages and encodings to build and install.
564 .It Va PRINTERDEVICE
565 .Pq Vt str
566 The default format for system documentation, depends on your
567 printer.
568 This can be set to
569 .Dq Li ascii
570 for simple printers or
571 .Dq Li ps
572 for postscript or graphics printers with a ghostscript
573 filter.
574 .It Va GROFF_PAPER_SIZE
575 .Pq Vt str
576 The default paper size for
577 .Xr groff 1
578 (either
579 .Dq letter
580 or
581 .Dq A4 ) .
582 .El
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
587 .It Pa /usr/src/Makefile
588 .It Pa /usr/src/Makefile.inc1
589 .El
590 .Sh SEE ALSO
591 .Xr gcc 1 ,
592 .Xr install 1 ,
593 .Xr make 1 ,
594 .Xr lpd 8 ,
595 .Xr sendmail 8
596 .Sh HISTORY
597 The
598 .Nm
599 file appeared sometime before
600 .Fx 4.0 .
601 .Sh AUTHORS
602 This manual page was written by
603 .An Mike W. Meyer Aq mwm@mired.org .
604 .Sh BUGS
605 This manual page may occasionally be out of date with respect to
606 the options currently available for use in
607 .Nm .
608 Please check the
609 .Pa /etc/defaults/make.conf
610 file for the latest options which are available.