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:
152 .Bd -literal -offset indent
157 Controls which processor should be targeted for generated
159 This controls processor-specific optimizations in
160 certain code (currently only OpenSSL) as well as modifying
165 to contain the appropriate optimization directive to
167 The automatic setting of
171 may be overridden using the
175 variables, respectively.
177 .Pa /usr/share/examples/etc/make.conf
178 for a list of recognized
190 .Dq Li "make update" .
193 Controls the compiler settings when compiling C++ code.
195 is initially set to the value of
206 the default install command.
207 To install only files for which the target differs or does not exist, use
208 .Bd -literal -offset indent
211 Note that some makefiles (including those in
213 may hardcode options for the supplied install command.
216 List any directories that should be entered when doing
222 Controls the shell used internally by
224 to process the command scripts in makefiles.
229 all currently supported.
232 .It Va MTREE_FOLLOWS_SYMLINKS
241 Setting this variable will prevent CPU specific compiler flags
242 from being automatically added to
245 .It Va NO_CPU_COPTFLAGS
247 Setting this variable will prevent CPU specific compiler flags
248 from being automatically added to
253 Set this to not update the doc tree during
254 .Dq Li "make update" .
255 .It Va NO_PORTSUPDATE
257 Set this to not update the ports tree during
258 .Dq Li "make update" .
264 .Dq Li "make update" .
266 .Pa /usr/share/examples/cvsup/ports-supfile .
274 .Dq Li "make update" .
280 .Dq Li "make update" .
282 .Pa /usr/share/examples/cvsup/standard-supfile .
288 .Dq Li "make update" .
294 .Dq Li "make update" .
300 .Dq Li "make update" .
305 The hostname of the sup server to use when doing
306 .Dq Li "make update" .
316 .Dq Li "make update" .
317 This option is deprecated.
321 .Xr freebsd-update 8 .
329 .Dq Li "make update" .
331 .Ss "BUILDING THE KERNEL"
332 The following list provides a name and short description for variables
333 that are only used doing a kernel build:
337 Controls the amount of time the kernel waits for a console keypress
338 before booting the default kernel.
339 The value is approximately milliseconds.
340 Keypresses are accepted by the BIOS before booting from disk,
341 making it possible to give custom boot parameters even when this is
345 Controls the compiler settings when building the
347 Optimization levels above
348 .Oo Fl O ( O2 , No ...\& ) Oc
349 are not guaranteed to work.
352 Controls which kernel configurations will be
354 .Dq Li "${MAKE} buildkernel"
356 .Dq Li "${MAKE} installkernel" .
358 .Bd -literal -offset indent
359 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
362 will build the kernels specified by the config files
363 .Pa MINE , DEBUG , GENERIC ,
366 and install the kernel specified by the config file
370 .It Va MODULES_OVERRIDE
372 Set to a list of modules to build instead of all of them.
373 .It Va NO_KERNELCLEAN
375 Set this to skip running
376 .Dq Li "${MAKE} clean"
378 .Dq Li "${MAKE} buildkernel" .
379 .It Va NO_KERNELCONFIG
381 Set this to skip running
384 .Dq Li "${MAKE} buildkernel" .
385 .It Va NO_KERNELDEPEND
387 Set this to skip running
388 .Dq Li "${MAKE} depend"
390 .Dq Li "${MAKE} buildkernel" .
393 Set this to skip running
396 .Dq Li "${MAKE} buildkernel" .
399 Set to not build modules with the kernel.
401 Set this to the list of ports you wish to rebuild every time the kernel
403 .It Va WITHOUT_MODULES
405 Set to a list of modules to exclude from the build.
407 somewhat easier way to exclude modules you are certain you will never
409 .Va MODULES_OVERRIDE .
412 .Va MODULES_OVERRIDE .
414 .Ss "BUILDING THE WORLD"
415 The following list provides a name and short description for variables
416 that are used during the world build:
418 .It Va BOOT_COMCONSOLE_PORT
420 The port address to use for the console if the boot blocks have
421 been configured to use a serial console instead of the keyboard/video card.
422 .It Va BOOT_COMCONSOLE_SPEED
424 The baud rate to use for the console if the boot blocks have
425 been configured to use a serial console instead of the keyboard/video card.
426 .It Va BOOT_PXELDR_ALWAYS_SERIAL
428 Compile in the code into
430 that forces the use of a serial console.
431 This is analogous to the
436 .It Va BOOT_PXELDR_PROBE_KEYBOARD
438 Compile in the code into
440 that probes the keyboard.
441 If no keyboard is found, boot with the dual console configuration.
442 This is analogous to the
447 .It Va ENABLE_SUID_K5SU
449 Set this if you wish to use the ksu utility.
450 Otherwise, it will be
451 installed without the set-user-ID bit set.
452 .It Va ENABLE_SUID_NEWGRP
456 with the set-user-ID bit set.
459 will not be able to change users' groups.
460 .It Va ENABLE_SUID_SSH
464 with the set-user-ID bit turned on.
465 .It Va LOADER_TFTP_SUPPORT
469 loader retrieves the kernel via NFS.
470 Defining this and recompiling
471 .Pa /usr/src/sys/boot
472 will cause it to retrieve the kernel via TFTP.
475 to load a custom BOOTP diskless kernel yet
476 still mount the server's
478 rather than load the server's kernel.
479 .It Va LOADER_FIREWIRE_SUPPORT
481 Defining this and recompiling
482 .Pa /usr/src/sys/boot/i386
487 and allow access over FireWire(IEEE1394) using
489 Currently, only i386 and amd64 are supported.
490 .It Va MALLOC_PRODUCTION
492 Set this to disable assertions and statistics gathering in
494 It also defaults the A and J runtime options to off.
495 Disabled by default on -CURRENT.
496 .It Va MODULES_WITH_WORLD
498 Set to build modules with the system instead of the kernel.
501 Set this to disable cleaning during
502 .Dq Li "make buildworld" .
503 This should not be set unless you know what you are doing.
507 .Dq Li "${MAKE} clean"
509 .Dq Li "${MAKE} cleandir" .
510 .It Va NO_MANCOMPRESS
512 Set to install manual pages uncompressed.
515 Set to not build in the
524 statically linked, this can be bad.
525 If set, every utility that uses
527 will be linked statically.
532 without support for network address translation (NAT).
533 .It Va PPP_NO_NETGRAPH
537 without support for Netgraph.
542 without support for RADIUS.
545 Set to disable the installation of
547 as a set-user-ID root program.
548 .It Va SENDMAIL_ADDITIONAL_MC
552 files which should be built into
555 The value should include the full path to the
558 .Pa /etc/mail/foo.mc ,
559 .Pa /etc/mail/bar.mc .
560 .It Va SENDMAIL_ALIASES
564 files to rebuild when using
565 .Pa /etc/mail/Makefile .
567 .Pa /etc/mail/aliases .
568 .It Va SENDMAIL_CFLAGS
570 Flags to pass to the compile command when building
574 flags can be used to provide SASL support with setting such as:
575 .Bd -literal -offset indent
576 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
577 SENDMAIL_LDFLAGS=-L/usr/local/lib
578 SENDMAIL_LDADD=-lsasl
580 .It Va SENDMAIL_CF_DIR
582 Override the default location for the
584 configuration files used to build a
589 .It Va SENDMAIL_DPADD
591 Extra dependencies to add when building
593 .It Va SENDMAIL_LDADD
595 Flags to add to the end of the
597 command when building
599 .It Va SENDMAIL_LDFLAGS
603 command when building
605 .It Va SENDMAIL_M4_FLAGS
614 .It Va SENDMAIL_MAP_PERMS
616 Mode to use when generating alias and map database files using
617 .Pa /etc/mail/Makefile .
618 The default value is 0640.
619 .It Va SENDMAIL_MAP_SRC
621 Additional maps to rebuild when using
622 .Pa /etc/mail/Makefile .
632 maps are always rebuilt if they exist.
633 .It Va SENDMAIL_MAP_TYPE
635 Database map type to use when generating map database files using
636 .Pa /etc/mail/Makefile .
637 The default value is hash.
638 The alternative is btree.
643 configuration file to use at install time.
644 The value should include the full path to the
647 .Pa /etc/mail/myconfig.mc .
648 Use with caution as a make install will overwrite any existing
649 .Pa /etc/mail/sendmail.cf .
653 .It Va SENDMAIL_SET_USER_ID
657 as a set-user-ID root binary instead of a set-group-ID binary
659 .Pa /etc/mail/submit.{cf,mc} .
660 Use of this flag is not recommended and the alternative advice in
662 should be followed instead if at all possible.
663 .It Va SENDMAIL_START_SCRIPT
666 .Pa /etc/mail/Makefile
667 to start, stop, and restart
670 .Pa /etc/rc.sendmail .
671 This value should match the
672 .Dq Li mta_start_script
675 .It Va SENDMAIL_SUBMIT_MC
679 configuration file for mail submission
680 to use at install time.
681 The value should include the full path to the
684 .Pa /etc/mail/mysubmit.mc .
685 Use with caution as a make install will overwrite any existing
686 .Pa /etc/mail/submit.cf .
687 .It Va TOP_TABLE_SIZE
690 uses a hash table for the user names.
691 The size of this hash can be tuned to match the number of local users.
692 The table size should be a prime number
693 approximately twice as large as the number of lines in
695 The default number is 20011.
696 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
698 Causes the system compiler to be built such that it forces high optimization
699 levels to a lower one.
702 and above is known to trigger known optimizer bugs at various
704 The value assigned is the highest optimization value used.
706 .Ss "BUILDING DOCUMENTATION"
707 The following list provides a name and short description for variables
708 that are used when building documentation.
709 .Bl -tag -width ".Va PRINTERDEVICE"
712 Where distfiles are kept.
719 The list of languages and encodings to build and install.
722 The default format for system documentation, depends on your
726 for simple printers, or
728 for postscript or graphics printers with a ghostscript
732 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
733 .It Pa /etc/make.conf
734 .It Pa /usr/doc/Makefile
735 .It Pa /usr/ports/Makefile
736 .It Pa /usr/share/examples/etc/make.conf
737 .It Pa /usr/share/mk/sys.mk
738 .It Pa /usr/src/Makefile
739 .It Pa /usr/src/Makefile.inc1
752 file appeared sometime before
756 manual page was written by
757 .An Mike W. Meyer Aq mwm@mired.org .
759 This manual page may occasionally be out of date with respect to
760 the options currently available for use in
763 .Pa /usr/share/examples/etc/make.conf
764 file for the latest options which are available.
770 are environment variables and should not be set in
772 but in make's environment.