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 February 17, 2013
  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 binutils221
 152 and
 153 .Dq binutils222
 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 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 WORLD_BACKUP
 216 .Pq Vt str
 217 defines where system binaries will be backed up for the
 218 .Dq make backupworld
 219 target.  The default value is
 220 .Dq /var/backups/world_binaries .
 221 .It Va DAYS_BACKUP
 222 .Pq Vt int
 223 If the last world backup is older than the number of days
 224 defined here, the
 225 .Dq make installworld
 226 will fail with an appropriate message.
 227 .Dq 28
 228 is the default value.
 229 .It Va NO_BACKUP
 230 .Pq Vt bool
 231 Set this to skip the existence and currency checks for world
 232 binary backups.
 233 .It Va LOCAL_DIRS
 234 .Pq Vt str
 235 List any directories that should be entered when running make
 236 .Pa /usr/src
 237 in this variable.
 238 .It Va MAKE_SHELL
 239 .Pq Vt str
 240 Controls the shell used internally by
 241 .Xr make 1
 242 to process the command scripts in makefiles.
 243 .Xr sh 1 ,
 244 .Xr ksh 1 ,
 245 and
 246 .Xr csh 1
 247 all currently supported.
 248 .Bd -literal -offset indent
 249 MAKE_SHELL?=sh
 250 .Ed
 251 .It Va MODULES_OVERRIDE
 252 .Pq Vt str
 253 Set to a list of modules to build instead of all of them.
 254 .It Va MTREE_FOLLOWS_SYMLINKS
 255 .Pq Vt str
 256 Set this to
 257 .Dq Fl L
 258 to cause
 259 .Xr mtree 8
 260 to follow symlinks.
 261 .It Va STRIP
 262 .Pq Vt str
 263 Set this to the flag to pass to the
 264 .Xr strip 1
 265 command.
 266 If set to a blank value, debug symbols will not be removed.
 267 .Va STRIP
 268 is automatically set to a blank value if
 269 .Va DEBUG_FLAGS
 270 is set.
 271 .It Va WANT_HESIOD
 272 .Pq Vt bool
 273 Set this to build
 274 .Xr hesiod 3
 275 support into libc.
 276 .It Va NO_NS_CACHING
 277 .Pq Vt bool
 278 Set this to disable name caching in the nsswitch subsystem.
 279 The generic caching daemon,
 280 .Xr nscd 8 ,
 281 will not be built either if this option is set.
 282 .It Va NO_WERROR
 283 Set this if you don't want
 284 .Fl Werror
 285 to be added to
 286 .Va CWARNFLAGS
 287 or used in the kernel build.
 288 .It Va STATIC_LOCALES
 289 .Pq Vt str
 290 Set to a list of locales to build into statically-linked binaries.
 291 Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
 292 .El
 293 .Pp
 294 The following list provides a name and short description for variables
 295 that are only used doing a kernel build:
 296 .Bl -tag -width Ar
 297 .It Va BOOT_COMCONSOLE_PORT
 298 .Pq Vt str
 299 The port address to use for the console if the boot blocks have
 300 been configured to use a serial console instead of the keyboard/video card.
 301 .It Va BOOT_COMCONSOLE_SPEED
 302 .Pq Vt int
 303 The baud rate to use for the console if the boot blocks have
 304 been configured to use a serial console instead of the keyboard/video card.
 305 .It Va COPTFLAGS
 306 .Pq Vt str
 307 Controls the compiler settings when building the
 308 kernel.
 309 Optimization levels above
 310 .Fl O
 311 .Pq Fl O2 , No ...
 312 are not guaranteed to work.
 313 .It Va KERNCONF
 314 .Pq Vt str
 315 Controls which kernel configurations will be
 316 built by
 317 .Dq Li "${MAKE} buildkernel"
 318 and installed by
 319 .Dq Li "${MAKE} installkernel" .
 320 For example,
 321 .Bd -literal -offset indent
 322 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
 323 .Ed
 324 .Pp
 325 will build the kernels specified by the config files
 326 .Pa MINE , DEBUG , GENERIC ,
 327 and
 328 .Pa OTHERMACHINE ,
 329 and install the kernel specified by the config file
 330 .Pa MINE .
 331 It defaults to
 332 .Pa GENERIC .
 333 .It Va NO_CPU_COPTFLAGS
 334 .Pq Vt str
 335 Setting this variable will prevent CPU specific compiler flags
 336 from being automatically added to
 337 .Va COPTFLAGS
 338 during compile time.
 339 .It Va NO_KERNELCLEAN
 340 .Pq Vt bool
 341 Set this to skip the clean target when using
 342 .Dq Li "${MAKE} buildkernel" .
 343 .It Va NO_KERNELCONFIG
 344 .Pq Vt bool
 345 Set this to skip running
 346 .Xr config 8
 347 during
 348 .Dq Li "${MAKE} buildkernel" .
 349 .It Va NO_KERNELDEPEND
 350 .Pq Vt bool
 351 Set this to skip running
 352 .Dq Li "${MAKE} depend"
 353 during
 354 .Dq Li "${MAKE} buildkernel" .
 355 .It Va NO_KERNEL_OLD_STRIP
 356 .Pq Vt bool
 357 Set this to skip stripping debugging symbols from old kernel and modules
 358 (kernel.old, modules.old) during
 359 .Dq Li "${MAKE} installkernel" .
 360 .It Va NO_MODULES
 361 .Pq Vt bool
 362 Set to not build modules with the kernel.
 363 .El
 364 .Pp
 365 The following list provides a name and short description for variables
 366 that are used during the world build:
 367 .Bl -tag -width Ar
 368 .It Va ENABLE_SUID_SSH
 369 .Pq Vt bool
 370 Set this to install
 371 .Xr ssh 1
 372 with the setuid bit turned on.
 373 .It Va MODULES_WITH_WORLD
 374 .Pq Vt bool
 375 Set to build modules with the system instead of the kernel.
 376 .It Va NO_BINUTILS221
 377 .Pq Vt bool
 378 Set to not build the older version of binutils (2.21).
 379 .It Va NO_CRYPT
 380 .Pq Vt bool
 381 Set to not build crypto code.
 382 .It Va NO_CVS
 383 .Pq Vt bool
 384 Set to not build CVS.
 385 .It Va NO_GAMES
 386 .Pq Vt bool
 387 Set to not build games.
 388 .It Va NO_GCC44
 389 .Pq Vt bool
 390 Set to not build the older version of GCC (4.4).
 391 .It Va NO_GDB
 392 .Pq Vt bool
 393 Set to not build
 394 .Xr gdb 1
 395 .It Va NO_LIBC_R
 396 .Pq Vt bool
 397 Set to not build
 398 .Nm libc_r
 399 (reentrant version of
 400 .Nm libc ) .
 401 .It Va NO_LPR
 402 .Pq Vt bool
 403 Set to not build
 404 .Xr lpr 1
 405 and related programs.
 406 .It Va NO_MAILWRAPPER
 407 .Pq Vt bool
 408 Set to not build the
 409 .Xr mailwrapper 8
 410 MTA selector.
 411 .It Va NO_OBJC
 412 .Pq Vt bool
 413 Set to not build Objective C support.
 414 .It Va NO_OPENSSH
 415 .Pq Vt bool
 416 Set to not build OpenSSH.
 417 .It Va NO_OPENSSL
 418 .Pq Vt bool
 419 Set to not build OpenSSL (implies
 420 .Va NO_OPENSSH ) .
 421 .It Va NO_SENDMAIL
 422 .Pq Vt bool
 423 Set to not build
 424 .Xr sendmail 8
 425 and related programs.
 426 .It Va NO_SHARE
 427 .Pq Vt bool
 428 Set to not enter the share subdirectory.
 429 .It Va NOCLEAN
 430 .Pq Vt bool
 431 Set this to disable cleaning during
 432 .Dq Li "make buildworld" .
 433 This should not be set unless you know what you are doing.
 434 .It Va NOCLEANDIR
 435 .Pq Vt bool
 436 Set this to run
 437 .Dq Li "${MAKE} clean"
 438 instead of
 439 .Dq Li "${MAKE} cleandir" .
 440 .It Va NOFSCHG
 441 .Pq Vt bool
 442 Set to not install certain components with flag schg.
 443 This is useful in a jailed environment.
 444 .It Va NOINFO
 445 .Pq Vt bool
 446 Set to not make or install
 447 .Xr info 5
 448 files.
 449 .It Va NOINFOCOMPRESS
 450 .Pq Vt bool
 451 Set to not compress the info pages.
 452 .It Va NOMAN
 453 .Pq Vt bool
 454 Set to not build manual pages
 455 .It Va NOMANCOMPRESS
 456 .Pq Vt bool
 457 Set to not compress the manual pages.
 458 .It Va NOPROFILE
 459 .Pq Vt bool
 460 Set to avoid compiling profiled libraries.
 461 .It Va PPP_NOSUID
 462 .Pq Vt bool
 463 Set to disable the installation of
 464 .Xr ppp 8
 465 with the set-user-ID bit on.
 466 .It Va SENDMAIL_MC
 467 .Pq Vt str
 468 The default
 469 .Xr m4 1
 470 configuration file to use at install time.
 471 The value should include the full path to the
 472 .Pa .mc
 473 file, e.g.,
 474 .Pa /etc/mail/myconfig.mc .
 475 Use with caution as a make install will overwrite any existing
 476 .Pa /etc/mail/sendmail.cf .
 477 Note that
 478 .Va SENDMAIL_CF
 479 is now deprecated.
 480 .It Va SENDMAIL_SUBMIT_MC
 481 .Pq Vt str
 482 The default
 483 .Xr m4 1
 484 configuration file for mail submission
 485 to use at install time.
 486 The value should include the full path to the
 487 .Pa .mc
 488 file, e.g.,
 489 .Pa /etc/mail/mysubmit.mc .
 490 Use with caution as a make install will overwrite any existing
 491 .Pa /etc/mail/submit.cf .
 492 .It Va SENDMAIL_ADDITIONAL_MC
 493 .Pq Vt str
 494 Additional
 495 .Pa .mc
 496 files which should be built into
 497 .Pa .cf
 498 files at build time.
 499 The value should include the full path to the
 500 .Pa .mc
 501 file(s), e.g.,
 502 .Pa /etc/mail/foo.mc
 503 .Pa /etc/mail/bar.mc .
 504 .It Va SENDMAIL_CF_DIR
 505 .Pq Vt str
 506 Override the default location for the
 507 .Xr m4 1
 508 configuration files used to build a
 509 .Pa .cf
 510 file from a
 511 .Pa .mc
 512 file.
 513 .It Va SENDMAIL_M4_FLAGS
 514 .Pq Vt str
 515 Flags passed to
 516 .Xr m4 1
 517 when building a
 518 .Pa .cf
 519 file from a
 520 .Pa .mc
 521 file.
 522 .It Va SENDMAIL_CFLAGS
 523 .Pq Vt str
 524 Flags to pass to the compile command when building
 525 .Xr sendmail 8 .
 526 The
 527 .Va SENDMAIL_*
 528 flags can be used to provide SASL support with setting such as:
 529 .Bd -literal -offset indent
 530 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
 531 SENDMAIL_LDFLAGS=-L/usr/local/lib
 532 SENDMAIL_LDADD=-lsasl
 533 .Ed
 534 .It Va SENDMAIL_LDFLAGS
 535 .Pq Vt str
 536 Flags to pass to the
 537 .Xr ld 1
 538 command when building
 539 .Xr sendmail 8 .
 540 .It Va SENDMAIL_LDADD
 541 .Pq Vt str
 542 Flags to add to the end of the
 543 .Xr ld 1
 544 command when building
 545 .Xr sendmail 8 .
 546 .It Va SENDMAIL_DPADD
 547 .Pq Vt str
 548 Extra dependencies to add when building
 549 .Xr sendmail 8 .
 550 .It Va SENDMAIL_SET_USER_ID
 551 .Pq Vt bool
 552 If set, install
 553 .Xr sendmail 8
 554 as a set-user-ID root binary instead of a set-group-ID binary
 555 and do not install
 556 .Pa /etc/mail/submit.{cf,mc} .
 557 Use of this flag is not recommended and the alternative advice in
 558 .Pa /etc/mail/README
 559 should be followed instead if at all possible.
 560 .It Va SENDMAIL_MAP_PERMS
 561 .Pq Vt str
 562 Mode to use when generating alias and map database files using
 563 .Pa /etc/mail/Makefile .
 564 The default value is 0640.
 565 .It Va THREAD_LIB
 566 .Pq Vt str
 567 Set to either
 568 .Li c_r
 569 or
 570 .Li thread_xu
 571 to configure the system's default threading library.
 572 The default is
 573 .Li thread_xu .
 574 .It Va WANT_IDEA
 575 .Pq Vt bool
 576 Set to build the IDEA encryption code.
 577 This code is patented in the USA and many European countries.
 578 It is
 579 .Em "YOUR RESPONSIBILITY"
 580 to determine if you can legally use IDEA.
 581 .It Va WANT_INSTALLER
 582 .Pq Vt bool
 583 Set to build the installer.
 584 .It Va WANT_NETGRAPH7
 585 .Pq Vt bool
 586 Set to build a newer, experimental
 587 .Xr netgraph 4
 588 userland.
 589 It has to be accompanied by
 590 .Dv NETGRAPH7*
 591 options in the kernel.
 592 .It Va WANT_USB4BSD
 593 .Pq Vt bool
 594 Set to build a newer, experimental
 595 .Xr usb 4
 596 userland.
 597 .El
 598 .Pp
 599 The following list provides a name and short description for variables
 600 that are used when building documentation.
 601 .Bl -tag -width Ar
 602 .It Va DOC_LANG
 603 .Pq Vt str
 604 The list of languages and encodings to build and install.
 605 .It Va PRINTERDEVICE
 606 .Pq Vt str
 607 The default format for system documentation, depends on your
 608 printer.
 609 This can be set to
 610 .Dq Li ascii
 611 for simple printers or
 612 .Dq Li ps
 613 for postscript or graphics printers with a ghostscript
 614 filter.
 615 .It Va GROFF_PAPER_SIZE
 616 .Pq Vt str
 617 The default paper size for
 618 .Xr groff 1
 619 (either
 620 .Dq letter
 621 or
 622 .Dq A4 ) .
 623 .El
 624 .Sh FILES
 625 .Bl -tag -width /etc/defaults/make.conf -compact
 626 .It Pa /etc/defaults/make.conf
 627 .It Pa /etc/make.conf
 628 .It Pa /usr/src/Makefile
 629 .It Pa /usr/src/Makefile.inc1
 630 .El
 631 .Sh SEE ALSO
 632 .Xr gcc 1 ,
 633 .Xr install 1 ,
 634 .Xr make 1 ,
 635 .Xr lpd 8 ,
 636 .Xr sendmail 8
 637 .Sh HISTORY
 638 The
 639 .Nm
 640 file appeared sometime before
 641 .Fx 4.0 .
 642 .Sh AUTHORS
 643 This manual page was written by
 644 .An Mike W. Meyer Aq mwm@mired.org .