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