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