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
32 .Nd system build information
36 contains system-wide settings that will apply to every build using
41 This is achieved as follows:
43 processes the system makefile
45 before any other file by default, and
52 uses the standard makefile syntax.
55 should not specify any dependencies to
61 variables that control the actions of other makefiles.
63 The default location of
67 though an alternative location can be specified in the
71 You may need to override the location of
73 if the system-wide settings are not suitable for a particular build.
78 effectively resets all build controls to their defaults.
80 The primary purpose of
82 is to control the compilation of the
84 sources, documentation, and ported applications,
85 which are usually found in
90 As a rule, the system administrator creates
92 when the values of certain control variables need to be changed
95 The system build procedures occur in four broad areas:
96 the world, the kernel, documentation and ports.
99 may be applicable in one, two, or all four of these areas.
100 In addition, control variables can be specified
101 for a particular build via the
108 The following lists provide a name and short description for each
109 variable you can use during the indicated builds.
113 are ignored; the variable being
119 be treated as if it were set.
121 The following list provides a name and short description for variables
122 that are used for all builds, or are used by the
124 for things other than builds.
126 .It Va ALWAYS_CHECK_MAKE
128 Instructs the top-level makefile in the source tree (normally
133 Normally this is only done for the world and buildworld targets to handle
134 upgrades from older versions of
138 Controls the compiler setting when compiling C code.
139 Optimization levels other than
145 is provided as a set of
147 settings suggested by
148 .An "Bruce Evans" Aq bde@FreeBSD.org
149 for developing and testing changes.
150 They can be used, if set, by:
151 .Bd -literal -offset indent
156 Controls which processor should be targeted for generated
158 This controls processor-specific optimizations in
159 certain code (currently only OpenSSL) as well as modifying
164 to contain the appropriate optimization directive to
166 The automatic setting of
170 may be overridden using the
174 variables, respectively.
176 .Pa /usr/share/examples/etc/make.conf
177 for a list of recognized
189 .Dq Li "make update" .
192 Controls the compiler settings when compiling C++ code.
194 is initially set to the value of
208 .Dq Li "make update" .
210 .Pa /usr/share/examples/cvsup/doc-supfile .
213 the default install command.
214 To install only files for which the target differs or does not exist, use
215 .Bd -literal -offset indent
218 Note that some makefiles (including those in
220 may hardcode options for the supplied install command.
223 List any directories that should be entered when doing
229 Controls the shell used internally by
231 to process the command scripts in makefiles.
236 all currently supported.
239 .It Va MTREE_FOLLOWS_SYMLINKS
248 Setting this variable will prevent CPU specific compiler flags
249 from being automatically added to
252 .It Va NO_CPU_COPTFLAGS
254 Setting this variable will prevent CPU specific compiler flags
255 from being automatically added to
260 Set this to not update the doc tree during
261 .Dq Li "make update" .
262 .It Va NO_PORTSUPDATE
264 Set this to not update the ports tree during
265 .Dq Li "make update" .
268 Set this to not update the www tree during
269 .Dq Li "make update" .
275 .Dq Li "make update" .
277 .Pa /usr/share/examples/cvsup/ports-supfile .
285 .Dq Li "make update" .
291 .Dq Li "make update" .
293 .Pa /usr/share/examples/cvsup/standard-supfile .
299 .Dq Li "make update" .
305 .Dq Li "make update" .
311 .Dq Li "make update" .
316 The hostname of the sup server to use when doing
317 .Dq Li "make update" .
323 .Pa src , ports , doc
327 .Dq Li "make update" .
335 .Dq Li "make update" .
336 Note that since a subversion client is not included in the base system,
339 to the full path of a
347 .Dq Li "make update" .
349 .Pa /usr/share/examples/cvsup/www-supfile .
351 .Ss "BUILDING THE KERNEL"
352 The following list provides a name and short description for variables
353 that are only used doing a kernel build:
357 Controls the amount of time the kernel waits for a console keypress
358 before booting the default kernel.
359 The value is approximately milliseconds.
360 Keypresses are accepted by the BIOS before booting from disk,
361 making it possible to give custom boot parameters even when this is
365 Controls the compiler settings when building the
367 Optimization levels above
368 .Oo Fl O ( O2 , No ...\& ) Oc
369 are not guaranteed to work.
372 Controls which kernel configurations will be
374 .Dq Li "${MAKE} buildkernel"
376 .Dq Li "${MAKE} installkernel" .
378 .Bd -literal -offset indent
379 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
382 will build the kernels specified by the config files
383 .Pa MINE , DEBUG , GENERIC ,
386 and install the kernel specified by the config file
390 .It Va MODULES_OVERRIDE
392 Set to a list of modules to build instead of all of them.
393 .It Va NO_KERNELCLEAN
395 Set this to skip running
396 .Dq Li "${MAKE} clean"
398 .Dq Li "${MAKE} buildkernel" .
399 .It Va NO_KERNELCONFIG
401 Set this to skip running
404 .Dq Li "${MAKE} buildkernel" .
405 .It Va NO_KERNELDEPEND
407 Set this to skip running
408 .Dq Li "${MAKE} depend"
410 .Dq Li "${MAKE} buildkernel" .
413 Set this to skip running
416 .Dq Li "${MAKE} buildkernel" .
419 Set to not build modules with the kernel.
421 Set this to the list of ports you wish to rebuild every time the kernel
423 .It Va WITHOUT_MODULES
425 Set to a list of modules to exclude from the build.
427 somewhat easier way to exclude modules you are certain you will never
429 .Va MODULES_OVERRIDE .
432 .Va MODULES_OVERRIDE .
434 .Ss "BUILDING THE WORLD"
435 The following list provides a name and short description for variables
436 that are used during the world build:
438 .It Va BOOT_COMCONSOLE_PORT
440 The port address to use for the console if the boot blocks have
441 been configured to use a serial console instead of the keyboard/video card.
442 .It Va BOOT_COMCONSOLE_SPEED
444 The baud rate to use for the console if the boot blocks have
445 been configured to use a serial console instead of the keyboard/video card.
446 .It Va BOOT_PXELDR_ALWAYS_SERIAL
448 Compile in the code into
450 that forces the use of a serial console.
451 This is analogous to the
456 .It Va BOOT_PXELDR_PROBE_KEYBOARD
458 Compile in the code into
460 that probes the keyboard.
461 If no keyboard is found, boot with the dual console configuration.
462 This is analogous to the
467 .It Va ENABLE_SUID_K5SU
469 Set this if you wish to use the ksu utility.
470 Otherwise, it will be
471 installed without the set-user-ID bit set.
472 .It Va ENABLE_SUID_NEWGRP
476 with the set-user-ID bit set.
479 will not be able to change users' groups.
480 .It Va ENABLE_SUID_SSH
484 with the set-user-ID bit turned on.
485 .It Va LOADER_TFTP_SUPPORT
489 loader retrieves the kernel via NFS.
490 Defining this and recompiling
491 .Pa /usr/src/sys/boot
492 will cause it to retrieve the kernel via TFTP.
495 to load a custom BOOTP diskless kernel yet
496 still mount the server's
498 rather than load the server's kernel.
499 .It Va LOADER_FIREWIRE_SUPPORT
501 Defining this and recompiling
502 .Pa /usr/src/sys/boot/i386
507 and allow access over FireWire(IEEE1394) using
509 Currently, only i386 and amd64 are supported.
510 .It Va MALLOC_PRODUCTION
512 Set this to disable assertions and statistics gathering in
514 It also defaults the A and J runtime options to off.
515 Disabled by default on -CURRENT.
516 .It Va MODULES_WITH_WORLD
518 Set to build modules with the system instead of the kernel.
521 Set this to disable cleaning during
522 .Dq Li "make buildworld" .
523 This should not be set unless you know what you are doing.
527 .Dq Li "${MAKE} clean"
529 .Dq Li "${MAKE} cleandir" .
530 .It Va NO_MANCOMPRESS
532 Set to install manual pages uncompressed.
535 Set to not build in the
544 statically linked, this can be bad.
545 If set, every utility that uses
547 will be linked statically.
552 without support for network address translation (NAT).
553 .It Va PPP_NO_NETGRAPH
557 without support for Netgraph.
562 without support for RADIUS.
565 Set to disable the installation of
567 as a set-user-ID root program.
568 .It Va SENDMAIL_ADDITIONAL_MC
572 files which should be built into
575 The value should include the full path to the
579 .Pa /etc/mail/bar.mc .
580 .It Va SENDMAIL_ALIASES
584 files to rebuild when using
585 .Pa /etc/mail/Makefile .
587 .Pa /etc/mail/aliases .
588 .It Va SENDMAIL_CFLAGS
590 Flags to pass to the compile command when building
594 flags can be used to provide SASL support with setting such as:
595 .Bd -literal -offset indent
596 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
597 SENDMAIL_LDFLAGS=-L/usr/local/lib
598 SENDMAIL_LDADD=-lsasl
600 .It Va SENDMAIL_CF_DIR
602 Override the default location for the
604 configuration files used to build a
609 .It Va SENDMAIL_DPADD
611 Extra dependencies to add when building
613 .It Va SENDMAIL_LDADD
615 Flags to add to the end of the
617 command when building
619 .It Va SENDMAIL_LDFLAGS
623 command when building
625 .It Va SENDMAIL_M4_FLAGS
634 .It Va SENDMAIL_MAP_PERMS
636 Mode to use when generating alias and map database files using
637 .Pa /etc/mail/Makefile .
638 The default value is 0640.
639 .It Va SENDMAIL_MAP_SRC
641 Additional maps to rebuild when using
642 .Pa /etc/mail/Makefile .
652 maps are always rebuilt if they exist.
653 .It Va SENDMAIL_MAP_TYPE
655 Database map type to use when generating map database files using
656 .Pa /etc/mail/Makefile .
657 The default value is hash.
658 The alternative is btree.
663 configuration file to use at install time.
664 The value should include the full path to the
667 .Pa /etc/mail/myconfig.mc .
668 Use with caution as a make install will overwrite any existing
669 .Pa /etc/mail/sendmail.cf .
673 .It Va SENDMAIL_SET_USER_ID
677 as a set-user-ID root binary instead of a set-group-ID binary
679 .Pa /etc/mail/submit.{cf,mc} .
680 Use of this flag is not recommended and the alternative advice in
682 should be followed instead if at all possible.
683 .It Va SENDMAIL_START_SCRIPT
686 .Pa /etc/mail/Makefile
687 to start, stop, and restart
690 .Pa /etc/rc.sendmail .
691 This value should match the
692 .Dq Li mta_start_script
695 .It Va SENDMAIL_SUBMIT_MC
699 configuration file for mail submission
700 to use at install time.
701 The value should include the full path to the
704 .Pa /etc/mail/mysubmit.mc .
705 Use with caution as a make install will overwrite any existing
706 .Pa /etc/mail/submit.cf .
707 .It Va TOP_TABLE_SIZE
710 uses a hash table for the user names.
711 The size of this hash can be tuned to match the number of local users.
712 The table size should be a prime number
713 approximately twice as large as the number of lines in
715 The default number is 20011.
716 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
718 Causes the system compiler to be built such that it forces high optimization
719 levels to a lower one.
722 and above is known to trigger known optimizer bugs at various
724 The value assigned is the highest optimization value used.
726 .Ss "BUILDING DOCUMENTATION"
727 The following list provides a name and short description for variables
728 that are used when building documentation.
729 .Bl -tag -width ".Va PRINTERDEVICE"
732 Where distfiles are kept.
739 The list of languages and encodings to build and install.
742 The default format for system documentation, depends on your
746 for simple printers, or
748 for postscript or graphics printers with a ghostscript
752 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
753 .It Pa /etc/make.conf
754 .It Pa /usr/doc/Makefile
755 .It Pa /usr/ports/Makefile
756 .It Pa /usr/share/examples/etc/make.conf
757 .It Pa /usr/share/mk/sys.mk
758 .It Pa /usr/src/Makefile
759 .It Pa /usr/src/Makefile.inc1
772 file appeared sometime before
776 manual page was written by
777 .An Mike W. Meyer Aq mwm@mired.org .
783 are environment variables and should not be set in
785 but in make's environment.
787 This manual page may occasionally be out of date with respect to
788 the options currently available for use in
791 .Pa /usr/share/examples/etc/make.conf
792 file for the latest options which are available.