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