Add a wrapper script to allow "foreign" compilers into our build system.
[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.\"
32.Dd July 3, 2009
33.Os
34.Dt COMPILERS.CONF 5
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.It Va <version>_VERSION
80What to output when the
81.Fl dumpversion
82option is used.
83This helps
84.Nm clang
85with
86.Xr pkgsrc 7 .
87.El
88.Pp
89Once configured the compiler can then be used like this:
90.Bd -literal -offset indent
91cd /usr/pkgsrc/wip/gcc44
92[build and install gcc44]
93cd /usr/src
94env WORLD_CCVER=gcc44 make buildworld
95.Ed
96.Pp
97Defaults are provided for
98.Nm clang
99(installed from SVN trunk)
100and
101.Nm gcc44
102(installed from
103.Pa pkgsrc/wip ) .
104.Sh FILES
105.Bl -tag -width ".Pa /etc/compilers.conf" -compact
106.It Pa /etc/compilers.conf
107external compiler configuration file
108.El
109.Sh SEE ALSO
110.Xr objformat 1 ,
111.Xr build 7
112.Sh HISTORY
113The
114.Nm
115file first appeared in
116.Dx 2.3 .