xref: /dflybsd-src/share/man/man5/compilers.conf.5 (revision 8711651202bb750eb3b64529c2e2f10dee79cd55)
1.\"
2.\" Copyright (c) 2009
3.\"	The DragonFly Project.  All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\"
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in
13.\"    the documentation and/or other materials provided with the
14.\"    distribution.
15.\" 3. Neither the name of The DragonFly Project nor the names of its
16.\"    contributors may be used to endorse or promote products derived
17.\"    from this software without specific, prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd October 14, 2014
33.Dt COMPILERS.CONF 5
34.Os
35.Sh NAME
36.Nm compilers.conf
37.Nd configuration file for external compilers
38.Sh SYNOPSIS
39.Pa /etc/compilers.conf
40.Sh DESCRIPTION
41The
42.Nm
43file allows to configure
44.Dq external
45compilers for usage with the
46.Dx
47.Xr build 7
48system.
49.Pp
50The
51.Pa /etc/defaults/compilers.conf
52file specifies the default settings for all variables, the
53.Pa /etc/compilers.conf
54file specifies override settings.
55.Pp
56The following variables are available:
57.Bl -tag -width ".Va <version>_CPPFLAGS"
58.It Va <version>_CC
59The pathname of the
60.Nm cc
61program of the compiler.
62.It Va <version>_CFLAGS
63Any additional flags to pass to
64.Va <version>_CC .
65.It Va <version>_CPP
66The pathname of the
67.Nm cpp
68program of the compiler.
69.It Va <version>_CPPFLAGS
70Any additional flags to pass to
71.Va <version>_CPP .
72.It Va <version>_CXX
73The pathname of the
74.Nm c++
75program of the compiler.
76.It Va <version>_CXXFLAGS
77Any additional flags to pass to
78.Va <version>_CXX .
79.El
80.Pp
81Currently, defaults are provided for
82.Nm gcc48
83(installed from
84.Xr dports 7 Ap s
85.Pa lang/gcc48 ) ,
86.Nm gcc49
87(installed from
88.Xr dports 7 Ap s
89.Pa lang/gcc49 ) ,
90and
91.Nm gcc5
92(installed from
93.Xr dports 7 Ap s
94.Pa lang/gcc5 ) .
95.Sh IMPLEMENTATION NOTES
96In
97.Dx ,
98compilers are selected by setting the
99.Ev CCVER
100variable.
101The
102.Pa cpp ,
103.Pa cc ,
104etc\&. programs in
105.Pa /usr/bin
106are actually links to the
107.Xr objformat 1
108deflector program which is responsible for executing the
109correct programs (located in
110.Pa /usr/libexec/$CCVER ) .
111.Pp
112Traditionally,
113.Dx
114has 2 compilers in base, one of which is the default compiler and the other
115is either a newer or older version.
116In order to allow additional non-base compilers into
117.Dx Ap s
118build process,
119.Xr objformat 1
120deflects to
121.Pa /usr/libexec/custom
122when
123.Ev CCVER Ap s
124setting is not one of the compilers in base.
125This directory contains a
126.Pa cc
127wrapper script (and some links to it).
128The wrapper script then takes care of making the compiler look and behave
129like a compiler in base.
130.Pp
131The settings in
132.Nm
133specify paths and flags for the
134.Pa /usr/libexec/custom/cc
135script.
136.Sh FILES
137.Bl -tag -width ".Pa /etc/compilers.conf" -compact
138.It Pa /etc/compilers.conf
139external compiler configuration file
140.El
141.Sh EXAMPLES
142Once configured the compiler can be used like this:
143.Bd -literal -offset indent
144env CCVER=<version> make
145.Ed
146.Pp
147To try building world and kernel, use:
148.Bd -literal -offset indent
149cd /usr/src
150env WORLD_CCVER=<version> make buildworld
151env WORLD_CCVER=<version> make buildkernel KERNCONF=MYCONF
152.Ed
153.Sh SEE ALSO
154.Xr objformat 1 ,
155.Xr build 7
156.Sh HISTORY
157The
158.Nm
159file first appeared in
160.Dx 2.3 .
161