Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / mesa3d / 2c56dd775771d9d5ea2e22cf4ee4b5dbbbb2a03d / . / docs / install.html
blob: be61ef304335f86990e658300dbc1bf9f568882c [file] [log] [blame]
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]1<HTML>
2
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]3<TITLE>Compiling and Installing</TITLE>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]4
Brian Paul36da0452005-01-20 03:55:10 +0000[diff] [blame]5<link rel="stylesheet" type="text/css" href="mesa.css"></head>
6
7<BODY>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]8
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]9
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]10<H1>Compiling and Installing</H1>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]11
12<ol>
13<li><a href="#unix-x11">Unix / X11</a>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]14 <ul>
15 <li><a href="#prereq">Prerequisites for DRI and hardware acceleration</a>
16 <li><a href="#autoconf">Building with autoconf</a>
17 <li><a href="#traditional">Building with traditional Makefiles</a>
18 <li><a href="#libs">The Libraries</a>
19 <li><a href="#demos">Running the demos
20 <li><a href="#install">Installing the header and library files
21 <li><a href="#pkg-config">Building OpenGL programs with pkg-config
22 </ul>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]23<li><a href="#windows">Windows</a>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]24<li><a href="#other">Other</a>
25</ol>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]26<br>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]27
28
29<a name="unix-x11">
30<H2>1. Unix/X11 Compilation and Installation</H1>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]31
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]32
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]33<a name="prereq">
34<h3>1.1 Prerequisites for DRI and hardware acceleration</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]35
36<p>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]37The following are required for DRI-based hardware acceleration with Mesa 7.3:
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]38</p>
39
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]40<ul>
Brian Pauld0c2cbd2009-01-08 17:19:51 -0700[diff] [blame]41<li><a href="http://xorg.freedesktop.org/releases/individual/proto/">dri2proto</a> version 1.99.3 or later
Brian Paul2c56dd72009-01-10 11:52:55 -0700[diff] [blame^]42<li>Linux 2.6.28
43<li><a href="http://dri.freedesktop.org/libdrm/" target="_parent">libDRM</a>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]44version 2.4.3 or later
Brian Paul2c56dd72009-01-10 11:52:55 -0700[diff] [blame^]45<li>Xorg server version 1.5 or later
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]46</ul>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]47</p>
48
49
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]50<a name="autoconf">
51<h3>1.2 Building with Autoconf</h3>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]52
53<p>
54Mesa may be <a href="autoconf.html">built using autoconf</a>.
55This should work well on most GNU-based systems.
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]56If that fails the traditional Mesa build system is available.
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]57
58
59
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]60<a name="traditional">
61<h3>1.3 Building with traditional Makefiles</h3>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]62
63<p>
64The traditional Mesa build system is based on a collection of pre-defined
65system configurations.
66</p>
67<p>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]68To see the list of configurations, just type <code>make</code>.
69Then choose a configuration from the list and type <code>make</code>
70<em>configname</em>.
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]71</p>
72
73<p>
74Mesa may be built in several different ways using the predefined configurations:
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]75</p>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]76<ul>
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]77<li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]78a software renderer using Xlib to do all rendering.
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]79The libGL.so library will be a self-contained rendering library that will
80allow you to run OpenGL/GLX applications on any X server (regardless of
81whether it supports the GLX X server extension).
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]82You will <em>not</em> be able to use hardware 3D acceleration.
Brian Paulb0eee792003-03-16 16:43:04 +0000[diff] [blame]83<p>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]84To compile stand-alone Mesa type <code>make</code> in the top-level directory.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]85You'll see a list of supported system configurations.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]86Choose one from the list (such as linux-x86), and type:
87</p>
88<pre>
89 make linux-x86
90</pre>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]91<p>This will produce libGL.so and several other libraries</p>
92</li>
93
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]94<li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers for
95accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built.
96The libGL.so library will support the GLX extension and will load/use
97the DRI hardware drivers.
98
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]99
100<p>
101Build Mesa and the DRI hardware drivers by running
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]102</p>
103<pre>
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]104 make linux-dri
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]105</pre>
106<p>
107There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>,
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]108and <code>linux-ppc</code> configurations which are optimized for those
109architectures.
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]110</p>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]111<p>
112Make sure you have the prerequisite versions of DRM and Xserver mentioned
113above.
114</p>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]115
116</li>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]117
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]118</ul>
119
120
121<p>
122Later, if you want to rebuild for a different configuration run
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]123<code>make realclean</code> before rebuilding.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]124</p>
125
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]126
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]127<a name="libs">
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]128<h3>1.4 The libraries</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]129
130<p>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]131When compilation has finished, look in the top-level <code>lib/</code>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]132(or <code>lib64/</code>) directory.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]133You'll see a set of library files similar to this:
134</p>
135<pre>
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]136lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -> libGL.so.1*
137lrwxrwxrwx 1 brian users 19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
138-rwxr-xr-x 1 brian users 3375861 Mar 26 07:53 libGL.so.1.5.060100*
139lrwxrwxrwx 1 brian users 11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
140lrwxrwxrwx 1 brian users 20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100*
141-rwxr-xr-x 1 brian users 549269 Mar 26 07:53 libGLU.so.1.3.060100*
142lrwxrwxrwx 1 brian users 12 Mar 26 07:53 libglut.so -> libglut.so.3*
143lrwxrwxrwx 1 brian users 16 Mar 26 07:53 libglut.so.3 -> libglut.so.3.7.1*
144-rwxr-xr-x 1 brian users 597754 Mar 26 07:53 libglut.so.3.7.1*
145lrwxrwxrwx 1 brian users 11 Mar 26 08:04 libGLw.so -> libGLw.so.1*
146lrwxrwxrwx 1 brian users 15 Mar 26 08:04 libGLw.so.1 -> libGLw.so.1.0.0*
147-rwxr-xr-x 1 brian users 20750 Mar 26 08:04 libGLw.so.1.0.0*
148lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
149lrwxrwxrwx 1 brian users 23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
150-rwxr-xr-x 1 brian users 23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]151</pre>
152
153<p>
154<b>libGL</b> is the main OpenGL library (i.e. Mesa).
155<br>
156<b>libGLU</b> is the OpenGL Utility library.
157<br>
158<b>libglut</b> is the GLUT library.
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]159<br>
160<b>libGLw</b> is the Xt/Motif OpenGL drawing area widget library.
161<br>
162<b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]163</p>
164
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]165<p>
166If you built the DRI hardware drivers, you'll also see the DRI drivers:
167</p>
168<pre>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]169-rwxr-xr-x 1 brian users 15607851 Jul 21 12:11 ffb_dri.so
170-rwxr-xr-x 1 brian users 15148747 Jul 21 12:11 i810_dri.so
171-rwxr-xr-x 1 brian users 14497814 Jul 21 12:11 i830_dri.so
172-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i915_dri.so
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]173-rwxr-xr-x 1 brian users 11320803 Jul 21 12:11 mach64_dri.so
174-rwxr-xr-x 1 brian users 11418014 Jul 21 12:12 mga_dri.so
175-rwxr-xr-x 1 brian users 11064426 Jul 21 12:12 r128_dri.so
176-rwxr-xr-x 1 brian users 11849858 Jul 21 12:12 r200_dri.so
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]177-rwxr-xr-x 1 brian users 16050488 Jul 21 12:11 r300_dri.so
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]178-rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so
179-rwxr-xr-x 1 brian users 11232304 Jul 21 12:13 s3v_dri.so
180-rwxr-xr-x 1 brian users 11062970 Jul 21 12:13 savage_dri.so
181-rwxr-xr-x 1 brian users 11214212 Jul 21 12:13 sis_dri.so
182-rwxr-xr-x 1 brian users 11368736 Jul 21 12:13 tdfx_dri.so
183-rwxr-xr-x 1 brian users 10598868 Jul 21 12:13 trident_dri.so
184-rwxr-xr-x 1 brian users 10997120 Jul 21 12:13 unichrome_dri.so
185</pre>
186
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]187
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]188<a name="demos">
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]189<h3>1.5 Running the demos</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]190
191<p>
192If you downloaded/unpacked the MesaDemos-x.y.z.tar.gz archive or
193obtained Mesa from CVS, the <b>progs/</b> directory will contain a
194bunch of demonstration programs.
195</p>
196
197<p>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]198Before running a demo, you'll probably have to set two environment variables
199to indicate where the libraries are located. For example:
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]200<p>
201<blockquote>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]202<b>cd lib/</b>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]203<br>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]204<b>export LD_LIBRARY_PATH=${PWD}</b>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]205<br>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]206<b>export LIBGL_DRIVERS_PATH=${PWD}</b> (if using DRI drivers)
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]207</blockquote>
208
209<p>
210Next, change to the Mesa/demos/ directory:
211</p>
212<blockquote>
213<b>cd ../progs/demos</b>
214</blockquote>
215
216<p>
217Run a demo such as gears:
218</p>
219<blockquote>
220<b>./gears</b>
221</blockquote>
222
223<p>
224If this doesn't work, try the <b>Mesa/progs/xdemos/glxinfo</b> program
225and see that it prints the expected Mesa version number.
226</p>
227
228<p>
229If you're using Linux or a similar OS, verify that the demo program is
230being linked with the proper library files:
231</p>
232<blockquote>
233<b>ldd gears</b>
234</blockquote>
235
236<p>
237You should see something like this:
238</p>
239<pre>
240 libglut.so.3 => /home/brian/Mesa/lib/libglut.so.3 (0x40013000)
241 libGLU.so.1 => /home/brian/Mesa/lib/libGLU.so.1 (0x40051000)
242 libGL.so.1 => /home/brian/Mesa/lib/libGL.so.1 (0x400e0000)
243 libc.so.6 => /lib/i686/libc.so.6 (0x42000000)
244 libm.so.6 => /lib/i686/libm.so.6 (0x403da000)
245 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x403fc000)
246 libXmu.so.6 => /usr/X11R6/lib/libXmu.so.6 (0x404da000)
247 libXt.so.6 => /usr/X11R6/lib/libXt.so.6 (0x404f1000)
248 libXi.so.6 => /usr/X11R6/lib/libXi.so.6 (0x40543000)
249 libstdc++.so.5 => /usr/lib/libstdc++.so.5 (0x4054b000)
250 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x405fd000)
251 libXext.so.6 => /usr/X11R6/lib/libXext.so.6 (0x40605000)
252 libpthread.so.0 => /lib/i686/libpthread.so.0 (0x40613000)
253 /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)
254 libdl.so.2 => /lib/libdl.so.2 (0x40644000)
255 libSM.so.6 => /usr/X11R6/lib/libSM.so.6 (0x40647000)
256 libICE.so.6 => /usr/X11R6/lib/libICE.so.6 (0x40650000)
257</pre>
258
259<p>
260Retrace your steps if this doesn't look right.
261</p>
262
263
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]264<a name="install">
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]265<H3>1.6 Installing the header and library files</H3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]266
267<p>
268The standard location for the OpenGL header files on Unix-type systems is
269in <code>/usr/include/GL/</code>.
270The standard location for the libraries is <code>/usr/lib/</code>.
271For more information see, the
272<a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent">
273Linux/OpenGL ABI specification</a>.
274</p>
275
276<p>
277If you'd like Mesa to co-exist with another implementation of OpenGL that's
278already installed, you'll have to choose different directories, like
279<code>/usr/local/include/GL/</code> and <code>/usr/local/lib/</code>.
280</p>
281
282<p>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]283To install Mesa's headers and libraries, run <code>make install</code>.
284But first, check the Mesa/configs/default file and examine the values
285of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
Dan Nicholsonf5557c32007-09-12 09:57:53 -0600[diff] [blame]286Change them if needed, then run <code>make install</code>.
287</p>
288
289<p>
290The variable
291<b>DESTDIR</b> may also be used to install the contents to a temporary
292staging directory.
293This can be useful for package management.
294For example: <code>make install DESTDIR=/somepath/</code>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]295</p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]296
297<p>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]298Note: at runtime you can use the LD_LIBRARY_PATH environment variable
299(on Linux at least) to switch
300between the Mesa libraries and other vendor's libraries whenever you want.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]301This is a handy way to compare multiple OpenGL implementations.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]302</p>
303
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]304
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]305<a name="pkg-config">
306<H3>1.7 Building OpenGL programs with pkg-config</H3>
Brian5bba58c2007-09-12 10:11:49 -0600[diff] [blame]307
308<p>
309Running <code>make install</code> will install package configuration files
310for the pkg-config utility.
311</p>
312
313<p>
314When compiling your OpenGL application you can use pkg-config to determine
315the proper compiler and linker flags.
316</p>
317
318<p>
319For example, compiling and linking a GLUT application can be done with:
320</p>
321<pre>
322 gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
323</pre>
324
325<br>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]326
327<a name="windows">
328<H2>2. Windows Compilation and Installation</H1>
329
330<p>
331Please see the <a href="README.WIN32">README.WIN32</a> file.
332</p>
333
334
335
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]336<a name="other">
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]337<H2>3. Other systems</H1>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]338
339<p>
340Documentation for other environments (some may be very out of date):
341</p>
342
343<UL>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]344<li><A HREF="README.VMS">README.VMS</A> - VMS
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]345<LI><A HREF="README.GGI">README.GGI</A> - GGI
346<LI><A HREF="README.3DFX">README.3DFX</A> - 3Dfx/Glide driver
347<LI><A HREF="README.AMIWIN">README.AMIWIN</A> - Amiga Amiwin
348<LI><A HREF="README.BEOS">README.BEOS</A> - BeOS
349<LI><A HREF="README.D3D">README.D3D</A> - Direct3D driver
350<LI><A HREF="README.DJ">README.DJ</A> - DJGPP
351<LI><A HREF="README.LYNXOS">README.LYNXOS</A> - LynxOS
352<LI><A HREF="README.MINGW32">README.MINGW32</A> - Mingw32
353<LI><A HREF="README.NeXT">README.NeXT</A> - NeXT
354<LI><A HREF="README.OpenStep">README.OpenStep</A> - OpenStep
355<LI><A HREF="README.OS2">README.OS2</A> - OS/2
356<LI><A HREF="README.WINDML">README.WINDML</A> - WindML
357</UL>
358
359
360
361
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]362</body>
363</html>