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$
  26 .\"
  27 .Dd February 23, 2017
  28 .Dt MAKE.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm make.conf
  32 .Nd system build information
  33 .Sh DESCRIPTION
  34 The file
  35 .Nm
  36 contains system-wide settings that will apply to every build using
  37 .Xr make 1
  38 and the standard
  39 .Pa sys.mk
  40 file.
  41 This is achieved as follows:
  42 .Xr make 1
  43 processes the system makefile
  44 .Pa sys.mk
  45 before any other file by default, and
  46 .Pa sys.mk
  47 includes
  48 .Nm .
  49 .Pp
  50 The file
  51 .Nm
  52 uses the standard makefile syntax.
  53 However,
  54 .Nm
  55 should not specify any dependencies to
  56 .Xr make 1 .
  57 Instead,
  58 .Nm
  59 is to set
  60 .Xr make 1
  61 variables that control the actions of other makefiles.
  62 .Pp
  63 The default location of
  64 .Nm
  65 is
  66 .Pa /etc/make.conf ,
  67 though an alternative location can be specified in the
  68 .Xr make 1
  69 variable
  70 .Va __MAKE_CONF .
  71 You may need to override the location of
  72 .Nm
  73 if the system-wide settings are not suitable for a particular build.
  74 For instance, setting
  75 .Va __MAKE_CONF
  76 to
  77 .Pa /dev/null
  78 effectively resets all build controls to their defaults.
  79 .Pp
  80 The primary purpose of
  81 .Nm
  82 is to control the compilation of the
  83 .Fx
  84 sources, documentation, and ported applications,
  85 which are usually found in
  86 .Pa /usr/src ,
  87 .Pa /usr/doc ,
  88 and
  89 .Pa /usr/ports .
  90 As a rule, the system administrator creates
  91 .Nm
  92 when the values of certain control variables need to be changed
  93 from their defaults.
  94 .Pp
  95 The system build procedures occur in four broad areas:
  96 the world, the kernel, documentation and ports.
  97 Variables set in
  98 .Nm
  99 may be applicable in one, two, or all four of these areas.
 100 In addition, control variables can be specified
 101 for a particular build via the
 102 .Fl D
 103 option of
 104 .Xr make 1
 105 or in
 106 .Xr environ 7 .
 107 .Pp
 108 The following lists provide a name and short description for each
 109 variable you can use during the indicated builds.
 110 The values of
 111 variables flagged as
 112 .Vt bool
 113 are ignored; the variable being
 114 set at all (even to
 115 .Dq Li FALSE
 116 or
 117 .Dq Li NO )
 118 causes it to
 119 be treated as if it were set.
 120 .Pp
 121 The following list provides a name and short description for variables
 122 that are used for all builds, or are used by the
 123 .Pa makefiles
 124 for things other than builds.
 125 .Bl -tag -width Ar
 126 .It Va ALWAYS_CHECK_MAKE
 127 .Pq Vt bool
 128 Instructs the top-level makefile in the source tree (normally
 129 .Pa /usr/src )
 130 to always check if
 131 .Xr make 1
 132 is up-to-date.
 133 Normally this is only done for the world and buildworld targets to handle
 134 upgrades from older versions of
 135 .Fx .
 136 .It Va CFLAGS
 137 .Pq Vt str
 138 Controls the compiler setting when compiling C code.
 139 Optimization levels other than
 140 .Fl O
 141 and
 142 .Fl O2
 143 are not supported.
 144 .It Va CPUTYPE
 145 .Pq Vt str
 146 Controls which processor should be targeted for generated
 147 code.
 148 This controls processor-specific optimizations in
 149 certain code (currently only OpenSSL) as well as modifying
 150 the value of
 151 .Va CFLAGS
 152 and
 153 .Va COPTFLAGS
 154 to contain the appropriate optimization directive to
 155 .Xr cc 1 .
 156 The automatic setting of
 157 .Va CFLAGS
 158 may be overridden using the
 159 .Va NO_CPU_CFLAGS
 160 variable.
 161 Refer to
 162 .Pa /usr/share/examples/etc/make.conf
 163 for a list of recognized
 164 .Va CPUTYPE
 165 options.
 166 .It Va CXXFLAGS
 167 .Pq Vt str
 168 Controls the compiler settings when compiling C++ code.
 169 .Va CXXFLAGS
 170 is initially set to the value of
 171 .Va CFLAGS .
 172 If you want to
 173 add to the
 174 .Va CXXFLAGS
 175 value, use
 176 .Dq Li +=
 177 instead of
 178 .Dq Li = .
 179 .It Va DTC
 180 .Pq Vt str
 181 Select the compiler for DTS (Device Tree Syntax) file.
 182 .Va DTC
 183 is initially set to the value of dtc
 184 .It Va INSTALL
 185 .Pq Vt str
 186 the default install command.
 187 To install only files for which the target differs or does not exist, use
 188 .Bd -literal -offset indent
 189 INSTALL+= -C
 190 .Ed
 191 Note that some makefiles (including those in
 192 .Pa /usr/share/mk )
 193 may hardcode options for the supplied install command.
 194 .It Va LOCAL_DIRS
 195 .Pq Vt str
 196 List any directories that should be entered when doing
 197 make's in
 198 .Pa /usr/src
 199 in this variable.
 200 .It Va MAKE_SHELL
 201 .Pq Vt str
 202 Controls the shell used internally by
 203 .Xr make 1
 204 to process the command scripts in makefiles.
 205 .Xr sh 1 ,
 206 .Xr ksh 1 ,
 207 and
 208 .Xr csh 1
 209 all currently supported.
 210 .Pp
 211 .Dl "MAKE_SHELL?=sh"
 212 .It Va MTREE_FOLLOWS_SYMLINKS
 213 .Pq Vt str
 214 Set this to
 215 .Dq Fl L
 216 to cause
 217 .Xr mtree 8
 218 to follow symlinks.
 219 .It Va NO_CPU_CFLAGS
 220 .Pq Vt str
 221 Setting this variable will prevent CPU specific compiler flags
 222 from being automatically added to
 223 .Va CFLAGS
 224 during compile time.
 225 .It Va NO_DOCUPDATE
 226 .Pq Vt bool
 227 Set this to not update the doc tree during
 228 .Dq Li "make update" .
 229 .It Va NO_PORTSUPDATE
 230 .Pq Vt bool
 231 Set this to not update the ports tree during
 232 .Dq Li "make update" .
 233 .It Va SVN_UPDATE
 234 .Pq Vt bool
 235 Set this to use
 236 .Xr svn 1
 237 to update your
 238 .Pa src
 239 tree with
 240 .Dq Li "make update" .
 241 Note that since a subversion client is not included in the base system,
 242 you will need to set
 243 .Va SVN
 244 to the full path of a
 245 .Xr svn 1
 246 binary.
 247 .El
 248 .Ss "BUILDING THE KERNEL"
 249 The following list provides a name and short description for variables
 250 that are only used doing a kernel build:
 251 .Bl -tag -width Ar
 252 .It Va BOOTWAIT
 253 .Pq Vt int
 254 Controls the amount of time the kernel waits for a console keypress
 255 before booting the default kernel.
 256 The value is approximately milliseconds.
 257 Keypresses are accepted by the BIOS before booting from disk,
 258 making it possible to give custom boot parameters even when this is
 259 set to 0.
 260 .It Va COPTFLAGS
 261 .Pq Vt str
 262 Controls the compiler settings when building the
 263 kernel.
 264 Optimization levels above
 265 .Oo Fl O ( O2 , No ...\& ) Oc
 266 are not guaranteed to work.
 267 .It Va KERNCONF
 268 .Pq Vt str
 269 Controls which kernel configurations will be
 270 built by
 271 .Dq Li "${MAKE} buildkernel"
 272 and installed by
 273 .Dq Li "${MAKE} installkernel" .
 274 For example,
 275 .Bd -literal -offset indent
 276 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
 277 .Ed
 278 .Pp
 279 will build the kernels specified by the config files
 280 .Pa MINE , DEBUG , GENERIC ,
 281 and
 282 .Pa OTHERMACHINE ,
 283 and install the kernel specified by the config file
 284 .Pa MINE .
 285 It defaults to
 286 .Pa GENERIC .
 287 .It Va MODULES_OVERRIDE
 288 .Pq Vt str
 289 Set to a list of modules to build instead of all of them.
 290 .It Va NO_KERNELCLEAN
 291 .Pq Vt bool
 292 Set this to skip running
 293 .Dq Li "${MAKE} clean"
 294 during
 295 .Dq Li "${MAKE} buildkernel" .
 296 .It Va NO_KERNELCONFIG
 297 .Pq Vt bool
 298 Set this to skip running
 299 .Xr config 8
 300 during
 301 .Dq Li "${MAKE} buildkernel" .
 302 .It Va NO_KERNELOBJ
 303 .Pq Vt bool
 304 Set this to skip running
 305 .Dq Li "${MAKE} obj"
 306 during
 307 .Dq Li "${MAKE} buildkernel" .
 308 .It Va NO_MODULES
 309 .Pq Vt bool
 310 Set to not build modules with the kernel.
 311 .It Va PORTS_MODULES
 312 Set this to the list of ports you wish to rebuild every time the kernel
 313 is built.
 314 .It Va WITHOUT_MODULES
 315 .Pq Vt str
 316 Set to a list of modules to exclude from the build.
 317 This provides a
 318 somewhat easier way to exclude modules you are certain you will never
 319 need than specifying
 320 .Va MODULES_OVERRIDE .
 321 This is applied
 322 .Em after
 323 .Va MODULES_OVERRIDE .
 324 .El
 325 .Ss "BUILDING THE WORLD"
 326 The following list provides a name and short description for variables
 327 that are used during the world build:
 328 .Bl -tag -width Ar
 329 .It Va BOOT_COMCONSOLE_PORT
 330 .Pq Vt str
 331 The port address to use for the console if the boot blocks have
 332 been configured to use a serial console instead of the keyboard/video card.
 333 .It Va BOOT_COMCONSOLE_SPEED
 334 .Pq Vt int
 335 The baud rate to use for the console if the boot blocks have
 336 been configured to use a serial console instead of the keyboard/video card.
 337 .It Va BOOT_PXELDR_ALWAYS_SERIAL
 338 .Pq Vt bool
 339 Compile in the code into
 340 .Xr pxeboot 8
 341 that forces the use of a serial console.
 342 This is analogous to the
 343 .Fl h
 344 option in
 345 .Xr boot 8
 346 blocks.
 347 .It Va BOOT_PXELDR_PROBE_KEYBOARD
 348 .Pq Vt bool
 349 Compile in the code into
 350 .Xr pxeboot 8
 351 that probes the keyboard.
 352 If no keyboard is found, boot with the dual console configuration.
 353 This is analogous to the
 354 .Fl D
 355 option in
 356 .Xr boot 8
 357 blocks.
 358 .It Va ENABLE_SUID_K5SU
 359 .Pq Vt bool
 360 Set this if you wish to use the ksu utility.
 361 Otherwise, it will be
 362 installed without the set-user-ID bit set.
 363 .It Va ENABLE_SUID_NEWGRP
 364 .Pq Vt bool
 365 Set this to install
 366 .Xr newgrp 1
 367 with the set-user-ID bit set.
 368 Otherwise,
 369 .Xr newgrp 1
 370 will not be able to change users' groups.
 371 .It Va LOADER_TFTP_SUPPORT
 372 .Pq Vt bool
 373 By default the
 374 .Xr pxeboot 8
 375 loader retrieves the kernel via NFS.
 376 Defining this and recompiling
 377 .Pa /usr/src/sys/boot
 378 will cause it to retrieve the kernel via TFTP.
 379 This allows
 380 .Xr pxeboot 8
 381 to load a custom BOOTP diskless kernel yet
 382 still mount the server's
 383 .Pa /
 384 rather than load the server's kernel.
 385 .It Va LOADER_FIREWIRE_SUPPORT
 386 .Pq Vt bool
 387 Defining this and recompiling
 388 .Pa /usr/src/sys/boot/i386
 389 will add
 390 .Xr dcons 4
 391 console driver to
 392 .Xr loader 8
 393 and allow access over FireWire(IEEE1394) using
 394 .Xr dconschat 8 .
 395 Currently, only i386 and amd64 are supported.
 396 .It Va MALLOC_PRODUCTION
 397 .Pq Vt bool
 398 Set this to disable assertions and statistics gathering in
 399 .Xr malloc 3 .
 400 It also defaults the A and J runtime options to off.
 401 Disabled by default on -CURRENT.
 402 .It Va MODULES_WITH_WORLD
 403 .Pq Vt bool
 404 Set to build modules with the system instead of the kernel.
 405 .It Va NO_CLEAN
 406 .Pq Vt bool
 407 Set this to disable cleaning during
 408 .Dq Li "make buildworld" .
 409 This should not be set unless you know what you are doing.
 410 .It Va NO_CLEANDIR
 411 .Pq Vt bool
 412 Set this to run
 413 .Dq Li "${MAKE} clean"
 414 instead of
 415 .Dq Li "${MAKE} cleandir" .
 416 .It Va WITH_MANCOMPRESS
 417 .Pq Vt defined
 418 Set to install manual pages compressed.
 419 .It Va WITHOUT_MANCOMPRESS
 420 .Pq Vt defined
 421 Set to install manual pages uncompressed.
 422 .It Va NO_SHARE
 423 .Pq Vt bool
 424 Set to not build in the
 425 .Pa share
 426 subdir.
 427 .It Va NO_SHARED
 428 .Pq Vt bool
 429 Set to build
 430 .Pa /bin
 431 and
 432 .Pa /sbin
 433 statically linked, this can be bad.
 434 If set, every utility that uses
 435 .Pa bsd.prog.mk
 436 will be linked statically.
 437 .It Va PPP_NO_NAT
 438 .Pq Vt bool
 439 Build
 440 .Xr ppp 8
 441 without support for network address translation (NAT).
 442 .It Va PPP_NO_NETGRAPH
 443 .Pq Vt bool
 444 Set to build
 445 .Xr ppp 8
 446 without support for Netgraph.
 447 .It Va PPP_NO_RADIUS
 448 .Pq Vt bool
 449 Set to build
 450 .Xr ppp 8
 451 without support for RADIUS.
 452 .It Va PPP_NO_SUID
 453 .Pq Vt bool
 454 Set to disable the installation of
 455 .Xr ppp 8
 456 as a set-user-ID root program.
 457 .It Va SENDMAIL_ADDITIONAL_MC
 458 .Pq Vt str
 459 Additional
 460 .Pa .mc
 461 files which should be built into
 462 .Pa .cf
 463 files at build time.
 464 The value should include the full path to the
 465 .Pa .mc
 466 file(s), e.g.,
 467 .Pa /etc/mail/foo.mc ,
 468 .Pa /etc/mail/bar.mc .
 469 .It Va SENDMAIL_ALIASES
 470 .Pq Vt str
 471 List of
 472 .Xr aliases 5
 473 files to rebuild when using
 474 .Pa /etc/mail/Makefile .
 475 The default value is
 476 .Pa /etc/mail/aliases .
 477 .It Va SENDMAIL_CFLAGS
 478 .Pq Vt str
 479 Flags to pass to the compile command when building
 480 .Xr sendmail 8 .
 481 The
 482 .Va SENDMAIL_*
 483 flags can be used to provide SASL support with setting such as:
 484 .Bd -literal -offset indent
 485 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
 486 SENDMAIL_LDFLAGS=-L/usr/local/lib
 487 SENDMAIL_LDADD=-lsasl
 488 .Ed
 489 .It Va SENDMAIL_CF_DIR
 490 .Pq Vt str
 491 Override the default location for the
 492 .Xr m4 1
 493 configuration files used to build a
 494 .Pa .cf
 495 file from a
 496 .Pa .mc
 497 file.
 498 .It Va SENDMAIL_DPADD
 499 .Pq Vt str
 500 Extra dependencies to add when building
 501 .Xr sendmail 8 .
 502 .It Va SENDMAIL_LDADD
 503 .Pq Vt str
 504 Flags to add to the end of the
 505 .Xr ld 1
 506 command when building
 507 .Xr sendmail 8 .
 508 .It Va SENDMAIL_LDFLAGS
 509 .Pq Vt str
 510 Flags to pass to the
 511 .Xr ld 1
 512 command when building
 513 .Xr sendmail 8 .
 514 .It Va SENDMAIL_M4_FLAGS
 515 .Pq Vt str
 516 Flags passed to
 517 .Xr m4 1
 518 when building a
 519 .Pa .cf
 520 file from a
 521 .Pa .mc
 522 file.
 523 .It Va SENDMAIL_MAP_PERMS
 524 .Pq Vt str
 525 Mode to use when generating alias and map database files using
 526 .Pa /etc/mail/Makefile .
 527 The default value is 0640.
 528 .It Va SENDMAIL_MAP_SRC
 529 .Pq Vt str
 530 Additional maps to rebuild when using
 531 .Pa /etc/mail/Makefile .
 532 The
 533 .Pa access ,
 534 .Pa bitdomain ,
 535 .Pa domaintable ,
 536 .Pa genericstable ,
 537 .Pa mailertable ,
 538 .Pa uucpdomain ,
 539 and
 540 .Pa virtusertable
 541 maps are always rebuilt if they exist.
 542 .It Va SENDMAIL_MAP_TYPE
 543 .Pq Vt str
 544 Database map type to use when generating map database files using
 545 .Pa /etc/mail/Makefile .
 546 The default value is hash.
 547 The alternative is btree.
 548 .It Va SENDMAIL_MC
 549 .Pq Vt str
 550 The default
 551 .Xr m4 1
 552 configuration file to use at install time.
 553 The value should include the full path to the
 554 .Pa .mc
 555 file, e.g.,
 556 .Pa /etc/mail/myconfig.mc .
 557 Use with caution as a make install will overwrite any existing
 558 .Pa /etc/mail/sendmail.cf .
 559 Note that
 560 .Va SENDMAIL_CF
 561 is now deprecated.
 562 .It Va SENDMAIL_SET_USER_ID
 563 .Pq Vt bool
 564 If set, install
 565 .Xr sendmail 8
 566 as a set-user-ID root binary instead of a set-group-ID binary
 567 and do not install
 568 .Pa /etc/mail/submit.{cf,mc} .
 569 Use of this flag is not recommended and the alternative advice in
 570 .Pa /etc/mail/README
 571 should be followed instead if at all possible.
 572 .It Va SENDMAIL_START_SCRIPT
 573 .Pq Vt str
 574 The script used by
 575 .Pa /etc/mail/Makefile
 576 to start, stop, and restart
 577 .Xr sendmail 8 .
 578 The default value is
 579 .Pa /etc/rc.sendmail .
 580 This value should match the
 581 .Dq Li mta_start_script
 582 setting in
 583 .Xr rc.conf 5 .
 584 .It Va SENDMAIL_SUBMIT_MC
 585 .Pq Vt str
 586 The default
 587 .Xr m4 1
 588 configuration file for mail submission
 589 to use at install time.
 590 The value should include the full path to the
 591 .Pa .mc
 592 file, e.g.,
 593 .Pa /etc/mail/mysubmit.mc .
 594 Use with caution as a make install will overwrite any existing
 595 .Pa /etc/mail/submit.cf .
 596 .It Va TOP_TABLE_SIZE
 597 .Pq Vt int
 598 .Xr top 1
 599 uses a hash table for the user names.
 600 The size of this hash can be tuned to match the number of local users.
 601 The table size should be a prime number
 602 approximately twice as large as the number of lines in
 603 .Pa /etc/passwd .
 604 The default number is 20011.
 605 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
 606 .Pq Vt int
 607 Causes the system compiler to be built such that it forces high optimization
 608 levels to a lower one.
 609 .Xr cc 1
 610 .Fl O2
 611 and above is known to trigger known optimizer bugs at various
 612 times.
 613 The value assigned is the highest optimization value used.
 614 .El
 615 .Ss "BUILDING DOCUMENTATION"
 616 The following list provides a name and short description for variables
 617 that are used when building documentation.
 618 .Bl -tag -width ".Va PRINTERDEVICE"
 619 .It Va DISTDIR
 620 .Pq Vt str
 621 Where distfiles are kept.
 622 Normally, this is
 623 .Pa distfiles
 624 in
 625 .Va PORTSDIR .
 626 .It Va DOC_LANG
 627 .Pq Vt str
 628 The list of languages and encodings to build and install.
 629 .It Va PRINTERDEVICE
 630 .Pq Vt str
 631 The default format for system documentation, depends on your
 632 printer.
 633 This can be set to
 634 .Dq Li ascii
 635 for simple printers, or
 636 .Dq Li ps
 637 for postscript or graphics printers with a ghostscript
 638 filter, or both.
 639 .El
 640 .Ss "BUILDING PORTS"
 641 Several make variables can be set that affect the building of ports.
 642 These variables and their effects are documented in
 643 .Xr ports 7 ,
 644 .Pa ${PORTSDIR}/Mk/*
 645 and the
 646 .Fx
 647 Porter's Handbook.
 648 .Sh FILES
 649 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
 650 .It Pa /etc/make.conf
 651 .It Pa /usr/doc/Makefile
 652 .It Pa /usr/ports/Makefile
 653 .It Pa /usr/share/examples/etc/make.conf
 654 .It Pa /usr/share/mk/sys.mk
 655 .It Pa /usr/src/Makefile
 656 .It Pa /usr/src/Makefile.inc1
 657 .El
 658 .Sh SEE ALSO
 659 .Xr cc 1 ,
 660 .Xr install 1 ,
 661 .Xr make 1 ,
 662 .Xr src.conf 5 ,
 663 .Xr environ 7 ,
 664 .Xr ports 7 ,
 665 .Xr sendmail 8
 666 .Sh HISTORY
 667 The
 668 .Nm
 669 file appeared sometime before
 670 .Fx 4.0 .
 671 .Sh AUTHORS
 672 This
 673 manual page was written by
 674 .An Mike W. Meyer Aq Mt mwm@mired.org .
 675 .Sh CAVEATS
 676 Note, that
 677 .Ev MAKEOBJDIRPREFIX
 678 and
 679 .Ev MAKEOBJDIR
 680 are environment variables and should not be set in
 681 .Nm
 682 or as command line arguments to
 683 .Xr make 1 ,
 684 but in make's environment.
 685 .Sh BUGS
 686 This manual page may occasionally be out of date with respect to
 687 the options currently available for use in
 688 .Nm .
 689 Please check the
 690 .Pa /usr/share/examples/etc/make.conf
 691 file for the latest options which are available.