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_SSH
 306 .Pq Vt bool
 307 Set this to install
 308 .Xr ssh 1
 309 with the setuid bit turned on.
 310 .It Va MODULES_WITH_WORLD
 311 .Pq Vt bool
 312 Set to build modules with the system instead of the kernel.
 313 .It Va NO_BIND
 314 .Pq Vt bool
 315 Set to not build BIND.
 316 .It Va NO_CRYPT
 317 .Pq Vt bool
 318 Set to not build crypto code.
 319 .It Va NO_CVS
 320 .Pq Vt bool
 321 Set to not build CVS.
 322 .It Va NO_GAMES
 323 .Pq Vt bool
 324 Set to not build games.
 325 .It Va NO_GCC44
 326 .Pq Vt bool
 327 Set to not build the newer version of GCC (4.4).
 328 .It Va NO_GDB
 329 .Pq Vt bool
 330 Set to not build
 331 .Xr gdb 1
 332 .It Va NO_I4B
 333 .Pq Vt bool
 334 Set to not build isdn4bsd package.
 335 .It Va NO_IPFILTER
 336 .Pq Vt bool
 337 Set to not build IP Filter package.
 338 .It Va NO_LIBC_R
 339 .Pq Vt bool
 340 Set to not build
 341 .Nm libc_r
 342 (reentrant version of
 343 .Nm libc ) .
 344 .It Va NO_LPR
 345 .Pq Vt bool
 346 Set to not build
 347 .Xr lpr 1
 348 and related programs.
 349 .It Va NO_MAILWRAPPER
 350 .Pq Vt bool
 351 Set to not build the
 352 .Xr mailwrapper 8
 353 MTA selector.
 354 .It Va NO_OBJC
 355 .Pq Vt bool
 356 Set to not build Objective C support.
 357 .It Va NO_OPENSSH
 358 .Pq Vt bool
 359 Set to not build OpenSSH.
 360 .It Va NO_OPENSSL
 361 .Pq Vt bool
 362 Set to not build OpenSSL (implies
 363 .Va NO_OPENSSH ) .
 364 .It Va NO_SENDMAIL
 365 .Pq Vt bool
 366 Set to not build
 367 .Xr sendmail 8
 368 and related programs.
 369 .It Va NO_SHARE
 370 .Pq Vt bool
 371 Set to not enter the share subdirectory.
 372 .It Va NO_X
 373 .Pq Vt bool
 374 Set to not compile in X\-Windows support (e.g.\&
 375 .Xr doscmd 1 ) .
 376 .It Va NOCLEAN
 377 .Pq Vt bool
 378 Set this to disable cleaning during
 379 .Dq Li "make buildworld" .
 380 This should not be set unless you know what you are doing.
 381 .It Va NOCLEANDIR
 382 .Pq Vt bool
 383 Set this to run
 384 .Dq Li "${MAKE} clean"
 385 instead of
 386 .Dq Li "${MAKE} cleandir" .
 387 .It Va NOFSCHG
 388 .Pq Vt bool
 389 Set to not install certain components with flag schg.
 390 This is useful in a jailed environment.
 391 .It Va NOINFO
 392 .Pq Vt bool
 393 Set to not make or install
 394 .Xr info 5
 395 files.
 396 .It Va NOINFOCOMPRESS
 397 .Pq Vt bool
 398 Set to not compress the info pages.
 399 .It Va NOMAN
 400 .Pq Vt bool
 401 Set to not build manual pages
 402 .It Va NOMANCOMPRESS
 403 .Pq Vt bool
 404 Set to not compress the manual pages.
 405 .It Va NOPROFILE
 406 .Pq Vt bool
 407 Set to avoid compiling profiled libraries.
 408 .It Va PPP_NOSUID
 409 .Pq Vt bool
 410 Set to disable the installation of
 411 .Xr ppp 8
 412 with the set-user-ID bit on.
 413 .It Va SENDMAIL_MC
 414 .Pq Vt str
 415 The default
 416 .Xr m4 1
 417 configuration file to use at install time.
 418 The value should include the full path to the
 419 .Pa .mc
 420 file, e.g.,
 421 .Pa /etc/mail/myconfig.mc .
 422 Use with caution as a make install will overwrite any existing
 423 .Pa /etc/mail/sendmail.cf .
 424 Note that
 425 .Va SENDMAIL_CF
 426 is now deprecated.
 427 .It Va SENDMAIL_SUBMIT_MC
 428 .Pq Vt str
 429 The default
 430 .Xr m4 1
 431 configuration file for mail submission
 432 to use at install time.
 433 The value should include the full path to the
 434 .Pa .mc
 435 file, e.g.,
 436 .Pa /etc/mail/mysubmit.mc .
 437 Use with caution as a make install will overwrite any existing
 438 .Pa /etc/mail/submit.cf .
 439 .It Va SENDMAIL_ADDITIONAL_MC
 440 .Pq Vt str
 441 Additional
 442 .Pa .mc
 443 files which should be built into
 444 .Pa .cf
 445 files at build time.
 446 The value should include the full path to the
 447 .Pa .mc
 448 file(s), e.g.,
 449 .Pa /etc/mail/foo.mc
 450 .Pa /etc/mail/bar.mc .
 451 .It Va SENDMAIL_CF_DIR
 452 .Pq Vt str
 453 Override the default location for the
 454 .Xr m4 1
 455 configuration files used to build a
 456 .Pa .cf
 457 file from a
 458 .Pa .mc
 459 file.
 460 .It Va SENDMAIL_M4_FLAGS
 461 .Pq Vt str
 462 Flags passed to
 463 .Xr m4 1
 464 when building a
 465 .Pa .cf
 466 file from a
 467 .Pa .mc
 468 file.
 469 .It Va SENDMAIL_CFLAGS
 470 .Pq Vt str
 471 Flags to pass to the compile command when building
 472 .Xr sendmail 8 .
 473 The
 474 .Va SENDMAIL_*
 475 flags can be used to provide SASL support with setting such as:
 476 .Bd -literal -offset indent
 477 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
 478 SENDMAIL_LDFLAGS=-L/usr/local/lib
 479 SENDMAIL_LDADD=-lsasl
 480 .Ed
 481 .It Va SENDMAIL_LDFLAGS
 482 .Pq Vt str
 483 Flags to pass to the
 484 .Xr ld 1
 485 command when building
 486 .Xr sendmail 8 .
 487 .It Va SENDMAIL_LDADD
 488 .Pq Vt str
 489 Flags to add to the end of the
 490 .Xr ld 1
 491 command when building
 492 .Xr sendmail 8 .
 493 .It Va SENDMAIL_DPADD
 494 .Pq Vt str
 495 Extra dependencies to add when building
 496 .Xr sendmail 8 .
 497 .It Va SENDMAIL_SET_USER_ID
 498 .Pq Vt bool
 499 If set, install
 500 .Xr sendmail 8
 501 as a set-user-ID root binary instead of a set-group-ID binary
 502 and do not install
 503 .Pa /etc/mail/submit.{cf,mc} .
 504 Use of this flag is not recommended and the alternative advice in
 505 .Pa /etc/mail/README
 506 should be followed instead if at all possible.
 507 .It Va SENDMAIL_MAP_PERMS
 508 .Pq Vt str
 509 Mode to use when generating alias and map database files using
 510 .Pa /etc/mail/Makefile .
 511 The default value is 0640.
 512 .It Va THREAD_LIB
 513 .Pq Vt str
 514 Set to either
 515 .Li c_r
 516 or
 517 .Li thread_xu
 518 to configure the system's default threading library.
 519 The default is
 520 .Li thread_xu .
 521 .It Va TOP_TABLE_SIZE
 522 .Pq Vt int
 523 .Xr top 1
 524 uses a hash table for the user names.  The size of this hash can be tuned
 525 to match the number of local users.  The table size should be a prime number
 526 approximately twice as large as the number of lines in
 527 .Pa /etc/passwd .
 528 The default number is 20011.
 529 .It Va WANT_IDEA
 530 .Pq Vt bool
 531 Set to build the IDEA encryption code.
 532 This code is patented in the USA and many European countries.
 533 It is
 534 .Em "YOUR RESPONSIBILITY"
 535 to determine if you can legally use IDEA.
 536 .It Va WANT_INSTALLER
 537 .Pq Vt bool
 538 Set to build the installer.
 539 .El
 540 .Pp
 541 The following list provides a name and short description for variables
 542 that are used when building documentation.
 543 .Bl -tag -width Ar
 544 .It Va DOC_LANG
 545 .Pq Vt str
 546 The list of languages and encodings to build and install.
 547 .It Va PRINTERDEVICE
 548 .Pq Vt str
 549 The default format for system documentation, depends on your
 550 printer.
 551 This can be set to
 552 .Dq Li ascii
 553 for simple printers or
 554 .Dq Li ps
 555 for postscript or graphics printers with a ghostscript
 556 filter.
 557 .It Va GROFF_PAPER_SIZE
 558 .Pq Vt str
 559 The default paper size for
 560 .Xr groff 1
 561 (either
 562 .Dq letter
 563 or
 564 .Dq A4 ) .
 565 .El
 566 .Sh FILES
 567 .Bl -tag -width /etc/defaults/make.conf -compact
 568 .It Pa /etc/defaults/make.conf
 569 .It Pa /etc/make.conf
 570 .It Pa /usr/src/Makefile
 571 .It Pa /usr/src/Makefile.inc1
 572 .El
 573 .Sh SEE ALSO
 574 .Xr gcc 1 ,
 575 .Xr install 1 ,
 576 .Xr make 1 ,
 577 .Xr lpd 8 ,
 578 .Xr sendmail 8
 579 .Sh HISTORY
 580 The
 581 .Nm
 582 file appeared sometime before
 583 .Fx 4.0 .
 584 .Sh AUTHORS
 585 This manual page was written by
 586 .An Mike W. Meyer Aq mwm@mired.org .
 587 .Sh BUGS
 588 This manual page may occasionally be out of date with respect to
 589 the options currently available for use in
 590 .Nm .
 591 Please check the
 592 .Pa /etc/defaults/make.conf
 593 file for the latest options which are available.