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