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