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
185 to update your ports with
186 .Dq Li "make update" .
189 Controls the compiler settings when compiling C++ code.
191 is initially set to the value of
205 .Dq Li "make update" .
207 .Pa /usr/share/examples/cvsup/doc\-supfile .
210 the default install command.
211 To install only files for which the target differs or does not exist, use
212 .Bd -literal -offset indent
215 Note that some makefiles (including those in
217 may hardcode options for the supplied install command.
220 List any directories that should be entered when doing
226 Controls the shell used internally by
228 to process the command scripts in makefiles.
233 all currently supported.
236 .It Va MTREE_FOLLOWS_SYMLINKS
245 Setting this variable will prevent CPU specific compiler flags
246 from being automatically added to
249 .It Va NO_CPU_COPTFLAGS
251 Setting this variable will prevent CPU specific compiler flags
252 from being automatically added to
257 Set this to not update the doc tree during
258 .Dq Li "make update" .
259 .It Va NO_PORTSUPDATE
261 Set this to not update the ports tree during
262 .Dq Li "make update" .
268 .Dq Li "make update" .
270 .Pa /usr/share/examples/cvsup/ports\-supfile .
278 .Dq Li "make update" .
284 .Dq Li "make update" .
286 .Pa /usr/share/examples/cvsup/standard\-supfile .
292 .Dq Li "make update" .
294 .Pa /usr/share/examples/cvsup/secure\-supfile .
300 .Dq Li "make update" .
302 .Pa /usr/share/examples/cvsup/secure\-supfile .
308 .Dq Li "make update" .
313 The hostname of the sup server to use when doing
314 .Dq Li "make update" .
319 to update your ports with
320 .Dq Li "make update" .
322 .Ss "BUILDING THE KERNEL"
323 The following list provides a name and short description for variables
324 that are only used doing a kernel build:
328 Controls the amount of time the kernel waits for a console keypress
329 before booting the default kernel.
330 The value is approximately milliseconds.
331 Keypresses are accepted by the BIOS before booting from disk,
332 making it possible to give custom boot parameters even when this is
336 Controls the compiler settings when building the
338 Optimization levels above
339 .Oo Fl O ( O2 , No ...\& ) Oc
340 are not guaranteed to work.
343 Controls which kernel configurations will be
345 .Dq Li "${MAKE} buildkernel"
347 .Dq Li "${MAKE} installkernel" .
349 .Bd -literal -offset indent
350 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
353 will build the kernels specified by the config files
354 .Pa MINE , DEBUG , GENERIC ,
357 and install the kernel specified by the config file
361 .It Va MODULES_OVERRIDE
363 Set to a list of modules to build instead of all of them.
364 .It Va NO_KERNELCONFIG
366 Set this to skip running
369 .Dq Li "${MAKE} buildkernel" .
370 .It Va NO_KERNELDEPEND
372 Set this to skip running
373 .Dq Li "${MAKE} depend"
375 .Dq Li "${MAKE} buildkernel" .
378 Set to not build modules with the kernel.
380 Set this to the list of ports you wish to rebuild every time the kernel
382 .It Va WITHOUT_MODULES
384 Set to a list of modules to exclude from the build.
386 somewhat easier way to exclude modules you are certain you will never
388 .Va MODULES_OVERRIDE .
391 .Va MODULES_OVERRIDE .
393 .Ss "BUILDING THE WORLD"
394 The following list provides a name and short description for variables
395 that are used during the world build:
397 .It Va BOOT_COMCONSOLE_PORT
399 The port address to use for the console if the boot blocks have
400 been configured to use a serial console instead of the keyboard/video card.
401 .It Va BOOT_COMCONSOLE_SPEED
403 The baud rate to use for the console if the boot blocks have
404 been configured to use a serial console instead of the keyboard/video card.
405 .It Va BOOT_PXELDR_ALWAYS_SERIAL
407 Compile in the code into
409 that forces the use of a serial console.
410 This is analogous to the
415 .It Va BOOT_PXELDR_PROBE_KEYBOARD
417 Compile in the code into
419 that probes the keyboard.
420 If no keyboard is found, boot with the dual console configuration.
421 This is analogous to the
426 .It Va ENABLE_SUID_K5SU
428 Set this if you wish to use the ksu utility.
429 Otherwise, it will be
430 installed without the set-user-ID bit set.
431 .It Va ENABLE_SUID_NEWGRP
435 with the set-user-ID bit set.
438 will not be able to change users' groups.
439 .It Va ENABLE_SUID_SSH
443 with the set-user-ID bit turned on.
444 .It Va LOADER_TFTP_SUPPORT
448 loader retrieves the kernel via NFS.
449 Defining this and recompiling
450 .Pa /usr/src/sys/boot
451 will cause it to retrieve the kernel via TFTP.
454 to load a custom BOOTP diskless kernel yet
455 still mount the server's
457 rather than load the server's kernel.
458 .It Va LOADER_FIREWIRE_SUPPORT
460 Defining this and recompiling
461 .Pa /usr/src/sys/boot/i386
466 and allow access over FireWire(IEEE1394) using
468 Currently, only i386 and amd64 are supported.
469 .It Va MODULES_WITH_WORLD
471 Set to build modules with the system instead of the kernel.
474 Set this to disable cleaning during
475 .Dq Li "make buildworld" .
476 This should not be set unless you know what you are doing.
480 .Dq Li "${MAKE} clean"
482 .Dq Li "${MAKE} cleandir" .
483 .It Va NO_MANCOMPRESS
485 Set to install manual pages uncompressed.
488 Set to not build in the
497 statically linked, this can be bad.
498 If set, every utility that uses
500 will be linked statically.
505 without support for network address translation (NAT).
506 .It Va PPP_NO_NETGRAPH
510 without support for Netgraph.
515 without support for RADIUS.
518 Set to disable the installation of
520 as a set-user-ID root program.
521 .It Va SENDMAIL_ADDITIONAL_MC
525 files which should be built into
528 The value should include the full path to the
532 .Pa /etc/mail/bar.mc .
533 .It Va SENDMAIL_ALIASES
537 files to rebuild when using
538 .Pa /etc/mail/Makefile .
540 .Pa /etc/mail/aliases .
541 .It Va SENDMAIL_CFLAGS
543 Flags to pass to the compile command when building
547 flags can be used to provide SASL support with setting such as:
548 .Bd -literal -offset indent
549 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
550 SENDMAIL_LDFLAGS=-L/usr/local/lib
551 SENDMAIL_LDADD=-lsasl
553 .It Va SENDMAIL_CF_DIR
555 Override the default location for the
557 configuration files used to build a
562 .It Va SENDMAIL_DPADD
564 Extra dependencies to add when building
566 .It Va SENDMAIL_LDADD
568 Flags to add to the end of the
570 command when building
572 .It Va SENDMAIL_LDFLAGS
576 command when building
578 .It Va SENDMAIL_M4_FLAGS
587 .It Va SENDMAIL_MAP_PERMS
589 Mode to use when generating alias and map database files using
590 .Pa /etc/mail/Makefile .
591 The default value is 0640.
592 .It Va SENDMAIL_MAP_SRC
594 Additional maps to rebuild when using
595 .Pa /etc/mail/Makefile .
605 maps are always rebuilt if they exist.
606 .It Va SENDMAIL_MAP_TYPE
608 Database map type to use when generating map database files using
609 .Pa /etc/mail/Makefile .
610 The default value is hash.
611 The alternative is btree.
616 configuration file to use at install time.
617 The value should include the full path to the
620 .Pa /etc/mail/myconfig.mc .
621 Use with caution as a make install will overwrite any existing
622 .Pa /etc/mail/sendmail.cf .
626 .It Va SENDMAIL_SET_USER_ID
630 as a set-user-ID root binary instead of a set-group-ID binary
632 .Pa /etc/mail/submit.{cf,mc} .
633 Use of this flag is not recommended and the alternative advice in
635 should be followed instead if at all possible.
636 .It Va SENDMAIL_START_SCRIPT
639 .Pa /etc/mail/Makefile
640 to start, stop, and restart
643 .Pa /etc/rc.sendmail .
644 This value should match the
645 .Dq Li mta_start_script
648 .It Va SENDMAIL_SUBMIT_MC
652 configuration file for mail submission
653 to use at install time.
654 The value should include the full path to the
657 .Pa /etc/mail/mysubmit.mc .
658 Use with caution as a make install will overwrite any existing
659 .Pa /etc/mail/submit.cf .
660 .It Va TOP_TABLE_SIZE
663 uses a hash table for the user names.
664 The size of this hash can be tuned to match the number of local users.
665 The table size should be a prime number
666 approximately twice as large as the number of lines in
668 The default number is 20011.
669 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
671 Causes the system compiler to be built such that it forces high optimization
672 levels to a lower one.
675 and above is known to trigger known optimizer bugs at various
677 The value assigned is the highest optimization value used.
679 .Ss "BUILDING DOCUMENTATION"
680 The following list provides a name and short description for variables
681 that are used when building documentation.
682 .Bl -tag -width ".Va PRINTERDEVICE"
685 Where distfiles are kept.
692 The list of languages and encodings to build and install.
695 The default format for system documentation, depends on your
699 for simple printers, or
701 for postscript or graphics printers with a ghostscript
705 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
706 .It Pa /etc/make.conf
707 .It Pa /usr/doc/Makefile
708 .It Pa /usr/share/examples/etc/make.conf
709 .It Pa /usr/share/mk/sys.mk
710 .It Pa /usr/src/Makefile
711 .It Pa /usr/src/Makefile.inc1
724 file appeared sometime before
728 manual page was written by
729 .An Mike W. Meyer Aq mwm@mired.org .
731 This manual page may occasionally be out of date with respect to
732 the options currently available for use in
735 .Pa /usr/share/examples/etc/make.conf
736 file for the latest options which are available.
742 are environment variables and should not be set in
744 but in make's environment.