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
27 .Dd September 27, 2018
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
107 In the case of world and kernel builds it is possible to put these variables
112 This way the environment for documentation and ports builds is not polluted
113 by unrelated variables.
115 The following lists provide a name and short description for each
116 variable you can use during the indicated builds.
120 are ignored; the variable being
126 be treated as if it were set.
128 The following list provides a name and short description for variables
129 that are used for all builds, or are used by the
131 for things other than builds.
133 .It Va ALWAYS_CHECK_MAKE
135 Instructs the top-level makefile in the source tree (normally
140 Normally this is only done for the world and buildworld targets to handle
141 upgrades from older versions of
145 Controls the compiler setting when compiling C code.
146 Optimization levels other than
153 Controls which processor should be targeted for generated
155 This controls processor-specific optimizations in
156 certain code (currently only OpenSSL) as well as modifying
161 to contain the appropriate optimization directive to
163 The automatic setting of
165 may be overridden using the
169 .Pa /usr/share/examples/etc/make.conf
170 for a list of recognized
175 Controls the compiler settings when compiling C++ code.
177 is initially set to the value of
188 Select the compiler for DTS (Device Tree Syntax) file.
190 is initially set to the value of dtc
193 the default install command.
194 To install only files for which the target differs or does not exist, use
195 .Bd -literal -offset indent
198 Note that some makefiles (including those in
200 may hardcode options for the supplied install command.
203 List any directories that should be entered when doing
209 Controls the shell used internally by
211 to process the command scripts in makefiles.
216 all currently supported.
219 .It Va MTREE_FOLLOWS_SYMLINKS
228 Setting this variable will prevent CPU specific compiler flags
229 from being automatically added to
234 Set this to not update the doc tree during
235 .Dq Li "make update" .
236 .It Va NO_PORTSUPDATE
238 Set this to not update the ports tree during
239 .Dq Li "make update" .
249 .Dq Li "make update" .
250 Note that you can set
252 to the full path of a
256 .Ss "BUILDING THE KERNEL"
257 The following list provides a name and short description for variables
258 that are only used doing a kernel build:
262 Controls the amount of time the kernel waits for a console keypress
263 before booting the default kernel.
264 The value is approximately milliseconds.
265 Keypresses are accepted by the BIOS before booting from disk,
266 making it possible to give custom boot parameters even when this is
270 Controls the compiler settings when building the
272 Optimization levels above
273 .Oo Fl O ( O2 , No ...\& ) Oc
274 are not guaranteed to work.
277 Controls which kernel configurations will be
279 .Dq Li "${MAKE} buildkernel"
281 .Dq Li "${MAKE} installkernel" .
283 .Bd -literal -offset indent
284 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
287 will build the kernels specified by the config files
288 .Pa MINE , DEBUG , GENERIC ,
291 and install the kernel specified by the config file
295 .It Va MODULES_OVERRIDE
297 Set to a list of modules to build instead of all of them.
298 .It Va NO_KERNELCLEAN
300 Set this to skip running
301 .Dq Li "${MAKE} clean"
303 .Dq Li "${MAKE} buildkernel" .
304 .It Va NO_KERNELCONFIG
306 Set this to skip running
309 .Dq Li "${MAKE} buildkernel" .
312 Set this to skip running
315 .Dq Li "${MAKE} buildkernel" .
318 Set to not build modules with the kernel.
320 Set this to the list of ports you wish to rebuild every time the kernel
322 .It Va WITHOUT_MODULES
324 Set to a list of modules to exclude from the build.
326 somewhat easier way to exclude modules you are certain you will never
328 .Va MODULES_OVERRIDE .
331 .Va MODULES_OVERRIDE .
333 .Ss "BUILDING THE WORLD"
334 The following list provides a name and short description for variables
335 that are used during the world build:
337 .It Va BOOT_COMCONSOLE_PORT
339 The port address to use for the console if the boot blocks have
340 been configured to use a serial console instead of the keyboard/video card.
341 .It Va BOOT_COMCONSOLE_SPEED
343 The baud rate to use for the console if the boot blocks have
344 been configured to use a serial console instead of the keyboard/video card.
345 .It Va BOOT_PXELDR_ALWAYS_SERIAL
347 Compile in the code into
349 that forces the use of a serial console.
350 This is analogous to the
355 .It Va BOOT_PXELDR_PROBE_KEYBOARD
357 Compile in the code into
359 that probes the keyboard.
360 If no keyboard is found, boot with the dual console configuration.
361 This is analogous to the
366 .It Va ENABLE_SUID_K5SU
368 Set this if you wish to use the ksu utility.
369 Otherwise, it will be
370 installed without the set-user-ID bit set.
371 .It Va ENABLE_SUID_NEWGRP
375 with the set-user-ID bit set.
378 will not be able to change users' groups.
379 .It Va LOADER_TFTP_SUPPORT
383 loader retrieves the kernel via NFS.
384 Defining this and recompiling
386 will cause it to retrieve the kernel via TFTP.
389 to load a custom BOOTP diskless kernel yet
390 still mount the server's
392 rather than load the server's kernel.
393 .It Va LOADER_FIREWIRE_SUPPORT
395 Defining this and recompiling
396 .Pa /usr/src/stand/i386
401 and allow access over FireWire(IEEE1394) using
403 Currently, only i386 and amd64 are supported.
406 Space-delimited list of one or more MACHINE and/or MACHINE_ARCH values
407 for which section 4 man pages will be installed.
410 installs all available architectures.
411 The default is the MACHINE and MACHINE_ARCH being built.
412 .It Va MODULES_WITH_WORLD
414 Set to build modules with the system instead of the kernel.
417 Set this to disable cleaning during
418 .Dq Li "make buildworld" .
419 This should not be set unless you know what you are doing.
423 .Dq Li "${MAKE} clean"
425 .Dq Li "${MAKE} cleandir" .
426 .It Va WITH_MANCOMPRESS
428 Set to install manual pages compressed.
429 .It Va WITHOUT_MANCOMPRESS
431 Set to install manual pages uncompressed.
434 Set to not build in the
443 statically linked, this can be bad.
444 If set, every utility that uses
446 will be linked statically.
451 without support for network address translation (NAT).
452 .It Va PPP_NO_NETGRAPH
456 without support for Netgraph.
461 without support for RADIUS.
464 Set to disable the installation of
466 as a set-user-ID root program.
467 .It Va SENDMAIL_ADDITIONAL_MC
471 files which should be built into
474 The value should include the full path to the
477 .Pa /etc/mail/foo.mc ,
478 .Pa /etc/mail/bar.mc .
479 .It Va SENDMAIL_ALIASES
483 files to rebuild when using
484 .Pa /etc/mail/Makefile .
486 .Pa /etc/mail/aliases .
487 .It Va SENDMAIL_CFLAGS
489 Flags to pass to the compile command when building
493 flags can be used to provide SASL support with setting such as:
494 .Bd -literal -offset indent
495 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
496 SENDMAIL_LDFLAGS=-L/usr/local/lib
497 SENDMAIL_LDADD=-lsasl
499 .It Va SENDMAIL_CF_DIR
501 Override the default location for the
503 configuration files used to build a
508 .It Va SENDMAIL_DPADD
510 Extra dependencies to add when building
512 .It Va SENDMAIL_LDADD
514 Flags to add to the end of the
516 command when building
518 .It Va SENDMAIL_LDFLAGS
522 command when building
524 .It Va SENDMAIL_M4_FLAGS
533 .It Va SENDMAIL_MAP_PERMS
535 Mode to use when generating alias and map database files using
536 .Pa /etc/mail/Makefile .
537 The default value is 0640.
538 .It Va SENDMAIL_MAP_SRC
540 Additional maps to rebuild when using
541 .Pa /etc/mail/Makefile .
551 maps are always rebuilt if they exist.
552 .It Va SENDMAIL_MAP_TYPE
554 Database map type to use when generating map database files using
555 .Pa /etc/mail/Makefile .
556 The default value is hash.
557 The alternative is btree.
562 configuration file to use at install time.
563 The value should include the full path to the
566 .Pa /etc/mail/myconfig.mc .
567 Use with caution as a make install will overwrite any existing
568 .Pa /etc/mail/sendmail.cf .
572 .It Va SENDMAIL_SET_USER_ID
576 as a set-user-ID root binary instead of a set-group-ID binary
578 .Pa /etc/mail/submit.{cf,mc} .
579 Use of this flag is not recommended and the alternative advice in
581 should be followed instead if at all possible.
582 .It Va SENDMAIL_START_SCRIPT
585 .Pa /etc/mail/Makefile
586 to start, stop, and restart
589 .Pa /etc/rc.sendmail .
590 This value should match the
591 .Dq Li mta_start_script
594 .It Va SENDMAIL_SUBMIT_MC
598 configuration file for mail submission
599 to use at install time.
600 The value should include the full path to the
603 .Pa /etc/mail/mysubmit.mc .
604 Use with caution as a make install will overwrite any existing
605 .Pa /etc/mail/submit.cf .
606 .It Va TOP_TABLE_SIZE
609 uses a hash table for the user names.
610 The size of this hash can be tuned to match the number of local users.
611 The table size should be a prime number
612 approximately twice as large as the number of lines in
614 The default number is 20011.
615 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
617 Causes the system compiler to be built such that it forces high optimization
618 levels to a lower one.
621 and above is known to trigger known optimizer bugs at various
623 The value assigned is the highest optimization value used.
625 .Ss "BUILDING DOCUMENTATION"
626 The following list provides a name and short description for variables
627 that are used when building documentation.
628 .Bl -tag -width ".Va PRINTERDEVICE"
631 Where distfiles are kept.
638 The list of languages and encodings to build and install.
641 The default format for system documentation, depends on your
645 for simple printers, or
647 for postscript or graphics printers with a ghostscript
651 Several make variables can be set that affect the building of ports.
652 These variables and their effects are documented in
659 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
660 .It Pa /etc/make.conf
661 .It Pa /usr/doc/Makefile
662 .It Pa /usr/ports/Makefile
663 .It Pa /usr/share/examples/etc/make.conf
664 .It Pa /usr/share/mk/sys.mk
665 .It Pa /usr/src/Makefile
666 .It Pa /usr/src/Makefile.inc1
673 .Xr style.Makefile 5 ,
680 file appeared sometime before
684 manual page was written by
685 .An Mike W. Meyer Aq Mt mwm@mired.org .
691 are environment variables and should not be set in
693 or as command line arguments to
695 but in make's environment.
697 This manual page may occasionally be out of date with respect to
698 the options currently available for use in
701 .Pa /usr/share/examples/etc/make.conf
702 file for the latest options which are available.