xref: /dragonfly/share/man/man5/make.conf.5 (revision 3d201fd0)
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: src/share/man/man5/make.conf.5,v 1.12.2.30 2003/05/18 17:05:55 brueffer Exp $
26.\" $DragonFly: src/share/man/man5/make.conf.5,v 1.10 2005/09/06 18:55:39 dillon Exp $
27.\"
28.Dd November 3, 2000
29.Dt MAKE.CONF 5
30.Os
31.Sh NAME
32.Nm make.conf
33.Nd system build information
34.Sh DESCRIPTION
35The file
36.Nm
37contains settings that control the compilation of the
38.Dx
39sources.
40The file
41.Nm
42is generally created by the system administrator when the values need
43to be changed from their defaults.
44.Pp
45The purpose of
46.Nm
47is not to run commands or perform compilation actions
48directly.
49Instead, it is included by the various makefiles in
50.Pa /usr/src
51which conditionalize their internal actions according to the settings
52found there.
53.Pp
54The
55.Pa /etc/make.conf
56file is included from the appropriate
57.Pa Makefile
58which specifies the default settings for all the available options.
59Options need only be specified in
60.Pa /etc/make.conf
61when the system administrator wishes to override these defaults.
62.Pp
63The build procedures occur in three areas: world, kernel, and
64documentation.
65Variables set in
66.Nm
67may be applicable during builds in one, two, or all of these areas.
68They may be specified for a particular build via the
69.Fl D
70option of
71.Xr make 1 .
72.Pp
73The following lists provide a name and short description for each
74variable you can use during the indicated builds.
75The values of variables flagged as
76.Vt bool
77are ignored; the variable being set at all (even to
78.Dq Li FALSE
79or
80.Dq Li NO )
81causes it to be treated as if it were set.
82.Pp
83The following list provides a name and short description for variables
84that are used for all builds, or are used by the
85.Pa makefiles
86for things other than builds.
87.Bl -tag -width Ar
88.It Va CPUTYPE
89.Pq Vt str
90Controls which processor should be targeted for generated code.
91This controls processor-specific optimizations in certain code
92(currently only OpenSSL) as well as modifying the value of
93.Va CFLAGS
94and
95.Va COPTFLAGS
96to contain the appropriate optimization directive to
97.Xr gcc 1 .
98The automatic setting of
99.Va CFLAGS
100and
101.Va COPTFLAGS
102may be overridden using the
103.Va NO_CPU_CFLAGS
104and
105.Va NO_CPU_COPTFLAGS
106variables, respectively.  Refer to
107.Pa /usr/share/examples/etc/defaults/make.conf
108for a list of recognized
109.Va CPUTYPE
110options.
111.It Va CCVER
112.Pq Vt str
113Controls which GCC version to use by default.  It should be set as
114CCVER?= so as not to interfere with overrides from userland. We
115currently recommend that an override NOT be set in
116.Pa /etc/make.conf .
117Currently accepted values are cc34 and cc40 (experimental).
118.It Va CFLAGS
119.Pq Vt str
120Controls the compiler setting when compiling C code.
121Optimization levels above
122.Fl O
123.Pq Fl O2 , No ...
124are not supported.
125.Va BDECFLAGS
126is provided as a set of
127.Xr gcc 1
128settings suggested by
129.An "Bruce Evans" Aq bde@FreeBSD.org
130for developing and testing changes.
131They can be used, if set, by:
132.Pp
133.Bd -literal -offset indent
134CFLAGS+=${BDECFLAGS}
135.Ed
136.It Va NO_CPU_CFLAGS
137.Pq Vt str
138Setting this variable will prevent CPU specific compiler flags
139from being automatically added to
140.Va CFLAGS
141during compile time.
142.It Va CXXFLAGS
143.Pq Vt str
144Controls the compiler settings when compiling C++ code.
145.Va CXXFLAGS
146is initially set to the value of
147.Va CFLAGS .
148If you want to add to the
149.Va CXXFLAGS
150value, use
151.Dq Li +=
152instead of
153.Dq Li = .
154.It Va INSTALL
155.Pq Vt str
156the default install command.
157To have components compared before doing the install, use
158.Bd -literal -offset indent
159INSTALL="install -C"
160.Ed
161.It Va LOCAL_DIRS
162.Pq Vt str
163List any directories that should be entered when running make
164.Pa /usr/src
165in this variable.
166.It Va MAKE_SHELL
167.Pq Vt str
168Controls the shell used internally by
169.Xr make 1
170to process the command scripts in makefiles.
171.Xr sh 1 ,
172.Xr ksh 1 ,
173and
174.Xr csh 1
175all currently supported.
176.Bd -literal -offset indent
177MAKE_SHELL?=sh
178.Ed
179.It Va MODULES_OVERRIDE
180.Pq Vt str
181Set to a list of modules to build instead of all of them.
182.It Va MTREE_FOLLOWS_SYMLINKS
183.Pq Vt str
184Set this to
185.Dq Fl L
186to cause
187.Xr mtree 8
188to follow symlinks.
189.It Va NO_DOCUPDATE
190.Pq Vt bool
191Set this to not update the doc tree during
192.Dq Li "make update" .
193.It Va STRIP
194.Pq Vt str
195Set this to the flag to pass the
196.Xr strip 1
197command.
198If set to a blank value, components will be installed with debugging
199symbols.
200.It Va SUP_UPDATE
201.Pq Vt bool
202Set this to use
203.Xr cvsup 1
204to update your ports with
205.Dq Li "make update" .
206.It Va SUP
207.Pq Vt str
208The location of the
209.Xr cvsup 1
210command for
211.Dq Li "make update" .
212.It Va SUPFLAGS
213.Pq Vt str
214The flag for the
215.Xr sup 1
216command when doing
217.Dq Li "make update" .
218This defaults to
219.Op Fl g L Ar 2 .
220.It Va SUPHOST
221.Pq Vt str
222The hostname of the sup server to use when doing
223.Dq Li "make update" .
224.It Va SUPFILE
225.Pq Vt str
226The first
227.Ar supfile
228to use when doing a
229.Dq Li "make update" .
230This defaults to
231.Pa /usr/share/examples/cvsup/standard\-supfile .
232.It Va SUPFILE1
233.Pq Vt str
234The second
235.Ar supfile
236to use when doing a
237.Dq Li "make update" .
238This defaults to
239.Pa /usr/share/examples/cvsup/secure\-supfile .
240.It Va SUPFILE2
241.Pq Vt str
242The third
243.Ar supfile
244to use when doing a
245.Dq Li "make update" .
246This defaults to
247.Pa /usr/share/examples/cvsup/secure\-supfile .
248.It Va DOCSUPFILE
249.Pq Vt str
250The documentation
251.Ar supfile
252to use when doing a
253.Dq Li "make update" .
254This defaults to
255.Pa /usr/share/examples/cvsup/doc\-supfile .
256.It Va WARNS_WERROR
257Causes
258.Fl Werror
259to be added to
260.Va CFLAGS
261when WARNS is in effect.
262.El
263.Pp
264The following list provides a name and short description for variables
265that are only used doing a kernel build:
266.Bl -tag -width Ar
267.It Va BOOT_COMCONSOLE_PORT
268.Pq Vt str
269The port address to use for the console if the boot blocks have
270been configured to use a serial console instead of the keyboard/video card.
271.It Va BOOT_COMCONSOLE_SPEED
272.Pq Vt int
273The baud rate to use for the console if the boot blocks have
274been configured to use a serial console instead of the keyboard/video card.
275.It Va BOOTWAIT
276.Pq Vt int
277Controls the amount of time the kernel waits for a console keypress
278before booting the default kernel.
279The value is approximately milliseconds.
280Keypresses are accepted by the BIOS before booting from disk,
281making it possible to give custom boot parameters even when this is
282set to 0.
283.It Va COPTFLAGS
284.Pq Vt str
285Controls the compiler settings when building the
286kernel.
287Optimization levels above
288.Oo Fl O ( O2 , No ...\& ) Oc
289are not guaranteed to work.
290.It Va KERNCONF
291.Pq Vt str
292Controls which kernel configurations will be
293built by
294.Dq Li "${MAKE} buildkernel"
295and installed by
296.Dq Li "${MAKE} installkernel" .
297For example,
298.Bd -literal -offset indent
299KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
300.Ed
301.Pp
302will build the kernels specified by the config files
303.Pa MINE , DEBUG , GENERIC ,
304and
305.Pa OTHERMACHINE ,
306and install the kernel specified by the config file
307.Pa MINE .
308It defaults to
309.Pa GENERIC .
310.It Va LOADER_TFTP_SUPPORT
311.Pq Vt bool
312While not a buildkernel-affected option, there is no better place for this.
313By default the
314.Xr pxeboot 8
315loader retrieves the kernel via NFS.
316Defining this and recompiling
317.Pa /usr/src/sys/boot
318will cause it to retrieve the kernel via TFTP.
319This allows pxeboot to load a custom BOOTP diskless kernel yet
320still mount the server's
321.Pa /
322rather than load the server's kernel.
323.It Va NO_CPU_COPTFLAGS
324.Pq Vt str
325Setting this variable will prevent CPU specific compiler flags
326from being automatically added to
327.Va COPTFLAGS
328during compile time.
329.It Va NO_KERNELCLEAN
330.Pq Vt bool
331Set this to skip the clean target when using
332.Dq Li "${MAKE} buildkernel" .
333.It Va NO_KERNELCONFIG
334.Pq Vt bool
335Set this to skip running
336.Xr config 8
337during
338.Dq Li "${MAKE} buildkernel" .
339.It Va NO_KERNELDEPEND
340.Pq Vt bool
341Set this to skip running
342.Dq Li "${MAKE} depend"
343during
344.Dq Li "${MAKE} buildkernel" .
345.It Va NO_MODULES
346.Pq Vt bool
347Set to not build modules with the kernel.
348.El
349.Pp
350The following list provides a name and short description for variables
351that are used during the world build:
352.Bl -tag -width Ar
353.It Va ENABLE_SUID_K5SU
354.Pq Vt bool
355Set this if you wish to use the k5su utility.
356Otherwise, it will be installed without the set-user-ID bit set.
357This is only relevant if
358.Va WANT_KERBEROS
359is defined.
360.It Va ENABLE_SUID_SSH
361.Pq Vt bool
362Set this to install
363.Xr ssh 1
364with the setuid bit turned on.
365.It Va FETCH_ENV
366.Pq Vt str
367If you're behind a firewall and need FTP or HTTP proxy services for
368.Xr fetch 1 ,
369the following examples provide the necessary syntax.
370.Pp
371.Bd -literal -offset indent
372FETCH_ENV=FTP_PROXY=ftp://10.0.0.1:21
373FETCH_ENV=FTP_PROXY=http://10.0.0.1:80
374.Ed
375.It Va MODULES_WITH_WORLD
376.Pq Vt bool
377Set to build modules with the system instead of the kernel.
378.It Va NO_BIND
379.Pq Vt bool
380Set to not build BIND.
381.It Va NO_CRYPT
382.Pq Vt bool
383Set to not build crypto code.
384.It Va NO_CVS
385.Pq Vt bool
386Set to not build CVS.
387.It Va NO_FORTRAN
388.Pq Vt bool
389Set to not build
390.Xr g77 1
391and related libraries.
392.It Va NO_GAMES
393.Pq Vt bool
394Set to not build games.
395.It Va NO_GDB
396.Pq Vt bool
397Set to not build
398.Xr gdb 1
399.It Va NO_I4B
400.Pq Vt bool
401Set to not build isdn4bsd package.
402.It Va NO_IPFILTER
403.Pq Vt bool
404Set to not build IP Filter package.
405.It Va NO_LIBC_R
406.Pq Vt bool
407Set to not build
408.Nm libc_r
409(reentrant version of
410.Nm libc ) .
411.It Va NO_LPR
412.Pq Vt bool
413Set to not build
414.Xr lpr 1
415and related programs.
416.It Va NO_MAILWRAPPER
417.Pq Vt bool
418Set to not build the
419.Xr mailwrapper 8
420MTA selector.
421.It Va NO_MAKEDEV
422.Pq Vt bool
423Set to avoid running
424.Dq Li "MAKEDEV all"
425on
426.Pa /dev
427during install.
428.It Va NO_OBJC
429.Pq Vt bool
430Set to not build Objective C support.
431.It Va NO_OPENSSH
432.Pq Vt bool
433Set to not build OpenSSH.
434.It Va NO_OPENSSL
435.Pq Vt bool
436Set to not build OpenSSL (implies
437.Va NO_OPENSSH ) .
438.It Va NO_SENDMAIL
439.Pq Vt bool
440Set to not build
441.Xr sendmail 8
442and related programs.
443.It Va NO_SHARE
444.Pq Vt bool
445Set to not enter the share subdirectory.
446.It Va NO_SHAREDOCS
447.Pq Vt bool
448Set to not build the
449.Bx 4.4
450legacy docs.
451.It Va NO_X
452.Pq Vt bool
453Set to not compile in X\-Windows support (e.g.\&
454.Xr doscmd 1 ) .
455.It Va NOCLEAN
456.Pq Vt bool
457Set this to disable cleaning during
458.Dq Li "make buildworld" .
459This should not be set unless you know what you are doing.
460.It Va NOCLEANDIR
461.Pq Vt bool
462Set this to run
463.Dq Li "${MAKE} clean"
464instead of
465.Dq Li "${MAKE} cleandir" .
466.It Va NOFSCHG
467.Pq Vt bool
468Set to not install certain components with flag fschg.
469This is useful in a jailed environment.
470.It Va NOINFO
471.Pq Vt bool
472Set to not make or install
473.Xr info 5
474files.
475.It Va NOINFOCOMPRESS
476.Pq Vt bool
477Set to not compress the info pages.
478.It Va NOMAN
479.Pq Vt bool
480Set to not build manual pages
481.It Va NOMANCOMPRESS
482.Pq Vt bool
483Set to not compress the manual pages.
484.It Va NOPROFILE
485.Pq Vt bool
486Set to avoid compiling profiled libraries.
487.It Va PPP_NOSUID
488.Pq Vt bool
489Set to disable the installation of
490.Xr ppp 8
491with the set-user-ID bit on.
492.It Va SENDMAIL_MC
493.Pq Vt str
494The default
495.Xr m4 1
496configuration file to use at install time.
497The value should include the full path to the
498.Pa .mc
499file, e.g.,
500.Pa /etc/mail/myconfig.mc .
501Use with caution as a make install will overwrite any existing
502.Pa /etc/mail/sendmail.cf .
503Note that
504.Va SENDMAIL_CF
505is now deprecated.
506.It Va SENDMAIL_SUBMIT_MC
507.Pq Vt str
508The default
509.Xr m4 1
510configuration file for mail submission
511to use at install time.
512The value should include the full path to the
513.Pa .mc
514file, e.g.,
515.Pa /etc/mail/mysubmit.mc .
516Use with caution as a make install will overwrite any existing
517.Pa /etc/mail/submit.cf .
518.It Va SENDMAIL_ADDITIONAL_MC
519.Pq Vt str
520Additional
521.Pa .mc
522files which should be built into
523.Pa .cf
524files at build time.
525The value should include the full path to the
526.Pa .mc
527file(s), e.g.,
528.Pa /etc/mail/foo.mc
529.Pa /etc/mail/bar.mc .
530.It Va SENDMAIL_CF_DIR
531.Pq Vt str
532Override the default location for the
533.Xr m4 1
534configuration files used to build a
535.Pa .cf
536file from a
537.Pa .mc
538file.
539.It Va SENDMAIL_M4_FLAGS
540.Pq Vt str
541Flags passed to
542.Xr m4 1
543when building a
544.Pa .cf
545file from a
546.Pa .mc
547file.
548.It Va SENDMAIL_CFLAGS
549.Pq Vt str
550Flags to pass to the compile command when building
551.Xr sendmail 8 .
552The
553.Va SENDMAIL_*
554flags can be used to provide SASL support with setting such as:
555.Bd -literal -offset indent
556SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
557SENDMAIL_LDFLAGS=-L/usr/local/lib
558SENDMAIL_LDADD=-lsasl
559.Ed
560.It Va SENDMAIL_LDFLAGS
561.Pq Vt str
562Flags to pass to the
563.Xr ld 1
564command when building
565.Xr sendmail 8 .
566.It Va SENDMAIL_LDADD
567.Pq Vt str
568Flags to add to the end of the
569.Xr ld 1
570command when building
571.Xr sendmail 8 .
572.It Va SENDMAIL_DPADD
573.Pq Vt str
574Extra dependencies to add when building
575.Xr sendmail 8 .
576.It Va SENDMAIL_SET_USER_ID
577.Pq Vt bool
578If set, install
579.Xr sendmail 8
580as a set-user-ID root binary instead of a set-group-ID binary
581and do not install
582.Pa /etc/mail/submit.{cf,mc} .
583Use of this flag is not recommended and the alternative advice in
584.Pa /etc/mail/README
585should be followed instead if at all possible.
586.It Va SENDMAIL_MAP_PERMS
587.Pq Vt str
588Mode to use when generating alias and map database files using
589.Pa /etc/mail/Makefile .
590The default value is 0640.
591.It Va TOP_TABLE_SIZE
592.Pq Vt int
593.Xr top 1
594uses a hash table for the user names.  The size of this hash can be tuned
595to match the number of local users.  The table size should be a prime number
596approximately twice as large as the number of lines in
597.Pa /etc/passwd .
598The default number is 20011.
599.It Va WANT_GCC40
600.Pq Vt bool
601Set to build the experimental version of GCC (4.0).
602.It Va WANT_IDEA
603.Pq Vt bool
604Set to build the IDEA encryption code.
605This code is patented in the USA and many European countries.
606It is
607.Em "YOUR RESPONSIBILITY"
608to determine if you can legally use IDEA.
609.It Va WANT_KERBEROS
610.Pq Vt bool
611Set this to build Kerberos5 (KTH Heimdal).
612.Em WARNING !
613This is still experimental code.
614.El
615.Pp
616The following list provides a name and short description for variables
617that are used when building documentation.
618.Bl -tag -width Ar
619.It Va DOC_LANG
620.Pq Vt str
621The list of languages and encodings to build and install.
622.It Va PRINTERDEVICE
623.Pq Vt str
624The default format for system documentation, depends on your
625printer.
626This can be set to
627.Dq Li ascii
628for simple printers or
629.Dq Li ps
630for postscript or graphics printers with a ghostscript
631filter.
632.El
633.Sh FILES
634.Bl -tag -width /etc/defaults/make.conf -compact
635.It Pa /etc/defaults/make.conf
636.It Pa /etc/make.conf
637.It Pa /usr/src/Makefile
638.It Pa /usr/src/Makefile.inc1
639.It Pa /usr/ports/Mk/bsd.port.mk
640.It Pa /usr/ports/Mk/bsd.sites.mk
641.El
642.Sh SEE ALSO
643.Xr gcc 1 ,
644.Xr install 1 ,
645.Xr make 1 ,
646.Xr ports 7 ,
647.Xr lpd 8 ,
648.Xr sendmail 8
649.Sh HISTORY
650The
651.Nm
652file appeared sometime before
653.Fx 4.0 .
654.Sh AUTHORS
655This manual page was written by
656.An Mike W. Meyer Aq mwm@mired.org .
657.Sh BUGS
658This manual page may occasionally be out of date with respect to
659the options currently available for use in
660.Nm .
661Please check the
662.Pa /etc/defaults/make.conf
663file for the latest options which are available.
664