Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / 0267c6d7ee0fd56702dafbc55b16313c6dc5a4ac / . / docs / autoconf.html
blob: 2ef8c63dbee0c3559a883473ba6b3d8869bbf44a [file] [log] [blame]
Andreas Bollecd5c7c2012-06-12 09:05:03 +0200[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html lang="en">
3<head>
4 <meta http-equiv="content-type" content="text/html; charset=utf-8">
5 <title>Compilation and Installation using Autoconf</title>
6 <link rel="stylesheet" type="text/css" href="mesa.css">
7</head>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]8<body>
9
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]10<div class="header">
11 <h1>The Mesa 3D Graphics Library</h1>
12</div>
13
14<iframe src="contents.html"></iframe>
15<div class="content">
16
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]17<h1>Compilation and Installation using Autoconf</h1>
18
19<ol>
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]20<li><p><a href="#basic">Basic Usage</a></li>
21<li><p><a href="#driver">Driver Options</a>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]22 <ul>
23 <li><a href="#xlib">Xlib Driver Options</a></li>
24 <li><a href="#dri">DRI Driver Options</a></li>
25 <li><a href="#osmesa">OSMesa Driver Options</a></li>
26 </ul>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]27</ol>
28
29
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]30<h2 id="basic">1. Basic Usage</h2>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]31
32<p>
33The autoconf generated configure script can be used to guess your
34platform and change various options for building Mesa. To use the
35configure script, type:
36</p>
37
38<pre>
39 ./configure
40</pre>
41
42<p>
43To see a short description of all the options, type <code>./configure
44--help</code>. If you are using a development snapshot and the configure
Dan Nicholson460d25d2008-03-07 12:04:17 -0800[diff] [blame]45script does not exist, type <code>./autogen.sh</code> to generate it
46first. If you know the options you want to pass to
47<code>configure</code>, you can pass them to <code>autogen.sh</code>. It
48will run <code>configure</code> with these options after it is
49generated. Once you have run <code>configure</code> and set the options
50to your preference, type:
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]51</p>
52
53<pre>
54 make
55</pre>
56
57<p>
58This will produce libGL.so and several other libraries depending on the
59options you have chosen. Later, if you want to rebuild for a different
60configuration run <code>make realclean</code> before rebuilding.
61</p>
62
63<p>
64Some of the generic autoconf options are used with Mesa:
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]65</p>
66<dl>
67<dt><code>--prefix=PREFIX</code></dt>
68<dd><p>This is the root directory where
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]69files will be installed by <code>make install</code>. The default is
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]70<code>/usr/local</code>.</p>
71</dd>
72
73<dt><code>--exec-prefix=EPREFIX</code></dt>
74<dd><p>This is the root directory
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]75where architecture-dependent files will be installed. In Mesa, this is
76only used to derive the directory for the libraries. The default is
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]77<code>${prefix}</code>.</p>
78</dd>
79
80<dt><code>--libdir=LIBDIR</code></dt>
81<dd><p>This option specifies the directory
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]82where the GL libraries will be installed. The default is
83<code>${exec_prefix}/lib</code>. It also serves as the name of the
84library staging area in the source tree. For instance, if the option
85<code>--libdir=/usr/local/lib64</code> is used, the libraries will be
86created in a <code>lib64</code> directory at the top of the Mesa source
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]87tree.</p>
88</dd>
89
90<dt><code>--enable-static, --disable-shared</code></dt>
91<dd><p>By default, Mesa
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]92will build shared libraries. Either of these options will force static
93libraries to be built. It is not currently possible to build static and
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]94shared libraries in a single pass.</p>
95</dd>
96
97<dt><code>CC, CFLAGS, CXX, CXXFLAGS</code></dt>
98<dd><p>These environment variables
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]99control the C and C++ compilers used during the build. By default,
Emil Velikov478f8272014-08-13 21:31:33 +0100[diff] [blame]100<code>gcc</code> and <code>g++</code> are used and the debug/optimisation
101level is left unchanged.</p>
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]102</dd>
103
104<dt><code>LDFLAGS</code></dt>
105<dd><p>An environment variable specifying flags to
Emil Velikov478f8272014-08-13 21:31:33 +0100[diff] [blame]106pass when linking programs. These should be empty and
107<code>PKG_CONFIG_PATH</code> is recommended to be used instead. If needed
108it can be used to direct the linker to use libraries in nonstandard
109directories. For example, <code>LDFLAGS="-L/usr/X11R6/lib"</code>.</p>
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]110</dd>
111
112<dt><code>PKG_CONFIG_PATH</code></dt>
Emil Velikov478f8272014-08-13 21:31:33 +0100[diff] [blame]113<dd><p>The
114<code>pkg-config</code> utility is a hard requirement for cofiguring and
115building mesa. It is used to search for external libraries
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]116on the system. This environment variable is used to control the search
117path for <code>pkg-config</code>. For instance, setting
118<code>PKG_CONFIG_PATH=/usr/X11R6/lib/pkgconfig</code> will search for
119package metadata in <code>/usr/X11R6</code> before the standard
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]120directories.</p>
121</dd>
122</dl>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]123
124<p>
125There are also a few general options for altering the Mesa build:
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]126</p>
127<dl>
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]128<dt><code>--enable-debug</code></dt>
129<dd><p>This option will enable compiler
130options and macros to aid in debugging the Mesa libraries.</p>
131</dd>
132
133<dt><code>--disable-asm</code></dt>
134<dd><p>There are assembly routines
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]135available for a few architectures. These will be used by default if
136one of these architectures is detected. This option ensures that
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]137assembly will not be used.</p>
138</dd>
139
Emil Velikov478f8272014-08-13 21:31:33 +0100[diff] [blame]140<dt><code>--build=</code></dt>
141<dt><code>--host=</code></dt>
142<dd><p>By default, the build will compile code for the architecture that
143it's running on. In order to build cross-compile Mesa on a x86-64 machine
144that is to run on a i686, one would need to set the options to:</p>
145
Emil Velikov0267c6d2014-08-15 17:58:14 +0100[diff] [blame^]146<p><code>--build=x86_64-pc-linux-gnu --host=i686-pc-linux-gnu</code></p>
Emil Velikov478f8272014-08-13 21:31:33 +0100[diff] [blame]147
148Note that these can vary from distribution to distribution. For more
149information check with the
150<a href="https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Specifying-Target-Triplets.html">
151autoconf manual</a>.
Emil Velikov0267c6d2014-08-15 17:58:14 +0100[diff] [blame^]152Note that you will need to correctly set <code>PKG_CONFIG_PATH</code> as well.
Emil Velikov478f8272014-08-13 21:31:33 +0100[diff] [blame]153
154
155<p>In some cases a single compiler is capable of handling both architectures
156(multilib) in that case one would need to set the <code>CC,CXX</code> variables
157appending the correct machine options. Seek your compiler documentation for
158further information -
159<a href="https://gcc.gnu.org/onlinedocs/gcc/Submodel-Options.html"> gcc
160machine dependent options</a></p>
161
Emil Velikov0267c6d2014-08-15 17:58:14 +0100[diff] [blame^]162<p>In addition to specifying correct <code>PKG_CONFIG_PATH</code> for the target
163architecture, the following should be sufficient to configure multilib Mesa</p>
Emil Velikov478f8272014-08-13 21:31:33 +0100[diff] [blame]164
Emil Velikov0267c6d2014-08-15 17:58:14 +0100[diff] [blame^]165<code>./configure CC="gcc -m32" CXX="g++ -m32" --build=x86_64-pc-linux-gnu --host=i686-pc-linux-gnu ...</code>
Andreas Boll63eade42012-09-20 16:01:03 +0200[diff] [blame]166</dd>
167</dl>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]168
169
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]170<h2 id="driver">2. Driver Options</h2>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]171
172<p>
173There are several different driver modes that Mesa can use. These are
174described in more detail in the <a href="install.html">basic
175installation instructions</a>. The Mesa driver is controlled through the
Matt Turner66be7b42013-09-09 16:27:18 -0700[diff] [blame]176configure options <code>--enable-xlib-glx</code>, <code>--enable-osmesa</code>,
177and <code>--enable-dri</code>.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]178</p>
179
Matt Turner66be7b42013-09-09 16:27:18 -0700[diff] [blame]180<h3 id="xlib">Xlib</h3><p>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]181It uses Xlib as a software renderer to do all rendering. It corresponds
Matt Turner66be7b42013-09-09 16:27:18 -0700[diff] [blame]182to the option <code>--enable-xlib-glx</code>. The libX11 and libXext
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]183libraries, as well as the X11 development headers, will be need to
184support the Xlib driver.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]185
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]186<h3 id="dri">DRI</h3><p>This mode uses the DRI hardware drivers for
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]187accelerated OpenGL rendering. Enable the DRI drivers with the option
Matt Turner66be7b42013-09-09 16:27:18 -0700[diff] [blame]188<code>--enable-dri</code>. See the <a href="install.html">basic
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]189installation instructions</a> for details on prerequisites for the DRI
190drivers.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]191
192<!-- DRI specific options -->
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]193<dl>
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]194<dt><code>--with-dri-driverdir=DIR</code>
195<dd><p> This option specifies the
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]196location the DRI drivers will be installed to and the location libGL
Dan Nicholson5dbbde52008-05-06 06:21:41 -0700[diff] [blame]197will search for DRI drivers. The default is <code>${libdir}/dri</code>.
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]198<dt><code>--with-dri-drivers=DRIVER,DRIVER,...</code>
199<dd><p> This option
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]200allows a specific set of DRI drivers to be built. For example,
Dan Nicholson5cae1b72008-06-30 10:28:02 -0700[diff] [blame]201<code>--with-dri-drivers="swrast,i965,radeon,nouveau"</code>. By
202default, the drivers will be chosen depending on the target platform.
203See the directory <code>src/mesa/drivers/dri</code> in the source tree
204for available drivers. Beware that the swrast DRI driver is used by both
205libGL and the X.Org xserver GLX module to do software rendering, so you
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]206may run into problems if it is not available.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]207<!-- This explanation might be totally bogus. Kristian? -->
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]208<dt><code>--disable-driglx-direct</code>
209<dd><p> Disable direct rendering in
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]210GLX. Normally, direct hardware rendering through the DRI drivers and
211indirect software rendering are enabled in GLX. This option disables
212direct rendering entirely. It can be useful on architectures where
213kernel DRM modules are not available.
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]214<dt><code>--enable-glx-tls</code> <dd><p>
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]215Enable Thread Local Storage (TLS) in
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]216GLX.
Emil Velikov478f8272014-08-13 21:31:33 +0100[diff] [blame]217<dt><code>--with-expat=DIR</code>
218<dd><p><strong>DEPRECATED</strong>, use <code>PKG_CONFIG_PATH</code> instead.</p>
219<p>The DRI-enabled libGL uses expat to
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]220parse the DRI configuration files in <code>/etc/drirc</code> and
221<code>~/.drirc</code>. This option allows a specific expat installation
222to be used. For example, <code>--with-expat=/usr/local</code> will
223search for expat headers and libraries in <code>/usr/local/include</code>
224and <code>/usr/local/lib</code>, respectively.
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]225</dl>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]226
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]227<h3 id="osmesa">OSMesa </h3><p> No libGL is built in this
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]228mode. Instead, the driver code is built into the Off-Screen Mesa
229(OSMesa) library. See the <a href="osmesa.html">Off-Screen Rendering</a>
Matt Turner66be7b42013-09-09 16:27:18 -0700[diff] [blame]230page for more details. It corresponds to the option
231<code>--enable-osmesa</code>.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]232
233<!-- OSMesa specific options -->
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]234<dl>
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]235<dt><code>--with-osmesa-bits=BITS</code>
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]236<dd><p> This option allows the size
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]237of the color channel in bits to be specified. By default, an 8-bit
238channel will be used, and the driver will be named libOSMesa. Other
239options are 16- and 32-bit color channels, which will add the bit size
240to the library name. For example, <code>--with-osmesa-bits=16</code>
241will create the libOSMesa16 library with a 16-bit color channel.
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]242</dl>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]243
244
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]245<h2 id="library">3. Library Options</h2>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]246
247<p>
248The configure script provides more fine grained control over the GL
249libraries that will be built. More details on the specific GL libraries
250can be found in the <a href="install.html">basic installation
251instructions</a>.
252
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]253</div>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]254</body>
255</html>