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 .\"
  27 .Dd November 28, 2014
  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 settings that control the compilation of the
  37 .Dx
  38 sources.
  39 The file
  40 .Nm
  41 is generally created by the system administrator when the values need
  42 to be changed from their defaults.
  43 .Pp
  44 The purpose of
  45 .Nm
  46 is not to run commands or perform compilation actions
  47 directly.
  48 Instead, it is included by the various makefiles in
  49 .Pa /usr/src
  50 which conditionalize their internal actions according to the settings
  51 found there.
  52 .Pp
  53 The
  54 .Pa /etc/make.conf
  55 file is included from the appropriate
  56 .Pa Makefile
  57 which specifies the default settings for all the available options.
  58 Options need only be specified in
  59 .Pa /etc/make.conf
  60 when the system administrator wishes to override these defaults.
  61 .Pp
  62 The build procedures occur in three areas: world, kernel, and
  63 documentation.
  64 Variables set in
  65 .Nm
  66 may be applicable during builds in one, two, or all of these areas.
  67 They may be specified for a particular build via the
  68 .Fl D
  69 option of
  70 .Xr make 1 .
  71 .Pp
  72 The following lists provide a name and short description for each
  73 variable you can use during the indicated builds.
  74 The values of variables flagged as
  75 .Vt bool
  76 are ignored; the variable being set at all (even to
  77 .Dq Li FALSE
  78 or
  79 .Dq Li NO )
  80 causes it to be treated as if it were set.
  81 .Pp
  82 The following list provides a name and short description for variables
  83 that are used for all builds, or are used by the
  84 .Pa makefiles
  85 for things other than builds.
  86 .Bl -tag -width Ar
  87 .It Va CPUTYPE
  88 .Pq Vt str
  89 Controls which processor should be targeted for generated code.
  90 This controls processor-specific optimizations in certain code
  91 (currently only OpenSSL) as well as modifying the value of
  92 .Va CFLAGS
  93 and
  94 .Va COPTFLAGS
  95 to contain the appropriate optimization directive to
  96 .Xr gcc 1 .
  97 The automatic setting of
  98 .Va CFLAGS
  99 and
 100 .Va COPTFLAGS
 101 may be overridden using the
 102 .Va NO_CPU_CFLAGS
 103 and
 104 .Va NO_CPU_COPTFLAGS
 105 variables, respectively.  Refer to
 106 .Pa /usr/share/examples/etc/defaults/make.conf
 107 for a list of recognized
 108 .Va CPUTYPE
 109 options.
 110 .It Va CCVER
 111 .Pq Vt str
 112 Controls which GCC version to use by default.
 113 It should be set as
 114 .Li CCVER?=
 115 so as not to interfere with overrides from userland.
 116 We currently recommend that an override NOT be set in
 117 .Pa /etc/make.conf .
 118 Currently accepted values for compilers which are part of
 119 .Dx
 120 are
 121 .Dq gcc44
 122 and
 123 .Dq gcc47
 124 (default).
 125 All other values will handled according to the settings in
 126 .Xr compilers.conf 5 .
 127 .It Va WORLD_CCVER
 128 .Pq Vt str
 129 Controls which version of GCC builds the base system, including
 130 the kernel.
 131 .Dq gcc47
 132 is the default value.
 133 .It Va LDVER
 134 .Pq Vt str
 135 Controls which linker to use by default.  Currently accepted
 136 values are
 137 .Dq ld.gold
 138 (GNU Gold linker) and
 139 .Dq ld.bfd
 140 (default).
 141 .It Va WORLD_LDVER
 142 .Pq Vt str
 143 Controls which linker builds the base system, including
 144 the kernel.
 145 .Dq ld.bfd
 146 is the default value.
 147 .It Va BINUTILSVER
 148 .Pq Vt str
 149 Controls which binutils to use by default.
 150 Currently accepted values are
 151 .Dq binutils222
 152 and
 153 .Dq binutils224
 154 (default).
 155 .It Va WORLD_BINUTILSVER
 156 .Pq Vt str
 157 Controls which version of binutils builds the base system, including
 158 the kernel.
 159 .Dq binutils222
 160 is the default value.
 161 .It Va CFLAGS
 162 .Pq Vt str
 163 Controls the compiler setting when compiling C code.
 164 Optimization levels above
 165 .Fl O
 166 .Pq Fl O2 , No ...
 167 are not supported.
 168 .Va BDECFLAGS
 169 is provided as a set of
 170 .Xr gcc 1
 171 settings suggested by
 172 .An Bruce Evans Aq Mt bde@FreeBSD.org
 173 for developing and testing changes.
 174 They can be used, if set, by:
 175 .Bd -literal -offset indent
 176 CFLAGS+=${BDECFLAGS}
 177 .Ed
 178 .It Va DEBUG_FLAGS
 179 .Pq Vt str
 180 Similar to
 181 .Va CFLAGS
 182 but it will cause
 183 .Va STRIP
 184 to be set to a blank value, if set.
 185 Typically,
 186 .Va DEBUG_FLAGS
 187 is set to
 188 .Fl g
 189 for compiling with debug symbols.
 190 .It Va NO_CPU_CFLAGS
 191 .Pq Vt str
 192 Setting this variable will prevent CPU specific compiler flags
 193 from being automatically added to
 194 .Va CFLAGS
 195 during compile time.
 196 .It Va CXXFLAGS
 197 .Pq Vt str
 198 Controls the compiler settings when compiling C++ code.
 199 .Va CXXFLAGS
 200 is initially set to the value of
 201 .Va CFLAGS .
 202 If you want to add to the
 203 .Va CXXFLAGS
 204 value, use
 205 .Dq Li +=
 206 instead of
 207 .Dq Li = .
 208 .It Va INSTALL
 209 .Pq Vt str
 210 the default install command.
 211 To have components compared before doing the install, use
 212 .Bd -literal -offset indent
 213 INSTALL="install -C"
 214 .Ed
 215 .It Va NO_BACKUP
 216 .Pq Vt str
 217 Inhibit automatic backup of world binaries as port of
 218 .Dq installworld
 219 .Xr make 1
 220 target.
 221 Default is unset.
 222 .It Va WORLD_BACKUP
 223 .Pq Vt str
 224 defines where system binaries will be backed up for the
 225 .Dq backupworld
 226 .Xr make 1
 227 target.
 228 The default is
 229 .Dq /var/backups/world_backup .
 230 .It Va AUTO_BACKUP
 231 .Pq Vt str
 232 defines where system binaries will be backed up automatically
 233 as part of the
 234 .Dq installworld
 235 .Xr make 1
 236 target.
 237 The default is
 238 .Dq Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR .
 239 .It Va LOCAL_DIRS
 240 .Pq Vt str
 241 List of directories that should be entered when running
 242 .Xr make 1
 243 in
 244 .Pa /usr/src .
 245 .It Va MAKE_SHELL
 246 .Pq Vt str
 247 Controls the shell used internally by
 248 .Xr make 1
 249 to process the command scripts in makefiles.
 250 .Xr sh 1 ,
 251 .Xr ksh 1 ,
 252 and
 253 .Xr csh 1
 254 all currently supported.
 255 .Bd -literal -offset indent
 256 MAKE_SHELL?=sh
 257 .Ed
 258 .It Va MODULES_OVERRIDE
 259 .Pq Vt str
 260 Set to a list of modules to build instead of all of them.
 261 .It Va MTREE_FOLLOWS_SYMLINKS
 262 .Pq Vt str
 263 Set this to
 264 .Dq Fl L
 265 to cause
 266 .Xr mtree 8
 267 to follow symlinks.
 268 .It Va STRIP
 269 .Pq Vt str
 270 Set this to the flag to pass to the
 271 .Xr strip 1
 272 command.
 273 If set to a blank value, debug symbols will not be removed.
 274 .Va STRIP
 275 is automatically set to a blank value if
 276 .Va DEBUG_FLAGS
 277 is set.
 278 .It Va WANT_HESIOD
 279 .Pq Vt bool
 280 Set this to build
 281 .Xr hesiod 3
 282 support into libc.
 283 .It Va NO_NS_CACHING
 284 .Pq Vt bool
 285 Set this to disable name caching in the nsswitch subsystem.
 286 The generic caching daemon,
 287 .Xr nscd 8 ,
 288 will not be built either if this option is set.
 289 .It Va NO_WERROR
 290 Set this if you don't want
 291 .Fl Werror
 292 to be added to
 293 .Va CWARNFLAGS
 294 or used in the kernel build.
 295 .It Va STATIC_LOCALES
 296 .Pq Vt str
 297 Set to a list of locales to build into statically-linked binaries.
 298 Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
 299 .El
 300 .Pp
 301 The following list provides a name and short description for variables
 302 that are only used doing a kernel build:
 303 .Bl -tag -width Ar
 304 .It Va BOOT_COMCONSOLE_PORT
 305 .Pq Vt str
 306 The port address to use for the console if the boot blocks have
 307 been configured to use a serial console instead of the keyboard/video card.
 308 .It Va BOOT_COMCONSOLE_SPEED
 309 .Pq Vt int
 310 The baud rate to use for the console if the boot blocks have
 311 been configured to use a serial console instead of the keyboard/video card.
 312 .It Va COPTFLAGS
 313 .Pq Vt str
 314 Controls the compiler settings when building the
 315 kernel.
 316 Optimization levels above
 317 .Fl O
 318 .Pq Fl O2 , No ...
 319 are not guaranteed to work.
 320 .It Va KERNCONF
 321 .Pq Vt str
 322 Controls which kernel configurations will be
 323 built by
 324 .Dq Li "${MAKE} buildkernel"
 325 and installed by
 326 .Dq Li "${MAKE} installkernel" .
 327 For example,
 328 .Bd -literal -offset indent
 329 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
 330 .Ed
 331 .Pp
 332 will build the kernels specified by the config files
 333 .Pa MINE , DEBUG , GENERIC ,
 334 and
 335 .Pa OTHERMACHINE ,
 336 and install the kernel specified by the config file
 337 .Pa MINE .
 338 It defaults to
 339 .Pa GENERIC .
 340 .It Va NO_CPU_COPTFLAGS
 341 .Pq Vt str
 342 Setting this variable will prevent CPU specific compiler flags
 343 from being automatically added to
 344 .Va COPTFLAGS
 345 during compile time.
 346 .It Va NO_KERNELCLEAN
 347 .Pq Vt bool
 348 Set this to skip the clean target when using
 349 .Dq Li "${MAKE} buildkernel" .
 350 .It Va NO_KERNELCONFIG
 351 .Pq Vt bool
 352 Set this to skip running
 353 .Xr config 8
 354 during
 355 .Dq Li "${MAKE} buildkernel" .
 356 .It Va NO_KERNELDEPEND
 357 .Pq Vt bool
 358 Set this to skip running
 359 .Dq Li "${MAKE} depend"
 360 during
 361 .Dq Li "${MAKE} buildkernel" .
 362 .It Va NO_KERNEL_OLD_STRIP
 363 .Pq Vt bool
 364 Set this to skip stripping debugging symbols from old kernel and modules
 365 (kernel.old, modules.old) during
 366 .Dq Li "${MAKE} installkernel" .
 367 .It Va NO_MODULES
 368 .Pq Vt bool
 369 Set to not build modules with the kernel.
 370 .El
 371 .Pp
 372 The following list provides a name and short description for variables
 373 that are used during the world build:
 374 .Bl -tag -width Ar
 375 .It Va ENABLE_SUID_SSH
 376 .Pq Vt bool
 377 Set this to install
 378 .Xr ssh 1
 379 with the setuid bit turned on.
 380 .It Va MODULES_WITH_WORLD
 381 .Pq Vt bool
 382 Set to build modules with the system instead of the kernel.
 383 .It Va NO_ALTBINUTILS
 384 .Pq Vt bool
 385 Set to not build the alternative (non-default) set of binutils.
 386 .It Va NO_CRYPT
 387 .Pq Vt bool
 388 Set to not build crypto code.
 389 .It Va NO_CVS
 390 .Pq Vt bool
 391 Set to not build CVS.
 392 .It Va NO_GAMES
 393 .Pq Vt bool
 394 Set to not build games.
 395 .It Va NO_GCC44
 396 .Pq Vt bool
 397 Set to not build the older version of GCC (4.4).
 398 .It Va NO_GDB
 399 .Pq Vt bool
 400 Set to not build
 401 .Xr gdb 1
 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_OBJC
 419 .Pq Vt bool
 420 Set to not build Objective C support.
 421 .It Va NO_OPENSSH
 422 .Pq Vt bool
 423 Set to not build OpenSSH.
 424 .It Va NO_OPENSSL
 425 .Pq Vt bool
 426 Set to not build OpenSSL (implies
 427 .Va NO_OPENSSH ) .
 428 .It Va NO_SENDMAIL
 429 .Pq Vt bool
 430 Set to not build
 431 .Xr sendmail 8
 432 and related programs.
 433 .It Va NO_SHARE
 434 .Pq Vt bool
 435 Set to not enter the share subdirectory.
 436 .It Va NOCLEAN
 437 .Pq Vt bool
 438 Set this to disable cleaning during
 439 .Dq Li "make buildworld" .
 440 This should not be set unless you know what you are doing.
 441 .It Va NOCLEANDIR
 442 .Pq Vt bool
 443 Set this to run
 444 .Dq Li "${MAKE} clean"
 445 instead of
 446 .Dq Li "${MAKE} cleandir" .
 447 .It Va NOFSCHG
 448 .Pq Vt bool
 449 Set to not install certain components with flag schg.
 450 This is useful in a jailed environment.
 451 .It Va NOINFO
 452 .Pq Vt bool
 453 Set to not make or install
 454 .Xr info 5
 455 files.
 456 .It Va NOINFOCOMPRESS
 457 .Pq Vt bool
 458 Set to not compress the info pages.
 459 .It Va NOMAN
 460 .Pq Vt bool
 461 Set to not build manual pages
 462 .It Va NOMANCOMPRESS
 463 .Pq Vt bool
 464 Set to not compress the manual pages.
 465 .It Va NOPROFILE
 466 .Pq Vt bool
 467 Set to avoid compiling profiled libraries.
 468 .It Va PPP_NOSUID
 469 .Pq Vt bool
 470 Set to disable the installation of
 471 .Xr ppp 8
 472 with the set-user-ID bit on.
 473 .It Va XAUTH_PATH
 474 .Pq Vt str
 475 The path to the xauth program used by OpenSSH client.
 476 .It Va SENDMAIL_MC
 477 .Pq Vt str
 478 The default
 479 .Xr m4 1
 480 configuration file to use at install time.
 481 The value should include the full path to the
 482 .Pa .mc
 483 file, e.g.,
 484 .Pa /etc/mail/myconfig.mc .
 485 Use with caution as a make install will overwrite any existing
 486 .Pa /etc/mail/sendmail.cf .
 487 Note that
 488 .Va SENDMAIL_CF
 489 is now deprecated.
 490 .It Va SENDMAIL_SUBMIT_MC
 491 .Pq Vt str
 492 The default
 493 .Xr m4 1
 494 configuration file for mail submission
 495 to use at install time.
 496 The value should include the full path to the
 497 .Pa .mc
 498 file, e.g.,
 499 .Pa /etc/mail/mysubmit.mc .
 500 Use with caution as a make install will overwrite any existing
 501 .Pa /etc/mail/submit.cf .
 502 .It Va SENDMAIL_ADDITIONAL_MC
 503 .Pq Vt str
 504 Additional
 505 .Pa .mc
 506 files which should be built into
 507 .Pa .cf
 508 files at build time.
 509 The value should include the full path to the
 510 .Pa .mc
 511 file(s), e.g.,
 512 .Pa /etc/mail/foo.mc
 513 .Pa /etc/mail/bar.mc .
 514 .It Va SENDMAIL_CF_DIR
 515 .Pq Vt str
 516 Override the default location for the
 517 .Xr m4 1
 518 configuration files used to build a
 519 .Pa .cf
 520 file from a
 521 .Pa .mc
 522 file.
 523 .It Va SENDMAIL_M4_FLAGS
 524 .Pq Vt str
 525 Flags passed to
 526 .Xr m4 1
 527 when building a
 528 .Pa .cf
 529 file from a
 530 .Pa .mc
 531 file.
 532 .It Va SENDMAIL_CFLAGS
 533 .Pq Vt str
 534 Flags to pass to the compile command when building
 535 .Xr sendmail 8 .
 536 The
 537 .Va SENDMAIL_*
 538 flags can be used to provide SASL support with setting such as:
 539 .Bd -literal -offset indent
 540 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
 541 SENDMAIL_LDFLAGS=-L/usr/local/lib
 542 SENDMAIL_LDADD=-lsasl
 543 .Ed
 544 .It Va SENDMAIL_LDFLAGS
 545 .Pq Vt str
 546 Flags to pass to the
 547 .Xr ld 1
 548 command when building
 549 .Xr sendmail 8 .
 550 .It Va SENDMAIL_LDADD
 551 .Pq Vt str
 552 Flags to add to the end of the
 553 .Xr ld 1
 554 command when building
 555 .Xr sendmail 8 .
 556 .It Va SENDMAIL_DPADD
 557 .Pq Vt str
 558 Extra dependencies to add when building
 559 .Xr sendmail 8 .
 560 .It Va SENDMAIL_SET_USER_ID
 561 .Pq Vt bool
 562 If set, install
 563 .Xr sendmail 8
 564 as a set-user-ID root binary instead of a set-group-ID binary
 565 and do not install
 566 .Pa /etc/mail/submit.{cf,mc} .
 567 Use of this flag is not recommended and the alternative advice in
 568 .Pa /etc/mail/README
 569 should be followed instead if at all possible.
 570 .It Va SENDMAIL_MAP_PERMS
 571 .Pq Vt str
 572 Mode to use when generating alias and map database files using
 573 .Pa /etc/mail/Makefile .
 574 The default value is 0640.
 575 .It Va THREAD_LIB
 576 .Pq Vt str
 577 Set to either
 578 .Li c_r
 579 or
 580 .Li thread_xu
 581 to configure the system's default threading library.
 582 The default is
 583 .Li thread_xu .
 584 .It Va WANT_IDEA
 585 .Pq Vt bool
 586 Set to build the IDEA encryption code.
 587 This code is patented in the USA and many European countries.
 588 It is
 589 .Em "YOUR RESPONSIBILITY"
 590 to determine if you can legally use IDEA.
 591 .It Va WANT_INSTALLER
 592 .Pq Vt bool
 593 Set to build the installer.
 594 .It Va WANT_NETGRAPH7
 595 .Pq Vt bool
 596 Set to build a newer, experimental
 597 .Xr netgraph 4
 598 userland.
 599 It has to be accompanied by
 600 .Dv NETGRAPH7*
 601 options in the kernel.
 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 .It Va GROFF_PAPER_SIZE
 621 .Pq Vt str
 622 The default paper size for
 623 .Xr groff 1
 624 (either
 625 .Dq letter
 626 or
 627 .Dq A4 ) .
 628 .El
 629 .Sh FILES
 630 .Bl -tag -width /etc/defaults/make.conf -compact
 631 .It Pa /etc/defaults/make.conf
 632 .It Pa /etc/make.conf
 633 .It Pa /usr/src/Makefile
 634 .It Pa /usr/src/Makefile.inc1
 635 .El
 636 .Sh SEE ALSO
 637 .Xr gcc 1 ,
 638 .Xr install 1 ,
 639 .Xr make 1 ,
 640 .Xr lpd 8 ,
 641 .Xr sendmail 8
 642 .Sh HISTORY
 643 The
 644 .Nm
 645 file appeared sometime before
 646 .Fx 4.0 .
 647 .Sh AUTHORS
 648 This manual page was written by
 649 .An Mike W. Meyer Aq Mt mwm@mired.org .