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