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 January 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 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 WITH_GCPIO
 209 .Pq Vt bool
 210 Set this to use
 211 .Xr gcpio 1
 212 as the standard
 213 .Xr cpio 1 .
 214 The default is to use
 215 .Xr bsdcpio 1 .
 216 .It Va WANT_HESIOD
 217 .Pq Vt bool
 218 Set this to build
 219 .Xr hesiod 3
 220 support into libc.
 221 .It Va NO_NS_CACHING
 222 .Pq Vt bool
 223 Set this to disable name caching in the nsswitch subsystem.
 224 The generic caching daemon,
 225 .Xr nscd 8 ,
 226 will not be built either if this option is set.
 227 .El
 228 .Pp
 229 The following list provides a name and short description for variables
 230 that are only used doing a kernel build:
 231 .Bl -tag -width Ar
 232 .It Va BOOT_COMCONSOLE_PORT
 233 .Pq Vt str
 234 The port address to use for the console if the boot blocks have
 235 been configured to use a serial console instead of the keyboard/video card.
 236 .It Va BOOT_COMCONSOLE_SPEED
 237 .Pq Vt int
 238 The baud rate to use for the console if the boot blocks have
 239 been configured to use a serial console instead of the keyboard/video card.
 240 .It Va COPTFLAGS
 241 .Pq Vt str
 242 Controls the compiler settings when building the
 243 kernel.
 244 Optimization levels above
 245 .Fl O
 246 .Pq Fl O2 , No ...
 247 are not guaranteed to work.
 248 .It Va KERNCONF
 249 .Pq Vt str
 250 Controls which kernel configurations will be
 251 built by
 252 .Dq Li "${MAKE} buildkernel"
 253 and installed by
 254 .Dq Li "${MAKE} installkernel" .
 255 For example,
 256 .Bd -literal -offset indent
 257 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
 258 .Ed
 259 .Pp
 260 will build the kernels specified by the config files
 261 .Pa MINE , DEBUG , GENERIC ,
 262 and
 263 .Pa OTHERMACHINE ,
 264 and install the kernel specified by the config file
 265 .Pa MINE .
 266 It defaults to
 267 .Pa GENERIC .
 268 .It Va LOADER_TFTP_SUPPORT
 269 .Pq Vt bool
 270 While not a buildkernel-affected option, there is no better place for this.
 271 By default the
 272 .Xr pxeboot 8
 273 loader retrieves the kernel via NFS.
 274 Defining this and recompiling
 275 .Pa /usr/src/sys/boot
 276 will cause it to retrieve the kernel via TFTP.
 277 This allows pxeboot to load a custom BOOTP diskless kernel yet
 278 still mount the server's
 279 .Pa /
 280 rather than load the server's kernel.
 281 .It Va NO_CPU_COPTFLAGS
 282 .Pq Vt str
 283 Setting this variable will prevent CPU specific compiler flags
 284 from being automatically added to
 285 .Va COPTFLAGS
 286 during compile time.
 287 .It Va NO_KERNELCLEAN
 288 .Pq Vt bool
 289 Set this to skip the clean target when using
 290 .Dq Li "${MAKE} buildkernel" .
 291 .It Va NO_KERNELCONFIG
 292 .Pq Vt bool
 293 Set this to skip running
 294 .Xr config 8
 295 during
 296 .Dq Li "${MAKE} buildkernel" .
 297 .It Va NO_KERNELDEPEND
 298 .Pq Vt bool
 299 Set this to skip running
 300 .Dq Li "${MAKE} depend"
 301 during
 302 .Dq Li "${MAKE} buildkernel" .
 303 .It Va NO_KERNEL_OLD_STRIP
 304 .Pq Vt bool
 305 Set this to skip stripping debugging symbols from old kernel and modules
 306 (kernel.old, modules.old) during
 307 .Dq Li "${MAKE} installkernel" .
 308 .It Va NO_MODULES
 309 .Pq Vt bool
 310 Set to not build modules with the kernel.
 311 .El
 312 .Pp
 313 The following list provides a name and short description for variables
 314 that are used during the world build:
 315 .Bl -tag -width Ar
 316 .It Va ENABLE_SUID_K5SU
 317 .Pq Vt bool
 318 Set this if you wish to use the k5su utility.
 319 Otherwise, it will be installed without the set-user-ID bit set.
 320 This is only relevant if
 321 .Va WANT_KERBEROS
 322 is defined.
 323 .It Va ENABLE_SUID_SSH
 324 .Pq Vt bool
 325 Set this to install
 326 .Xr ssh 1
 327 with the setuid bit turned on.
 328 .It Va MODULES_WITH_WORLD
 329 .Pq Vt bool
 330 Set to build modules with the system instead of the kernel.
 331 .It Va NO_BIND
 332 .Pq Vt bool
 333 Set to not build BIND.
 334 .It Va NO_CRYPT
 335 .Pq Vt bool
 336 Set to not build crypto code.
 337 .It Va NO_CVS
 338 .Pq Vt bool
 339 Set to not build CVS.
 340 .It Va NO_GAMES
 341 .Pq Vt bool
 342 Set to not build games.
 343 .It Va NO_GCC34
 344 .Pq Vt bool
 345 Set to not build the older version of GCC (3.4).
 346 .It Va NO_GDB
 347 .Pq Vt bool
 348 Set to not build
 349 .Xr gdb 1
 350 .It Va NO_I4B
 351 .Pq Vt bool
 352 Set to not build isdn4bsd package.
 353 .It Va NO_IPFILTER
 354 .Pq Vt bool
 355 Set to not build IP Filter package.
 356 .It Va NO_LIBC_R
 357 .Pq Vt bool
 358 Set to not build
 359 .Nm libc_r
 360 (reentrant version of
 361 .Nm libc ) .
 362 .It Va NO_LPR
 363 .Pq Vt bool
 364 Set to not build
 365 .Xr lpr 1
 366 and related programs.
 367 .It Va NO_MAILWRAPPER
 368 .Pq Vt bool
 369 Set to not build the
 370 .Xr mailwrapper 8
 371 MTA selector.
 372 .It Va NO_MAKEDEV
 373 .Pq Vt bool
 374 Set to avoid running
 375 .Dq Li "MAKEDEV all"
 376 on
 377 .Pa /dev
 378 during install.
 379 .It Va NO_OBJC
 380 .Pq Vt bool
 381 Set to not build Objective C support.
 382 .It Va NO_OPENSSH
 383 .Pq Vt bool
 384 Set to not build OpenSSH.
 385 .It Va NO_OPENSSL
 386 .Pq Vt bool
 387 Set to not build OpenSSL (implies
 388 .Va NO_OPENSSH ) .
 389 .It Va NO_SENDMAIL
 390 .Pq Vt bool
 391 Set to not build
 392 .Xr sendmail 8
 393 and related programs.
 394 .It Va NO_SHARE
 395 .Pq Vt bool
 396 Set to not enter the share subdirectory.
 397 .It Va NO_X
 398 .Pq Vt bool
 399 Set to not compile in X\-Windows support (e.g.\&
 400 .Xr doscmd 1 ) .
 401 .It Va NOCLEAN
 402 .Pq Vt bool
 403 Set this to disable cleaning during
 404 .Dq Li "make buildworld" .
 405 This should not be set unless you know what you are doing.
 406 .It Va NOCLEANDIR
 407 .Pq Vt bool
 408 Set this to run
 409 .Dq Li "${MAKE} clean"
 410 instead of
 411 .Dq Li "${MAKE} cleandir" .
 412 .It Va NOFSCHG
 413 .Pq Vt bool
 414 Set to not install certain components with flag schg.
 415 This is useful in a jailed environment.
 416 .It Va NOINFO
 417 .Pq Vt bool
 418 Set to not make or install
 419 .Xr info 5
 420 files.
 421 .It Va NOINFOCOMPRESS
 422 .Pq Vt bool
 423 Set to not compress the info pages.
 424 .It Va NOMAN
 425 .Pq Vt bool
 426 Set to not build manual pages
 427 .It Va NOMANCOMPRESS
 428 .Pq Vt bool
 429 Set to not compress the manual pages.
 430 .It Va NOPROFILE
 431 .Pq Vt bool
 432 Set to avoid compiling profiled libraries.
 433 .It Va PPP_NOSUID
 434 .Pq Vt bool
 435 Set to disable the installation of
 436 .Xr ppp 8
 437 with the set-user-ID bit on.
 438 .It Va SENDMAIL_MC
 439 .Pq Vt str
 440 The default
 441 .Xr m4 1
 442 configuration file 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/myconfig.mc .
 447 Use with caution as a make install will overwrite any existing
 448 .Pa /etc/mail/sendmail.cf .
 449 Note that
 450 .Va SENDMAIL_CF
 451 is now deprecated.
 452 .It Va SENDMAIL_SUBMIT_MC
 453 .Pq Vt str
 454 The default
 455 .Xr m4 1
 456 configuration file for mail submission
 457 to use at install time.
 458 The value should include the full path to the
 459 .Pa .mc
 460 file, e.g.,
 461 .Pa /etc/mail/mysubmit.mc .
 462 Use with caution as a make install will overwrite any existing
 463 .Pa /etc/mail/submit.cf .
 464 .It Va SENDMAIL_ADDITIONAL_MC
 465 .Pq Vt str
 466 Additional
 467 .Pa .mc
 468 files which should be built into
 469 .Pa .cf
 470 files at build time.
 471 The value should include the full path to the
 472 .Pa .mc
 473 file(s), e.g.,
 474 .Pa /etc/mail/foo.mc
 475 .Pa /etc/mail/bar.mc .
 476 .It Va SENDMAIL_CF_DIR
 477 .Pq Vt str
 478 Override the default location for the
 479 .Xr m4 1
 480 configuration files used to build a
 481 .Pa .cf
 482 file from a
 483 .Pa .mc
 484 file.
 485 .It Va SENDMAIL_M4_FLAGS
 486 .Pq Vt str
 487 Flags passed to
 488 .Xr m4 1
 489 when building a
 490 .Pa .cf
 491 file from a
 492 .Pa .mc
 493 file.
 494 .It Va SENDMAIL_CFLAGS
 495 .Pq Vt str
 496 Flags to pass to the compile command when building
 497 .Xr sendmail 8 .
 498 The
 499 .Va SENDMAIL_*
 500 flags can be used to provide SASL support with setting such as:
 501 .Bd -literal -offset indent
 502 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
 503 SENDMAIL_LDFLAGS=-L/usr/local/lib
 504 SENDMAIL_LDADD=-lsasl
 505 .Ed
 506 .It Va SENDMAIL_LDFLAGS
 507 .Pq Vt str
 508 Flags to pass to the
 509 .Xr ld 1
 510 command when building
 511 .Xr sendmail 8 .
 512 .It Va SENDMAIL_LDADD
 513 .Pq Vt str
 514 Flags to add to the end of the
 515 .Xr ld 1
 516 command when building
 517 .Xr sendmail 8 .
 518 .It Va SENDMAIL_DPADD
 519 .Pq Vt str
 520 Extra dependencies to add when building
 521 .Xr sendmail 8 .
 522 .It Va SENDMAIL_SET_USER_ID
 523 .Pq Vt bool
 524 If set, install
 525 .Xr sendmail 8
 526 as a set-user-ID root binary instead of a set-group-ID binary
 527 and do not install
 528 .Pa /etc/mail/submit.{cf,mc} .
 529 Use of this flag is not recommended and the alternative advice in
 530 .Pa /etc/mail/README
 531 should be followed instead if at all possible.
 532 .It Va SENDMAIL_MAP_PERMS
 533 .Pq Vt str
 534 Mode to use when generating alias and map database files using
 535 .Pa /etc/mail/Makefile .
 536 The default value is 0640.
 537 .It Va THREAD_LIB
 538 .Pq Vt str
 539 Set to either
 540 .Li c_r
 541 or
 542 .Li thread_xu
 543 to configure the system's default threading library.
 544 The default is
 545 .Li thread_xu .
 546 .It Va TOP_TABLE_SIZE
 547 .Pq Vt int
 548 .Xr top 1
 549 uses a hash table for the user names.  The size of this hash can be tuned
 550 to match the number of local users.  The table size should be a prime number
 551 approximately twice as large as the number of lines in
 552 .Pa /etc/passwd .
 553 The default number is 20011.
 554 .It Va WANT_IDEA
 555 .Pq Vt bool
 556 Set to build the IDEA encryption code.
 557 This code is patented in the USA and many European countries.
 558 It is
 559 .Em "YOUR RESPONSIBILITY"
 560 to determine if you can legally use IDEA.
 561 .It Va WANT_INSTALLER
 562 .Pq Vt bool
 563 Set to build the installer.
 564 .It Va WANT_KERBEROS
 565 .Pq Vt bool
 566 Set this to build Kerberos5 (KTH Heimdal).
 567 .Em WARNING !
 568 This is still experimental code.
 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 .
 617 .Sh BUGS
 618 This manual page may occasionally be out of date with respect to
 619 the options currently available for use in
 620 .Nm .
 621 Please check the
 622 .Pa /etc/defaults/make.conf
 623 file for the latest options which are available.