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