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