Remove doscmd(1).
[dragonfly.git] / share / man / man5 / make.conf.5
CommitLineData
984263bc
MD
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.\"
1feb8780 27.Dd December 15, 2011
984263bc
MD
28.Dt MAKE.CONF 5
29.Os
30.Sh NAME
31.Nm make.conf
32.Nd system build information
33.Sh DESCRIPTION
34The file
35.Nm
36contains settings that control the compilation of the
9bb2a92d 37.Dx
cecff5c1 38sources.
984263bc
MD
39The file
40.Nm
41is generally created by the system administrator when the values need
42to be changed from their defaults.
43.Pp
44The purpose of
45.Nm
46is not to run commands or perform compilation actions
47directly.
cecff5c1 48Instead, it is included by the various makefiles in
0cd7b3a7 49.Pa /usr/src
cecff5c1
MD
50which conditionalize their internal actions according to the settings
51found there.
984263bc
MD
52.Pp
53The
54.Pa /etc/make.conf
55file is included from the appropriate
56.Pa Makefile
57which specifies the default settings for all the available options.
58Options need only be specified in
59.Pa /etc/make.conf
60when the system administrator wishes to override these defaults.
61.Pp
cecff5c1
MD
62The build procedures occur in three areas: world, kernel, and
63documentation.
984263bc
MD
64Variables set in
65.Nm
cecff5c1 66may be applicable during builds in one, two, or all of these areas.
984263bc
MD
67They may be specified for a particular build via the
68.Fl D
69option of
70.Xr make 1 .
71.Pp
72The following lists provide a name and short description for each
73variable you can use during the indicated builds.
cecff5c1 74The values of variables flagged as
984263bc 75.Vt bool
cecff5c1 76are ignored; the variable being set at all (even to
984263bc
MD
77.Dq Li FALSE
78or
79.Dq Li NO )
cecff5c1 80causes it to be treated as if it were set.
984263bc
MD
81.Pp
82The following list provides a name and short description for variables
83that are used for all builds, or are used by the
84.Pa makefiles
85for things other than builds.
86.Bl -tag -width Ar
984263bc
MD
87.It Va CPUTYPE
88.Pq Vt str
cecff5c1
MD
89Controls which processor should be targeted for generated code.
90This controls processor-specific optimizations in certain code
91(currently only OpenSSL) as well as modifying the value of
984263bc
MD
92.Va CFLAGS
93and
94.Va COPTFLAGS
95to contain the appropriate optimization directive to
96.Xr gcc 1 .
97The automatic setting of
98.Va CFLAGS
99and
100.Va COPTFLAGS
101may be overridden using the
102.Va NO_CPU_CFLAGS
103and
104.Va NO_CPU_COPTFLAGS
105variables, respectively. Refer to
0cd7b3a7 106.Pa /usr/share/examples/etc/defaults/make.conf
984263bc
MD
107for a list of recognized
108.Va CPUTYPE
109options.
cecff5c1
MD
110.It Va CCVER
111.Pq Vt str
05664f8a
PA
112Controls which GCC version to use by default.
113It should be set as
114.Li CCVER?=
115so as not to interfere with overrides from userland.
116We currently recommend that an override NOT be set in
cecff5c1 117.Pa /etc/make.conf .
e20d3103
SW
118Currently accepted values for compilers which are part of
119.Dx
120are
7879b9ff 121.Dq gcc41
30c91f0c
SW
122and
123.Dq gcc44
124(default).
e20d3103
SW
125All other values will handled according to the settings in
126.Xr compilers.conf 5 .
127.It Va BINUTILSVER
128.Pq Vt str
129Controls which binutils to use by default.
130Currently accepted values are
1c05bfaa 131.Dq binutils221
e685772e
JM
132and
133.Dq binutils222
b1242318 134(default).
cecff5c1
MD
135.It Va CFLAGS
136.Pq Vt str
137Controls the compiler setting when compiling C code.
138Optimization levels above
139.Fl O
140.Pq Fl O2 , No ...
141are not supported.
142.Va BDECFLAGS
143is provided as a set of
144.Xr gcc 1
145settings suggested by
146.An "Bruce Evans" Aq bde@FreeBSD.org
147for developing and testing changes.
148They can be used, if set, by:
cecff5c1
MD
149.Bd -literal -offset indent
150CFLAGS+=${BDECFLAGS}
151.Ed
e20d3103
SW
152.It Va DEBUG_FLAGS
153.Pq Vt str
154Similar to
155.Va CFLAGS
156but it will cause
157.Va STRIP
158to be set to a blank value, if set.
159Typically,
160.Va DEBUG_FLAGS
161is set to
162.Fl g
163for compiling with debug symbols.
984263bc
MD
164.It Va NO_CPU_CFLAGS
165.Pq Vt str
166Setting this variable will prevent CPU specific compiler flags
167from being automatically added to
168.Va CFLAGS
169during compile time.
984263bc
MD
170.It Va CXXFLAGS
171.Pq Vt str
172Controls the compiler settings when compiling C++ code.
173.Va CXXFLAGS
174is initially set to the value of
175.Va CFLAGS .
cecff5c1 176If you want to add to the
984263bc
MD
177.Va CXXFLAGS
178value, use
179.Dq Li +=
180instead of
181.Dq Li = .
182.It Va INSTALL
183.Pq Vt str
184the default install command.
cecff5c1 185To have components compared before doing the install, use
984263bc
MD
186.Bd -literal -offset indent
187INSTALL="install -C"
188.Ed
189.It Va LOCAL_DIRS
190.Pq Vt str
cecff5c1 191List any directories that should be entered when running make
984263bc
MD
192.Pa /usr/src
193in this variable.
194.It Va MAKE_SHELL
195.Pq Vt str
196Controls the shell used internally by
197.Xr make 1
198to process the command scripts in makefiles.
199.Xr sh 1 ,
200.Xr ksh 1 ,
201and
202.Xr csh 1
203all currently supported.
204.Bd -literal -offset indent
205MAKE_SHELL?=sh
206.Ed
cecff5c1
MD
207.It Va MODULES_OVERRIDE
208.Pq Vt str
209Set to a list of modules to build instead of all of them.
984263bc
MD
210.It Va MTREE_FOLLOWS_SYMLINKS
211.Pq Vt str
212Set this to
213.Dq Fl L
214to cause
215.Xr mtree 8
216to follow symlinks.
cecff5c1
MD
217.It Va STRIP
218.Pq Vt str
e20d3103 219Set this to the flag to pass to the
cecff5c1
MD
220.Xr strip 1
221command.
e20d3103
SW
222If set to a blank value, debug symbols will not be removed.
223.Va STRIP
224is automatically set to a blank value if
225.Va DEBUG_FLAGS
226is set.
ed5d5720
PA
227.It Va WANT_HESIOD
228.Pq Vt bool
229Set this to build
230.Xr hesiod 3
231support into libc.
232.It Va NO_NS_CACHING
233.Pq Vt bool
234Set this to disable name caching in the nsswitch subsystem.
235The generic caching daemon,
236.Xr nscd 8 ,
237will not be built either if this option is set.
18c2eecf
SS
238.It Va NO_WERROR
239Set this if you don't want
240.Fl Werror
241to be added to
74facaa5
SW
242.Va CWARNFLAGS
243or used in the kernel build.
003525a9
AP
244.It Va STATIC_LOCALES
245.Pq Vt str
246Set to a list of locales to build into statically-linked binaries.
24b4fe1f 247Currently supported locales are: BIG5 EUC EUCTW ISO2022 MSKanji UTF8
984263bc
MD
248.El
249.Pp
250The following list provides a name and short description for variables
251that are only used doing a kernel build:
252.Bl -tag -width Ar
253.It Va BOOT_COMCONSOLE_PORT
254.Pq Vt str
255The port address to use for the console if the boot blocks have
256been configured to use a serial console instead of the keyboard/video card.
257.It Va BOOT_COMCONSOLE_SPEED
258.Pq Vt int
259The baud rate to use for the console if the boot blocks have
260been configured to use a serial console instead of the keyboard/video card.
984263bc
MD
261.It Va COPTFLAGS
262.Pq Vt str
263Controls the compiler settings when building the
264kernel.
265Optimization levels above
7879b9ff
SW
266.Fl O
267.Pq Fl O2 , No ...
984263bc
MD
268are not guaranteed to work.
269.It Va KERNCONF
270.Pq Vt str
271Controls which kernel configurations will be
272built by
273.Dq Li "${MAKE} buildkernel"
274and installed by
275.Dq Li "${MAKE} installkernel" .
276For example,
277.Bd -literal -offset indent
278KERNCONF=MINE DEBUG GENERIC OTHERMACHINE
279.Ed
280.Pp
281will build the kernels specified by the config files
282.Pa MINE , DEBUG , GENERIC ,
283and
284.Pa OTHERMACHINE ,
285and install the kernel specified by the config file
286.Pa MINE .
287It defaults to
288.Pa GENERIC .
cecff5c1 289.It Va NO_CPU_COPTFLAGS
984263bc 290.Pq Vt str
cecff5c1
MD
291Setting this variable will prevent CPU specific compiler flags
292from being automatically added to
293.Va COPTFLAGS
294during compile time.
295.It Va NO_KERNELCLEAN
296.Pq Vt bool
297Set this to skip the clean target when using
298.Dq Li "${MAKE} buildkernel" .
984263bc
MD
299.It Va NO_KERNELCONFIG
300.Pq Vt bool
301Set this to skip running
302.Xr config 8
303during
304.Dq Li "${MAKE} buildkernel" .
305.It Va NO_KERNELDEPEND
306.Pq Vt bool
307Set this to skip running
308.Dq Li "${MAKE} depend"
309during
310.Dq Li "${MAKE} buildkernel" .
9200f41c
SS
311.It Va NO_KERNEL_OLD_STRIP
312.Pq Vt bool
313Set this to skip stripping debugging symbols from old kernel and modules
314(kernel.old, modules.old) during
315.Dq Li "${MAKE} installkernel" .
984263bc
MD
316.It Va NO_MODULES
317.Pq Vt bool
318Set to not build modules with the kernel.
319.El
320.Pp
321The following list provides a name and short description for variables
322that are used during the world build:
323.Bl -tag -width Ar
984263bc
MD
324.It Va ENABLE_SUID_SSH
325.Pq Vt bool
326Set this to install
327.Xr ssh 1
328with the setuid bit turned on.
329.It Va MODULES_WITH_WORLD
330.Pq Vt bool
331Set to build modules with the system instead of the kernel.
1feb8780
SW
332.It Va NO_BINUTILS221
333.Pq Vt bool
334Set to not build the older version of binutils (2.21).
cecff5c1
MD
335.It Va NO_CRYPT
336.Pq Vt bool
337Set to not build crypto code.
338.It Va NO_CVS
339.Pq Vt bool
340Set to not build CVS.
cecff5c1
MD
341.It Va NO_GAMES
342.Pq Vt bool
343Set to not build games.
30c91f0c 344.It Va NO_GCC41
48dff0ad 345.Pq Vt bool
30c91f0c 346Set to not build the older version of GCC (4.1).
984263bc
MD
347.It Va NO_GDB
348.Pq Vt bool
349Set to not build
350.Xr gdb 1
cecff5c1
MD
351.It Va NO_LIBC_R
352.Pq Vt bool
353Set to not build
354.Nm libc_r
355(reentrant version of
356.Nm libc ) .
984263bc
MD
357.It Va NO_LPR
358.Pq Vt bool
359Set to not build
360.Xr lpr 1
361and related programs.
362.It Va NO_MAILWRAPPER
363.Pq Vt bool
364Set to not build the
365.Xr mailwrapper 8
366MTA selector.
984263bc
MD
367.It Va NO_OBJC
368.Pq Vt bool
369Set to not build Objective C support.
370.It Va NO_OPENSSH
371.Pq Vt bool
372Set to not build OpenSSH.
373.It Va NO_OPENSSL
374.Pq Vt bool
375Set to not build OpenSSL (implies
376.Va NO_OPENSSH ) .
377.It Va NO_SENDMAIL
378.Pq Vt bool
379Set to not build
380.Xr sendmail 8
381and related programs.
cecff5c1
MD
382.It Va NO_SHARE
383.Pq Vt bool
384Set to not enter the share subdirectory.
984263bc
MD
385.It Va NOCLEAN
386.Pq Vt bool
387Set this to disable cleaning during
388.Dq Li "make buildworld" .
389This should not be set unless you know what you are doing.
390.It Va NOCLEANDIR
391.Pq Vt bool
392Set this to run
393.Dq Li "${MAKE} clean"
394instead of
395.Dq Li "${MAKE} cleandir" .
cecff5c1 396.It Va NOFSCHG
984263bc 397.Pq Vt bool
566002a4 398Set to not install certain components with flag schg.
cecff5c1 399This is useful in a jailed environment.
984263bc
MD
400.It Va NOINFO
401.Pq Vt bool
402Set to not make or install
403.Xr info 5
404files.
cecff5c1 405.It Va NOINFOCOMPRESS
984263bc 406.Pq Vt bool
cecff5c1
MD
407Set to not compress the info pages.
408.It Va NOMAN
984263bc 409.Pq Vt bool
cecff5c1
MD
410Set to not build manual pages
411.It Va NOMANCOMPRESS
984263bc 412.Pq Vt bool
cecff5c1 413Set to not compress the manual pages.
984263bc
MD
414.It Va NOPROFILE
415.Pq Vt bool
416Set to avoid compiling profiled libraries.
984263bc
MD
417.It Va PPP_NOSUID
418.Pq Vt bool
419Set to disable the installation of
420.Xr ppp 8
cecff5c1 421with the set-user-ID bit on.
984263bc
MD
422.It Va SENDMAIL_MC
423.Pq Vt str
3181538d
GNS
424The default
425.Xr m4 1
426configuration file to use at install time.
984263bc
MD
427The value should include the full path to the
428.Pa .mc
429file, e.g.,
430.Pa /etc/mail/myconfig.mc .
431Use with caution as a make install will overwrite any existing
432.Pa /etc/mail/sendmail.cf .
433Note that
434.Va SENDMAIL_CF
435is now deprecated.
984263bc
MD
436.It Va SENDMAIL_SUBMIT_MC
437.Pq Vt str
3181538d
GNS
438The default
439.Xr m4 1
440configuration file for mail submission
984263bc
MD
441to use at install time.
442The value should include the full path to the
443.Pa .mc
444file, e.g.,
445.Pa /etc/mail/mysubmit.mc .
446Use with caution as a make install will overwrite any existing
447.Pa /etc/mail/submit.cf .
984263bc
MD
448.It Va SENDMAIL_ADDITIONAL_MC
449.Pq Vt str
450Additional
451.Pa .mc
452files which should be built into
453.Pa .cf
454files at build time.
455The value should include the full path to the
456.Pa .mc
457file(s), e.g.,
458.Pa /etc/mail/foo.mc
459.Pa /etc/mail/bar.mc .
3181538d
GNS
460.It Va SENDMAIL_CF_DIR
461.Pq Vt str
462Override the default location for the
463.Xr m4 1
464configuration files used to build a
465.Pa .cf
466file from a
467.Pa .mc
468file.
984263bc
MD
469.It Va SENDMAIL_M4_FLAGS
470.Pq Vt str
3181538d
GNS
471Flags passed to
472.Xr m4 1
473when building a
984263bc
MD
474.Pa .cf
475file from a
476.Pa .mc
477file.
478.It Va SENDMAIL_CFLAGS
479.Pq Vt str
480Flags to pass to the compile command when building
481.Xr sendmail 8 .
482The
483.Va SENDMAIL_*
484flags can be used to provide SASL support with setting such as:
485.Bd -literal -offset indent
486SENDMAIL_CFLAGS=-I/usr/local/include -DSASL
487SENDMAIL_LDFLAGS=-L/usr/local/lib
488SENDMAIL_LDADD=-lsasl
489.Ed
490.It Va SENDMAIL_LDFLAGS
491.Pq Vt str
492Flags to pass to the
493.Xr ld 1
494command when building
495.Xr sendmail 8 .
496.It Va SENDMAIL_LDADD
497.Pq Vt str
498Flags to add to the end of the
499.Xr ld 1
500command when building
501.Xr sendmail 8 .
502.It Va SENDMAIL_DPADD
503.Pq Vt str
504Extra dependencies to add when building
505.Xr sendmail 8 .
506.It Va SENDMAIL_SET_USER_ID
507.Pq Vt bool
508If set, install
509.Xr sendmail 8
510as a set-user-ID root binary instead of a set-group-ID binary
511and do not install
512.Pa /etc/mail/submit.{cf,mc} .
513Use of this flag is not recommended and the alternative advice in
514.Pa /etc/mail/README
3181538d 515should be followed instead if at all possible.
984263bc
MD
516.It Va SENDMAIL_MAP_PERMS
517.Pq Vt str
518Mode to use when generating alias and map database files using
519.Pa /etc/mail/Makefile .
520The default value is 0640.
587bc464
SW
521.It Va THREAD_LIB
522.Pq Vt str
523Set to either
524.Li c_r
525or
526.Li thread_xu
527to configure the system's default threading library.
528The default is
529.Li thread_xu .
3e84a8c5 530.It Va WANT_IDEA
cecff5c1
MD
531.Pq Vt bool
532Set to build the IDEA encryption code.
533This code is patented in the USA and many European countries.
534It is
535.Em "YOUR RESPONSIBILITY"
536to determine if you can legally use IDEA.
7ebbae99
SW
537.It Va WANT_INSTALLER
538.Pq Vt bool
539Set to build the installer.
984263bc
MD
540.El
541.Pp
542The following list provides a name and short description for variables
543that are used when building documentation.
544.Bl -tag -width Ar
984263bc
MD
545.It Va DOC_LANG
546.Pq Vt str
547The list of languages and encodings to build and install.
548.It Va PRINTERDEVICE
549.Pq Vt str
550The default format for system documentation, depends on your
551printer.
552This can be set to
553.Dq Li ascii
554for simple printers or
555.Dq Li ps
556for postscript or graphics printers with a ghostscript
557filter.
42a03791
SW
558.It Va GROFF_PAPER_SIZE
559.Pq Vt str
560The default paper size for
561.Xr groff 1
562(either
563.Dq letter
564or
565.Dq A4 ) .
984263bc 566.El
984263bc
MD
567.Sh FILES
568.Bl -tag -width /etc/defaults/make.conf -compact
569.It Pa /etc/defaults/make.conf
570.It Pa /etc/make.conf
984263bc
MD
571.It Pa /usr/src/Makefile
572.It Pa /usr/src/Makefile.inc1
984263bc
MD
573.El
574.Sh SEE ALSO
575.Xr gcc 1 ,
576.Xr install 1 ,
577.Xr make 1 ,
984263bc
MD
578.Xr lpd 8 ,
579.Xr sendmail 8
580.Sh HISTORY
581The
582.Nm
583file appeared sometime before
584.Fx 4.0 .
585.Sh AUTHORS
cecff5c1 586This manual page was written by
984263bc 587.An Mike W. Meyer Aq mwm@mired.org .