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