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 .\"
  27 .Dd January 28, 2018
  28 .Dt MAKE.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm make.conf
  32 .Nd system build information
  33 .Sh DESCRIPTION
  34 The file
  35 .Nm
  36 contains settings that control the compilation of the
  37 .Dx
  38 sources.
  39 The file
  40 .Nm
  41 is generally created by the system administrator when the values need
  42 to be changed from their defaults.
  43 .Pp
  44 The purpose of
  45 .Nm
  46 is not to run commands or perform compilation actions
  47 directly.
  48 Instead, it is included by the various makefiles in
  49 .Pa /usr/src
  50 which conditionalize their internal actions according to the settings
  51 found there.
  52 .Pp
  53 The
  54 .Pa /etc/make.conf
  55 file is included from the appropriate
  56 .Pa Makefile
  57 which specifies the default settings for all the available options.
  58 Options need only be specified in
  59 .Pa /etc/make.conf
  60 when the system administrator wishes to override these defaults.
  61 .Pp
  62 The build procedures occur in three areas: world, kernel, and
  63 documentation.
  64 Variables set in
  65 .Nm
  66 may be applicable during builds in one, two, or all of these areas.
  67 They may be specified for a particular build via the
  68 .Fl D
  69 option of
  70 .Xr make 1 .
  71 .Pp
  72 The following lists provide a name and short description for each
  73 variable you can use during the indicated builds.
  74 The values of variables flagged as
  75 .Vt bool
  76 are ignored; the variable being set at all (even to
  77 .Dq Li FALSE
  78 or
  79 .Dq Li NO )
  80 causes it to be treated as if it were set.
  81 .Pp
  82 The following list provides a name and short description for variables
  83 that are used for all builds, or are used by the
  84 .Pa makefiles
  85 for things other than builds.
  86 .Bl -tag -width Ar
  87 .It Va CPUTYPE
  88 .Pq Vt str
  89 Controls which processor should be targeted for generated code.
  90 This controls processor-specific optimizations in certain code
  91 (currently only OpenSSL) as well as modifying the value of
  92 .Va CFLAGS
  93 and
  94 .Va COPTFLAGS
  95 to contain the appropriate optimization directive to
  96 .Xr gcc 1 .
  97 The automatic setting of
  98 .Va CFLAGS
  99 and
 100 .Va COPTFLAGS
 101 may be overridden using the
 102 .Va NO_CPU_CFLAGS
 103 and
 104 .Va NO_CPU_COPTFLAGS
 105 variables, respectively.  Refer to
 106 .Pa /usr/share/examples/etc/defaults/make.conf
 107 for a list of recognized
 108 .Va CPUTYPE
 109 options.
 110 .It Va CCVER
 111 .Pq Vt str
 112 Controls which GCC version to use by default.
 113 It should be set as
 114 .Li CCVER?=
 115 so as not to interfere with overrides from userland.
 116 We currently recommend that an override NOT be set in
 117 .Pa /etc/make.conf .
 118 Currently accepted values for compilers which are part of
 119 .Dx
 120 are
 121 .Dq gcc47
 122 and
 123 .Dq gcc50
 124 (default).
 125 All other values will handled according to the settings in
 126 .Xr compilers.conf 5 .
 127 .It Va WORLD_CCVER
 128 .Pq Vt str
 129 Controls which version of GCC builds the base system, including
 130 the kernel.
 131 .Dq gcc50
 132 is the default value.
 133 .It Va LDVER
 134 .Pq Vt str
 135 Controls which linker to use by default.  Currently accepted
 136 values are
 137 .Dq ld.gold
 138 (GNU gold linker, default) and
 139 .Dq ld.bfd
 140 (classic GNU ld linker).
 141 .It Va WORLD_LDVER
 142 .Pq Vt str
 143 Controls which linker builds the base system, including
 144 the kernel.
 145 .Dq ld.gold
 146 is the default value.
 147 .It Va BINUTILSVER
 148 .Pq Vt str
 149 Controls which binutils to use by default.
 150 Currently accepted values are
 151 .Dq binutils225
 152 and
 153 .Dq binutils227
 154 (default).
 155 .It Va WORLD_BINUTILSVER
 156 .Pq Vt str
 157 Controls which version of binutils builds the base system, including
 158 the kernel.
 159 .Dq binutils227
 160 is the default value.
 161 .It Va WORLD_CFLAGS
 162 .Pq Vt str
 163 Controls the compiler setting when compiling C code.
 164 Optimization levels are controlled by
 165 .Va WORLD_CCOPTLEVEL .
 166 .Va BDECFLAGS
 167 is provided as a set of
 168 .Xr gcc 1
 169 settings suggested by
 170 .An Bruce Evans Aq Mt bde@FreeBSD.org
 171 for developing and testing changes.
 172 They can be used safely, if set, by:
 173 .Bd -literal -offset indent
 174 WORLD_CFLAGS+=${BDECFLAGS}
 175 .Ed
 176 .It Va WORLD_CCOPTLEVEL
 177 (str) Allows to override default compiler optimization level
 178 .Fl \&Ox .
 179 Common levels are: 0, 1, 2, 3, g, s, fast.
 180 Use of
 181 .Fl O3
 182 and
 183 .Fl Ofast
 184 is strongly discouraged.
 185 .It Va DEBUG_FLAGS
 186 .Pq Vt str
 187 Similar to
 188 .Va WORLD_CFLAGS
 189 but it will cause
 190 .Va STRIP
 191 to be set to a blank value, if set.
 192 Typically,
 193 .Va DEBUG_FLAGS
 194 is set to
 195 .Fl g
 196 for compiling with debug symbols.
 197 .It Va NO_CPU_CFLAGS
 198 .Pq Vt str
 199 Setting this variable will prevent CPU specific compiler flags
 200 from being automatically added to
 201 .Va CFLAGS
 202 during compile time.
 203 .It Va CXXFLAGS
 204 .Pq Vt str
 205 Controls the compiler settings when compiling C++ code.
 206 .Va CXXFLAGS
 207 is initially set to the value of
 208 .Va CFLAGS .
 209 If you want to add to the
 210 .Va CXXFLAGS
 211 value, use
 212 .Dq Li +=
 213 instead of
 214 .Dq Li = .
 215 .It Va INSTALL
 216 .Pq Vt str
 217 the default install command.
 218 To have components compared before doing the install, use
 219 .Bd -literal -offset indent
 220 INSTALL="install -C"
 221 .Ed
 222 .It Va NO_BACKUP
 223 .Pq Vt str
 224 Inhibit automatic backup of world binaries as port of
 225 .Dq installworld
 226 .Xr make 1
 227 target.
 228 Default is unset.
 229 .It Va WORLD_BACKUP
 230 .Pq Vt str
 231 defines where system binaries will be backed up for the
 232 .Dq backupworld
 233 .Xr make 1
 234 target.
 235 The default is
 236 .Dq /var/backups/world_backup .
 237 .It Va AUTO_BACKUP
 238 .Pq Vt str
 239 defines where system binaries will be backed up automatically
 240 as part of the
 241 .Dq installworld
 242 .Xr make 1
 243 target.
 244 The default is
 245 .Dq Ev MAKEOBJDIRPREFIX Ns /world_binaries/ Ns Ev DESTDIR .
 246 .It Va LOCAL_DIRS
 247 .Pq Vt str
 248 List of directories that should be entered when running
 249 .Xr make 1
 250 in
 251 .Pa /usr/src .
 252 .It Va MAKE_SHELL
 253 .Pq Vt str
 254 Controls the shell used internally by
 255 .Xr make 1
 256 to process the command scripts in makefiles.
 257 .Xr sh 1 ,
 258 .Xr ksh 1 ,
 259 and
 260 .Xr csh 1
 261 all currently supported.
 262 .Bd -literal -offset indent
 263 MAKE_SHELL?=sh
 264 .Ed
 265 .It Va MODULES_OVERRIDE
 266 .Pq Vt str
 267 Set to a list of modules to build instead of all of them.
 268 .It Va MTREE_FOLLOWS_SYMLINKS
 269 .Pq Vt str
 270 Set this to
 271 .Dq Fl L
 272 to cause
 273 .Xr mtree 8
 274 to follow symlinks.
 275 .It Va STRIP
 276 .Pq Vt str
 277 Set this to the flag to pass to the
 278 .Xr strip 1
 279 command.
 280 If set to a blank value, debug symbols will not be removed.
 281 .Va STRIP
 282 is automatically set to a blank value if
 283 .Va DEBUG_FLAGS
 284 is set.
 285 .It Va WANT_HESIOD
 286 .Pq Vt bool
 287 Set this to build
 288 .Xr hesiod 3
 289 support into libc.
 290 .It Va NO_NS_CACHING
 291 .Pq Vt bool
 292 Set this to disable name caching in the nsswitch subsystem.
 293 The generic caching daemon,
 294 .Xr nscd 8 ,
 295 will not be built either if this option is set.
 296 .It Va NO_WERROR
 297 Set this if you don't want
 298 .Fl Werror
 299 to be added to
 300 .Va CWARNFLAGS
 301 or used in the kernel build.
 302 .It Va STATIC_LOCALES
 303 .Pq Vt str
 304 Set to a list of locales to build into statically-linked binaries.
 305 Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
 306 .El
 307 .Pp
 308 The following list provides a name and short description for variables
 309 that are only used doing a kernel build:
 310 .Bl -tag -width Ar
 311 .It Va BOOT_COMCONSOLE_PORT
 312 .Pq Vt str
 313 The port address to use for the console if the boot blocks have
 314 been configured to use a serial console instead of the keyboard/video card.
 315 .It Va BOOT_COMCONSOLE_SPEED
 316 .Pq Vt int
 317 The baud rate to use for the console if the boot blocks have
 318 been configured to use a serial console instead of the keyboard/video card.
 319 .It Va COPTFLAGS
 320 .Pq Vt str
 321 Controls the compiler optimization settings for kernel and module compiles.
 322 .It Va KCFLAGS
 323 Allows you to add additional compiler flags for kernel and module compiles.
 324 But use
 325 .Va COPTFLAGS
 326 .Pq Vt str
 327 to specify any optimization overrides, as some modules may have to override
 328 it to enforce a lower optimization level.
 329 .It Va KERNCONF
 330 .Pq Vt str
 331 Controls which kernel configurations will be
 332 built by
 333 .Dq Li "${MAKE} buildkernel"
 334 and installed by
 335 .Dq Li "${MAKE} installkernel" .
 336 For example,
 337 .Bd -literal -offset indent
 338 KERNCONF=MINE DEBUG X86_64_GENERIC OTHERMACHINE
 339 .Ed
 340 .Pp
 341 will build the kernels specified by the config files
 342 .Pa MINE , DEBUG , X86_64_GENERIC ,
 343 and
 344 .Pa OTHERMACHINE ,
 345 and install the kernel specified by the config file
 346 .Pa MINE .
 347 It defaults to
 348 .Pa X86_64_GENERIC .
 349 .It Va NO_CPU_COPTFLAGS
 350 .Pq Vt str
 351 Setting this variable will prevent CPU specific compiler flags
 352 from being automatically added to
 353 .Va COPTFLAGS
 354 during compile time.
 355 .It Va NO_KERNELCLEAN
 356 .Pq Vt bool
 357 Set this to skip the clean target when using
 358 .Dq Li "${MAKE} buildkernel" .
 359 .It Va NO_KERNELCONFIG
 360 .Pq Vt bool
 361 Set this to skip running
 362 .Xr config 8
 363 during
 364 .Dq Li "${MAKE} buildkernel" .
 365 .It Va NO_KERNELDEPEND
 366 .Pq Vt bool
 367 Set this to skip running
 368 .Dq Li "${MAKE} depend"
 369 during
 370 .Dq Li "${MAKE} buildkernel" .
 371 .It Va NO_KERNEL_OLD_STRIP
 372 .Pq Vt bool
 373 Set this to skip stripping debugging symbols from old kernel and modules
 374 (kernel.old, modules.old) during
 375 .Dq Li "${MAKE} installkernel" .
 376 .It Va NO_MODULES
 377 .Pq Vt bool
 378 Set to not build modules with the kernel.
 379 .El
 380 .Pp
 381 The following list provides a name and short description for variables
 382 that are used during the world build:
 383 .Bl -tag -width Ar
 384 .It Va ENABLE_SUID_SSH
 385 .Pq Vt bool
 386 Set this to install
 387 .Xr ssh 1
 388 with the setuid bit turned on.
 389 .It Va MODULES_WITH_WORLD
 390 .Pq Vt bool
 391 Set to build modules with the system instead of the kernel.
 392 .It Va NO_ALTBINUTILS
 393 .Pq Vt bool
 394 Set to not build the alternative (non-default) set of binutils.
 395 .It Va NO_ALTCOMPILER
 396 .Pq Vt bool
 397 Set to not build the designated secondary compiler (GCC 4.7 and others).
 398 .It Va NO_CVS
 399 .Pq Vt bool
 400 Set to not build CVS.
 401 .It Va NO_GAMES
 402 .Pq Vt bool
 403 Set to not build games.
 404 .It Va NO_GDB
 405 .Pq Vt bool
 406 Set to not build
 407 .Xr gdb 1
 408 .It Va NO_LIBC_R
 409 .Pq Vt bool
 410 Set to not build
 411 .Nm libc_r
 412 (reentrant version of
 413 .Nm libc ) .
 414 .It Va NO_LPR
 415 .Pq Vt bool
 416 Set to not build
 417 .Xr lpr 1
 418 and related programs.
 419 .It Va NO_SHARE
 420 .Pq Vt bool
 421 Set to not enter or install to the share subdirectory.
 422 .It Va NOCLEAN
 423 .Pq Vt bool
 424 Set this to disable cleaning during
 425 .Dq Li "make buildworld" .
 426 This should not be set unless you know what you are doing.
 427 .It Va NOCLEANDIR
 428 .Pq Vt bool
 429 Set this to run
 430 .Dq Li "${MAKE} clean"
 431 instead of
 432 .Dq Li "${MAKE} cleandir" .
 433 .It Va NOFSCHG
 434 .Pq Vt bool
 435 Set to not install certain components with flag schg.
 436 This is useful in a jailed environment.
 437 .It Va NOMAN
 438 .Pq Vt bool
 439 Set to not build manual pages
 440 .It Va NOMANCOMPRESS
 441 .Pq Vt bool
 442 Set to not compress the manual pages.
 443 .It Va NOPROFILE
 444 .Pq Vt bool
 445 Set to avoid compiling profiled libraries.
 446 .It Va PPP_NOSUID
 447 .Pq Vt bool
 448 Set to disable the installation of
 449 .Xr ppp 8
 450 with the set-user-ID bit on.
 451 .It Va XAUTH_PATH
 452 .Pq Vt str
 453 The path to the xauth program used by OpenSSH client.
 454 .It Va SENDMAIL_MC
 455 .Pq Vt str
 456 The default
 457 .Xr m4 1
 458 configuration file to use at install time.
 459 The value should include the full path to the
 460 .Pa .mc
 461 file, e.g.,
 462 .Pa /etc/mail/myconfig.mc .
 463 Use with caution as a make install will overwrite any existing
 464 .Pa /etc/mail/sendmail.cf .
 465 .It Va SENDMAIL_SUBMIT_MC
 466 .Pq Vt str
 467 The default
 468 .Xr m4 1
 469 configuration file for mail submission
 470 to use at install time.
 471 The value should include the full path to the
 472 .Pa .mc
 473 file, e.g.,
 474 .Pa /etc/mail/mysubmit.mc .
 475 Use with caution as a make install will overwrite any existing
 476 .Pa /etc/mail/submit.cf .
 477 .It Va SENDMAIL_CF_DIR
 478 .Pq Vt str
 479 Override the default location for the
 480 .Xr m4 1
 481 configuration files used to build a
 482 .Pa .cf
 483 file from a
 484 .Pa .mc
 485 file.
 486 The default is
 487 .Pa /usr/local/share/sendmail/cf .
 488 .It Va SENDMAIL_M4_FLAGS
 489 .Pq Vt str
 490 Flags passed to
 491 .Xr m4 1
 492 when building a
 493 .Pa .cf
 494 file from a
 495 .Pa .mc
 496 file.
 497 .It Va SENDMAIL_MAP_PERMS
 498 .Pq Vt str
 499 Mode to use when generating alias and map database files using
 500 .Pa /etc/mail/Makefile .
 501 The default value is 0640.
 502 .It Va THREAD_LIB
 503 .Pq Vt str
 504 Set to either
 505 .Li c_r
 506 or
 507 .Li thread_xu
 508 to configure the system's default threading library.
 509 The default is
 510 .Li thread_xu .
 511 .It Va WANT_INSTALLER
 512 .Pq Vt bool
 513 Set to build the installer.
 514 .It Va WANT_NETGRAPH7
 515 .Pq Vt bool
 516 Set to build a newer, experimental
 517 .Xr netgraph 4
 518 userland.
 519 It has to be accompanied by
 520 .Dv NETGRAPH7*
 521 options in the kernel.
 522 .El
 523 .Pp
 524 The following list provides a name and short description for variables
 525 that are used when performing various audit builds.
 526 .Bl -tag -width Ar
 527 .It Va FORMAT_AUDIT
 528 Enable extra format checking related warnings.
 529 .It Va WARNS_AUDIT
 530 Include skipped or moved warning flags for a given
 531 .Va WARNS
 532 level in the
 533 .Pa makefiles .
 534 .El
 535 .Pp
 536 The following list provides a name and short description for variables
 537 that are used when building documentation.
 538 .Bl -tag -width Ar
 539 .It Va PRINTERDEVICE
 540 .Pq Vt str
 541 The default format for system documentation, depends on your
 542 printer.
 543 This can be set to
 544 .Dq Li ascii
 545 for simple printers or
 546 .Dq Li ps
 547 for postscript or graphics printers with a ghostscript
 548 filter.
 549 .It Va GROFF_PAPER_SIZE
 550 .Pq Vt str
 551 The default paper size for
 552 .Xr groff 1
 553 (either
 554 .Dq letter
 555 or
 556 .Dq A4 ) .
 557 .El
 558 .Sh FILES
 559 .Bl -tag -width /etc/defaults/make.conf -compact
 560 .It Pa /etc/defaults/make.conf
 561 .It Pa /etc/make.conf
 562 .It Pa /usr/src/Makefile
 563 .It Pa /usr/src/Makefile.inc1
 564 .El
 565 .Sh SEE ALSO
 566 .Xr gcc 1 ,
 567 .Xr install 1 ,
 568 .Xr make 1 ,
 569 .Xr lpd 8
 570 .Sh HISTORY
 571 The
 572 .Nm
 573 file appeared sometime before
 574 .Fx 4.0 .
 575 .Sh AUTHORS
 576 This manual page was written by
 577 .An Mike W. Meyer Aq Mt mwm@mired.org .