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