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