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