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