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 Mt 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
168 may be overridden using the
172 .Pa /usr/share/examples/etc/make.conf
173 for a list of recognized
178 Controls the compiler settings when compiling C++ code.
180 is initially set to the value of
191 the default install command.
192 To install only files for which the target differs or does not exist, use
193 .Bd -literal -offset indent
196 Note that some makefiles (including those in
198 may hardcode options for the supplied install command.
201 List any directories that should be entered when doing
207 Controls the shell used internally by
209 to process the command scripts in makefiles.
214 all currently supported.
217 .It Va MTREE_FOLLOWS_SYMLINKS
226 Setting this variable will prevent CPU specific compiler flags
227 from being automatically added to
232 Set this to not update the doc tree during
233 .Dq Li "make update" .
234 .It Va NO_PORTSUPDATE
236 Set this to not update the ports tree during
237 .Dq Li "make update" .
245 .Dq Li "make update" .
246 Note that since a subversion client is not included in the base system,
249 to the full path of a
253 .Ss "BUILDING THE KERNEL"
254 The following list provides a name and short description for variables
255 that are only used doing a kernel build:
259 Controls the amount of time the kernel waits for a console keypress
260 before booting the default kernel.
261 The value is approximately milliseconds.
262 Keypresses are accepted by the BIOS before booting from disk,
263 making it possible to give custom boot parameters even when this is
267 Controls the compiler settings when building the
269 Optimization levels above
270 .Oo Fl O ( O2 , No ...\& ) Oc
271 are not guaranteed to work.
274 Controls which kernel configurations will be
276 .Dq Li "${MAKE} buildkernel"
278 .Dq Li "${MAKE} installkernel" .
280 .Bd -literal -offset indent
281 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
284 will build the kernels specified by the config files
285 .Pa MINE , DEBUG , GENERIC ,
288 and install the kernel specified by the config file
292 .It Va MODULES_OVERRIDE
294 Set to a list of modules to build instead of all of them.
295 .It Va NO_KERNELCLEAN
297 Set this to skip running
298 .Dq Li "${MAKE} clean"
300 .Dq Li "${MAKE} buildkernel" .
301 .It Va NO_KERNELCONFIG
303 Set this to skip running
306 .Dq Li "${MAKE} buildkernel" .
307 .It Va NO_KERNELDEPEND
309 Set this to skip running
310 .Dq Li "${MAKE} depend"
312 .Dq Li "${MAKE} buildkernel" .
315 Set this to skip running
318 .Dq Li "${MAKE} buildkernel" .
321 Set to not build modules with the kernel.
323 Set this to the list of ports you wish to rebuild every time the kernel
325 .It Va WITHOUT_MODULES
327 Set to a list of modules to exclude from the build.
329 somewhat easier way to exclude modules you are certain you will never
331 .Va MODULES_OVERRIDE .
334 .Va MODULES_OVERRIDE .
336 .Ss "BUILDING THE WORLD"
337 The following list provides a name and short description for variables
338 that are used during the world build:
340 .It Va BOOT_COMCONSOLE_PORT
342 The port address to use for the console if the boot blocks have
343 been configured to use a serial console instead of the keyboard/video card.
344 .It Va BOOT_COMCONSOLE_SPEED
346 The baud rate to use for the console if the boot blocks have
347 been configured to use a serial console instead of the keyboard/video card.
348 .It Va BOOT_PXELDR_ALWAYS_SERIAL
350 Compile in the code into
352 that forces the use of a serial console.
353 This is analogous to the
358 .It Va BOOT_PXELDR_PROBE_KEYBOARD
360 Compile in the code into
362 that probes the keyboard.
363 If no keyboard is found, boot with the dual console configuration.
364 This is analogous to the
369 .It Va ENABLE_SUID_K5SU
371 Set this if you wish to use the ksu utility.
372 Otherwise, it will be
373 installed without the set-user-ID bit set.
374 .It Va ENABLE_SUID_NEWGRP
378 with the set-user-ID bit set.
381 will not be able to change users' groups.
382 .It Va LOADER_TFTP_SUPPORT
386 loader retrieves the kernel via NFS.
387 Defining this and recompiling
388 .Pa /usr/src/sys/boot
389 will cause it to retrieve the kernel via TFTP.
392 to load a custom BOOTP diskless kernel yet
393 still mount the server's
395 rather than load the server's kernel.
396 .It Va LOADER_FIREWIRE_SUPPORT
398 Defining this and recompiling
399 .Pa /usr/src/sys/boot/i386
404 and allow access over FireWire(IEEE1394) using
406 Currently, only i386 and amd64 are supported.
407 .It Va MALLOC_PRODUCTION
409 Set this to disable assertions and statistics gathering in
411 It also defaults the A and J runtime options to off.
412 Disabled by default on -CURRENT.
413 .It Va MODULES_WITH_WORLD
415 Set to build modules with the system instead of the kernel.
418 Set this to disable cleaning during
419 .Dq Li "make buildworld" .
420 This should not be set unless you know what you are doing.
424 .Dq Li "${MAKE} clean"
426 .Dq Li "${MAKE} cleandir" .
427 .It Va WITH_MANCOMPRESS
429 Set to install manual pages compressed.
430 .It Va WITHOUT_MANCOMPRESS
432 Set to install manual pages uncompressed.
435 Set to not build in the
444 statically linked, this can be bad.
445 If set, every utility that uses
447 will be linked statically.
452 without support for network address translation (NAT).
453 .It Va PPP_NO_NETGRAPH
457 without support for Netgraph.
462 without support for RADIUS.
465 Set to disable the installation of
467 as a set-user-ID root program.
468 .It Va SENDMAIL_ADDITIONAL_MC
472 files which should be built into
475 The value should include the full path to the
478 .Pa /etc/mail/foo.mc ,
479 .Pa /etc/mail/bar.mc .
480 .It Va SENDMAIL_ALIASES
484 files to rebuild when using
485 .Pa /etc/mail/Makefile .
487 .Pa /etc/mail/aliases .
488 .It Va SENDMAIL_CFLAGS
490 Flags to pass to the compile command when building
494 flags can be used to provide SASL support with setting such as:
495 .Bd -literal -offset indent
496 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
497 SENDMAIL_LDFLAGS=-L/usr/local/lib
498 SENDMAIL_LDADD=-lsasl
500 .It Va SENDMAIL_CF_DIR
502 Override the default location for the
504 configuration files used to build a
509 .It Va SENDMAIL_DPADD
511 Extra dependencies to add when building
513 .It Va SENDMAIL_LDADD
515 Flags to add to the end of the
517 command when building
519 .It Va SENDMAIL_LDFLAGS
523 command when building
525 .It Va SENDMAIL_M4_FLAGS
534 .It Va SENDMAIL_MAP_PERMS
536 Mode to use when generating alias and map database files using
537 .Pa /etc/mail/Makefile .
538 The default value is 0640.
539 .It Va SENDMAIL_MAP_SRC
541 Additional maps to rebuild when using
542 .Pa /etc/mail/Makefile .
552 maps are always rebuilt if they exist.
553 .It Va SENDMAIL_MAP_TYPE
555 Database map type to use when generating map database files using
556 .Pa /etc/mail/Makefile .
557 The default value is hash.
558 The alternative is btree.
563 configuration file to use at install time.
564 The value should include the full path to the
567 .Pa /etc/mail/myconfig.mc .
568 Use with caution as a make install will overwrite any existing
569 .Pa /etc/mail/sendmail.cf .
573 .It Va SENDMAIL_SET_USER_ID
577 as a set-user-ID root binary instead of a set-group-ID binary
579 .Pa /etc/mail/submit.{cf,mc} .
580 Use of this flag is not recommended and the alternative advice in
582 should be followed instead if at all possible.
583 .It Va SENDMAIL_START_SCRIPT
586 .Pa /etc/mail/Makefile
587 to start, stop, and restart
590 .Pa /etc/rc.sendmail .
591 This value should match the
592 .Dq Li mta_start_script
595 .It Va SENDMAIL_SUBMIT_MC
599 configuration file for mail submission
600 to use at install time.
601 The value should include the full path to the
604 .Pa /etc/mail/mysubmit.mc .
605 Use with caution as a make install will overwrite any existing
606 .Pa /etc/mail/submit.cf .
607 .It Va TOP_TABLE_SIZE
610 uses a hash table for the user names.
611 The size of this hash can be tuned to match the number of local users.
612 The table size should be a prime number
613 approximately twice as large as the number of lines in
615 The default number is 20011.
616 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
618 Causes the system compiler to be built such that it forces high optimization
619 levels to a lower one.
622 and above is known to trigger known optimizer bugs at various
624 The value assigned is the highest optimization value used.
626 .Ss "BUILDING DOCUMENTATION"
627 The following list provides a name and short description for variables
628 that are used when building documentation.
629 .Bl -tag -width ".Va PRINTERDEVICE"
632 Where distfiles are kept.
639 The list of languages and encodings to build and install.
642 The default format for system documentation, depends on your
646 for simple printers, or
648 for postscript or graphics printers with a ghostscript
652 Several make variables can be set that affect the building of ports.
653 These variables and their effects are documented in
660 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
661 .It Pa /etc/make.conf
662 .It Pa /usr/doc/Makefile
663 .It Pa /usr/ports/Makefile
664 .It Pa /usr/share/examples/etc/make.conf
665 .It Pa /usr/share/mk/sys.mk
666 .It Pa /usr/src/Makefile
667 .It Pa /usr/src/Makefile.inc1
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.