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 August 19, 2004 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 other than 110.Fl O 111and 112.Fl O2 113are not supported. 114.Va BDECFLAGS 115is provided as a set of 116.Xr gcc 1 117settings suggested by 118.An "Bruce Evans" Aq bde@FreeBSD.org 119for developing and testing changes. 120They can be used, if set, by: 121.Pp 122.Bd -literal -offset indent 123CFLAGS+=${BDECFLAGS} 124.Ed 125.It Va CPUTYPE 126.Pq Vt str 127Controls which processor should be targeted for generated 128code. 129This controls processor-specific optimizations in 130certain code (currently only OpenSSL) as well as modifying 131the value of 132.Va CFLAGS 133and 134.Va COPTFLAGS 135to contain the appropriate optimization directive to 136.Xr gcc 1 . 137The automatic setting of 138.Va CFLAGS 139and 140.Va COPTFLAGS 141may be overridden using the 142.Va NO_CPU_CFLAGS 143and 144.Va NO_CPU_COPTFLAGS 145variables, respectively. 146Refer to 147.Pa /usr/share/examples/etc/make.conf 148for a list of recognized 149.Va CPUTYPE 150options. 151.It Va NO_CPU_CFLAGS 152.Pq Vt str 153Setting this variable will prevent CPU specific compiler flags 154from being automatically added to 155.Va CFLAGS 156during compile time. 157.It Va NO_CPU_COPTFLAGS 158.Pq Vt str 159Setting this variable will prevent CPU specific compiler flags 160from being automatically added to 161.Va COPTFLAGS 162during compile time. 163.It Va CVS_UPDATE 164.Pq Vt bool 165Set this to use 166.Xr cvs 1 167to update your ports with 168.Dq Li "make update" . 169.It Va CXXFLAGS 170.Pq Vt str 171Controls the compiler settings when compiling C++ code. 172.Va CXXFLAGS 173is initially set to the value of 174.Va CFLAGS . 175If you want to 176add to the 177.Va CXXFLAGS 178value, use 179.Dq Li += 180instead of 181.Dq Li = . 182.It Va INSTALL 183.Pq Vt str 184the default install command. 185To install only files for which the target differs or does not exist, use 186.Bd -literal -offset indent 187INSTALL="install -C" 188.Ed 189Note that some makefiles (including those in 190.Pa /usr/share/mk ) 191may hardcode options for the supplied install command. 192.It Va LOCAL_DIRS 193.Pq Vt str 194List any directories that should be entered when doing 195make's in 196.Pa /usr/src 197in this variable. 198.It Va MAKE_SHELL 199.Pq Vt str 200Controls the shell used internally by 201.Xr make 1 202to process the command scripts in makefiles. 203.Xr sh 1 , 204.Xr ksh 1 , 205and 206.Xr csh 1 207all currently supported. 208.Pp 209.Dl "MAKE_SHELL?=sh" 210.It Va MTREE_FOLLOWS_SYMLINKS 211.Pq Vt str 212Set this to 213.Dq Fl L 214to cause 215.Xr mtree 8 216to follow symlinks. 217.It Va NO_DOCUPDATE 218.Pq Vt bool 219Set this to not update the doc tree during 220.Dq Li "make update" . 221.It Va NO_PORTSUPDATE 222.Pq Vt bool 223Set this to not update the ports tree during 224.Dq Li "make update" . 225.It Va SUP_UPDATE 226.Pq Vt bool 227Set this to use 228.Xr cvsup 1 229to update your ports with 230.Dq Li "make update" . 231.It Va SUP 232.Pq Vt str 233The location of the 234.Xr cvsup 1 235command for 236.Dq Li "make update" . 237.It Va SUPFLAGS 238.Pq Vt str 239The flag for the 240.Xr sup 1 241command when doing 242.Dq Li "make update" . 243This defaults to 244.Op Fl g L Ar 2 . 245.It Va SUPHOST 246.Pq Vt str 247The hostname of the sup server to use when doing 248.Dq Li "make update" . 249.It Va SUPFILE 250.Pq Vt str 251The first 252.Ar supfile 253to use when doing a 254.Dq Li "make update" . 255This defaults to 256.Pa /usr/share/examples/cvsup/standard\-supfile . 257.It Va SUPFILE1 258.Pq Vt str 259The second 260.Ar supfile 261to use when doing a 262.Dq Li "make update" . 263This defaults to 264.Pa /usr/share/examples/cvsup/secure\-supfile . 265.It Va SUPFILE2 266.Pq Vt str 267The third 268.Ar supfile 269to use when doing a 270.Dq Li "make update" . 271This defaults to 272.Pa /usr/share/examples/cvsup/secure\-supfile . 273.It Va PORTSSUPFILE 274.Pq Vt str 275The ports 276.Ar supfile 277to use when doing a 278.Dq Li "make update" . 279This defaults to 280.Pa /usr/share/examples/cvsup/ports\-supfile . 281.It Va DOCSUPFILE 282.Pq Vt str 283The documentation 284.Ar supfile 285to use when doing a 286.Dq Li "make update" . 287This defaults to 288.Pa /usr/share/examples/cvsup/doc\-supfile . 289.El 290.Pp 291The following list provides a name and short description for variables 292that are only used doing a kernel build: 293.Bl -tag -width Ar 294.It Va BOOT_COMCONSOLE_PORT 295.Pq Vt str 296The port address to use for the console if the boot blocks have 297been configured to use a serial console instead of the keyboard/video card. 298.It Va BOOT_COMCONSOLE_SPEED 299.Pq Vt int 300The baud rate to use for the console if the boot blocks have 301been configured to use a serial console instead of the keyboard/video card. 302.It Va BOOTWAIT 303.Pq Vt int 304Controls the amount of time the kernel waits for a console keypress 305before booting the default kernel. 306The value is approximately milliseconds. 307Keypresses are accepted by the BIOS before booting from disk, 308making it possible to give custom boot parameters even when this is 309set to 0. 310.It Va COPTFLAGS 311.Pq Vt str 312Controls the compiler settings when building the 313kernel. 314Optimization levels above 315.Oo Fl O ( O2 , No ...\& ) Oc 316are not guaranteed to work. 317.It Va KERNCONF 318.Pq Vt str 319Controls which kernel configurations will be 320built by 321.Dq Li "${MAKE} buildkernel" 322and installed by 323.Dq Li "${MAKE} installkernel" . 324For example, 325.Bd -literal -offset indent 326KERNCONF=MINE DEBUG GENERIC OTHERMACHINE 327.Ed 328.Pp 329will build the kernels specified by the config files 330.Pa MINE , DEBUG , GENERIC , 331and 332.Pa OTHERMACHINE , 333and install the kernel specified by the config file 334.Pa MINE . 335It defaults to 336.Pa GENERIC . 337.It Va LOADER_TFTP_SUPPORT 338.Pq Vt bool 339While not a buildkernel-affected option, there is no better place for this. 340By default the 341.Xr pxeboot 8 342loader retrieves the kernel via NFS. 343Defining this and recompiling 344.Pa /usr/src/sys/boot 345will cause it to retrieve the kernel via TFTP. 346This allows 347.Xr pxeboot 8 348to load a custom BOOTP diskless kernel yet 349still mount the server's 350.Pa / 351rather than load the server's kernel. 352.It Va MODULES_OVERRIDE 353.Pq Vt str 354Set to a list of modules to build instead of all of them. 355.It Va NO_KERNELCONFIG 356.Pq Vt bool 357Set this to skip running 358.Xr config 8 359during 360.Dq Li "${MAKE} buildkernel" . 361.It Va NO_KERNELDEPEND 362.Pq Vt bool 363Set this to skip running 364.Dq Li "${MAKE} depend" 365during 366.Dq Li "${MAKE} buildkernel" . 367.It Va NO_MODULES 368.Pq Vt bool 369Set to not build modules with the kernel. 370.El 371.Pp 372The following list provides a name and short description for variables 373that are used during the world build: 374.Bl -tag -width Ar 375.It Va COMPAT1X 376.Pq Vt bool 377Set to install the 378.Fx 3791 compatibility libraries. 380.It Va COMPAT20 381.Pq Vt bool 382Set to install the 383.Fx 2.0 384compatibility libraries. 385.It Va COMPAT21 386.Pq Vt bool 387Set to install the 388.Fx 2.1 389compatibility libraries. 390.It Va COMPAT22 391.Pq Vt bool 392Set to install the 393.Fx 2.2 394compatibility libraries. 395.It Va COMPAT3X 396.Pq Vt bool 397Set to install the 398.Fx 3993 400compatibility libraries. 401.It Va COMPAT4X 402.Pq Vt bool 403Set to install the 404.Fx 4054 406compatibility libraries. 407.It Va MAKE_IDEA 408.Pq Vt bool 409Set to build the IDEA encryption code. 410This code is patented in the USA and many European countries. 411It is 412.Em "YOUR RESPONSIBILITY" 413to determine if you can legally use IDEA. 414.It Va NO_DYNAMICROOT 415.Pq Vt bool 416Set this if you do not want to link 417.Pa /bin 418and 419.Pa /sbin 420dynamically. 421.It Va NO_KERBEROS 422.Pq Vt bool 423Set this if you do not want to build Kerberos 5 (KTH Heimdal). 424.It Va ENABLE_SUID_K5SU 425.Pq Vt bool 426Set this if you wish to use the ksu utility. 427Otherwise, it will be 428installed without the set-user-ID bit set. 429.It Va ENABLE_SUID_NEWGRP 430.Pq Vt bool 431Set this to install 432.Xr newgrp 1 433with the set-user-ID bit set. 434Otherwise, 435.Xr newgrp 1 436will not be able to change users' groups. 437.It Va ENABLE_SUID_SSH 438.Pq Vt bool 439Set this to install 440.Xr ssh 1 441with the set-user-ID bit turned on. 442.It Va MODULES_WITH_WORLD 443.Pq Vt bool 444Set to build modules with the system instead of the kernel. 445.It Va NO_BLUETOOTH 446.Pq Vt bool 447Set to not build Bluetooth related kernel modules, programs and libraries. 448.It Va NO_BOOT 449.Pq Vt bool 450Set to not build the boot blocks and loader. 451.It Va NO_CVS 452.Pq Vt bool 453Set to not build CVS. 454.It Va NO_CXX 455.Pq Vt bool 456Set to not build 457.Xr g++ 1 458and related libraries. 459.It Va NO_BIND 460.Pq Vt bool 461Set to not build BIND. 462.It Va NO_FORTRAN 463.Pq Vt bool 464Set to not build 465.Xr g77 1 466and related libraries. 467.It Va NO_GDB 468.Pq Vt bool 469Set to not build 470.Xr gdb 1 . 471.It Va NO_I4B 472.Pq Vt bool 473Set to not build isdn4bsd package. 474.It Va NO_IPFILTER 475.Pq Vt bool 476Set to not build IP Filter package. 477.It Va NO_PF 478.Pq Vt bool 479Set to not build PF firewall package. 480.It Va NO_AUTHPF 481.Pq Vt bool 482Set to not build 483.Xr authpf 8 . 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 613.Xr m4 1 614configuration file to use at install time. 615The value should include the full path to the 616.Pa .mc 617file, e.g., 618.Pa /etc/mail/myconfig.mc . 619Use with caution as a make install will overwrite any existing 620.Pa /etc/mail/sendmail.cf . 621Note that 622.Va SENDMAIL_CF 623is now deprecated. 624.It Va SENDMAIL_SUBMIT_MC 625.Pq Vt str 626The default 627.Xr m4 1 628configuration file for mail submission 629to use at install time. 630The value should include the full path to the 631.Pa .mc 632file, e.g., 633.Pa /etc/mail/mysubmit.mc . 634Use with caution as a make install will overwrite any existing 635.Pa /etc/mail/submit.cf . 636.It Va SENDMAIL_ADDITIONAL_MC 637.Pq Vt str 638Additional 639.Pa .mc 640files which should be built into 641.Pa .cf 642files at build time. 643The value should include the full path to the 644.Pa .mc 645file(s), e.g., 646.Pa /etc/mail/foo.mc 647.Pa /etc/mail/bar.mc . 648.It Va SENDMAIL_CF_DIR 649.Pq Vt str 650Override the default location for the 651.Xr m4 1 652configuration files used to build a 653.Pa .cf 654file from a 655.Pa .mc 656file. 657.It Va SENDMAIL_M4_FLAGS 658.Pq Vt str 659Flags passed to 660.Xr m4 1 661when building a 662.Pa .cf 663file from a 664.Pa .mc 665file. 666.It Va SENDMAIL_CFLAGS 667.Pq Vt str 668Flags to pass to the compile command when building 669.Xr sendmail 8 . 670The 671.Va SENDMAIL_* 672flags can be used to provide SASL support with setting such as: 673.Bd -literal -offset indent 674SENDMAIL_CFLAGS=-I/usr/local/include -DSASL 675SENDMAIL_LDFLAGS=-L/usr/local/lib 676SENDMAIL_LDADD=-lsasl 677.Ed 678.It Va SENDMAIL_LDFLAGS 679.Pq Vt str 680Flags to pass to the 681.Xr ld 1 682command when building 683.Xr sendmail 8 . 684.It Va SENDMAIL_LDADD 685.Pq Vt str 686Flags to add to the end of the 687.Xr ld 1 688command when building 689.Xr sendmail 8 . 690.It Va SENDMAIL_DPADD 691.Pq Vt str 692Extra dependencies to add when building 693.Xr sendmail 8 . 694.It Va SENDMAIL_SET_USER_ID 695.Pq Vt bool 696If set, install 697.Xr sendmail 8 698as a set-user-ID root binary instead of a set-group-ID binary 699and do not install 700.Pa /etc/mail/submit.{cf,mc} . 701Use of this flag is not recommended and the alternative advice in 702.Pa /etc/mail/README 703should be followed instead if at all possible. 704.It Va SENDMAIL_MAP_PERMS 705.Pq Vt str 706Mode to use when generating alias and map database files using 707.Pa /etc/mail/Makefile . 708The default value is 0640. 709.It Va TOP_TABLE_SIZE 710.Pq Vt int 711.Xr top 1 712uses a hash table for the user names. 713The size of this hash can be tuned to match the number of local users. 714The table size should be a prime number 715approximately twice as large as the number of lines in 716.Pa /etc/passwd . 717The default number is 20011. 718.It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE 719.Pq Vt int 720Causes the system compiler to be built such that it forces high optimization 721levels to a lower one. 722.Xr gcc 1 723.Fl O2 724and above is known to trigger known optimizer bugs at various 725times \(em this is worse on the Alpha platform. 726The value assigned is the highest optimization value used. 727.El 728.Pp 729The following list provides a name and short description for variables 730that are used when building documentation. 731.Bl -tag -width Ar 732.It Va DISTDIR 733.Pq Vt str 734Where distfiles are kept. 735Normally, this is 736.Pa distfiles 737in 738.Va PORTSDIR . 739.It Va DOC_LANG 740.Pq Vt str 741The list of languages and encodings to build and install. 742.It Va PRINTERDEVICE 743.Pq Vt str 744The default format for system documentation, depends on your 745printer. 746This can be set to 747.Dq Li ascii 748for simple printers, or 749.Dq Li ps 750for postscript or graphics printers with a ghostscript 751filter, or both. 752.El 753.Sh FILES 754.Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact 755.It Pa /etc/make.conf 756.It Pa /usr/doc/Makefile 757.It Pa /usr/share/examples/etc/make.conf 758.It Pa /usr/src/Makefile 759.It Pa /usr/src/Makefile.inc1 760.El 761.Sh SEE ALSO 762.Xr gcc 1 , 763.Xr install 1 , 764.Xr make 1 , 765.Xr ports 7 , 766.Xr lpd 8 , 767.Xr sendmail 8 768.Sh HISTORY 769The 770.Nm 771file appeared sometime before 772.Fx 4.0 . 773.Sh AUTHORS 774This 775manual page was written by 776.An Mike W. Meyer Aq mwm@mired.org . 777.Sh BUGS 778This manual page may occasionally be out of date with respect to 779the options currently available for use in 780.Nm . 781Please check the 782.Pa /usr/share/examples/etc/make.conf 783file for the latest options which are available. 784.Sh CAVEATS 785Note, that 786.Ev MAKEOBJDIRPREFIX 787and 788.Ev MAKEOBJDIR 789are environment variables and should not be set in 790.Nm 791but in make's environment. 792