Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / ab06629d5d257c6a205054de9fe34d24a55cd150 / . / docs / autoconf.html
blob: d707e60515e89bfa826576c40068ab6831efd642 [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:
65
66<ul>
67<li><code>--prefix=PREFIX</code> - This is the root directory where
68files will be installed by <code>make install</code>. The default is
69<code>/usr/local</code>.
70</li>
71<li><code>--exec-prefix=EPREFIX</code> - This is the root directory
72where architecture-dependent files will be installed. In Mesa, this is
73only used to derive the directory for the libraries. The default is
74<code>${prefix}</code>.
75</li>
76<li><code>--libdir=LIBDIR</code> - This option specifies the directory
77where the GL libraries will be installed. The default is
78<code>${exec_prefix}/lib</code>. It also serves as the name of the
79library staging area in the source tree. For instance, if the option
80<code>--libdir=/usr/local/lib64</code> is used, the libraries will be
81created in a <code>lib64</code> directory at the top of the Mesa source
82tree.
83</li>
84<li><code>--enable-static, --disable-shared</code> - By default, Mesa
85will build shared libraries. Either of these options will force static
86libraries to be built. It is not currently possible to build static and
87shared libraries in a single pass.
88</li>
89<li><code>CC, CFLAGS, CXX, CXXFLAGS</code> - These environment variables
90control the C and C++ compilers used during the build. By default,
91<code>gcc</code> and <code>g++</code> are used with the options
92<code>"-g -O2"</code>.
93</li>
94<li><code>LDFLAGS</code> - An environment variable specifying flags to
95pass when linking programs. These are normally empty, but can be used
96to direct the linker to use libraries in nonstandard directories. For
97example, <code>LDFLAGS="-L/usr/X11R6/lib"</code>.
98</li>
99<li><code>PKG_CONFIG_PATH</code> - When available, the
100<code>pkg-config</code> utility is used to search for external libraries
101on the system. This environment variable is used to control the search
102path for <code>pkg-config</code>. For instance, setting
103<code>PKG_CONFIG_PATH=/usr/X11R6/lib/pkgconfig</code> will search for
104package metadata in <code>/usr/X11R6</code> before the standard
105directories.
106</li>
107</ul>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]108
109<p>
110There are also a few general options for altering the Mesa build:
111<ul>
112<li><code>--with-x</code> - When the X11 development libraries are
113needed, the <code>pkg-config</code> utility <a href="#pkg-config">will
114be used</a> for locating them. If they cannot be found through
115<code>pkg-config</code> a fallback routing using <code>imake</code> will
116be used. In this case, the <code>--with-x</code>,
117<code>--x-includes</code> and <code>--x-libraries</code> options can
118control the use of X for Mesa.
119</li>
Dan Nicholson544ab202007-12-30 08:41:53 -0800[diff] [blame]120<li><code>--enable-gl-osmesa</code> - The <a href="osmesa.html">OSMesa
121library</a> can be built on top of libGL for drivers that provide it.
122This option controls whether to build libOSMesa. By default, this is
123enabled for the Xlib driver and disabled otherwise. Note that this
124option is different than using OSMesa as the driver.
125</li>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]126<li><code>--enable-debug</code> - This option will enable compiler
127options and macros to aid in debugging the Mesa libraries.
128</li>
129<li><code>--disable-asm</code> - There are assembly routines
130available for a few architectures. These will be used by default if
131one of these architectures is detected. This option ensures that
132assembly will not be used.
133</li>
Dan Nicholsonab57cba2007-12-26 11:12:29 -0600[diff] [blame]134<li><code>--enable-32-bit, --enable-64-bit</code> - By default, the
135build will compile code as directed by the environment variables
136<code>CC</code>, <code>CFLAGS</code>, etc. If the compiler is
137<code>gcc</code>, these options offer a helper to add the compiler flags
138to force 32- or 64-bit code generation as used on the x86 and x86_64
139architectures.
140</li>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]141</ul>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]142
143
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]144<h2 id="driver">2. Driver Options</h2>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]145
146<p>
147There are several different driver modes that Mesa can use. These are
148described in more detail in the <a href="install.html">basic
149installation instructions</a>. The Mesa driver is controlled through the
150configure option --with-driver. There are currently three supported
151options in the configure script.
152</p>
153
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]154<h3 id="xlib">Xlib</h3><p>This is the default mode for building Mesa.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]155It uses Xlib as a software renderer to do all rendering. It corresponds
156to the option <code>--with-driver=xlib</code>. The libX11 and libXext
157libraries, as well as the X11 development headers, will be need to
158support the Xlib driver.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]159
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]160<h3 id="dri">DRI</h3><p>This mode uses the DRI hardware drivers for
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]161accelerated OpenGL rendering. Enable the DRI drivers with the option
162<code>--with-driver=dri</code>. See the <a href="install.html">basic
163installation instructions</a> for details on prerequisites for the DRI
164drivers.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]165
166<!-- DRI specific options -->
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]167<dl>
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]168<dt><code>--with-dri-driverdir=DIR</code>
169<dd><p> This option specifies the
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]170location the DRI drivers will be installed to and the location libGL
Dan Nicholson5dbbde52008-05-06 06:21:41 -0700[diff] [blame]171will search for DRI drivers. The default is <code>${libdir}/dri</code>.
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]172<dt><code>--with-dri-drivers=DRIVER,DRIVER,...</code>
173<dd><p> This option
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]174allows a specific set of DRI drivers to be built. For example,
Dan Nicholson5cae1b72008-06-30 10:28:02 -0700[diff] [blame]175<code>--with-dri-drivers="swrast,i965,radeon,nouveau"</code>. By
176default, the drivers will be chosen depending on the target platform.
177See the directory <code>src/mesa/drivers/dri</code> in the source tree
178for available drivers. Beware that the swrast DRI driver is used by both
179libGL and the X.Org xserver GLX module to do software rendering, so you
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]180may run into problems if it is not available.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]181<!-- This explanation might be totally bogus. Kristian? -->
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]182<dt><code>--disable-driglx-direct</code>
183<dd><p> Disable direct rendering in
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]184GLX. Normally, direct hardware rendering through the DRI drivers and
185indirect software rendering are enabled in GLX. This option disables
186direct rendering entirely. It can be useful on architectures where
187kernel DRM modules are not available.
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]188<dt><code>--enable-glx-tls</code> <dd><p>
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]189Enable Thread Local Storage (TLS) in
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]190GLX.
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]191<dt><code>--with-expat=DIR</code> <dd> The DRI-enabled libGL uses expat to
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]192parse the DRI configuration files in <code>/etc/drirc</code> and
193<code>~/.drirc</code>. This option allows a specific expat installation
194to be used. For example, <code>--with-expat=/usr/local</code> will
195search for expat headers and libraries in <code>/usr/local/include</code>
196and <code>/usr/local/lib</code>, respectively.
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]197</dl>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]198
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]199<h3 id="osmesa">OSMesa </h3><p> No libGL is built in this
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]200mode. Instead, the driver code is built into the Off-Screen Mesa
201(OSMesa) library. See the <a href="osmesa.html">Off-Screen Rendering</a>
202page for more details.
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]203
204<!-- OSMesa specific options -->
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]205<dl>
Andreas Bolldae9b0f2012-06-25 21:52:47 +0200[diff] [blame]206<dt><code>--with-osmesa-bits=BITS</code>
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]207<dd><p> This option allows the size
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]208of the color channel in bits to be specified. By default, an 8-bit
209channel will be used, and the driver will be named libOSMesa. Other
210options are 16- and 32-bit color channels, which will add the bit size
211to the library name. For example, <code>--with-osmesa-bits=16</code>
212will create the libOSMesa16 library with a 16-bit color channel.
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]213</dl>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]214
215
Christopher Yeleighton7f94d982012-03-12 12:21:24 -0600[diff] [blame]216<h2 id="library">3. Library Options</h2>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]217
218<p>
219The configure script provides more fine grained control over the GL
220libraries that will be built. More details on the specific GL libraries
221can be found in the <a href="install.html">basic installation
222instructions</a>.
223
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]224</div>
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]225</body>
226</html>