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