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.33 2008/05/14 15:02:48 hasso 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_GAMES
 382 .Pq Vt bool
 383 Set to not build games.
 384 .It Va NO_GCC34
 385 .Pq Vt bool
 386 Set to not build the older version of GCC (3.4).
 387 .It Va NO_GDB
 388 .Pq Vt bool
 389 Set to not build
 390 .Xr gdb 1
 391 .It Va NO_I4B
 392 .Pq Vt bool
 393 Set to not build isdn4bsd package.
 394 .It Va NO_IPFILTER
 395 .Pq Vt bool
 396 Set to not build IP Filter package.
 397 .It Va NO_LIBC_R
 398 .Pq Vt bool
 399 Set to not build
 400 .Nm libc_r
 401 (reentrant version of
 402 .Nm libc ) .
 403 .It Va NO_LPR
 404 .Pq Vt bool
 405 Set to not build
 406 .Xr lpr 1
 407 and related programs.
 408 .It Va NO_MAILWRAPPER
 409 .Pq Vt bool
 410 Set to not build the
 411 .Xr mailwrapper 8
 412 MTA selector.
 413 .It Va NO_MAKEDEV
 414 .Pq Vt bool
 415 Set to avoid running
 416 .Dq Li "MAKEDEV all"
 417 on
 418 .Pa /dev
 419 during install.
 420 .It Va NO_OBJC
 421 .Pq Vt bool
 422 Set to not build Objective C support.
 423 .It Va NO_OPENSSH
 424 .Pq Vt bool
 425 Set to not build OpenSSH.
 426 .It Va NO_OPENSSL
 427 .Pq Vt bool
 428 Set to not build OpenSSL (implies
 429 .Va NO_OPENSSH ) .
 430 .It Va NO_SENDMAIL
 431 .Pq Vt bool
 432 Set to not build
 433 .Xr sendmail 8
 434 and related programs.
 435 .It Va NO_SHARE
 436 .Pq Vt bool
 437 Set to not enter the share subdirectory.
 438 .It Va NO_X
 439 .Pq Vt bool
 440 Set to not compile in X\-Windows support (e.g.\&
 441 .Xr doscmd 1 ) .
 442 .It Va NOCLEAN
 443 .Pq Vt bool
 444 Set this to disable cleaning during
 445 .Dq Li "make buildworld" .
 446 This should not be set unless you know what you are doing.
 447 .It Va NOCLEANDIR
 448 .Pq Vt bool
 449 Set this to run
 450 .Dq Li "${MAKE} clean"
 451 instead of
 452 .Dq Li "${MAKE} cleandir" .
 453 .It Va NOFSCHG
 454 .Pq Vt bool
 455 Set to not install certain components with flag schg.
 456 This is useful in a jailed environment.
 457 .It Va NOINFO
 458 .Pq Vt bool
 459 Set to not make or install
 460 .Xr info 5
 461 files.
 462 .It Va NOINFOCOMPRESS
 463 .Pq Vt bool
 464 Set to not compress the info pages.
 465 .It Va NOMAN
 466 .Pq Vt bool
 467 Set to not build manual pages
 468 .It Va NOMANCOMPRESS
 469 .Pq Vt bool
 470 Set to not compress the manual pages.
 471 .It Va NOPROFILE
 472 .Pq Vt bool
 473 Set to avoid compiling profiled libraries.
 474 .It Va PPP_NOSUID
 475 .Pq Vt bool
 476 Set to disable the installation of
 477 .Xr ppp 8
 478 with the set-user-ID bit on.
 479 .It Va SENDMAIL_MC
 480 .Pq Vt str
 481 The default
 482 .Xr m4 1
 483 configuration file to use at install time.
 484 The value should include the full path to the
 485 .Pa .mc
 486 file, e.g.,
 487 .Pa /etc/mail/myconfig.mc .
 488 Use with caution as a make install will overwrite any existing
 489 .Pa /etc/mail/sendmail.cf .
 490 Note that
 491 .Va SENDMAIL_CF
 492 is now deprecated.
 493 .It Va SENDMAIL_SUBMIT_MC
 494 .Pq Vt str
 495 The default
 496 .Xr m4 1
 497 configuration file for mail submission
 498 to use at install time.
 499 The value should include the full path to the
 500 .Pa .mc
 501 file, e.g.,
 502 .Pa /etc/mail/mysubmit.mc .
 503 Use with caution as a make install will overwrite any existing
 504 .Pa /etc/mail/submit.cf .
 505 .It Va SENDMAIL_ADDITIONAL_MC
 506 .Pq Vt str
 507 Additional
 508 .Pa .mc
 509 files which should be built into
 510 .Pa .cf
 511 files at build time.
 512 The value should include the full path to the
 513 .Pa .mc
 514 file(s), e.g.,
 515 .Pa /etc/mail/foo.mc
 516 .Pa /etc/mail/bar.mc .
 517 .It Va SENDMAIL_CF_DIR
 518 .Pq Vt str
 519 Override the default location for the
 520 .Xr m4 1
 521 configuration files used to build a
 522 .Pa .cf
 523 file from a
 524 .Pa .mc
 525 file.
 526 .It Va SENDMAIL_M4_FLAGS
 527 .Pq Vt str
 528 Flags passed to
 529 .Xr m4 1
 530 when building a
 531 .Pa .cf
 532 file from a
 533 .Pa .mc
 534 file.
 535 .It Va SENDMAIL_CFLAGS
 536 .Pq Vt str
 537 Flags to pass to the compile command when building
 538 .Xr sendmail 8 .
 539 The
 540 .Va SENDMAIL_*
 541 flags can be used to provide SASL support with setting such as:
 542 .Bd -literal -offset indent
 543 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
 544 SENDMAIL_LDFLAGS=-L/usr/local/lib
 545 SENDMAIL_LDADD=-lsasl
 546 .Ed
 547 .It Va SENDMAIL_LDFLAGS
 548 .Pq Vt str
 549 Flags to pass to the
 550 .Xr ld 1
 551 command when building
 552 .Xr sendmail 8 .
 553 .It Va SENDMAIL_LDADD
 554 .Pq Vt str
 555 Flags to add to the end of the
 556 .Xr ld 1
 557 command when building
 558 .Xr sendmail 8 .
 559 .It Va SENDMAIL_DPADD
 560 .Pq Vt str
 561 Extra dependencies to add when building
 562 .Xr sendmail 8 .
 563 .It Va SENDMAIL_SET_USER_ID
 564 .Pq Vt bool
 565 If set, install
 566 .Xr sendmail 8
 567 as a set-user-ID root binary instead of a set-group-ID binary
 568 and do not install
 569 .Pa /etc/mail/submit.{cf,mc} .
 570 Use of this flag is not recommended and the alternative advice in
 571 .Pa /etc/mail/README
 572 should be followed instead if at all possible.
 573 .It Va SENDMAIL_MAP_PERMS
 574 .Pq Vt str
 575 Mode to use when generating alias and map database files using
 576 .Pa /etc/mail/Makefile .
 577 The default value is 0640.
 578 .It Va THREAD_LIB
 579 .Pq Vt str
 580 Set to either
 581 .Li c_r
 582 or
 583 .Li thread_xu
 584 to configure the system's default threading library.
 585 The default is
 586 .Li thread_xu .
 587 .It Va TOP_TABLE_SIZE
 588 .Pq Vt int
 589 .Xr top 1
 590 uses a hash table for the user names.  The size of this hash can be tuned
 591 to match the number of local users.  The table size should be a prime number
 592 approximately twice as large as the number of lines in
 593 .Pa /etc/passwd .
 594 The default number is 20011.
 595 .It Va WANT_IDEA
 596 .Pq Vt bool
 597 Set to build the IDEA encryption code.
 598 This code is patented in the USA and many European countries.
 599 It is
 600 .Em "YOUR RESPONSIBILITY"
 601 to determine if you can legally use IDEA.
 602 .It Va WANT_KERBEROS
 603 .Pq Vt bool
 604 Set this to build Kerberos5 (KTH Heimdal).
 605 .Em WARNING !
 606 This is still experimental code.
 607 .El
 608 .Pp
 609 The following list provides a name and short description for variables
 610 that are used when building documentation.
 611 .Bl -tag -width Ar
 612 .It Va DOC_LANG
 613 .Pq Vt str
 614 The list of languages and encodings to build and install.
 615 .It Va PRINTERDEVICE
 616 .Pq Vt str
 617 The default format for system documentation, depends on your
 618 printer.
 619 This can be set to
 620 .Dq Li ascii
 621 for simple printers or
 622 .Dq Li ps
 623 for postscript or graphics printers with a ghostscript
 624 filter.
 625 .It Va GROFF_PAPER_SIZE
 626 .Pq Vt str
 627 The default paper size for
 628 .Xr groff 1
 629 (either
 630 .Dq letter
 631 or
 632 .Dq A4 ) .
 633 .El
 634 .Sh FILES
 635 .Bl -tag -width /etc/defaults/make.conf -compact
 636 .It Pa /etc/defaults/make.conf
 637 .It Pa /etc/make.conf
 638 .It Pa /usr/src/Makefile
 639 .It Pa /usr/src/Makefile.inc1
 640 .El
 641 .Sh SEE ALSO
 642 .Xr gcc 1 ,
 643 .Xr install 1 ,
 644 .Xr make 1 ,
 645 .Xr lpd 8 ,
 646 .Xr sendmail 8
 647 .Sh HISTORY
 648 The
 649 .Nm
 650 file appeared sometime before
 651 .Fx 4.0 .
 652 .Sh AUTHORS
 653 This manual page was written by
 654 .An Mike W. Meyer Aq mwm@mired.org .
 655 .Sh BUGS
 656 This manual page may occasionally be out of date with respect to
 657 the options currently available for use in
 658 .Nm .
 659 Please check the
 660 .Pa /etc/defaults/make.conf
 661 file for the latest options which are available.