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 .\" $DragonFly: src/share/man/man5/make.conf.5,v 1.38 2008/11/03 00:25:45 pavalos Exp $
  27 .\"
  28 .Dd October 31, 2009
  29 .Dt MAKE.CONF 5
  30 .Os
  31 .Sh NAME
  32 .Nm make.conf
  33 .Nd system build information
  34 .Sh DESCRIPTION
  35 The file
  36 .Nm
  37 contains settings that control the compilation of the
  38 .Dx
  39 sources.
  40 The file
  41 .Nm
  42 is generally created by the system administrator when the values need
  43 to be changed from their defaults.
  44 .Pp
  45 The purpose of
  46 .Nm
  47 is not to run commands or perform compilation actions
  48 directly.
  49 Instead, it is included by the various makefiles in
  50 .Pa /usr/src
  51 which conditionalize their internal actions according to the settings
  52 found there.
  53 .Pp
  54 The
  55 .Pa /etc/make.conf
  56 file is included from the appropriate
  57 .Pa Makefile
  58 which specifies the default settings for all the available options.
  59 Options need only be specified in
  60 .Pa /etc/make.conf
  61 when the system administrator wishes to override these defaults.
  62 .Pp
  63 The build procedures occur in three areas: world, kernel, and
  64 documentation.
  65 Variables set in
  66 .Nm
  67 may be applicable during builds in one, two, or all of these areas.
  68 They may be specified for a particular build via the
  69 .Fl D
  70 option of
  71 .Xr make 1 .
  72 .Pp
  73 The following lists provide a name and short description for each
  74 variable you can use during the indicated builds.
  75 The values of variables flagged as
  76 .Vt bool
  77 are ignored; the variable being set at all (even to
  78 .Dq Li FALSE
  79 or
  80 .Dq Li NO )
  81 causes it to be treated as if it were set.
  82 .Pp
  83 The following list provides a name and short description for variables
  84 that are used for all builds, or are used by the
  85 .Pa makefiles
  86 for things other than builds.
  87 .Bl -tag -width Ar
  88 .It Va CPUTYPE
  89 .Pq Vt str
  90 Controls which processor should be targeted for generated code.
  91 This controls processor-specific optimizations in certain code
  92 (currently only OpenSSL) as well as modifying the value of
  93 .Va CFLAGS
  94 and
  95 .Va COPTFLAGS
  96 to contain the appropriate optimization directive to
  97 .Xr gcc 1 .
  98 The automatic setting of
  99 .Va CFLAGS
 100 and
 101 .Va COPTFLAGS
 102 may be overridden using the
 103 .Va NO_CPU_CFLAGS
 104 and
 105 .Va NO_CPU_COPTFLAGS
 106 variables, respectively.  Refer to
 107 .Pa /usr/share/examples/etc/defaults/make.conf
 108 for a list of recognized
 109 .Va CPUTYPE
 110 options.
 111 .It Va CCVER
 112 .Pq Vt str
 113 Controls which GCC version to use by default.
 114 It should be set as
 115 .Li CCVER?=
 116 so as not to interfere with overrides from userland.
 117 We currently recommend that an override NOT be set in
 118 .Pa /etc/make.conf .
 119 Currently accepted values for compilers which are part of
 120 .Dx
 121 are
 122 .Dq gcc41
 123 (default) and
 124 .Dq gcc44 .
 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 binutils217
 132 (default) and
 133 .Dq binutils220 .
 134 .It Va CFLAGS
 135 .Pq Vt str
 136 Controls the compiler setting when compiling C code.
 137 Optimization levels above
 138 .Fl O
 139 .Pq Fl O2 , No ...
 140 are not supported.
 141 .Va BDECFLAGS
 142 is provided as a set of
 143 .Xr gcc 1
 144 settings suggested by
 145 .An "Bruce Evans" Aq bde@FreeBSD.org
 146 for developing and testing changes.
 147 They can be used, if set, by:
 148 .Bd -literal -offset indent
 149 CFLAGS+=${BDECFLAGS}
 150 .Ed
 151 .It Va DEBUG_FLAGS
 152 .Pq Vt str
 153 Similar to
 154 .Va CFLAGS
 155 but it will cause
 156 .Va STRIP
 157 to be set to a blank value, if set.
 158 Typically,
 159 .Va DEBUG_FLAGS
 160 is set to
 161 .Fl g
 162 for compiling with debug symbols.
 163 .It Va NO_CPU_CFLAGS
 164 .Pq Vt str
 165 Setting this variable will prevent CPU specific compiler flags
 166 from being automatically added to
 167 .Va CFLAGS
 168 during compile time.
 169 .It Va CXXFLAGS
 170 .Pq Vt str
 171 Controls the compiler settings when compiling C++ code.
 172 .Va CXXFLAGS
 173 is initially set to the value of
 174 .Va CFLAGS .
 175 If you want to add to the
 176 .Va CXXFLAGS
 177 value, use
 178 .Dq Li +=
 179 instead of
 180 .Dq Li = .
 181 .It Va INSTALL
 182 .Pq Vt str
 183 the default install command.
 184 To have components compared before doing the install, use
 185 .Bd -literal -offset indent
 186 INSTALL="install -C"
 187 .Ed
 188 .It Va LOCAL_DIRS
 189 .Pq Vt str
 190 List any directories that should be entered when running make
 191 .Pa /usr/src
 192 in this variable.
 193 .It Va MAKE_SHELL
 194 .Pq Vt str
 195 Controls the shell used internally by
 196 .Xr make 1
 197 to process the command scripts in makefiles.
 198 .Xr sh 1 ,
 199 .Xr ksh 1 ,
 200 and
 201 .Xr csh 1
 202 all currently supported.
 203 .Bd -literal -offset indent
 204 MAKE_SHELL?=sh
 205 .Ed
 206 .It Va MODULES_OVERRIDE
 207 .Pq Vt str
 208 Set to a list of modules to build instead of all of them.
 209 .It Va MTREE_FOLLOWS_SYMLINKS
 210 .Pq Vt str
 211 Set this to
 212 .Dq Fl L
 213 to cause
 214 .Xr mtree 8
 215 to follow symlinks.
 216 .It Va STRIP
 217 .Pq Vt str
 218 Set this to the flag to pass to the
 219 .Xr strip 1
 220 command.
 221 If set to a blank value, debug symbols will not be removed.
 222 .Va STRIP
 223 is automatically set to a blank value if
 224 .Va DEBUG_FLAGS
 225 is set.
 226 .It Va WANT_HESIOD
 227 .Pq Vt bool
 228 Set this to build
 229 .Xr hesiod 3
 230 support into libc.
 231 .It Va NO_NS_CACHING
 232 .Pq Vt bool
 233 Set this to disable name caching in the nsswitch subsystem.
 234 The generic caching daemon,
 235 .Xr nscd 8 ,
 236 will not be built either if this option is set.
 237 .It Va NO_WERROR
 238 Set this if you don't want
 239 .Fl Werror
 240 to be added to
 241 .Va CWARNFLAGS .
 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_BIND
 344 .Pq Vt bool
 345 Set to not build BIND.
 346 .It Va NO_CRYPT
 347 .Pq Vt bool
 348 Set to not build crypto code.
 349 .It Va NO_CVS
 350 .Pq Vt bool
 351 Set to not build CVS.
 352 .It Va NO_GAMES
 353 .Pq Vt bool
 354 Set to not build games.
 355 .It Va NO_GCC44
 356 .Pq Vt bool
 357 Set to not build the newer version of GCC (4.4).
 358 .It Va NO_GDB
 359 .Pq Vt bool
 360 Set to not build
 361 .Xr gdb 1
 362 .It Va NO_I4B
 363 .Pq Vt bool
 364 Set to not build isdn4bsd package.
 365 .It Va NO_IPFILTER
 366 .Pq Vt bool
 367 Set to not build IP Filter package.
 368 .It Va NO_LIBC_R
 369 .Pq Vt bool
 370 Set to not build
 371 .Nm libc_r
 372 (reentrant version of
 373 .Nm libc ) .
 374 .It Va NO_LPR
 375 .Pq Vt bool
 376 Set to not build
 377 .Xr lpr 1
 378 and related programs.
 379 .It Va NO_MAILWRAPPER
 380 .Pq Vt bool
 381 Set to not build the
 382 .Xr mailwrapper 8
 383 MTA selector.
 384 .It Va NO_OBJC
 385 .Pq Vt bool
 386 Set to not build Objective C support.
 387 .It Va NO_OPENSSH
 388 .Pq Vt bool
 389 Set to not build OpenSSH.
 390 .It Va NO_OPENSSL
 391 .Pq Vt bool
 392 Set to not build OpenSSL (implies
 393 .Va NO_OPENSSH ) .
 394 .It Va NO_SENDMAIL
 395 .Pq Vt bool
 396 Set to not build
 397 .Xr sendmail 8
 398 and related programs.
 399 .It Va NO_SHARE
 400 .Pq Vt bool
 401 Set to not enter the share subdirectory.
 402 .It Va NO_X
 403 .Pq Vt bool
 404 Set to not compile in X\-Windows support (e.g.\&
 405 .Xr doscmd 1 ) .
 406 .It Va NOCLEAN
 407 .Pq Vt bool
 408 Set this to disable cleaning during
 409 .Dq Li "make buildworld" .
 410 This should not be set unless you know what you are doing.
 411 .It Va NOCLEANDIR
 412 .Pq Vt bool
 413 Set this to run
 414 .Dq Li "${MAKE} clean"
 415 instead of
 416 .Dq Li "${MAKE} cleandir" .
 417 .It Va NOFSCHG
 418 .Pq Vt bool
 419 Set to not install certain components with flag schg.
 420 This is useful in a jailed environment.
 421 .It Va NOINFO
 422 .Pq Vt bool
 423 Set to not make or install
 424 .Xr info 5
 425 files.
 426 .It Va NOINFOCOMPRESS
 427 .Pq Vt bool
 428 Set to not compress the info pages.
 429 .It Va NOMAN
 430 .Pq Vt bool
 431 Set to not build manual pages
 432 .It Va NOMANCOMPRESS
 433 .Pq Vt bool
 434 Set to not compress the manual pages.
 435 .It Va NOPROFILE
 436 .Pq Vt bool
 437 Set to avoid compiling profiled libraries.
 438 .It Va PPP_NOSUID
 439 .Pq Vt bool
 440 Set to disable the installation of
 441 .Xr ppp 8
 442 with the set-user-ID bit on.
 443 .It Va SENDMAIL_MC
 444 .Pq Vt str
 445 The default
 446 .Xr m4 1
 447 configuration file to use at install time.
 448 The value should include the full path to the
 449 .Pa .mc
 450 file, e.g.,
 451 .Pa /etc/mail/myconfig.mc .
 452 Use with caution as a make install will overwrite any existing
 453 .Pa /etc/mail/sendmail.cf .
 454 Note that
 455 .Va SENDMAIL_CF
 456 is now deprecated.
 457 .It Va SENDMAIL_SUBMIT_MC
 458 .Pq Vt str
 459 The default
 460 .Xr m4 1
 461 configuration file for mail submission
 462 to use at install time.
 463 The value should include the full path to the
 464 .Pa .mc
 465 file, e.g.,
 466 .Pa /etc/mail/mysubmit.mc .
 467 Use with caution as a make install will overwrite any existing
 468 .Pa /etc/mail/submit.cf .
 469 .It Va SENDMAIL_ADDITIONAL_MC
 470 .Pq Vt str
 471 Additional
 472 .Pa .mc
 473 files which should be built into
 474 .Pa .cf
 475 files at build time.
 476 The value should include the full path to the
 477 .Pa .mc
 478 file(s), e.g.,
 479 .Pa /etc/mail/foo.mc
 480 .Pa /etc/mail/bar.mc .
 481 .It Va SENDMAIL_CF_DIR
 482 .Pq Vt str
 483 Override the default location for the
 484 .Xr m4 1
 485 configuration files used to build a
 486 .Pa .cf
 487 file from a
 488 .Pa .mc
 489 file.
 490 .It Va SENDMAIL_M4_FLAGS
 491 .Pq Vt str
 492 Flags passed to
 493 .Xr m4 1
 494 when building a
 495 .Pa .cf
 496 file from a
 497 .Pa .mc
 498 file.
 499 .It Va SENDMAIL_CFLAGS
 500 .Pq Vt str
 501 Flags to pass to the compile command when building
 502 .Xr sendmail 8 .
 503 The
 504 .Va SENDMAIL_*
 505 flags can be used to provide SASL support with setting such as:
 506 .Bd -literal -offset indent
 507 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
 508 SENDMAIL_LDFLAGS=-L/usr/local/lib
 509 SENDMAIL_LDADD=-lsasl
 510 .Ed
 511 .It Va SENDMAIL_LDFLAGS
 512 .Pq Vt str
 513 Flags to pass to the
 514 .Xr ld 1
 515 command when building
 516 .Xr sendmail 8 .
 517 .It Va SENDMAIL_LDADD
 518 .Pq Vt str
 519 Flags to add to the end of the
 520 .Xr ld 1
 521 command when building
 522 .Xr sendmail 8 .
 523 .It Va SENDMAIL_DPADD
 524 .Pq Vt str
 525 Extra dependencies to add when building
 526 .Xr sendmail 8 .
 527 .It Va SENDMAIL_SET_USER_ID
 528 .Pq Vt bool
 529 If set, install
 530 .Xr sendmail 8
 531 as a set-user-ID root binary instead of a set-group-ID binary
 532 and do not install
 533 .Pa /etc/mail/submit.{cf,mc} .
 534 Use of this flag is not recommended and the alternative advice in
 535 .Pa /etc/mail/README
 536 should be followed instead if at all possible.
 537 .It Va SENDMAIL_MAP_PERMS
 538 .Pq Vt str
 539 Mode to use when generating alias and map database files using
 540 .Pa /etc/mail/Makefile .
 541 The default value is 0640.
 542 .It Va THREAD_LIB
 543 .Pq Vt str
 544 Set to either
 545 .Li c_r
 546 or
 547 .Li thread_xu
 548 to configure the system's default threading library.
 549 The default is
 550 .Li thread_xu .
 551 .It Va TOP_TABLE_SIZE
 552 .Pq Vt int
 553 .Xr top 1
 554 uses a hash table for the user names.  The size of this hash can be tuned
 555 to match the number of local users.  The table size should be a prime number
 556 approximately twice as large as the number of lines in
 557 .Pa /etc/passwd .
 558 The default number is 20011.
 559 .It Va WANT_IDEA
 560 .Pq Vt bool
 561 Set to build the IDEA encryption code.
 562 This code is patented in the USA and many European countries.
 563 It is
 564 .Em "YOUR RESPONSIBILITY"
 565 to determine if you can legally use IDEA.
 566 .It Va WANT_INSTALLER
 567 .Pq Vt bool
 568 Set to build the installer.
 569 .El
 570 .Pp
 571 The following list provides a name and short description for variables
 572 that are used when building documentation.
 573 .Bl -tag -width Ar
 574 .It Va DOC_LANG
 575 .Pq Vt str
 576 The list of languages and encodings to build and install.
 577 .It Va PRINTERDEVICE
 578 .Pq Vt str
 579 The default format for system documentation, depends on your
 580 printer.
 581 This can be set to
 582 .Dq Li ascii
 583 for simple printers or
 584 .Dq Li ps
 585 for postscript or graphics printers with a ghostscript
 586 filter.
 587 .It Va GROFF_PAPER_SIZE
 588 .Pq Vt str
 589 The default paper size for
 590 .Xr groff 1
 591 (either
 592 .Dq letter
 593 or
 594 .Dq A4 ) .
 595 .El
 596 .Sh FILES
 597 .Bl -tag -width /etc/defaults/make.conf -compact
 598 .It Pa /etc/defaults/make.conf
 599 .It Pa /etc/make.conf
 600 .It Pa /usr/src/Makefile
 601 .It Pa /usr/src/Makefile.inc1
 602 .El
 603 .Sh SEE ALSO
 604 .Xr gcc 1 ,
 605 .Xr install 1 ,
 606 .Xr make 1 ,
 607 .Xr lpd 8 ,
 608 .Xr sendmail 8
 609 .Sh HISTORY
 610 The
 611 .Nm
 612 file appeared sometime before
 613 .Fx 4.0 .
 614 .Sh AUTHORS
 615 This manual page was written by
 616 .An Mike W. Meyer Aq mwm@mired.org .