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