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
205 the default install command.
206 To install only files for which the target differs or does not exist, use
207 .Bd -literal -offset indent
210 Note that some makefiles (including those in
212 may hardcode options for the supplied install command.
215 List any directories that should be entered when doing
221 Controls the shell used internally by
223 to process the command scripts in makefiles.
228 all currently supported.
231 .It Va MTREE_FOLLOWS_SYMLINKS
240 Setting this variable will prevent CPU specific compiler flags
241 from being automatically added to
244 .It Va NO_CPU_COPTFLAGS
246 Setting this variable will prevent CPU specific compiler flags
247 from being automatically added to
252 Set this to not update the doc tree during
253 .Dq Li "make update" .
254 .It Va NO_PORTSUPDATE
256 Set this to not update the ports tree during
257 .Dq Li "make update" .
265 .Dq Li "make update" .
271 .Dq Li "make update" .
273 .Pa /usr/share/examples/cvsup/standard-supfile .
279 .Dq Li "make update" .
285 .Dq Li "make update" .
291 .Dq Li "make update" .
296 The hostname of the sup server to use when doing
297 .Dq Li "make update" .
307 .Dq Li "make update" .
308 This option is deprecated.
312 .Xr freebsd-update 8 .
320 .Dq Li "make update" .
321 Note that since a subversion client is not included in the base system,
324 to the full path of a
328 .Ss "BUILDING THE KERNEL"
329 The following list provides a name and short description for variables
330 that are only used doing a kernel build:
334 Controls the amount of time the kernel waits for a console keypress
335 before booting the default kernel.
336 The value is approximately milliseconds.
337 Keypresses are accepted by the BIOS before booting from disk,
338 making it possible to give custom boot parameters even when this is
342 Controls the compiler settings when building the
344 Optimization levels above
345 .Oo Fl O ( O2 , No ...\& ) Oc
346 are not guaranteed to work.
349 Controls which kernel configurations will be
351 .Dq Li "${MAKE} buildkernel"
353 .Dq Li "${MAKE} installkernel" .
355 .Bd -literal -offset indent
356 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
359 will build the kernels specified by the config files
360 .Pa MINE , DEBUG , GENERIC ,
363 and install the kernel specified by the config file
367 .It Va MODULES_OVERRIDE
369 Set to a list of modules to build instead of all of them.
370 .It Va NO_KERNELCLEAN
372 Set this to skip running
373 .Dq Li "${MAKE} clean"
375 .Dq Li "${MAKE} buildkernel" .
376 .It Va NO_KERNELCONFIG
378 Set this to skip running
381 .Dq Li "${MAKE} buildkernel" .
382 .It Va NO_KERNELDEPEND
384 Set this to skip running
385 .Dq Li "${MAKE} depend"
387 .Dq Li "${MAKE} buildkernel" .
390 Set this to skip running
393 .Dq Li "${MAKE} buildkernel" .
396 Set to not build modules with the kernel.
398 Set this to the list of ports you wish to rebuild every time the kernel
400 .It Va WITHOUT_MODULES
402 Set to a list of modules to exclude from the build.
404 somewhat easier way to exclude modules you are certain you will never
406 .Va MODULES_OVERRIDE .
409 .Va MODULES_OVERRIDE .
411 .Ss "BUILDING THE WORLD"
412 The following list provides a name and short description for variables
413 that are used during the world build:
415 .It Va BOOT_COMCONSOLE_PORT
417 The port address to use for the console if the boot blocks have
418 been configured to use a serial console instead of the keyboard/video card.
419 .It Va BOOT_COMCONSOLE_SPEED
421 The baud rate to use for the console if the boot blocks have
422 been configured to use a serial console instead of the keyboard/video card.
423 .It Va BOOT_PXELDR_ALWAYS_SERIAL
425 Compile in the code into
427 that forces the use of a serial console.
428 This is analogous to the
433 .It Va BOOT_PXELDR_PROBE_KEYBOARD
435 Compile in the code into
437 that probes the keyboard.
438 If no keyboard is found, boot with the dual console configuration.
439 This is analogous to the
444 .It Va ENABLE_SUID_K5SU
446 Set this if you wish to use the ksu utility.
447 Otherwise, it will be
448 installed without the set-user-ID bit set.
449 .It Va ENABLE_SUID_NEWGRP
453 with the set-user-ID bit set.
456 will not be able to change users' groups.
457 .It Va LOADER_TFTP_SUPPORT
461 loader retrieves the kernel via NFS.
462 Defining this and recompiling
463 .Pa /usr/src/sys/boot
464 will cause it to retrieve the kernel via TFTP.
467 to load a custom BOOTP diskless kernel yet
468 still mount the server's
470 rather than load the server's kernel.
471 .It Va LOADER_FIREWIRE_SUPPORT
473 Defining this and recompiling
474 .Pa /usr/src/sys/boot/i386
479 and allow access over FireWire(IEEE1394) using
481 Currently, only i386 and amd64 are supported.
482 .It Va MALLOC_PRODUCTION
484 Set this to disable assertions and statistics gathering in
486 It also defaults the A and J runtime options to off.
487 Disabled by default on -CURRENT.
488 .It Va MODULES_WITH_WORLD
490 Set to build modules with the system instead of the kernel.
493 Set this to disable cleaning during
494 .Dq Li "make buildworld" .
495 This should not be set unless you know what you are doing.
499 .Dq Li "${MAKE} clean"
501 .Dq Li "${MAKE} cleandir" .
502 .It Va NO_MANCOMPRESS
504 Set to install manual pages uncompressed.
507 Set to not build in the
516 statically linked, this can be bad.
517 If set, every utility that uses
519 will be linked statically.
524 without support for network address translation (NAT).
525 .It Va PPP_NO_NETGRAPH
529 without support for Netgraph.
534 without support for RADIUS.
537 Set to disable the installation of
539 as a set-user-ID root program.
540 .It Va SENDMAIL_ADDITIONAL_MC
544 files which should be built into
547 The value should include the full path to the
550 .Pa /etc/mail/foo.mc ,
551 .Pa /etc/mail/bar.mc .
552 .It Va SENDMAIL_ALIASES
556 files to rebuild when using
557 .Pa /etc/mail/Makefile .
559 .Pa /etc/mail/aliases .
560 .It Va SENDMAIL_CFLAGS
562 Flags to pass to the compile command when building
566 flags can be used to provide SASL support with setting such as:
567 .Bd -literal -offset indent
568 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
569 SENDMAIL_LDFLAGS=-L/usr/local/lib
570 SENDMAIL_LDADD=-lsasl
572 .It Va SENDMAIL_CF_DIR
574 Override the default location for the
576 configuration files used to build a
581 .It Va SENDMAIL_DPADD
583 Extra dependencies to add when building
585 .It Va SENDMAIL_LDADD
587 Flags to add to the end of the
589 command when building
591 .It Va SENDMAIL_LDFLAGS
595 command when building
597 .It Va SENDMAIL_M4_FLAGS
606 .It Va SENDMAIL_MAP_PERMS
608 Mode to use when generating alias and map database files using
609 .Pa /etc/mail/Makefile .
610 The default value is 0640.
611 .It Va SENDMAIL_MAP_SRC
613 Additional maps to rebuild when using
614 .Pa /etc/mail/Makefile .
624 maps are always rebuilt if they exist.
625 .It Va SENDMAIL_MAP_TYPE
627 Database map type to use when generating map database files using
628 .Pa /etc/mail/Makefile .
629 The default value is hash.
630 The alternative is btree.
635 configuration file to use at install time.
636 The value should include the full path to the
639 .Pa /etc/mail/myconfig.mc .
640 Use with caution as a make install will overwrite any existing
641 .Pa /etc/mail/sendmail.cf .
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 if at all possible.
655 .It Va SENDMAIL_START_SCRIPT
658 .Pa /etc/mail/Makefile
659 to start, stop, and restart
662 .Pa /etc/rc.sendmail .
663 This value should match the
664 .Dq Li mta_start_script
667 .It Va SENDMAIL_SUBMIT_MC
671 configuration file for mail submission
672 to use at install time.
673 The value should include the full path to the
676 .Pa /etc/mail/mysubmit.mc .
677 Use with caution as a make install will overwrite any existing
678 .Pa /etc/mail/submit.cf .
679 .It Va TOP_TABLE_SIZE
682 uses a hash table for the user names.
683 The size of this hash can be tuned to match the number of local users.
684 The table size should be a prime number
685 approximately twice as large as the number of lines in
687 The default number is 20011.
688 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
690 Causes the system compiler to be built such that it forces high optimization
691 levels to a lower one.
694 and above is known to trigger known optimizer bugs at various
696 The value assigned is the highest optimization value used.
698 .Ss "BUILDING DOCUMENTATION"
699 The following list provides a name and short description for variables
700 that are used when building documentation.
701 .Bl -tag -width ".Va PRINTERDEVICE"
704 Where distfiles are kept.
711 The list of languages and encodings to build and install.
714 The default format for system documentation, depends on your
718 for simple printers, or
720 for postscript or graphics printers with a ghostscript
724 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
725 .It Pa /etc/make.conf
726 .It Pa /usr/doc/Makefile
727 .It Pa /usr/ports/Makefile
728 .It Pa /usr/share/examples/etc/make.conf
729 .It Pa /usr/share/mk/sys.mk
730 .It Pa /usr/src/Makefile
731 .It Pa /usr/src/Makefile.inc1
744 file appeared sometime before
748 manual page was written by
749 .An Mike W. Meyer Aq mwm@mired.org .
755 are environment variables and should not be set in
757 but in make's environment.
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.