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
182 Controls the compiler settings when compiling C++ code.
184 is initially set to the value of
195 the default install command.
196 To install only files for which the target differs or does not exist, use
197 .Bd -literal -offset indent
200 Note that some makefiles (including those in
202 may hardcode options for the supplied install command.
205 List any directories that should be entered when doing
211 Controls the shell used internally by
213 to process the command scripts in makefiles.
218 all currently supported.
221 .It Va MTREE_FOLLOWS_SYMLINKS
230 Setting this variable will prevent CPU specific compiler flags
231 from being automatically added to
234 .It Va NO_CPU_COPTFLAGS
236 Setting this variable will prevent CPU specific compiler flags
237 from being automatically added to
242 Set this to not update the doc tree during
243 .Dq Li "make update" .
244 .It Va NO_PORTSUPDATE
246 Set this to not update the ports tree during
247 .Dq Li "make update" .
255 .Dq Li "make update" .
256 Note that since a subversion client is not included in the base system,
259 to the full path of a
263 .Ss "BUILDING THE KERNEL"
264 The following list provides a name and short description for variables
265 that are only used doing a kernel build:
269 Controls the amount of time the kernel waits for a console keypress
270 before booting the default kernel.
271 The value is approximately milliseconds.
272 Keypresses are accepted by the BIOS before booting from disk,
273 making it possible to give custom boot parameters even when this is
277 Controls the compiler settings when building the
279 Optimization levels above
280 .Oo Fl O ( O2 , No ...\& ) Oc
281 are not guaranteed to work.
284 Controls which kernel configurations will be
286 .Dq Li "${MAKE} buildkernel"
288 .Dq Li "${MAKE} installkernel" .
290 .Bd -literal -offset indent
291 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
294 will build the kernels specified by the config files
295 .Pa MINE , DEBUG , GENERIC ,
298 and install the kernel specified by the config file
302 .It Va MODULES_OVERRIDE
304 Set to a list of modules to build instead of all of them.
305 .It Va NO_KERNELCLEAN
307 Set this to skip running
308 .Dq Li "${MAKE} clean"
310 .Dq Li "${MAKE} buildkernel" .
311 .It Va NO_KERNELCONFIG
313 Set this to skip running
316 .Dq Li "${MAKE} buildkernel" .
317 .It Va NO_KERNELDEPEND
319 Set this to skip running
320 .Dq Li "${MAKE} depend"
322 .Dq Li "${MAKE} buildkernel" .
325 Set this to skip running
328 .Dq Li "${MAKE} buildkernel" .
331 Set to not build modules with the kernel.
333 Set this to the list of ports you wish to rebuild every time the kernel
335 .It Va WITHOUT_MODULES
337 Set to a list of modules to exclude from the build.
339 somewhat easier way to exclude modules you are certain you will never
341 .Va MODULES_OVERRIDE .
344 .Va MODULES_OVERRIDE .
346 .Ss "BUILDING THE WORLD"
347 The following list provides a name and short description for variables
348 that are used during the world build:
350 .It Va BOOT_COMCONSOLE_PORT
352 The port address to use for the console if the boot blocks have
353 been configured to use a serial console instead of the keyboard/video card.
354 .It Va BOOT_COMCONSOLE_SPEED
356 The baud rate to use for the console if the boot blocks have
357 been configured to use a serial console instead of the keyboard/video card.
358 .It Va BOOT_PXELDR_ALWAYS_SERIAL
360 Compile in the code into
362 that forces the use of a serial console.
363 This is analogous to the
368 .It Va BOOT_PXELDR_PROBE_KEYBOARD
370 Compile in the code into
372 that probes the keyboard.
373 If no keyboard is found, boot with the dual console configuration.
374 This is analogous to the
379 .It Va ENABLE_SUID_K5SU
381 Set this if you wish to use the ksu utility.
382 Otherwise, it will be
383 installed without the set-user-ID bit set.
384 .It Va ENABLE_SUID_NEWGRP
388 with the set-user-ID bit set.
391 will not be able to change users' groups.
392 .It Va LOADER_TFTP_SUPPORT
396 loader retrieves the kernel via NFS.
397 Defining this and recompiling
398 .Pa /usr/src/sys/boot
399 will cause it to retrieve the kernel via TFTP.
402 to load a custom BOOTP diskless kernel yet
403 still mount the server's
405 rather than load the server's kernel.
406 .It Va LOADER_FIREWIRE_SUPPORT
408 Defining this and recompiling
409 .Pa /usr/src/sys/boot/i386
414 and allow access over FireWire(IEEE1394) using
416 Currently, only i386 and amd64 are supported.
417 .It Va MALLOC_PRODUCTION
419 Set this to disable assertions and statistics gathering in
421 It also defaults the A and J runtime options to off.
422 Disabled by default on -CURRENT.
423 .It Va MODULES_WITH_WORLD
425 Set to build modules with the system instead of the kernel.
428 Set this to disable cleaning during
429 .Dq Li "make buildworld" .
430 This should not be set unless you know what you are doing.
434 .Dq Li "${MAKE} clean"
436 .Dq Li "${MAKE} cleandir" .
437 .It Va NO_MANCOMPRESS
439 Set to install manual pages uncompressed.
442 Set to not build in the
451 statically linked, this can be bad.
452 If set, every utility that uses
454 will be linked statically.
459 without support for network address translation (NAT).
460 .It Va PPP_NO_NETGRAPH
464 without support for Netgraph.
469 without support for RADIUS.
472 Set to disable the installation of
474 as a set-user-ID root program.
475 .It Va SENDMAIL_ADDITIONAL_MC
479 files which should be built into
482 The value should include the full path to the
485 .Pa /etc/mail/foo.mc ,
486 .Pa /etc/mail/bar.mc .
487 .It Va SENDMAIL_ALIASES
491 files to rebuild when using
492 .Pa /etc/mail/Makefile .
494 .Pa /etc/mail/aliases .
495 .It Va SENDMAIL_CFLAGS
497 Flags to pass to the compile command when building
501 flags can be used to provide SASL support with setting such as:
502 .Bd -literal -offset indent
503 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
504 SENDMAIL_LDFLAGS=-L/usr/local/lib
505 SENDMAIL_LDADD=-lsasl
507 .It Va SENDMAIL_CF_DIR
509 Override the default location for the
511 configuration files used to build a
516 .It Va SENDMAIL_DPADD
518 Extra dependencies to add when building
520 .It Va SENDMAIL_LDADD
522 Flags to add to the end of the
524 command when building
526 .It Va SENDMAIL_LDFLAGS
530 command when building
532 .It Va SENDMAIL_M4_FLAGS
541 .It Va SENDMAIL_MAP_PERMS
543 Mode to use when generating alias and map database files using
544 .Pa /etc/mail/Makefile .
545 The default value is 0640.
546 .It Va SENDMAIL_MAP_SRC
548 Additional maps to rebuild when using
549 .Pa /etc/mail/Makefile .
559 maps are always rebuilt if they exist.
560 .It Va SENDMAIL_MAP_TYPE
562 Database map type to use when generating map database files using
563 .Pa /etc/mail/Makefile .
564 The default value is hash.
565 The alternative is btree.
570 configuration file to use at install time.
571 The value should include the full path to the
574 .Pa /etc/mail/myconfig.mc .
575 Use with caution as a make install will overwrite any existing
576 .Pa /etc/mail/sendmail.cf .
580 .It Va SENDMAIL_SET_USER_ID
584 as a set-user-ID root binary instead of a set-group-ID binary
586 .Pa /etc/mail/submit.{cf,mc} .
587 Use of this flag is not recommended and the alternative advice in
589 should be followed instead if at all possible.
590 .It Va SENDMAIL_START_SCRIPT
593 .Pa /etc/mail/Makefile
594 to start, stop, and restart
597 .Pa /etc/rc.sendmail .
598 This value should match the
599 .Dq Li mta_start_script
602 .It Va SENDMAIL_SUBMIT_MC
606 configuration file for mail submission
607 to use at install time.
608 The value should include the full path to the
611 .Pa /etc/mail/mysubmit.mc .
612 Use with caution as a make install will overwrite any existing
613 .Pa /etc/mail/submit.cf .
614 .It Va TOP_TABLE_SIZE
617 uses a hash table for the user names.
618 The size of this hash can be tuned to match the number of local users.
619 The table size should be a prime number
620 approximately twice as large as the number of lines in
622 The default number is 20011.
623 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
625 Causes the system compiler to be built such that it forces high optimization
626 levels to a lower one.
629 and above is known to trigger known optimizer bugs at various
631 The value assigned is the highest optimization value used.
633 .Ss "BUILDING DOCUMENTATION"
634 The following list provides a name and short description for variables
635 that are used when building documentation.
636 .Bl -tag -width ".Va PRINTERDEVICE"
639 Where distfiles are kept.
646 The list of languages and encodings to build and install.
649 The default format for system documentation, depends on your
653 for simple printers, or
655 for postscript or graphics printers with a ghostscript
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
679 file appeared sometime before
683 manual page was written by
684 .An Mike W. Meyer Aq mwm@mired.org .
690 are environment variables and should not be set in
692 but in make's environment.
694 This manual page may occasionally be out of date with respect to
695 the options currently available for use in
698 .Pa /usr/share/examples/etc/make.conf
699 file for the latest options which are available.