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
146 Controls which processor should be targeted for generated
148 This controls processor-specific optimizations in
149 certain code (currently only OpenSSL) as well as modifying
154 to contain the appropriate optimization directive to
156 The automatic setting of
158 may be overridden using the
162 .Pa /usr/share/examples/etc/make.conf
163 for a list of recognized
168 Controls the compiler settings when compiling C++ code.
170 is initially set to the value of
181 Select the compiler for DTS (Device Tree Syntax) file.
183 is initially set to the value of dtc
186 the default install command.
187 To install only files for which the target differs or does not exist, use
188 .Bd -literal -offset indent
191 Note that some makefiles (including those in
193 may hardcode options for the supplied install command.
196 List any directories that should be entered when doing
202 Controls the shell used internally by
204 to process the command scripts in makefiles.
209 all currently supported.
212 .It Va MTREE_FOLLOWS_SYMLINKS
221 Setting this variable will prevent CPU specific compiler flags
222 from being automatically added to
227 Set this to not update the doc tree during
228 .Dq Li "make update" .
229 .It Va NO_PORTSUPDATE
231 Set this to not update the ports tree during
232 .Dq Li "make update" .
240 .Dq Li "make update" .
241 Note that since a subversion client is not included in the base system,
244 to the full path of a
248 .Ss "BUILDING THE KERNEL"
249 The following list provides a name and short description for variables
250 that are only used doing a kernel build:
254 Controls the amount of time the kernel waits for a console keypress
255 before booting the default kernel.
256 The value is approximately milliseconds.
257 Keypresses are accepted by the BIOS before booting from disk,
258 making it possible to give custom boot parameters even when this is
262 Controls the compiler settings when building the
264 Optimization levels above
265 .Oo Fl O ( O2 , No ...\& ) Oc
266 are not guaranteed to work.
269 Controls which kernel configurations will be
271 .Dq Li "${MAKE} buildkernel"
273 .Dq Li "${MAKE} installkernel" .
275 .Bd -literal -offset indent
276 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
279 will build the kernels specified by the config files
280 .Pa MINE , DEBUG , GENERIC ,
283 and install the kernel specified by the config file
287 .It Va MODULES_OVERRIDE
289 Set to a list of modules to build instead of all of them.
290 .It Va NO_KERNELCLEAN
292 Set this to skip running
293 .Dq Li "${MAKE} clean"
295 .Dq Li "${MAKE} buildkernel" .
296 .It Va NO_KERNELCONFIG
298 Set this to skip running
301 .Dq Li "${MAKE} buildkernel" .
304 Set this to skip running
307 .Dq Li "${MAKE} buildkernel" .
310 Set to not build modules with the kernel.
312 Set this to the list of ports you wish to rebuild every time the kernel
314 .It Va WITHOUT_MODULES
316 Set to a list of modules to exclude from the build.
318 somewhat easier way to exclude modules you are certain you will never
320 .Va MODULES_OVERRIDE .
323 .Va MODULES_OVERRIDE .
325 .Ss "BUILDING THE WORLD"
326 The following list provides a name and short description for variables
327 that are used during the world build:
329 .It Va BOOT_COMCONSOLE_PORT
331 The port address to use for the console if the boot blocks have
332 been configured to use a serial console instead of the keyboard/video card.
333 .It Va BOOT_COMCONSOLE_SPEED
335 The baud rate to use for the console if the boot blocks have
336 been configured to use a serial console instead of the keyboard/video card.
337 .It Va BOOT_PXELDR_ALWAYS_SERIAL
339 Compile in the code into
341 that forces the use of a serial console.
342 This is analogous to the
347 .It Va BOOT_PXELDR_PROBE_KEYBOARD
349 Compile in the code into
351 that probes the keyboard.
352 If no keyboard is found, boot with the dual console configuration.
353 This is analogous to the
358 .It Va ENABLE_SUID_K5SU
360 Set this if you wish to use the ksu utility.
361 Otherwise, it will be
362 installed without the set-user-ID bit set.
363 .It Va ENABLE_SUID_NEWGRP
367 with the set-user-ID bit set.
370 will not be able to change users' groups.
371 .It Va LOADER_TFTP_SUPPORT
375 loader retrieves the kernel via NFS.
376 Defining this and recompiling
377 .Pa /usr/src/sys/boot
378 will cause it to retrieve the kernel via TFTP.
381 to load a custom BOOTP diskless kernel yet
382 still mount the server's
384 rather than load the server's kernel.
385 .It Va LOADER_FIREWIRE_SUPPORT
387 Defining this and recompiling
388 .Pa /usr/src/sys/boot/i386
393 and allow access over FireWire(IEEE1394) using
395 Currently, only i386 and amd64 are supported.
396 .It Va MALLOC_PRODUCTION
398 Set this to disable assertions and statistics gathering in
400 It also defaults the A and J runtime options to off.
401 Disabled by default on -CURRENT.
402 .It Va MODULES_WITH_WORLD
404 Set to build modules with the system instead of the kernel.
407 Set this to disable cleaning during
408 .Dq Li "make buildworld" .
409 This should not be set unless you know what you are doing.
413 .Dq Li "${MAKE} clean"
415 .Dq Li "${MAKE} cleandir" .
416 .It Va WITH_MANCOMPRESS
418 Set to install manual pages compressed.
419 .It Va WITHOUT_MANCOMPRESS
421 Set to install manual pages uncompressed.
424 Set to not build in the
433 statically linked, this can be bad.
434 If set, every utility that uses
436 will be linked statically.
441 without support for network address translation (NAT).
442 .It Va PPP_NO_NETGRAPH
446 without support for Netgraph.
451 without support for RADIUS.
454 Set to disable the installation of
456 as a set-user-ID root program.
457 .It Va SENDMAIL_ADDITIONAL_MC
461 files which should be built into
464 The value should include the full path to the
467 .Pa /etc/mail/foo.mc ,
468 .Pa /etc/mail/bar.mc .
469 .It Va SENDMAIL_ALIASES
473 files to rebuild when using
474 .Pa /etc/mail/Makefile .
476 .Pa /etc/mail/aliases .
477 .It Va SENDMAIL_CFLAGS
479 Flags to pass to the compile command when building
483 flags can be used to provide SASL support with setting such as:
484 .Bd -literal -offset indent
485 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
486 SENDMAIL_LDFLAGS=-L/usr/local/lib
487 SENDMAIL_LDADD=-lsasl
489 .It Va SENDMAIL_CF_DIR
491 Override the default location for the
493 configuration files used to build a
498 .It Va SENDMAIL_DPADD
500 Extra dependencies to add when building
502 .It Va SENDMAIL_LDADD
504 Flags to add to the end of the
506 command when building
508 .It Va SENDMAIL_LDFLAGS
512 command when building
514 .It Va SENDMAIL_M4_FLAGS
523 .It Va SENDMAIL_MAP_PERMS
525 Mode to use when generating alias and map database files using
526 .Pa /etc/mail/Makefile .
527 The default value is 0640.
528 .It Va SENDMAIL_MAP_SRC
530 Additional maps to rebuild when using
531 .Pa /etc/mail/Makefile .
541 maps are always rebuilt if they exist.
542 .It Va SENDMAIL_MAP_TYPE
544 Database map type to use when generating map database files using
545 .Pa /etc/mail/Makefile .
546 The default value is hash.
547 The alternative is btree.
552 configuration file to use at install time.
553 The value should include the full path to the
556 .Pa /etc/mail/myconfig.mc .
557 Use with caution as a make install will overwrite any existing
558 .Pa /etc/mail/sendmail.cf .
562 .It Va SENDMAIL_SET_USER_ID
566 as a set-user-ID root binary instead of a set-group-ID binary
568 .Pa /etc/mail/submit.{cf,mc} .
569 Use of this flag is not recommended and the alternative advice in
571 should be followed instead if at all possible.
572 .It Va SENDMAIL_START_SCRIPT
575 .Pa /etc/mail/Makefile
576 to start, stop, and restart
579 .Pa /etc/rc.sendmail .
580 This value should match the
581 .Dq Li mta_start_script
584 .It Va SENDMAIL_SUBMIT_MC
588 configuration file for mail submission
589 to use at install time.
590 The value should include the full path to the
593 .Pa /etc/mail/mysubmit.mc .
594 Use with caution as a make install will overwrite any existing
595 .Pa /etc/mail/submit.cf .
596 .It Va TOP_TABLE_SIZE
599 uses a hash table for the user names.
600 The size of this hash can be tuned to match the number of local users.
601 The table size should be a prime number
602 approximately twice as large as the number of lines in
604 The default number is 20011.
605 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
607 Causes the system compiler to be built such that it forces high optimization
608 levels to a lower one.
611 and above is known to trigger known optimizer bugs at various
613 The value assigned is the highest optimization value used.
615 .Ss "BUILDING DOCUMENTATION"
616 The following list provides a name and short description for variables
617 that are used when building documentation.
618 .Bl -tag -width ".Va PRINTERDEVICE"
621 Where distfiles are kept.
628 The list of languages and encodings to build and install.
631 The default format for system documentation, depends on your
635 for simple printers, or
637 for postscript or graphics printers with a ghostscript
641 Several make variables can be set that affect the building of ports.
642 These variables and their effects are documented in
649 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
650 .It Pa /etc/make.conf
651 .It Pa /usr/doc/Makefile
652 .It Pa /usr/ports/Makefile
653 .It Pa /usr/share/examples/etc/make.conf
654 .It Pa /usr/share/mk/sys.mk
655 .It Pa /usr/src/Makefile
656 .It Pa /usr/src/Makefile.inc1
669 file appeared sometime before
673 manual page was written by
674 .An Mike W. Meyer Aq Mt mwm@mired.org .
680 are environment variables and should not be set in
682 or as command line arguments to
684 but in make's environment.
686 This manual page may occasionally be out of date with respect to
687 the options currently available for use in
690 .Pa /usr/share/examples/etc/make.conf
691 file for the latest options which are available.