xref: /dragonfly/share/man/man5/make.conf.5 (revision 0bb9290e)
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.14 2006/07/02 16:03:42 swildner Exp $
27.\"
28.Dd July 2, 2006
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 COPTFLAGS
276.Pq Vt str
277Controls the compiler settings when building the
278kernel.
279Optimization levels above
280.Oo Fl O ( O2 , No ...\& ) Oc
281are not guaranteed to work.
282.It Va KERNCONF
283.Pq Vt str
284Controls which kernel configurations will be
285built by
286.Dq Li "${MAKE} buildkernel"
287and installed by
288.Dq Li "${MAKE} installkernel" .
289For example,
290.Bd -literal -offset indent
291KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
292.Ed
293.Pp
294will build the kernels specified by the config files
295.Pa MINE , DEBUG , GENERIC ,
296and
297.Pa OTHERMACHINE ,
298and install the kernel specified by the config file
299.Pa MINE .
300It defaults to
301.Pa GENERIC .
302.It Va LOADER_TFTP_SUPPORT
303.Pq Vt bool
304While not a buildkernel-affected option, there is no better place for this.
305By default the
306.Xr pxeboot 8
307loader retrieves the kernel via NFS.
308Defining this and recompiling
309.Pa /usr/src/sys/boot
310will cause it to retrieve the kernel via TFTP.
311This allows pxeboot to load a custom BOOTP diskless kernel yet
312still mount the server's
313.Pa /
314rather than load the server's kernel.
315.It Va NO_CPU_COPTFLAGS
316.Pq Vt str
317Setting this variable will prevent CPU specific compiler flags
318from being automatically added to
319.Va COPTFLAGS
320during compile time.
321.It Va NO_KERNELCLEAN
322.Pq Vt bool
323Set this to skip the clean target when using
324.Dq Li "${MAKE} buildkernel" .
325.It Va NO_KERNELCONFIG
326.Pq Vt bool
327Set this to skip running
328.Xr config 8
329during
330.Dq Li "${MAKE} buildkernel" .
331.It Va NO_KERNELDEPEND
332.Pq Vt bool
333Set this to skip running
334.Dq Li "${MAKE} depend"
335during
336.Dq Li "${MAKE} buildkernel" .
337.It Va NO_MODULES
338.Pq Vt bool
339Set to not build modules with the kernel.
340.El
341.Pp
342The following list provides a name and short description for variables
343that are used during the world build:
344.Bl -tag -width Ar
345.It Va ENABLE_SUID_K5SU
346.Pq Vt bool
347Set this if you wish to use the k5su utility.
348Otherwise, it will be installed without the set-user-ID bit set.
349This is only relevant if
350.Va WANT_KERBEROS
351is defined.
352.It Va ENABLE_SUID_SSH
353.Pq Vt bool
354Set this to install
355.Xr ssh 1
356with the setuid bit turned on.
357.It Va FETCH_ENV
358.Pq Vt str
359If you're behind a firewall and need FTP or HTTP proxy services for
360.Xr fetch 1 ,
361the following examples provide the necessary syntax.
362.Pp
363.Bd -literal -offset indent
364FETCH_ENV=FTP_PROXY=ftp://10.0.0.1:21
365FETCH_ENV=FTP_PROXY=http://10.0.0.1:80
366.Ed
367.It Va MODULES_WITH_WORLD
368.Pq Vt bool
369Set to build modules with the system instead of the kernel.
370.It Va NO_BIND
371.Pq Vt bool
372Set to not build BIND.
373.It Va NO_CRYPT
374.Pq Vt bool
375Set to not build crypto code.
376.It Va NO_CVS
377.Pq Vt bool
378Set to not build CVS.
379.It Va NO_FORTRAN
380.Pq Vt bool
381Set to not build
382.Xr g77 1
383and related libraries.
384.It Va NO_GAMES
385.Pq Vt bool
386Set to not build games.
387.It Va NO_GDB
388.Pq Vt bool
389Set to not build
390.Xr gdb 1
391.It Va NO_I4B
392.Pq Vt bool
393Set to not build isdn4bsd package.
394.It Va NO_IPFILTER
395.Pq Vt bool
396Set to not build IP Filter package.
397.It Va NO_LIBC_R
398.Pq Vt bool
399Set to not build
400.Nm libc_r
401(reentrant version of
402.Nm libc ) .
403.It Va NO_LPR
404.Pq Vt bool
405Set to not build
406.Xr lpr 1
407and related programs.
408.It Va NO_MAILWRAPPER
409.Pq Vt bool
410Set to not build the
411.Xr mailwrapper 8
412MTA selector.
413.It Va NO_MAKEDEV
414.Pq Vt bool
415Set to avoid running
416.Dq Li "MAKEDEV all"
417on
418.Pa /dev
419during install.
420.It Va NO_OBJC
421.Pq Vt bool
422Set to not build Objective C support.
423.It Va NO_OPENSSH
424.Pq Vt bool
425Set to not build OpenSSH.
426.It Va NO_OPENSSL
427.Pq Vt bool
428Set to not build OpenSSL (implies
429.Va NO_OPENSSH ) .
430.It Va NO_SENDMAIL
431.Pq Vt bool
432Set to not build
433.Xr sendmail 8
434and related programs.
435.It Va NO_SHARE
436.Pq Vt bool
437Set to not enter the share subdirectory.
438.It Va NO_X
439.Pq Vt bool
440Set to not compile in X\-Windows support (e.g.\&
441.Xr doscmd 1 ) .
442.It Va NOCLEAN
443.Pq Vt bool
444Set this to disable cleaning during
445.Dq Li "make buildworld" .
446This should not be set unless you know what you are doing.
447.It Va NOCLEANDIR
448.Pq Vt bool
449Set this to run
450.Dq Li "${MAKE} clean"
451instead of
452.Dq Li "${MAKE} cleandir" .
453.It Va NOFSCHG
454.Pq Vt bool
455Set to not install certain components with flag fschg.
456This is useful in a jailed environment.
457.It Va NOINFO
458.Pq Vt bool
459Set to not make or install
460.Xr info 5
461files.
462.It Va NOINFOCOMPRESS
463.Pq Vt bool
464Set to not compress the info pages.
465.It Va NOMAN
466.Pq Vt bool
467Set to not build manual pages
468.It Va NOMANCOMPRESS
469.Pq Vt bool
470Set to not compress the manual pages.
471.It Va NOPROFILE
472.Pq Vt bool
473Set to avoid compiling profiled libraries.
474.It Va PPP_NOSUID
475.Pq Vt bool
476Set to disable the installation of
477.Xr ppp 8
478with the set-user-ID bit on.
479.It Va SENDMAIL_MC
480.Pq Vt str
481The default
482.Xr m4 1
483configuration file to use at install time.
484The value should include the full path to the
485.Pa .mc
486file, e.g.,
487.Pa /etc/mail/myconfig.mc .
488Use with caution as a make install will overwrite any existing
489.Pa /etc/mail/sendmail.cf .
490Note that
491.Va SENDMAIL_CF
492is now deprecated.
493.It Va SENDMAIL_SUBMIT_MC
494.Pq Vt str
495The default
496.Xr m4 1
497configuration file for mail submission
498to use at install time.
499The value should include the full path to the
500.Pa .mc
501file, e.g.,
502.Pa /etc/mail/mysubmit.mc .
503Use with caution as a make install will overwrite any existing
504.Pa /etc/mail/submit.cf .
505.It Va SENDMAIL_ADDITIONAL_MC
506.Pq Vt str
507Additional
508.Pa .mc
509files which should be built into
510.Pa .cf
511files at build time.
512The value should include the full path to the
513.Pa .mc
514file(s), e.g.,
515.Pa /etc/mail/foo.mc
516.Pa /etc/mail/bar.mc .
517.It Va SENDMAIL_CF_DIR
518.Pq Vt str
519Override the default location for the
520.Xr m4 1
521configuration files used to build a
522.Pa .cf
523file from a
524.Pa .mc
525file.
526.It Va SENDMAIL_M4_FLAGS
527.Pq Vt str
528Flags passed to
529.Xr m4 1
530when building a
531.Pa .cf
532file from a
533.Pa .mc
534file.
535.It Va SENDMAIL_CFLAGS
536.Pq Vt str
537Flags to pass to the compile command when building
538.Xr sendmail 8 .
539The
540.Va SENDMAIL_*
541flags can be used to provide SASL support with setting such as:
542.Bd -literal -offset indent
543SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
544SENDMAIL_LDFLAGS=-L/usr/local/lib
545SENDMAIL_LDADD=-lsasl
546.Ed
547.It Va SENDMAIL_LDFLAGS
548.Pq Vt str
549Flags to pass to the
550.Xr ld 1
551command when building
552.Xr sendmail 8 .
553.It Va SENDMAIL_LDADD
554.Pq Vt str
555Flags to add to the end of the
556.Xr ld 1
557command when building
558.Xr sendmail 8 .
559.It Va SENDMAIL_DPADD
560.Pq Vt str
561Extra dependencies to add when building
562.Xr sendmail 8 .
563.It Va SENDMAIL_SET_USER_ID
564.Pq Vt bool
565If set, install
566.Xr sendmail 8
567as a set-user-ID root binary instead of a set-group-ID binary
568and do not install
569.Pa /etc/mail/submit.{cf,mc} .
570Use of this flag is not recommended and the alternative advice in
571.Pa /etc/mail/README
572should be followed instead if at all possible.
573.It Va SENDMAIL_MAP_PERMS
574.Pq Vt str
575Mode to use when generating alias and map database files using
576.Pa /etc/mail/Makefile .
577The default value is 0640.
578.It Va TOP_TABLE_SIZE
579.Pq Vt int
580.Xr top 1
581uses a hash table for the user names.  The size of this hash can be tuned
582to match the number of local users.  The table size should be a prime number
583approximately twice as large as the number of lines in
584.Pa /etc/passwd .
585The default number is 20011.
586.It Va WANT_GCC40
587.Pq Vt bool
588Set to build the experimental version of GCC (4.0).
589.It Va WANT_IDEA
590.Pq Vt bool
591Set to build the IDEA encryption code.
592This code is patented in the USA and many European countries.
593It is
594.Em "YOUR RESPONSIBILITY"
595to determine if you can legally use IDEA.
596.It Va WANT_KERBEROS
597.Pq Vt bool
598Set this to build Kerberos5 (KTH Heimdal).
599.Em WARNING !
600This is still experimental code.
601.It Va WITH_BSDTAR
602.Pq Vt bool
603Set this to use
604.Xr bsdtar 1
605as the stardard
606.Xr tar 1 .
607The default is to use GNU
608.Xr tar 1 .
609.El
610.Pp
611The following list provides a name and short description for variables
612that are used when building documentation.
613.Bl -tag -width Ar
614.It Va DOC_LANG
615.Pq Vt str
616The list of languages and encodings to build and install.
617.It Va PRINTERDEVICE
618.Pq Vt str
619The default format for system documentation, depends on your
620printer.
621This can be set to
622.Dq Li ascii
623for simple printers or
624.Dq Li ps
625for postscript or graphics printers with a ghostscript
626filter.
627.El
628.Sh FILES
629.Bl -tag -width /etc/defaults/make.conf -compact
630.It Pa /etc/defaults/make.conf
631.It Pa /etc/make.conf
632.It Pa /usr/src/Makefile
633.It Pa /usr/src/Makefile.inc1
634.El
635.Sh SEE ALSO
636.Xr gcc 1 ,
637.Xr install 1 ,
638.Xr make 1 ,
639.Xr lpd 8 ,
640.Xr sendmail 8
641.Sh HISTORY
642The
643.Nm
644file appeared sometime before
645.Fx 4.0 .
646.Sh AUTHORS
647This manual page was written by
648.An Mike W. Meyer Aq mwm@mired.org .
649.Sh BUGS
650This manual page may occasionally be out of date with respect to
651the options currently available for use in
652.Nm .
653Please check the
654.Pa /etc/defaults/make.conf
655file for the latest options which are available.
656