4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $FreeBSD: src/share/man/man5/make.conf.5,v 1.12.2.30 2003/05/18 17:05:55 brueffer Exp $
26 .\" $DragonFly: src/share/man/man5/make.conf.5,v 1.8 2004/08/12 08:08:08 dillon Exp $
33 .Nd system build information
37 contains settings that control the compilation of the
40 and ported applications.
43 is generally created by the system administrator when the values need
44 to be changed from their defaults.
48 is not to run commands or perform compilation actions
50 Instead, it is included by the
55 which conditionalize their
56 internal actions according to the settings found there.
60 file is included from the appropriate
62 which specifies the default settings for all the available options.
63 Options need only be specified in
65 when the system administrator wishes to override these defaults.
67 The build procedures occur in four broad areas: the world, the kernel,
68 documentations and ports.
71 may be applicable during builds in one, two, or all four of these
73 They may be specified for a particular build via the
78 The following lists provide a name and short description for each
79 variable you can use during the indicated builds.
83 are ignored; the variable being
89 be treated as if it were set.
91 The following list provides a name and short description for variables
92 that are used for all builds, or are used by the
94 for things other than builds.
98 Controls the compiler setting when compiling C code.
99 Optimization levels above
104 is provided as a set of
106 settings suggested by
107 .An "Bruce Evans" Aq bde@FreeBSD.org
108 for developing and testing changes.
109 They can be used, if set, by:
111 .Bd -literal -offset indent
116 Controls which processor should be targeted for generated
117 code. This controls processor-specific optimizations in
118 certain code (currently only OpenSSL) as well as modifying
123 to contain the appropriate optimization directive to
125 The automatic setting of
129 may be overridden using the
133 variables, respectively. Refer to
134 .Pa /usr/share/examples/etc/defaults/make.conf
135 for a list of recognized
140 Setting this variable will prevent CPU specific compiler flags
141 from being automatically added to
144 .It Va NO_CPU_COPTFLAGS
146 Setting this variable will prevent CPU specific compiler flags
147 from being automatically added to
154 to update your ports with
155 .Dq Li "make update" .
158 Controls the compiler settings when compiling C++ code.
160 is initially set to the value of
171 the default install command.
172 To have commands compared before doing
174 .Bd -literal -offset indent
179 List any directories that should be entered when doing
185 Controls the shell used internally by
187 to process the command scripts in makefiles.
192 all currently supported.
193 .Bd -literal -offset indent
196 .It Va MTREE_FOLLOWS_SYMLINKS
205 Set this to not update the doc tree during
206 .Dq Li "make update" .
207 .It Va NO_PORTSUPDATE
209 Set this to not update the ports tree during
210 .Dq Li "make update" .
215 to update your ports with
216 .Dq Li "make update" .
222 .Dq Li "make update" .
228 .Dq Li "make update" .
233 The hostname of the sup server to use when doing
234 .Dq Li "make update" .
240 .Dq Li "make update" .
242 .Pa /usr/share/examples/cvsup/standard\-supfile .
248 .Dq Li "make update" .
250 .Pa /usr/share/examples/cvsup/secure\-supfile .
256 .Dq Li "make update" .
258 .Pa /usr/share/examples/cvsup/secure\-supfile .
264 .Dq Li "make update" .
266 .Pa /usr/share/examples/cvsup/ports\-supfile .
272 .Dq Li "make update" .
274 .Pa /usr/share/examples/cvsup/doc\-supfile .
276 Causes -Werror to be added to
278 when WARNS is in effect.
281 The following list provides a name and short description for variables
282 that are only used doing a kernel build:
284 .It Va BOOT_COMCONSOLE_PORT
286 The port address to use for the console if the boot blocks have
287 been configured to use a serial console instead of the keyboard/video card.
288 .It Va BOOT_COMCONSOLE_SPEED
290 The baud rate to use for the console if the boot blocks have
291 been configured to use a serial console instead of the keyboard/video card.
294 Controls the amount of time the kernel waits for a console keypress
295 before booting the default kernel.
296 The value is approximately milliseconds.
297 Keypresses are accepted by the BIOS before booting from disk,
298 making it possible to give custom boot parameters even when this is
302 Controls the compiler settings when building the
304 Optimization levels above
305 .Oo Fl O ( O2 , No ...\& ) Oc
306 are not guaranteed to work.
309 Controls which kernel configurations will be
311 .Dq Li "${MAKE} buildkernel"
313 .Dq Li "${MAKE} installkernel" .
315 .Bd -literal -offset indent
316 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
319 will build the kernels specified by the config files
320 .Pa MINE , DEBUG , GENERIC ,
323 and install the kernel specified by the config file
327 .It Va LOADER_TFTP_SUPPORT
329 While not a buildkernel-affected option, there is no better place for this.
332 loader retrieves the kernel via NFS.
333 Defining this and recompiling
334 .Pa /usr/src/sys/boot
335 will cause it to retrieve the kernel via TFTP.
336 This allows pxeboot to load a custom BOOTP diskless kernel yet
337 still mount the server's
339 rather than load the server's kernel.
340 .It Va MODULES_OVERRIDE
342 Set to a list of modules to build instead of all of them.
343 .It Va NO_KERNELCONFIG
345 Set this to skip running
348 .Dq Li "${MAKE} buildkernel" .
349 .It Va NO_KERNELDEPEND
351 Set this to skip running
352 .Dq Li "${MAKE} depend"
354 .Dq Li "${MAKE} buildkernel" .
357 Set to not build modules with the kernel.
360 The following list provides a name and short description for variables
361 that are used during the world build:
367 1 compatibility libraries.
372 compatibility libraries.
377 compatibility libraries.
382 compatibility libraries.
388 compatibility libraries.
394 compatibility libraries.
395 .It Va ENABLE_SUIDPERL
397 Set to enable the installation of an suid
402 Command to use to fetch files.
407 If you want to install the MIT Kerberos5 port somewhere other than
409 define this. This is also used to tell ssh1 that kerberos is needed.
412 Set to build the IDEA encryption code.
413 This code is patented in the USA and many European countries.
415 .Em "YOUR RESPONSIBILITY"
416 to determine if you can legally use IDEA.
417 .It Va MAKE_KERBEROS5
419 Set this to build Kerberos5 (KTH Heimdal).
421 This is still experimental code.
422 If you need stable Kerberos5, use the
424 .It Va ENABLE_SUID_K5SU
426 Set this if you wish to use the k5su utility. Otherwise, it will be
427 installed without the set-user-ID bit set.
428 .It Va ENABLE_SUID_SSH
432 with the setuid bit turned on.
433 .It Va MODULES_WITH_WORLD
435 Set to build modules with the system instead of the kernel.
438 Set to not build CVS.
441 Set to not build BIND.
446 and related libraries.
453 Set to not build isdn4bsd package.
456 Set to not build IP Filter package.
461 and related programs.
462 .It Va NO_MAILWRAPPER
469 Set to not build manual pages
479 Set to not build Objective C support.
482 Set to not build OpenSSH.
485 Set to not build OpenSSL (implies
491 and related programs.
499 Set to not compile in X\-Windows support (e.g.\&
503 Set this to disable cleaning during
504 .Dq Li "make buildworld" .
505 This should not be set unless you know what you are doing.
509 .Dq Li "${MAKE} clean"
511 .Dq Li "${MAKE} cleandir" .
514 Set to not build any crypto code.
517 Set to not build games.
520 Set to not make or install
527 (reentrant version of
531 Set to install man pages uncompressed.
534 Set to avoid building
538 Set to avoid compiling profiled libraries.
541 Set to not build in the
546 Set to enable the building and installation of
552 Set to disable the installation of
554 as an suid root program.
557 The default m4 configuration file to use at install time.
558 The value should include the full path to the
561 .Pa /etc/mail/myconfig.mc .
562 Use with caution as a make install will overwrite any existing
563 .Pa /etc/mail/sendmail.cf .
567 Avoid using a value of
568 .Pa /etc/mail/sendmail.mc
569 as a buildworld will create
570 .Pa /etc/mail/sendmail.cf
571 before installworld installs an updated
574 .It Va SENDMAIL_SUBMIT_MC
576 The default m4 configuration file for mail submission
577 to use at install time.
578 The value should include the full path to the
581 .Pa /etc/mail/mysubmit.mc .
582 Use with caution as a make install will overwrite any existing
583 .Pa /etc/mail/submit.cf .
584 Avoid using a value of
585 .Pa /etc/mail/submit.mc
586 as a buildworld will create
587 .Pa /etc/mail/submit.cf
588 before installworld installs an updated
591 .It Va SENDMAIL_ADDITIONAL_MC
595 files which should be built into
598 The value should include the full path to the
602 .Pa /etc/mail/bar.mc .
603 Avoid using a value of
604 .Pa /etc/mail/sendmail.mc
605 as a buildworld will create
606 .Pa /etc/mail/sendmail.cf
607 before installworld installs an updated
610 .It Va SENDMAIL_M4_FLAGS
612 Flags passed to m4 when building a
617 .It Va SENDMAIL_CFLAGS
619 Flags to pass to the compile command when building
623 flags can be used to provide SASL support with setting such as:
624 .Bd -literal -offset indent
625 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
626 SENDMAIL_LDFLAGS=-L/usr/local/lib
627 SENDMAIL_LDADD=-lsasl
629 .It Va SENDMAIL_LDFLAGS
633 command when building
635 .It Va SENDMAIL_LDADD
637 Flags to add to the end of the
639 command when building
641 .It Va SENDMAIL_DPADD
643 Extra dependencies to add when building
645 .It Va SENDMAIL_SET_USER_ID
649 as a set-user-ID root binary instead of a set-group-ID binary
651 .Pa /etc/mail/submit.{cf,mc} .
652 Use of this flag is not recommended and the alternative advice in
654 should be followed instead of at all possible.
655 .It Va SENDMAIL_MAP_PERMS
657 Mode to use when generating alias and map database files using
658 .Pa /etc/mail/Makefile .
659 The default value is 0640.
660 .It Va TOP_TABLE_SIZE
663 uses a hash table for the user names. The size of this hash can be tuned
664 to match the number of local users. The table size should be a prime number
665 approximately twice as large as the number of lines in
667 The default number is 20011.
670 The following list provides a name and short description for variables
671 that are used when building documentation.
675 Where distfiles are kept.
682 The list of languages and encodings to build and install.
685 The default format for system documentation, depends on your
689 for simple printers or
691 for postscript or graphics printers with a ghostscript
695 The following list provides a name and short description for variables
696 that are used when building ports:
698 .It Va FORCE_PKG_REGISTER
700 Set this to override any existing package registration.
703 Set this if you have Motif on your system.
706 Set this if you want to install the MIT Kerberos5 port somewhere
711 Set this to the base directory that non\-X ports should be
713 It provides the default for
717 .It Va MASTER_SITE_AFTERSTEP
719 Set this to change the master site for AfterStep ports.
721 part of the path must be
723 .It Va MASTER_SITE_BACKUP
725 Controls the site location that ports check for distfiles if the
726 locations listed in their
729 The last part of the path must be
730 .Dq Li /${DIST_SUBDIR}/ .
731 .It Va MASTER_SITE_COMP_SOURCES
733 Controls the master site location for
737 last part of the path must be
739 .It Va MASTER_SITE_GNOME
741 Controls the master site location for GNOME ports.
743 last part of the path must be
745 .It Va MASTER_SITE_GNU
747 Controls the master site location for GNU ports.
749 last part of the path must be
751 .It Va MASTER_SITE_KDE
753 Controls the master site location for KDE ports.
755 last part of the path must be
757 .It Va MASTER_SITE_FREEBSD
759 If set, go to the master
762 .It Va MASTER_SITE_MOZILLA
764 Controls the master site location for Mozilla ports.
766 last part of the path must be
768 .It Va MASTER_SITE_OVERRIDE
770 If set, this site is checked before the sites listed in the ports
772 You can have it check the backup site first by like so:
773 .Bd -literal -offset indent
774 MASTER_SITE_OVERRIDE?= ${MASTER_SITE_BACKUP}
776 .It Va MASTER_SITE_PERL_CPAN
778 Controls the master site location for Perl ports.
780 last part of the path must be
781 .Bd -literal -offset indent
784 .It Va MASTER_SORT_REGEX
786 Set this to control the sort order for mirror sets.
788 prefer mirrors in the
791 .Bd -literal -offset indent
792 MASTER_SORT_REGEX?= ^file: ^ftp://ftp\.FreeBSD\.org/pub/FreeBSD/ports/local-distfiles/ ://[^/]*\.jp/ ://[^/]*\.jp\.
795 Users of other ccTLD domains should change the
799 .It Va MASTER_SITE_RINGSERVER
801 Controls the master site location for Ringserver ports.
803 part of the path must be
805 .It Va MASTER_SITE_RUBY
807 Controls the master site location for Ruby ports.
809 part of the path must be
811 .It Va MASTER_SITE_SUNSITE
813 Controls the master site location for Sunsite ports.
815 part of the path must be
817 .It Va MASTER_SITE_TCLTK
819 Controls the master site location for Tcl and Tk ports.
821 part of the path must be
823 .It Va MASTER_SITE_TEX_CTAN
825 Controls the master site location for TeX ports.
827 part of the path must be
829 .It Va MASTER_SITE_WINDOWMAKER
831 Controls the master site location for WindowMaker ports.
833 part of the path must be
835 .It Va MASTER_SITE_XCONTRIB
837 Controls the master site location for contributed X ports.
839 part of the path must be
841 .It Va MASTER_SITE_XEMACS
843 Controls the master site location for Xemacs ports.
845 part of the path must be
847 .It Va MASTER_SITE_XFREE
849 Controls the master site location for XFree ports.
851 part of the path must be
861 Set this if you want ports that use Motif to be built so they
862 can be run on systems without the Motif shared libraries.
863 .It Va NOCLEANDEPENDS
867 from cleaning the ports that the one being cleaned depends on.
870 Set this to disable installing additional documentation with ports.
873 Used only for the package target; the directory for the package tree.
876 Primary location(s) for the distribution of patch files.
879 The location of the ports tree.
882 Set this if you are a resident of the USA so that ports that
883 need to can attempt to comply with U.S. export regulations.
886 Set this so that ports that can be built with or without X11
887 support will build without X11 support by default.
890 Where to create temporary files used when building ports.
893 Should be set to where the X11 distribution has been
894 installed if it is installed anywhere other than
898 .Bl -tag -width /etc/defaults/make.conf -compact
899 .It Pa /etc/defaults/make.conf
900 .It Pa /etc/make.conf
901 .It Pa /usr/src/Makefile
902 .It Pa /usr/src/Makefile.inc1
903 .It Pa /usr/ports/Mk/bsd.port.mk
904 .It Pa /usr/ports/Mk/bsd.sites.mk
916 file appeared sometime before
920 manual page was written by
921 .An Mike W. Meyer Aq mwm@mired.org .
923 This manual page may occasionally be out of date with respect to
924 the options currently available for use in
927 .Pa /etc/defaults/make.conf
928 file for the latest options which are available.