Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / 4c5a2b3af214e7a0ec0742b17beb1e719552ecae / . / docs / autoconf.html
blob: ab1e21db08f9d36deecb52d41f98e4e3d84ab502 [file] [log] [blame]
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame^]1<html>
2
3<title>Compilation and Installation using Autoconf</title>
4
5<link rel="stylesheet" type="text/css" href="mesa.css"></head>
6
7<body>
8
9
10<h1>Compilation and Installation using Autoconf</h1>
11
12<ol>
13<li><a href="#basic">Basic Usage</a></li>
14<li><a href="#driver">Driver Options</a></li>
15 <ul>
16 <li><a href="#xlib">Xlib Driver Options</a></li>
17 <li><a href="#dri">DRI Driver Options</a></li>
18 <li><a href="#osmesa">OSMesa Driver Options</a></li>
19 </ul>
20<li><a href="#library">Library Options</a></li>
21 <ul>
22 <li><a href="#glu">GLU</a></li>
23 <li><a href="#glw">GLw</a></li>
24 <li><a href="#glut">GLUT</a></li>
25 </ul>
26<li><a href="#demos">Demo Program Options</a></li>
27</ol>
28
29
30<a name="basic">
31<h2>1. Basic Usage</h2>
32
33<p>
34The autoconf generated configure script can be used to guess your
35platform and change various options for building Mesa. To use the
36configure script, type:
37</p>
38
39<pre>
40 ./configure
41</pre>
42
43<p>
44To see a short description of all the options, type <code>./configure
45--help</code>. If you are using a development snapshot and the configure
46script does not exist, type <code>make configure</code> to generate it
47first. Once you have run <code>./configure</code> and set the options to
48your preference, type:
49</p>
50
51<pre>
52 make
53</pre>
54
55<p>
56This will produce libGL.so and several other libraries depending on the
57options you have chosen. Later, if you want to rebuild for a different
58configuration run <code>make realclean</code> before rebuilding.
59</p>
60
61<p>
62Some of the generic autoconf options are used with Mesa:
63
64<ul>
65<li><code>--prefix=PREFIX</code> - This is the root directory where
66files will be installed by <code>make install</code>. The default is
67<code>/usr/local</code>.
68</li>
69<li><code>--exec-prefix=EPREFIX</code> - This is the root directory
70where architecture-dependent files will be installed. In Mesa, this is
71only used to derive the directory for the libraries. The default is
72<code>${prefix}</code>.
73</li>
74<li><code>--libdir=LIBDIR</code> - This option specifies the directory
75where the GL libraries will be installed. The default is
76<code>${exec_prefix}/lib</code>. It also serves as the name of the
77library staging area in the source tree. For instance, if the option
78<code>--libdir=/usr/local/lib64</code> is used, the libraries will be
79created in a <code>lib64</code> directory at the top of the Mesa source
80tree.
81</li>
82<li><code>--enable-static, --disable-shared</code> - By default, Mesa
83will build shared libraries. Either of these options will force static
84libraries to be built. It is not currently possible to build static and
85shared libraries in a single pass.
86</li>
87<li><code>CC, CFLAGS, CXX, CXXFLAGS</code> - These environment variables
88control the C and C++ compilers used during the build. By default,
89<code>gcc</code> and <code>g++</code> are used with the options
90<code>"-g -O2"</code>.
91</li>
92<li><code>LDFLAGS</code> - An environment variable specifying flags to
93pass when linking programs. These are normally empty, but can be used
94to direct the linker to use libraries in nonstandard directories. For
95example, <code>LDFLAGS="-L/usr/X11R6/lib"</code>.
96</li>
97<li><code>PKG_CONFIG_PATH</code> - When available, the
98<code>pkg-config</code> utility is used to search for external libraries
99on the system. This environment variable is used to control the search
100path for <code>pkg-config</code>. For instance, setting
101<code>PKG_CONFIG_PATH=/usr/X11R6/lib/pkgconfig</code> will search for
102package metadata in <code>/usr/X11R6</code> before the standard
103directories.
104</li>
105</ul>
106</p>
107
108<p>
109There are also a few general options for altering the Mesa build:
110<ul>
111<li><code>--with-x</code> - When the X11 development libraries are
112needed, the <code>pkg-config</code> utility <a href="#pkg-config">will
113be used</a> for locating them. If they cannot be found through
114<code>pkg-config</code> a fallback routing using <code>imake</code> will
115be used. In this case, the <code>--with-x</code>,
116<code>--x-includes</code> and <code>--x-libraries</code> options can
117control the use of X for Mesa.
118</li>
119<li><code>--enable-debug</code> - This option will enable compiler
120options and macros to aid in debugging the Mesa libraries.
121</li>
122<li><code>--disable-asm</code> - There are assembly routines
123available for a few architectures. These will be used by default if
124one of these architectures is detected. This option ensures that
125assembly will not be used.
126</li>
127</ul>
128</p>
129
130
131<a name="driver">
132<h2>2. Driver Options</h2>
133
134<p>
135There are several different driver modes that Mesa can use. These are
136described in more detail in the <a href="install.html">basic
137installation instructions</a>. The Mesa driver is controlled through the
138configure option --with-driver. There are currently three supported
139options in the configure script.
140</p>
141
142<ul>
143
144<a name="xlib">
145<li><b><em>Xlib</em></b> - This is the default mode for building Mesa.
146It uses Xlib as a software renderer to do all rendering. It corresponds
147to the option <code>--with-driver=xlib</code>. The libX11 and libXext
148libraries, as well as the X11 development headers, will be need to
149support the Xlib driver.
150</li>
151
152<!-- Xlib specific options -->
153<p>
154<ul>
155<li><code>--disable-xlib-osmesa</code> - By default, the OSMesa library
156will be built and linked to the Xlib enabled libGL. This option disables
157building of libOSMesa.
158</li>
159</ul>
160</p>
161
162<a name="dri">
163<li><b><em>DRI</em></b> - This mode uses the DRI hardware drivers for
164accelerated OpenGL rendering. Enable the DRI drivers with the option
165<code>--with-driver=dri</code>. See the <a href="install.html">basic
166installation instructions</a> for details on prerequisites for the DRI
167drivers.
168</li>
169
170<!-- DRI specific options -->
171<p>
172<ul>
173<li><code>--with-dri-driverdir=DIR</code> - This option specifies the
174location the DRI drivers will be installed to and the location libGL
175will search for DRI drivers. The default is
176<code>/usr/X11R6/lib/modules/dri</code>.
177</li>
178<li><code>--with-dri-drivers=DRIVER,DRIVER,...</code> - This option
179allows a specific set of DRI drivers to be built. For example,
180<code>--with-dri-drivers="i965,radeon,nouveau"</code>. By default,
181the drivers will be chosen depending on the target platform. See the
182directory <code>src/mesa/drivers/dri</code> in the source tree for
183available drivers.
184</li>
185<!-- This explanation might be totally bogus. Kristian? -->
186<li><code>--disable-driglx-direct</code> - Disable direct rendering in
187GLX. Normally, direct hardware rendering through the DRI drivers and
188indirect software rendering are enabled in GLX. This option disables
189direct rendering entirely. It can be useful on architectures where
190kernel DRM modules are not available.
191</li>
192<li><code>--enable-glx-tls</code> - Enable Thread Local Storage (TLS) in
193GLX.
194</li>
195<li><code>--with-expat=DIR</code> - The DRI-enabled libGL uses expat to
196parse the DRI configuration files in <code>/etc/drirc</code> and
197<code>~/.drirc</code>. This option allows a specific expat installation
198to be used. For example, <code>--with-expat=/usr/local</code> will
199search for expat headers and libraries in <code>/usr/local/include</code>
200and <code>/usr/local/lib</code>, respectively.
201</li>
202</ul>
203</p>
204
205<a name="osmesa">
206<li><b><em>OSMesa</em></b> - No libGL is built in this
207mode. Instead, the driver code is built into the Off-Screen Mesa
208(OSMesa) library. See the <a href="osmesa.html">Off-Screen Rendering</a>
209page for more details.
210</li>
211
212<!-- OSMesa specific options -->
213<p>
214<ul>
215<li><code>--with-osmesa-bits=BITS</code> - This option allows the size
216of the color channel in bits to be specified. By default, an 8-bit
217channel will be used, and the driver will be named libOSMesa. Other
218options are 16- and 32-bit color channels, which will add the bit size
219to the library name. For example, <code>--with-osmesa-bits=16</code>
220will create the libOSMesa16 library with a 16-bit color channel.
221</li>
222</ul>
223</p>
224
225</ul>
226
227
228<a name="library">
229<h2>3. Library Options</h2>
230
231<p>
232The configure script provides more fine grained control over the GL
233libraries that will be built. More details on the specific GL libraries
234can be found in the <a href="install.html">basic installation
235instructions</a>.
236
237<ul>
238<a name="glu">
239<li><b><em>GLU</em></b> - The libGLU library will be built by default
240on all drivers. This can be disable with the option
241<code>--disable-glu</code>.
242</li>
243
244<a name="glw">
245<li><b><em>GLw</em></b> - The libGLw library will be built by default
246if libGLU has been enabled. This can be disable with the option
247<code>--disable-glw</code>.
248</li>
249
250<a name="glut">
251<li><b><em>GLUT</em></b> - The libglut library will be built by default
252if libGLU has been enabled and the glut source code from the MesaGLUT
253tarball is available. This can be disable with the option
254<code>--disable-glut</code>.
255</li>
256</ul>
257</p>
258
259
260<a name="demos">
261<h2>4. Demo Program Options</h2>
262
263<p>
264There are many demonstration programs in the MesaDemos tarball. If the
265programs are available when <code>./configure</code> is run, a subset of
266the programs will be built depending on the driver and library options
267chosen. See the directory <code>progs</code> for the full set of demos.
268
269<ul>
270<li><code>--with-demos=DEMOS,DEMOS,...</code> - This option allows a
271specific set of demo programs to be built. For example,
272<code>--with-demos="xdemos,slang"</code>. Beware that if this option is
273used, it will not be ensured that the necessary GL libraries will be
274available.
275</li>
276<li><code>--without-demos</code> - This completely disables building the
277demo programs. It is equivalent to <code>--with-demos=no</code>.
278</li>
279</ul>
280</p>
281
282</body>
283</html>