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