xref: /dragonfly/share/man/man5/compilers.conf.5 (revision 19380330)
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, 2012
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 clang
83(installed from
84.Xr pkgsrc 7 Ap s
85.Pa lang/clang ) ,
86.Nm clangsvn
87(installed from SVN trunk as described in
88.Pa http://clang.llvm.org/get_started.html ) ,
89.Nm gcc46
90(installed from
91.Xr pkgsrc 7 Ap s
92.Pa lang/gnat-aux ) ,
93and
94.Nm pcc
95(installed from
96.Xr pkgsrc 7 Ap s
97.Pa lang/pcc-current ) .
98.Sh IMPLEMENTATION NOTES
99In
100.Dx ,
101compilers are selected by setting the
102.Ev CCVER
103variable.
104The
105.Pa cpp ,
106.Pa cc ,
107etc\&. programs in
108.Pa /usr/bin
109are actually links to the
110.Xr objformat 1
111deflector program which is responsible for executing the
112correct programs (located in
113.Pa /usr/libexec/$CCVER ) .
114.Pp
115Traditionally,
116.Dx
117has 2 compilers in base, one of which is the default compiler and the other
118is either a newer or older version.
119In order to allow additional non-base compilers into
120.Dx Ap s
121build process,
122.Xr objformat 1
123deflects to
124.Pa /usr/libexec/custom
125when
126.Ev CCVER Ap s
127setting is not one of the compilers in base.
128This directory contains a
129.Pa cc
130wrapper script (and some links to it).
131The wrapper script then takes care of making the compiler look and behave
132like a compiler in base.
133.Pp
134The settings in
135.Nm
136specify paths and flags for the
137.Pa /usr/libexec/custom/cc
138script.
139.Sh FILES
140.Bl -tag -width ".Pa /etc/compilers.conf" -compact
141.It Pa /etc/compilers.conf
142external compiler configuration file
143.El
144.Sh EXAMPLES
145Once configured the compiler can be used like this:
146.Bd -literal -offset indent
147env CCVER=clang make
148.Ed
149.Pp
150To try building world and kernel, use:
151.Bd -literal -offset indent
152cd /usr/src
153env WORLD_CCVER=<version> make -DNO_GCC47 buildworld
154env WORLD_CCVER=<version> make buildkernel KERNCONF=MYCONF
155.Ed
156.Sh SEE ALSO
157.Xr objformat 1 ,
158.Xr build 7
159.Sh HISTORY
160The
161.Nm
162file first appeared in
163.Dx 2.3 .
164