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$ 26.\" 27.Dd November 3, 2000 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.Fx 38sources 39and ported applications. 40The file 41.Nm 42is generally created by the system administrator when the values need 43to be changed from their defaults. 44.Pp 45The purpose of 46.Nm 47is not to run commands or perform compilation actions 48directly. 49Instead, it is included by the 50various makefiles in 51.Pa /usr/src , 52.Pa /usr/ports 53and 54.Pa /usr/doc 55which conditionalize their 56internal actions according to the settings found there. 57.Pp 58The 59.Pa /etc/make.conf 60file is included from the appropriate 61.Pa Makefile 62which specifies the default settings for all the available options. 63Options need only be specified in 64.Pa /etc/make.conf 65when the system administrator wishes to override these defaults. 66.Pp 67The build procedures occur in four broad areas: the world, the kernel, 68documentations and ports. 69Variables set in 70.Nm 71may be applicable during builds in one, two, or all four of these 72areas. 73They may be specified for a particular build via the 74.Fl D 75option of 76.Xr make 1 . 77.Pp 78The following lists provide a name and short description for each 79variable you can use during the indicated builds. 80The values of 81variables flagged as 82.Vt bool 83are ignored; the variable being 84set at all (even to 85.Dq Li FALSE 86or 87.Dq Li NO ) 88causes it to 89be treated as if it were set. 90.Pp 91The following list provides a name and short description for variables 92that are used for all builds, or are used by the 93.Pa makefiles 94for things other than builds. 95.Bl -tag -width Ar 96.It Va ALWAYS_CHECK_MAKE 97.Pq Vt bool 98Instructs the top-level makefile in the source tree (normally 99.Pa /usr/src ) 100to always check if 101.Xr make 1 102is up-to-date. 103Normally this is only done for the world and buildworld targets to handle 104upgrades from older versions of 105.Fx . 106.It Va CFLAGS 107.Pq Vt str 108Controls the compiler setting when compiling C code. 109Optimization levels above 110.Fl O 111.Pq Fl O2 , No ... 112are not supported. 113.Va BDECFLAGS 114is provided as a set of 115.Xr gcc 1 116settings suggested by 117.An "Bruce Evans" Aq bde@FreeBSD.org 118for developing and testing changes. 119They can be used, if set, by: 120.Pp 121.Bd -literal -offset indent 122CFLAGS+=${BDECFLAGS} 123.Ed 124.It Va CPUTYPE 125.Pq Vt str 126Controls which processor should be targeted for generated 127code. 128This controls processor-specific optimizations in 129certain code (currently only OpenSSL) as well as modifying 130the value of 131.Va CFLAGS 132and 133.Va COPTFLAGS 134to contain the appropriate optimization directive to 135.Xr gcc 1 . 136The automatic setting of 137.Va CFLAGS 138and 139.Va COPTFLAGS 140may be overridden using the 141.Va NO_CPU_CFLAGS 142and 143.Va NO_CPU_COPTFLAGS 144variables, respectively. 145Refer to 146.Pa /usr/share/examples/etc/make.conf 147for a list of recognized 148.Va CPUTYPE 149options. 150.It Va NO_CPU_CFLAGS 151.Pq Vt str 152Setting this variable will prevent CPU specific compiler flags 153from being automatically added to 154.Va CFLAGS 155during compile time. 156.It Va NO_CPU_COPTFLAGS 157.Pq Vt str 158Setting this variable will prevent CPU specific compiler flags 159from being automatically added to 160.Va COPTFLAGS 161during compile time. 162.It Va CVS_UPDATE 163.Pq Vt bool 164Set this to use 165.Xr cvs 1 166to update your ports with 167.Dq Li "make update" . 168.It Va CXXFLAGS 169.Pq Vt str 170Controls the compiler settings when compiling C++ code. 171.Va CXXFLAGS 172is initially set to the value of 173.Va CFLAGS . 174If you want to 175add to the 176.Va CXXFLAGS 177value, use 178.Dq Li += 179instead of 180.Dq Li = . 181.It Va INSTALL 182.Pq Vt str 183the default install command. 184To install only files for which the target differs or does not exist, use 185.Bd -literal -offset indent 186INSTALL="install -C" 187.Ed 188Note that some makefiles (including those in 189.Pa /usr/share/mk ) 190may hardcode options for the supplied install command. 191.It Va LOCAL_DIRS 192.Pq Vt str 193List any directories that should be entered when doing 194make's in 195.Pa /usr/src 196in this variable. 197.It Va MAKE_SHELL 198.Pq Vt str 199Controls the shell used internally by 200.Xr make 1 201to process the command scripts in makefiles. 202.Xr sh 1 , 203.Xr ksh 1 , 204and 205.Xr csh 1 206all currently supported. 207.Pp 208.Dl "MAKE_SHELL?=sh" 209.It Va MTREE_FOLLOWS_SYMLINKS 210.Pq Vt str 211Set this to 212.Dq Fl L 213to cause 214.Xr mtree 8 215to follow symlinks. 216.It Va NO_DOCUPDATE 217.Pq Vt bool 218Set this to not update the doc tree during 219.Dq Li "make update" . 220.It Va NO_PORTSUPDATE 221.Pq Vt bool 222Set this to not update the ports tree during 223.Dq Li "make update" . 224.It Va SUP_UPDATE 225.Pq Vt bool 226Set this to use 227.Xr cvsup 1 228to update your ports with 229.Dq Li "make update" . 230.It Va SUP 231.Pq Vt str 232The location of the 233.Xr cvsup 1 234command for 235.Dq Li "make update" . 236.It Va SUPFLAGS 237.Pq Vt str 238The flag for the 239.Xr sup 1 240command when doing 241.Dq Li "make update" . 242This defaults to 243.Op Fl g L Ar 2 . 244.It Va SUPHOST 245.Pq Vt str 246The hostname of the sup server to use when doing 247.Dq Li "make update" . 248.It Va SUPFILE 249.Pq Vt str 250The first 251.Ar supfile 252to use when doing a 253.Dq Li "make update" . 254This defaults to 255.Pa /usr/share/examples/cvsup/standard\-supfile . 256.It Va SUPFILE1 257.Pq Vt str 258The second 259.Ar supfile 260to use when doing a 261.Dq Li "make update" . 262This defaults to 263.Pa /usr/share/examples/cvsup/secure\-supfile . 264.It Va SUPFILE2 265.Pq Vt str 266The third 267.Ar supfile 268to use when doing a 269.Dq Li "make update" . 270This defaults to 271.Pa /usr/share/examples/cvsup/secure\-supfile . 272.It Va PORTSSUPFILE 273.Pq Vt str 274The ports 275.Ar supfile 276to use when doing a 277.Dq Li "make update" . 278This defaults to 279.Pa /usr/share/examples/cvsup/ports\-supfile . 280.It Va DOCSUPFILE 281.Pq Vt str 282The documentation 283.Ar supfile 284to use when doing a 285.Dq Li "make update" . 286This defaults to 287.Pa /usr/share/examples/cvsup/doc\-supfile . 288.El 289.Pp 290The following list provides a name and short description for variables 291that are only used doing a kernel build: 292.Bl -tag -width Ar 293.It Va BOOT_COMCONSOLE_PORT 294.Pq Vt str 295The port address to use for the console if the boot blocks have 296been configured to use a serial console instead of the keyboard/video card. 297.It Va BOOT_COMCONSOLE_SPEED 298.Pq Vt int 299The baud rate to use for the console if the boot blocks have 300been configured to use a serial console instead of the keyboard/video card. 301.It Va BOOTWAIT 302.Pq Vt int 303Controls the amount of time the kernel waits for a console keypress 304before booting the default kernel. 305The value is approximately milliseconds. 306Keypresses are accepted by the BIOS before booting from disk, 307making it possible to give custom boot parameters even when this is 308set to 0. 309.It Va COPTFLAGS 310.Pq Vt str 311Controls the compiler settings when building the 312kernel. 313Optimization levels above 314.Oo Fl O ( O2 , No ...\& ) Oc 315are not guaranteed to work. 316.It Va KERNCONF 317.Pq Vt str 318Controls which kernel configurations will be 319built by 320.Dq Li "${MAKE} buildkernel" 321and installed by 322.Dq Li "${MAKE} installkernel" . 323For example, 324.Bd -literal -offset indent 325KERNCONF=MINE DEBUG GENERIC OTHERMACHINE 326.Ed 327.Pp 328will build the kernels specified by the config files 329.Pa MINE , DEBUG , GENERIC , 330and 331.Pa OTHERMACHINE , 332and install the kernel specified by the config file 333.Pa MINE . 334It defaults to 335.Pa GENERIC . 336.It Va LOADER_TFTP_SUPPORT 337.Pq Vt bool 338While not a buildkernel-affected option, there is no better place for this. 339By default the 340.Xr pxeboot 8 341loader retrieves the kernel via NFS. 342Defining this and recompiling 343.Pa /usr/src/sys/boot 344will cause it to retrieve the kernel via TFTP. 345This allows 346.Xr pxeboot 8 347to load a custom BOOTP diskless kernel yet 348still mount the server's 349.Pa / 350rather than load the server's kernel. 351.It Va MODULES_OVERRIDE 352.Pq Vt str 353Set to a list of modules to build instead of all of them. 354.It Va NO_KERNELCONFIG 355.Pq Vt bool 356Set this to skip running 357.Xr config 8 358during 359.Dq Li "${MAKE} buildkernel" . 360.It Va NO_KERNELDEPEND 361.Pq Vt bool 362Set this to skip running 363.Dq Li "${MAKE} depend" 364during 365.Dq Li "${MAKE} buildkernel" . 366.It Va NO_MODULES 367.Pq Vt bool 368Set to not build modules with the kernel. 369.El 370.Pp 371The following list provides a name and short description for variables 372that are used during the world build: 373.Bl -tag -width Ar 374.It Va COMPAT1X 375.Pq Vt bool 376Set to install the 377.Fx 3781 compatibility libraries. 379.It Va COMPAT20 380.Pq Vt bool 381Set to install the 382.Fx 2.0 383compatibility libraries. 384.It Va COMPAT21 385.Pq Vt bool 386Set to install the 387.Fx 2.1 388compatibility libraries. 389.It Va COMPAT22 390.Pq Vt bool 391Set to install the 392.Fx 2.2 393compatibility libraries. 394.It Va COMPAT3X 395.Pq Vt bool 396Set to install the 397.Fx 3983 399compatibility libraries. 400.It Va COMPAT4X 401.Pq Vt bool 402Set to install the 403.Fx 4044 405compatibility libraries. 406.It Va FETCH_CMD 407.Pq Vt str 408Command to use to fetch files. 409Normally 410.Xr fetch 1 . 411.It Va KRB5_HOME 412.Pq Vt str 413If you want to install the MIT Kerberos5 port somewhere other than 414.Pa /usr/local , 415define this. 416This is also used to tell ssh1 that Kerberos is needed. 417.It Va MAKE_IDEA 418.Pq Vt bool 419Set to build the IDEA encryption code. 420This code is patented in the USA and many European countries. 421It is 422.Em "YOUR RESPONSIBILITY" 423to determine if you can legally use IDEA. 424.It Va NO_DYNAMICROOT 425.Pq Vt bool 426Set this if you do not want to link 427.Pa /bin 428and 429.Pa /sbin 430dynamically. 431.It Va NO_KERBEROS 432.Pq Vt bool 433Set this if you do not want to build Kerberos 5 (KTH Heimdal). 434.It Va ENABLE_SUID_K5SU 435.Pq Vt bool 436Set this if you wish to use the ksu utility. 437Otherwise, it will be 438installed without the set-user-ID bit set. 439.It Va ENABLE_SUID_NEWGRP 440.Pq Vt bool 441Set this to install 442.Xr newgrp 1 443with the set-user-ID bit set. 444Otherwise, 445.Xr newgrp 1 446will not be able to change users' groups. 447.It Va ENABLE_SUID_SSH 448.Pq Vt bool 449Set this to install 450.Xr ssh 1 451with the set-user-ID bit turned on. 452.It Va MODULES_WITH_WORLD 453.Pq Vt bool 454Set to build modules with the system instead of the kernel. 455.It Va NO_BLUETOOTH 456.Pq Vt bool 457Set to not build Bluetooth related kernel modules, programs and libraries. 458.It Va NO_CVS 459.Pq Vt bool 460Set to not build CVS. 461.It Va NO_CXX 462.Pq Vt bool 463Set to not build 464.Xr g++ 1 465and related libraries. 466.It Va NO_BIND 467.Pq Vt bool 468Set to not build BIND. 469.It Va NO_FORTRAN 470.Pq Vt bool 471Set to not build 472.Xr g77 1 473and related libraries. 474.It Va NO_GDB 475.Pq Vt bool 476Set to not build 477.Xr gdb 1 . 478.It Va NO_I4B 479.Pq Vt bool 480Set to not build isdn4bsd package. 481.It Va NO_IPFILTER 482.Pq Vt bool 483Set to not build IP Filter package. 484.It Va NO_TOOLCHAIN 485.Pq Vt bool 486Set to not build 487programs used for program development, 488compilers, debuggers etc. 489.It Va NOINET6 490.Pq Vt bool 491Set to not build 492programs and libraries related to IPv6 networking. 493.It Va NOATM 494.Pq Vt bool 495Set to not build 496programs and libraries related to ATM networking. 497.It Va NO_USB 498.Pq Vt bool 499Set to not build 500.Xr usbd 8 501and related programs. 502.It Va NO_LPR 503.Pq Vt bool 504Set to not build 505.Xr lpr 1 506and related programs. 507.It Va NO_ACPI 508.Pq Vt bool 509Set to not build 510.Xr acpiconf 8 , 511.Xr acpidump 8 512and related programs. 513.It Va NO_VINUM 514.Pq Vt bool 515Set to not build 516.Xr vinum 8 517and related programs. 518.It Va NO_MAILWRAPPER 519.Pq Vt bool 520Set to not build the 521.Xr mailwrapper 8 522MTA selector. 523.It Va NOMAN 524.Pq Vt bool 525Set to not build manual pages. 526.It Va NO_OBJC 527.Pq Vt bool 528Set to not build Objective C support. 529.It Va NO_OPENSSH 530.Pq Vt bool 531Set to not build OpenSSH. 532.It Va NO_OPENSSL 533.Pq Vt bool 534Set to not build OpenSSL (implies 535.Va NO_KERBEROS 536and 537.Va NO_OPENSSH ) . 538.It Va NO_SENDMAIL 539.Pq Vt bool 540Set to not build 541.Xr sendmail 8 542and related programs. 543.It Va NO_SHAREDOCS 544.Pq Vt bool 545Set to not build the 546.Bx 4.4 547legacy docs. 548.It Va NO_TCSH 549.Pq Vt bool 550Set to not build and install 551.Pa /bin/csh 552(which is 553.Xr tcsh 1 ) . 554.It Va NOCLEAN 555.Pq Vt bool 556Set this to disable cleaning during 557.Dq Li "make buildworld" . 558This should not be set unless you know what you are doing. 559.It Va NOCLEANDIR 560.Pq Vt bool 561Set this to run 562.Dq Li "${MAKE} clean" 563instead of 564.Dq Li "${MAKE} cleandir" . 565.It Va NOCRYPT 566.Pq Vt bool 567Set to not build any crypto code. 568.It Va NOGAMES 569.Pq Vt bool 570Set to not build games. 571.It Va NOINFO 572.Pq Vt bool 573Set to not make or install 574.Xr info 5 575files. 576.It Va NOLIBC_R 577.Pq Vt bool 578Set to not build 579.Nm libc_r 580(reentrant version of 581.Nm libc ) . 582.It Va NOLIBPTHREAD 583.Pq Vt bool 584Set to not build the 585.Nm libpthread 586(M:N threading) 587library. 588.It Va NOLIBTHR 589.Pq Vt bool 590Set to not build the 591.Nm libthr 592(1:1 threading) 593library. 594.It Va NOMANCOMPRESS 595.Pq Vt bool 596Set to install man pages uncompressed. 597.It Va NOPROFILE 598.Pq Vt bool 599Set to avoid compiling profiled libraries. 600.It Va NOSHARE 601.Pq Vt bool 602Set to not build in the 603.Pa share 604subdir. 605.It Va PPP_NOSUID 606.Pq Vt bool 607Set to disable the installation of 608.Xr ppp 8 609as an suid root program. 610.It Va SENDMAIL_MC 611.Pq Vt str 612The default m4 configuration file to use at install time. 613The value should include the full path to the 614.Pa .mc 615file, e.g., 616.Pa /etc/mail/myconfig.mc . 617Use with caution as a make install will overwrite any existing 618.Pa /etc/mail/sendmail.cf . 619Note that 620.Va SENDMAIL_CF 621is now deprecated. 622.It Va SENDMAIL_SUBMIT_MC 623.Pq Vt str 624The default m4 configuration file for mail submission 625to use at install time. 626The value should include the full path to the 627.Pa .mc 628file, e.g., 629.Pa /etc/mail/mysubmit.mc . 630Use with caution as a make install will overwrite any existing 631.Pa /etc/mail/submit.cf . 632.It Va SENDMAIL_ADDITIONAL_MC 633.Pq Vt str 634Additional 635.Pa .mc 636files which should be built into 637.Pa .cf 638files at build time. 639The value should include the full path to the 640.Pa .mc 641file(s), e.g., 642.Pa /etc/mail/foo.mc 643.Pa /etc/mail/bar.mc . 644.It Va SENDMAIL_CF_DIR 645.Pq Vt str 646Override the default location for the m4 configuration files used to build a 647.Pa .cf 648file from a 649.Pa .mc 650file. 651.It Va SENDMAIL_M4_FLAGS 652.Pq Vt str 653Flags passed to m4 when building a 654.Pa .cf 655file from a 656.Pa .mc 657file. 658.It Va SENDMAIL_CFLAGS 659.Pq Vt str 660Flags to pass to the compile command when building 661.Xr sendmail 8 . 662The 663.Va SENDMAIL_* 664flags can be used to provide SASL support with setting such as: 665.Bd -literal -offset indent 666SENDMAIL_CFLAGS=-I/usr/local/include -DSASL 667SENDMAIL_LDFLAGS=-L/usr/local/lib 668SENDMAIL_LDADD=-lsasl 669.Ed 670.It Va SENDMAIL_LDFLAGS 671.Pq Vt str 672Flags to pass to the 673.Xr ld 1 674command when building 675.Xr sendmail 8 . 676.It Va SENDMAIL_LDADD 677.Pq Vt str 678Flags to add to the end of the 679.Xr ld 1 680command when building 681.Xr sendmail 8 . 682.It Va SENDMAIL_DPADD 683.Pq Vt str 684Extra dependencies to add when building 685.Xr sendmail 8 . 686.It Va SENDMAIL_SET_USER_ID 687.Pq Vt bool 688If set, install 689.Xr sendmail 8 690as a set-user-ID root binary instead of a set-group-ID binary 691and do not install 692.Pa /etc/mail/submit.{cf,mc} . 693Use of this flag is not recommended and the alternative advice in 694.Pa /etc/mail/README 695should be followed instead if at all possible. 696.It Va SENDMAIL_MAP_PERMS 697.Pq Vt str 698Mode to use when generating alias and map database files using 699.Pa /etc/mail/Makefile . 700The default value is 0640. 701.It Va TOP_TABLE_SIZE 702.Pq Vt int 703.Xr top 1 704uses a hash table for the user names. 705The size of this hash can be tuned to match the number of local users. 706The table size should be a prime number 707approximately twice as large as the number of lines in 708.Pa /etc/passwd . 709The default number is 20011. 710.It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE 711.Pq Vt int 712Causes the system compiler to be built such that it forces high optimization 713levels to a lower one. 714.Xr gcc 1 715.Fl O2 716and above is known to trigger known optimizer bugs at various 717times \(em this is worse on the Alpha platform. 718The value assigned is the highest optimization value used. 719.El 720.Pp 721The following list provides a name and short description for variables 722that are used when building documentation. 723.Bl -tag -width Ar 724.It Va DISTDIR 725.Pq Vt str 726Where distfiles are kept. 727Normally, this is 728.Pa distfiles 729in 730.Va PORTSDIR . 731.It Va DOC_LANG 732.Pq Vt str 733The list of languages and encodings to build and install. 734.It Va PRINTERDEVICE 735.Pq Vt str 736The default format for system documentation, depends on your 737printer. 738This can be set to 739.Dq Li ascii 740for simple printers, or 741.Dq Li ps 742for postscript or graphics printers with a ghostscript 743filter, or both. 744.El 745.Sh FILES 746.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact 747.It Pa /etc/make.conf 748.It Pa /usr/doc/Makefile 749.It Pa /usr/share/examples/etc/make.conf 750.It Pa /usr/src/Makefile 751.It Pa /usr/src/Makefile.inc1 752.El 753.Sh SEE ALSO 754.Xr gcc 1 , 755.Xr install 1 , 756.Xr make 1 , 757.Xr ports 7 , 758.Xr lpd 8 , 759.Xr sendmail 8 760.Sh HISTORY 761The 762.Nm 763file appeared sometime before 764.Fx 4.0 . 765.Sh AUTHORS 766This 767manual page was written by 768.An Mike W. Meyer Aq mwm@mired.org . 769.Sh BUGS 770This manual page may occasionally be out of date with respect to 771the options currently available for use in 772.Nm . 773Please check the 774.Pa /usr/share/examples/etc/make.conf 775file for the latest options which are available. 776