]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - share/man/man5/make.conf.5
Merge ACPICA 20200326.
[FreeBSD/FreeBSD.git] / share / man / man5 / make.conf.5
1 .\" Copyright (c) 2000
2 .\"     Mike W. Meyer
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
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.
12 .\"
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
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD$
26 .\"
27 .Dd September 27, 2018
28 .Dt MAKE.CONF 5
29 .Os
30 .Sh NAME
31 .Nm make.conf
32 .Nd system build information
33 .Sh DESCRIPTION
34 The file
35 .Nm
36 contains system-wide settings that will apply to every build using
37 .Xr make 1
38 and the standard
39 .Pa sys.mk
40 file.
41 This is achieved as follows:
42 .Xr make 1
43 processes the system makefile
44 .Pa sys.mk
45 before any other file by default, and
46 .Pa sys.mk
47 includes
48 .Nm .
49 .Pp
50 The file
51 .Nm
52 uses the standard makefile syntax.
53 However,
54 .Nm
55 should not specify any dependencies to
56 .Xr make 1 .
57 Instead,
58 .Nm
59 is to set
60 .Xr make 1
61 variables that control the actions of other makefiles.
62 .Pp
63 The default location of
64 .Nm
65 is
66 .Pa /etc/make.conf ,
67 though an alternative location can be specified in the
68 .Xr make 1
69 variable
70 .Va __MAKE_CONF .
71 You may need to override the location of
72 .Nm
73 if the system-wide settings are not suitable for a particular build.
74 For instance, setting
75 .Va __MAKE_CONF
76 to
77 .Pa /dev/null
78 effectively resets all build controls to their defaults.
79 .Pp
80 The primary purpose of
81 .Nm
82 is to control the compilation of the
83 .Fx
84 sources, documentation, and ported applications,
85 which are usually found in
86 .Pa /usr/src ,
87 .Pa /usr/doc ,
88 and
89 .Pa /usr/ports .
90 As a rule, the system administrator creates
91 .Nm
92 when the values of certain control variables need to be changed
93 from their defaults.
94 .Pp
95 The system build procedures occur in four broad areas:
96 the world, the kernel, documentation and ports.
97 Variables set in
98 .Nm
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
102 .Fl D
103 option of
104 .Xr make 1
105 or in
106 .Xr environ 7 .
107 In the case of world and kernel builds it is possible to put these variables
108 into
109 .Xr src.conf 5
110 instead of
111 .Nm .
112 This way the environment for documentation and ports builds is not polluted
113 by unrelated variables.
114 .Pp
115 The following lists provide a name and short description for each
116 variable you can use during the indicated builds.
117 The values of
118 variables flagged as
119 .Vt bool
120 are ignored; the variable being
121 set at all (even to
122 .Dq Li FALSE
123 or
124 .Dq Li NO )
125 causes it to
126 be treated as if it were set.
127 .Pp
128 The following list provides a name and short description for variables
129 that are used for all builds, or are used by the
130 .Pa makefiles
131 for things other than builds.
132 .Bl -tag -width Ar
133 .It Va ALWAYS_CHECK_MAKE
134 .Pq Vt bool
135 Instructs the top-level makefile in the source tree (normally
136 .Pa /usr/src )
137 to always check if
138 .Xr make 1
139 is up-to-date.
140 Normally this is only done for the world and buildworld targets to handle
141 upgrades from older versions of
142 .Fx .
143 .It Va CFLAGS
144 .Pq Vt str
145 Controls the compiler setting when compiling C code.
146 Optimization levels other than
147 .Fl O
148 and
149 .Fl O2
150 are not supported.
151 .It Va CPUTYPE
152 .Pq Vt str
153 Controls which processor should be targeted for generated
154 code.
155 This controls processor-specific optimizations in
156 certain code (currently only OpenSSL) as well as modifying
157 the value of
158 .Va CFLAGS
159 and
160 .Va COPTFLAGS
161 to contain the appropriate optimization directive to
162 .Xr cc 1 .
163 The automatic setting of
164 .Va CFLAGS
165 may be overridden using the
166 .Va NO_CPU_CFLAGS
167 variable.
168 Refer to
169 .Pa /usr/share/examples/etc/make.conf
170 for a list of recognized
171 .Va CPUTYPE
172 options.
173 .It Va CXXFLAGS
174 .Pq Vt str
175 Controls the compiler settings when compiling C++ code.
176 .Va CXXFLAGS
177 is initially set to the value of
178 .Va CFLAGS .
179 If you want to
180 add to the
181 .Va CXXFLAGS
182 value, use
183 .Dq Li +=
184 instead of
185 .Dq Li = .
186 .It Va DTC
187 .Pq Vt str
188 Select the compiler for DTS (Device Tree Syntax) file.
189 .Va DTC
190 is initially set to the value of dtc
191 .It Va INSTALL
192 .Pq Vt str
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
196 INSTALL+= -C
197 .Ed
198 Note that some makefiles (including those in
199 .Pa /usr/share/mk )
200 may hardcode options for the supplied install command.
201 .It Va LOCAL_DIRS
202 .Pq Vt str
203 List any directories that should be entered when doing
204 make's in
205 .Pa /usr/src
206 in this variable.
207 .It Va MAKE_SHELL
208 .Pq Vt str
209 Controls the shell used internally by
210 .Xr make 1
211 to process the command scripts in makefiles.
212 .Xr sh 1 ,
213 .Xr ksh 1 ,
214 and
215 .Xr csh 1
216 all currently supported.
217 .Pp
218 .Dl "MAKE_SHELL?=sh"
219 .It Va MTREE_FOLLOWS_SYMLINKS
220 .Pq Vt str
221 Set this to
222 .Dq Fl L
223 to cause
224 .Xr mtree 8
225 to follow symlinks.
226 .It Va NO_CPU_CFLAGS
227 .Pq Vt str
228 Setting this variable will prevent CPU specific compiler flags
229 from being automatically added to
230 .Va CFLAGS
231 during compile time.
232 .It Va NO_DOCUPDATE
233 .Pq Vt bool
234 Set this to not update the doc tree during
235 .Dq Li "make update" .
236 .It Va NO_PORTSUPDATE
237 .Pq Vt bool
238 Set this to not update the ports tree during
239 .Dq Li "make update" .
240 .It Va SVN_UPDATE
241 .Pq Vt bool
242 Set this to use
243 .Xr svn 1
244 or
245 .Xr svnlite 1
246 to update your
247 .Pa src
248 tree with
249 .Dq Li "make update" .
250 Note that you can set
251 .Va SVN
252 to the full path of a
253 .Xr svn 1
254 binary.
255 .El
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:
259 .Bl -tag -width Ar
260 .It Va BOOTWAIT
261 .Pq Vt int
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
267 set to 0.
268 .It Va COPTFLAGS
269 .Pq Vt str
270 Controls the compiler settings when building the
271 kernel.
272 Optimization levels above
273 .Oo Fl O ( O2 , No ...\& ) Oc
274 are not guaranteed to work.
275 .It Va KERNCONF
276 .Pq Vt str
277 Controls which kernel configurations will be
278 built by
279 .Dq Li "${MAKE} buildkernel"
280 and installed by
281 .Dq Li "${MAKE} installkernel" .
282 For example,
283 .Bd -literal -offset indent
284 KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
285 .Ed
286 .Pp
287 will build the kernels specified by the config files
288 .Pa MINE , DEBUG , GENERIC ,
289 and
290 .Pa OTHERMACHINE ,
291 and install the kernel specified by the config file
292 .Pa MINE .
293 It defaults to
294 .Pa GENERIC .
295 .It Va MODULES_OVERRIDE
296 .Pq Vt str
297 Set to a list of modules to build instead of all of them.
298 .It Va NO_KERNELCLEAN
299 .Pq Vt bool
300 Set this to skip running
301 .Dq Li "${MAKE} clean"
302 during
303 .Dq Li "${MAKE} buildkernel" .
304 .It Va NO_KERNELCONFIG
305 .Pq Vt bool
306 Set this to skip running
307 .Xr config 8
308 during
309 .Dq Li "${MAKE} buildkernel" .
310 .It Va NO_KERNELOBJ
311 .Pq Vt bool
312 Set this to skip running
313 .Dq Li "${MAKE} obj"
314 during
315 .Dq Li "${MAKE} buildkernel" .
316 .It Va NO_MODULES
317 .Pq Vt bool
318 Set to not build modules with the kernel.
319 .It Va PORTS_MODULES
320 Set this to the list of ports you wish to rebuild every time the kernel
321 is built.
322 .It Va WITHOUT_MODULES
323 .Pq Vt str
324 Set to a list of modules to exclude from the build.
325 This provides a
326 somewhat easier way to exclude modules you are certain you will never
327 need than specifying
328 .Va MODULES_OVERRIDE .
329 This is applied
330 .Em after
331 .Va MODULES_OVERRIDE .
332 .El
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:
336 .Bl -tag -width Ar
337 .It Va BOOT_COMCONSOLE_PORT
338 .Pq Vt str
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
342 .Pq Vt int
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
346 .Pq Vt bool
347 Compile in the code into
348 .Xr pxeboot 8
349 that forces the use of a serial console.
350 This is analogous to the
351 .Fl h
352 option in
353 .Xr boot 8
354 blocks.
355 .It Va BOOT_PXELDR_PROBE_KEYBOARD
356 .Pq Vt bool
357 Compile in the code into
358 .Xr pxeboot 8
359 that probes the keyboard.
360 If no keyboard is found, boot with the dual console configuration.
361 This is analogous to the
362 .Fl D
363 option in
364 .Xr boot 8
365 blocks.
366 .It Va ENABLE_SUID_K5SU
367 .Pq Vt bool
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
372 .Pq Vt bool
373 Set this to install
374 .Xr newgrp 1
375 with the set-user-ID bit set.
376 Otherwise,
377 .Xr newgrp 1
378 will not be able to change users' groups.
379 .It Va LOADER_TFTP_SUPPORT
380 .Pq Vt bool
381 By default the
382 .Xr pxeboot 8
383 loader retrieves the kernel via NFS.
384 Defining this and recompiling
385 .Pa /usr/src/stand
386 will cause it to retrieve the kernel via TFTP.
387 This allows
388 .Xr pxeboot 8
389 to load a custom BOOTP diskless kernel yet
390 still mount the server's
391 .Pa /
392 rather than load the server's kernel.
393 .It Va LOADER_FIREWIRE_SUPPORT
394 .Pq Vt bool
395 Defining this and recompiling
396 .Pa /usr/src/stand/i386
397 will add
398 .Xr dcons 4
399 console driver to
400 .Xr loader 8
401 and allow access over FireWire(IEEE1394) using
402 .Xr dconschat 8 .
403 Currently, only i386 and amd64 are supported.
404 .It Va MALLOC_PRODUCTION
405 .Pq Vt bool
406 Set this to disable assertions and statistics gathering in
407 .Xr malloc 3 .
408 It also defaults the A and J runtime options to off.
409 Disabled by default on -CURRENT.
410 .It Va MAN_ARCH
411 .Pq Vt str
412 Space-delimited list of one or more MACHINE and/or MACHINE_ARCH values
413 for which section 4 man pages will be installed.
414 The special value
415 .Sq all
416 installs all available architectures.
417 The default is the MACHINE and MACHINE_ARCH being built.
418 .It Va MODULES_WITH_WORLD
419 .Pq Vt bool
420 Set to build modules with the system instead of the kernel.
421 .It Va NO_CLEAN
422 .Pq Vt bool
423 Set this to disable cleaning during
424 .Dq Li "make buildworld" .
425 This should not be set unless you know what you are doing.
426 .It Va NO_CLEANDIR
427 .Pq Vt bool
428 Set this to run
429 .Dq Li "${MAKE} clean"
430 instead of
431 .Dq Li "${MAKE} cleandir" .
432 .It Va WITH_MANCOMPRESS
433 .Pq Vt defined
434 Set to install manual pages compressed.
435 .It Va WITHOUT_MANCOMPRESS
436 .Pq Vt defined
437 Set to install manual pages uncompressed.
438 .It Va NO_SHARE
439 .Pq Vt bool
440 Set to not build in the
441 .Pa share
442 subdir.
443 .It Va NO_SHARED
444 .Pq Vt bool
445 Set to build
446 .Pa /bin
447 and
448 .Pa /sbin
449 statically linked, this can be bad.
450 If set, every utility that uses
451 .Pa bsd.prog.mk
452 will be linked statically.
453 .It Va PPP_NO_NAT
454 .Pq Vt bool
455 Build
456 .Xr ppp 8
457 without support for network address translation (NAT).
458 .It Va PPP_NO_NETGRAPH
459 .Pq Vt bool
460 Set to build
461 .Xr ppp 8
462 without support for Netgraph.
463 .It Va PPP_NO_RADIUS
464 .Pq Vt bool
465 Set to build
466 .Xr ppp 8
467 without support for RADIUS.
468 .It Va PPP_NO_SUID
469 .Pq Vt bool
470 Set to disable the installation of
471 .Xr ppp 8
472 as a set-user-ID root program.
473 .It Va SENDMAIL_ADDITIONAL_MC
474 .Pq Vt str
475 Additional
476 .Pa .mc
477 files which should be built into
478 .Pa .cf
479 files at build time.
480 The value should include the full path to the
481 .Pa .mc
482 file(s), e.g.,
483 .Pa /etc/mail/foo.mc ,
484 .Pa /etc/mail/bar.mc .
485 .It Va SENDMAIL_ALIASES
486 .Pq Vt str
487 List of
488 .Xr aliases 5
489 files to rebuild when using
490 .Pa /etc/mail/Makefile .
491 The default value is
492 .Pa /etc/mail/aliases .
493 .It Va SENDMAIL_CFLAGS
494 .Pq Vt str
495 Flags to pass to the compile command when building
496 .Xr sendmail 8 .
497 The
498 .Va SENDMAIL_*
499 flags can be used to provide SASL support with setting such as:
500 .Bd -literal -offset indent
501 SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
502 SENDMAIL_LDFLAGS=-L/usr/local/lib
503 SENDMAIL_LDADD=-lsasl
504 .Ed
505 .It Va SENDMAIL_CF_DIR
506 .Pq Vt str
507 Override the default location for the
508 .Xr m4 1
509 configuration files used to build a
510 .Pa .cf
511 file from a
512 .Pa .mc
513 file.
514 .It Va SENDMAIL_DPADD
515 .Pq Vt str
516 Extra dependencies to add when building
517 .Xr sendmail 8 .
518 .It Va SENDMAIL_LDADD
519 .Pq Vt str
520 Flags to add to the end of the
521 .Xr ld 1
522 command when building
523 .Xr sendmail 8 .
524 .It Va SENDMAIL_LDFLAGS
525 .Pq Vt str
526 Flags to pass to the
527 .Xr ld 1
528 command when building
529 .Xr sendmail 8 .
530 .It Va SENDMAIL_M4_FLAGS
531 .Pq Vt str
532 Flags passed to
533 .Xr m4 1
534 when building a
535 .Pa .cf
536 file from a
537 .Pa .mc
538 file.
539 .It Va SENDMAIL_MAP_PERMS
540 .Pq Vt str
541 Mode to use when generating alias and map database files using
542 .Pa /etc/mail/Makefile .
543 The default value is 0640.
544 .It Va SENDMAIL_MAP_SRC
545 .Pq Vt str
546 Additional maps to rebuild when using
547 .Pa /etc/mail/Makefile .
548 The
549 .Pa access ,
550 .Pa bitdomain ,
551 .Pa domaintable ,
552 .Pa genericstable ,
553 .Pa mailertable ,
554 .Pa uucpdomain ,
555 and
556 .Pa virtusertable
557 maps are always rebuilt if they exist.
558 .It Va SENDMAIL_MAP_TYPE
559 .Pq Vt str
560 Database map type to use when generating map database files using
561 .Pa /etc/mail/Makefile .
562 The default value is hash.
563 The alternative is btree.
564 .It Va SENDMAIL_MC
565 .Pq Vt str
566 The default
567 .Xr m4 1
568 configuration file to use at install time.
569 The value should include the full path to the
570 .Pa .mc
571 file, e.g.,
572 .Pa /etc/mail/myconfig.mc .
573 Use with caution as a make install will overwrite any existing
574 .Pa /etc/mail/sendmail.cf .
575 Note that
576 .Va SENDMAIL_CF
577 is deprecated.
578 .It Va SENDMAIL_SET_USER_ID
579 .Pq Vt bool
580 If set, install
581 .Xr sendmail 8
582 as a set-user-ID root binary instead of a set-group-ID binary
583 and do not install
584 .Pa /etc/mail/submit.{cf,mc} .
585 Use of this flag is not recommended and the alternative advice in
586 .Pa /etc/mail/README
587 should be followed instead if at all possible.
588 .It Va SENDMAIL_START_SCRIPT
589 .Pq Vt str
590 The script used by
591 .Pa /etc/mail/Makefile
592 to start, stop, and restart
593 .Xr sendmail 8 .
594 The default value is
595 .Pa /etc/rc.sendmail .
596 This value should match the
597 .Dq Li mta_start_script
598 setting in
599 .Xr rc.conf 5 .
600 .It Va SENDMAIL_SUBMIT_MC
601 .Pq Vt str
602 The default
603 .Xr m4 1
604 configuration file for mail submission
605 to use at install time.
606 The value should include the full path to the
607 .Pa .mc
608 file, e.g.,
609 .Pa /etc/mail/mysubmit.mc .
610 Use with caution as a make install will overwrite any existing
611 .Pa /etc/mail/submit.cf .
612 .It Va TOP_TABLE_SIZE
613 .Pq Vt int
614 .Xr top 1
615 uses a hash table for the user names.
616 The size of this hash can be tuned to match the number of local users.
617 The table size should be a prime number
618 approximately twice as large as the number of lines in
619 .Pa /etc/passwd .
620 The default number is 20011.
621 .It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
622 .Pq Vt int
623 Causes the system compiler to be built such that it forces high optimization
624 levels to a lower one.
625 .Xr cc 1
626 .Fl O2
627 and above is known to trigger known optimizer bugs at various
628 times.
629 The value assigned is the highest optimization value used.
630 .El
631 .Ss "BUILDING DOCUMENTATION"
632 The following list provides a name and short description for variables
633 that are used when building documentation.
634 .Bl -tag -width ".Va PRINTERDEVICE"
635 .It Va DISTDIR
636 .Pq Vt str
637 Where distfiles are kept.
638 Normally, this is
639 .Pa distfiles
640 in
641 .Va PORTSDIR .
642 .It Va DOC_LANG
643 .Pq Vt str
644 The list of languages and encodings to build and install.
645 .It Va PRINTERDEVICE
646 .Pq Vt str
647 The default format for system documentation, depends on your
648 printer.
649 This can be set to
650 .Dq Li ascii
651 for simple printers, or
652 .Dq Li ps
653 for postscript or graphics printers with a ghostscript
654 filter, or both.
655 .El
656 .Ss "BUILDING PORTS"
657 Several make variables can be set that affect the building of ports.
658 These variables and their effects are documented in
659 .Xr ports 7 ,
660 .Pa ${PORTSDIR}/Mk/*
661 and the
662 .Fx
663 Porter's Handbook.
664 .Sh FILES
665 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
666 .It Pa /etc/make.conf
667 .It Pa /usr/doc/Makefile
668 .It Pa /usr/ports/Makefile
669 .It Pa /usr/share/examples/etc/make.conf
670 .It Pa /usr/share/mk/sys.mk
671 .It Pa /usr/src/Makefile
672 .It Pa /usr/src/Makefile.inc1
673 .El
674 .Sh SEE ALSO
675 .Xr cc 1 ,
676 .Xr install 1 ,
677 .Xr make 1 ,
678 .Xr src.conf 5 ,
679 .Xr style.Makefile 5 ,
680 .Xr environ 7 ,
681 .Xr ports 7 ,
682 .Xr sendmail 8
683 .Sh HISTORY
684 The
685 .Nm
686 file appeared sometime before
687 .Fx 4.0 .
688 .Sh AUTHORS
689 This
690 manual page was written by
691 .An Mike W. Meyer Aq Mt mwm@mired.org .
692 .Sh CAVEATS
693 Note, that
694 .Ev MAKEOBJDIRPREFIX
695 and
696 .Ev MAKEOBJDIR
697 are environment variables and should not be set in
698 .Nm
699 or as command line arguments to
700 .Xr make 1 ,
701 but in make's environment.
702 .Sh BUGS
703 This manual page may occasionally be out of date with respect to
704 the options currently available for use in
705 .Nm .
706 Please check the
707 .Pa /usr/share/examples/etc/make.conf
708 file for the latest options which are available.