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