blob: 953d2094d5b314dd87bb3899953fdc18cad45866 [file] [log] [blame]
Brian Paul0b27ace2003-03-08 17:38:57 +00001<HTML>
2
Brian Paul49a3fab2008-12-30 07:57:16 -07003<TITLE>Compiling and Installing</TITLE>
Brian Paul0b27ace2003-03-08 17:38:57 +00004
Brian Paul36da0452005-01-20 03:55:10 +00005<link rel="stylesheet" type="text/css" href="mesa.css"></head>
6
7<BODY>
Brian Paul0b27ace2003-03-08 17:38:57 +00008
Brian Paul5f37abf2003-09-05 14:47:07 +00009
Brian Paul49a3fab2008-12-30 07:57:16 -070010<H1>Compiling and Installing</H1>
Brian Paul5f37abf2003-09-05 14:47:07 +000011
12<ol>
13<li><a href="#unix-x11">Unix / X11</a>
Brian Paul49a3fab2008-12-30 07:57:16 -070014 <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 +000023<li><a href="#windows">Windows</a>
José Fonsecaebe07962009-06-17 10:12:11 +010024<li><a href="#scons">SCons</a>
Brian Paul5f37abf2003-09-05 14:47:07 +000025<li><a href="#other">Other</a>
26</ol>
Brian Paul49a3fab2008-12-30 07:57:16 -070027<br>
Brian Paul5f37abf2003-09-05 14:47:07 +000028
29
30<a name="unix-x11">
31<H2>1. Unix/X11 Compilation and Installation</H1>
Brian Paul0b27ace2003-03-08 17:38:57 +000032
Brian Paul8bd70a72008-05-27 13:27:57 -060033
Brian Paul49a3fab2008-12-30 07:57:16 -070034<a name="prereq">
35<h3>1.1 Prerequisites for DRI and hardware acceleration</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +000036
37<p>
Brian Paul49a3fab2008-12-30 07:57:16 -070038The following are required for DRI-based hardware acceleration with Mesa 7.3:
Brian Paul8bd70a72008-05-27 13:27:57 -060039</p>
40
Brian Paul49a3fab2008-12-30 07:57:16 -070041<ul>
Brian Pauld0c2cbd2009-01-08 17:19:51 -070042<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 -070043<li>Linux 2.6.28
44<li><a href="http://dri.freedesktop.org/libdrm/" target="_parent">libDRM</a>
Brian Paul49a3fab2008-12-30 07:57:16 -070045version 2.4.3 or later
Brian Paul2c56dd72009-01-10 11:52:55 -070046<li>Xorg server version 1.5 or later
Brian Paul49a3fab2008-12-30 07:57:16 -070047</ul>
Brian Paul8bd70a72008-05-27 13:27:57 -060048</p>
49
50
Brian Paul49a3fab2008-12-30 07:57:16 -070051<a name="autoconf">
52<h3>1.2 Building with Autoconf</h3>
Brian Paul8bd70a72008-05-27 13:27:57 -060053
54<p>
55Mesa may be <a href="autoconf.html">built using autoconf</a>.
56This should work well on most GNU-based systems.
Brian Paul49a3fab2008-12-30 07:57:16 -070057If that fails the traditional Mesa build system is available.
Brian Paul8bd70a72008-05-27 13:27:57 -060058
59
60
Brian Paul49a3fab2008-12-30 07:57:16 -070061<a name="traditional">
62<h3>1.3 Building with traditional Makefiles</h3>
Brian Paul8bd70a72008-05-27 13:27:57 -060063
64<p>
65The traditional Mesa build system is based on a collection of pre-defined
66system configurations.
67</p>
68<p>
Brian Paul49a3fab2008-12-30 07:57:16 -070069To see the list of configurations, just type <code>make</code>.
70Then choose a configuration from the list and type <code>make</code>
71<em>configname</em>.
Brian Paul8bd70a72008-05-27 13:27:57 -060072</p>
73
74<p>
75Mesa may be built in several different ways using the predefined configurations:
Brian Paul5f37abf2003-09-05 14:47:07 +000076</p>
Brian Paulf87bb142005-07-21 18:45:44 +000077<ul>
Brian Paul5dbd0a42006-06-08 23:42:07 +000078<li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as
Brian Paulf87bb142005-07-21 18:45:44 +000079a software renderer using Xlib to do all rendering.
Brian Paul5dbd0a42006-06-08 23:42:07 +000080The libGL.so library will be a self-contained rendering library that will
81allow you to run OpenGL/GLX applications on any X server (regardless of
82whether it supports the GLX X server extension).
Brian Pauld9eff8b2006-07-12 20:14:43 +000083You will <em>not</em> be able to use hardware 3D acceleration.
Brian Paulb0eee792003-03-16 16:43:04 +000084<p>
Brian Paul49a3fab2008-12-30 07:57:16 -070085To compile stand-alone Mesa type <code>make</code> in the top-level directory.
Brian Paul0b27ace2003-03-08 17:38:57 +000086You'll see a list of supported system configurations.
Brian Paul5f37abf2003-09-05 14:47:07 +000087Choose one from the list (such as linux-x86), and type:
88</p>
89<pre>
90 make linux-x86
91</pre>
Brian Paulf87bb142005-07-21 18:45:44 +000092<p>This will produce libGL.so and several other libraries</p>
93</li>
94
Brian Paul5dbd0a42006-06-08 23:42:07 +000095<li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers for
96accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built.
97The libGL.so library will support the GLX extension and will load/use
98the DRI hardware drivers.
99
Brian Paul5dbd0a42006-06-08 23:42:07 +0000100
101<p>
102Build Mesa and the DRI hardware drivers by running
Brian Paulf87bb142005-07-21 18:45:44 +0000103</p>
104<pre>
Brian Paul5dbd0a42006-06-08 23:42:07 +0000105 make linux-dri
Brian Paulf87bb142005-07-21 18:45:44 +0000106</pre>
107<p>
108There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>,
Brian Paul5dbd0a42006-06-08 23:42:07 +0000109and <code>linux-ppc</code> configurations which are optimized for those
110architectures.
Brian Paulf87bb142005-07-21 18:45:44 +0000111</p>
Brian Paul8bd70a72008-05-27 13:27:57 -0600112<p>
113Make sure you have the prerequisite versions of DRM and Xserver mentioned
114above.
115</p>
Brian Paulf87bb142005-07-21 18:45:44 +0000116
117</li>
Brian Paul8bd70a72008-05-27 13:27:57 -0600118
Brian Paulf87bb142005-07-21 18:45:44 +0000119</ul>
120
121
122<p>
123Later, if you want to rebuild for a different configuration run
Brian Paul26f334a2004-03-26 15:20:08 +0000124<code>make realclean</code> before rebuilding.
Brian Paul0b27ace2003-03-08 17:38:57 +0000125</p>
126
Brian Paul26f334a2004-03-26 15:20:08 +0000127
Brian Paul49a3fab2008-12-30 07:57:16 -0700128<a name="libs">
Brian Paul8bd70a72008-05-27 13:27:57 -0600129<h3>1.4 The libraries</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000130
131<p>
Brian Paulf87bb142005-07-21 18:45:44 +0000132When compilation has finished, look in the top-level <code>lib/</code>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000133(or <code>lib64/</code>) directory.
Brian Paul5f37abf2003-09-05 14:47:07 +0000134You'll see a set of library files similar to this:
135</p>
136<pre>
Brian Paul26f334a2004-03-26 15:20:08 +0000137lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -> libGL.so.1*
138lrwxrwxrwx 1 brian users 19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
139-rwxr-xr-x 1 brian users 3375861 Mar 26 07:53 libGL.so.1.5.060100*
140lrwxrwxrwx 1 brian users 11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
141lrwxrwxrwx 1 brian users 20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100*
142-rwxr-xr-x 1 brian users 549269 Mar 26 07:53 libGLU.so.1.3.060100*
143lrwxrwxrwx 1 brian users 12 Mar 26 07:53 libglut.so -> libglut.so.3*
144lrwxrwxrwx 1 brian users 16 Mar 26 07:53 libglut.so.3 -> libglut.so.3.7.1*
145-rwxr-xr-x 1 brian users 597754 Mar 26 07:53 libglut.so.3.7.1*
146lrwxrwxrwx 1 brian users 11 Mar 26 08:04 libGLw.so -> libGLw.so.1*
147lrwxrwxrwx 1 brian users 15 Mar 26 08:04 libGLw.so.1 -> libGLw.so.1.0.0*
148-rwxr-xr-x 1 brian users 20750 Mar 26 08:04 libGLw.so.1.0.0*
149lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
150lrwxrwxrwx 1 brian users 23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
151-rwxr-xr-x 1 brian users 23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
Brian Paul5f37abf2003-09-05 14:47:07 +0000152</pre>
153
154<p>
155<b>libGL</b> is the main OpenGL library (i.e. Mesa).
156<br>
157<b>libGLU</b> is the OpenGL Utility library.
158<br>
159<b>libglut</b> is the GLUT library.
Brian Paul26f334a2004-03-26 15:20:08 +0000160<br>
161<b>libGLw</b> is the Xt/Motif OpenGL drawing area widget library.
162<br>
163<b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
Brian Paul5f37abf2003-09-05 14:47:07 +0000164</p>
165
Brian Paulf87bb142005-07-21 18:45:44 +0000166<p>
167If you built the DRI hardware drivers, you'll also see the DRI drivers:
168</p>
169<pre>
Brian Paul8bd70a72008-05-27 13:27:57 -0600170-rwxr-xr-x 1 brian users 15607851 Jul 21 12:11 ffb_dri.so
171-rwxr-xr-x 1 brian users 15148747 Jul 21 12:11 i810_dri.so
172-rwxr-xr-x 1 brian users 14497814 Jul 21 12:11 i830_dri.so
173-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i915_dri.so
Brian Paulf87bb142005-07-21 18:45:44 +0000174-rwxr-xr-x 1 brian users 11320803 Jul 21 12:11 mach64_dri.so
175-rwxr-xr-x 1 brian users 11418014 Jul 21 12:12 mga_dri.so
176-rwxr-xr-x 1 brian users 11064426 Jul 21 12:12 r128_dri.so
177-rwxr-xr-x 1 brian users 11849858 Jul 21 12:12 r200_dri.so
Brian Paul8bd70a72008-05-27 13:27:57 -0600178-rwxr-xr-x 1 brian users 16050488 Jul 21 12:11 r300_dri.so
Brian Paulf87bb142005-07-21 18:45:44 +0000179-rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so
180-rwxr-xr-x 1 brian users 11232304 Jul 21 12:13 s3v_dri.so
181-rwxr-xr-x 1 brian users 11062970 Jul 21 12:13 savage_dri.so
182-rwxr-xr-x 1 brian users 11214212 Jul 21 12:13 sis_dri.so
183-rwxr-xr-x 1 brian users 11368736 Jul 21 12:13 tdfx_dri.so
184-rwxr-xr-x 1 brian users 10598868 Jul 21 12:13 trident_dri.so
185-rwxr-xr-x 1 brian users 10997120 Jul 21 12:13 unichrome_dri.so
186</pre>
187
Brian Paul5f37abf2003-09-05 14:47:07 +0000188
Brian Paul49a3fab2008-12-30 07:57:16 -0700189<a name="demos">
Brian Paul8bd70a72008-05-27 13:27:57 -0600190<h3>1.5 Running the demos</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000191
192<p>
193If you downloaded/unpacked the MesaDemos-x.y.z.tar.gz archive or
194obtained Mesa from CVS, the <b>progs/</b> directory will contain a
195bunch of demonstration programs.
196</p>
197
198<p>
Brian Paul8bd70a72008-05-27 13:27:57 -0600199Before running a demo, you'll probably have to set two environment variables
200to indicate where the libraries are located. For example:
Brian Paul5f37abf2003-09-05 14:47:07 +0000201<p>
202<blockquote>
Brian Paul8bd70a72008-05-27 13:27:57 -0600203<b>cd lib/</b>
Brian Paul5f37abf2003-09-05 14:47:07 +0000204<br>
Brian Paul8bd70a72008-05-27 13:27:57 -0600205<b>export LD_LIBRARY_PATH=${PWD}</b>
Brian Paul5f37abf2003-09-05 14:47:07 +0000206<br>
Brian Paul8bd70a72008-05-27 13:27:57 -0600207<b>export LIBGL_DRIVERS_PATH=${PWD}</b> (if using DRI drivers)
Brian Paul5f37abf2003-09-05 14:47:07 +0000208</blockquote>
209
210<p>
211Next, change to the Mesa/demos/ directory:
212</p>
213<blockquote>
214<b>cd ../progs/demos</b>
215</blockquote>
216
217<p>
218Run a demo such as gears:
219</p>
220<blockquote>
221<b>./gears</b>
222</blockquote>
223
224<p>
225If this doesn't work, try the <b>Mesa/progs/xdemos/glxinfo</b> program
226and see that it prints the expected Mesa version number.
227</p>
228
229<p>
230If you're using Linux or a similar OS, verify that the demo program is
231being linked with the proper library files:
232</p>
233<blockquote>
234<b>ldd gears</b>
235</blockquote>
236
237<p>
238You should see something like this:
239</p>
240<pre>
241 libglut.so.3 => /home/brian/Mesa/lib/libglut.so.3 (0x40013000)
242 libGLU.so.1 => /home/brian/Mesa/lib/libGLU.so.1 (0x40051000)
243 libGL.so.1 => /home/brian/Mesa/lib/libGL.so.1 (0x400e0000)
244 libc.so.6 => /lib/i686/libc.so.6 (0x42000000)
245 libm.so.6 => /lib/i686/libm.so.6 (0x403da000)
246 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x403fc000)
247 libXmu.so.6 => /usr/X11R6/lib/libXmu.so.6 (0x404da000)
248 libXt.so.6 => /usr/X11R6/lib/libXt.so.6 (0x404f1000)
249 libXi.so.6 => /usr/X11R6/lib/libXi.so.6 (0x40543000)
250 libstdc++.so.5 => /usr/lib/libstdc++.so.5 (0x4054b000)
251 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x405fd000)
252 libXext.so.6 => /usr/X11R6/lib/libXext.so.6 (0x40605000)
253 libpthread.so.0 => /lib/i686/libpthread.so.0 (0x40613000)
254 /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)
255 libdl.so.2 => /lib/libdl.so.2 (0x40644000)
256 libSM.so.6 => /usr/X11R6/lib/libSM.so.6 (0x40647000)
257 libICE.so.6 => /usr/X11R6/lib/libICE.so.6 (0x40650000)
258</pre>
259
260<p>
261Retrace your steps if this doesn't look right.
262</p>
263
264
Brian Paul49a3fab2008-12-30 07:57:16 -0700265<a name="install">
Brian Paul8bd70a72008-05-27 13:27:57 -0600266<H3>1.6 Installing the header and library files</H3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000267
268<p>
269The standard location for the OpenGL header files on Unix-type systems is
270in <code>/usr/include/GL/</code>.
271The standard location for the libraries is <code>/usr/lib/</code>.
272For more information see, the
273<a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent">
274Linux/OpenGL ABI specification</a>.
275</p>
276
277<p>
278If you'd like Mesa to co-exist with another implementation of OpenGL that's
279already installed, you'll have to choose different directories, like
280<code>/usr/local/include/GL/</code> and <code>/usr/local/lib/</code>.
281</p>
282
283<p>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000284To install Mesa's headers and libraries, run <code>make install</code>.
285But first, check the Mesa/configs/default file and examine the values
286of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
Dan Nicholsonf5557c32007-09-12 09:57:53 -0600287Change them if needed, then run <code>make install</code>.
288</p>
289
290<p>
291The variable
292<b>DESTDIR</b> may also be used to install the contents to a temporary
293staging directory.
294This can be useful for package management.
295For example: <code>make install DESTDIR=/somepath/</code>
Brian Paul0b27ace2003-03-08 17:38:57 +0000296</p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000297
298<p>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000299Note: at runtime you can use the LD_LIBRARY_PATH environment variable
300(on Linux at least) to switch
301between the Mesa libraries and other vendor's libraries whenever you want.
Brian Paul5f37abf2003-09-05 14:47:07 +0000302This is a handy way to compare multiple OpenGL implementations.
Brian Paul0b27ace2003-03-08 17:38:57 +0000303</p>
304
Brian Paul5f37abf2003-09-05 14:47:07 +0000305
Brian Paul49a3fab2008-12-30 07:57:16 -0700306<a name="pkg-config">
307<H3>1.7 Building OpenGL programs with pkg-config</H3>
Brian5bba58c2007-09-12 10:11:49 -0600308
309<p>
310Running <code>make install</code> will install package configuration files
311for the pkg-config utility.
312</p>
313
314<p>
315When compiling your OpenGL application you can use pkg-config to determine
316the proper compiler and linker flags.
317</p>
318
319<p>
320For example, compiling and linking a GLUT application can be done with:
321</p>
322<pre>
323 gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
324</pre>
325
326<br>
Brian Paul5f37abf2003-09-05 14:47:07 +0000327
328<a name="windows">
329<H2>2. Windows Compilation and Installation</H1>
330
331<p>
José Fonsecaebe07962009-06-17 10:12:11 +0100332Please see the <a href="#scons">instructions on building with SCons</a>.
333Alternatively see <a href="README.WIN32">README.WIN32</a> file.
Brian Paul5f37abf2003-09-05 14:47:07 +0000334</p>
335
336
337
José Fonsecaebe07962009-06-17 10:12:11 +0100338<a name="scons">
339<H2>3. Building with SCons</H1>
340
341<p>
342To build Mesa with SCons on Linux or Windows do
343</p>
344<pre>
345 scons
346</pre>
347<p>
348The build output will be placed in
349build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
350example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
351by -debug for debug builds.
352</p>
353
354<p>
355The sample programs are built seperately. To build them do
356<pre>
357 scons -C progs
358</pre>
359And the build output will be placed in progs/build/...
360</p>
361
362<p>
363To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
364</p>
365<pre>
366 scons platform=windows toolchain=crossmingw machine=x86 statetrackers=mesa drivers=softpipe,trace winsys=gdi
367 scons -C progs platform=windows toolchain=crossmingw machine=x86 -k
368</pre>
369<p>
370This will create:
371</p>
372<ul>
373<li>build/windows-x86-debug/gallium/winsys/gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe, binary compatible with Windows's opengl32.dll
374<li>build/windows-x86-debug/glut/glx/glut32.dll
375<li>progs/build/windows-x86-debug/wgl/wglinfo.exe
376<li>progs/build/windows-x86-debug/trivial/tri.exe
377<li>and many other samples in progs/build/windows-x86-debug/...
378</ul>
379<p>
380Put them all in the same directory to test them.
381</p>
382
383
Brian Paul5f37abf2003-09-05 14:47:07 +0000384<a name="other">
José Fonsecaebe07962009-06-17 10:12:11 +0100385<H2>4. Other systems</H1>
Brian Paul5f37abf2003-09-05 14:47:07 +0000386
387<p>
388Documentation for other environments (some may be very out of date):
389</p>
390
391<UL>
Brian Paul49a3fab2008-12-30 07:57:16 -0700392<li><A HREF="README.VMS">README.VMS</A> - VMS
Brian Paul5f37abf2003-09-05 14:47:07 +0000393<LI><A HREF="README.GGI">README.GGI</A> - GGI
394<LI><A HREF="README.3DFX">README.3DFX</A> - 3Dfx/Glide driver
395<LI><A HREF="README.AMIWIN">README.AMIWIN</A> - Amiga Amiwin
396<LI><A HREF="README.BEOS">README.BEOS</A> - BeOS
397<LI><A HREF="README.D3D">README.D3D</A> - Direct3D driver
398<LI><A HREF="README.DJ">README.DJ</A> - DJGPP
399<LI><A HREF="README.LYNXOS">README.LYNXOS</A> - LynxOS
400<LI><A HREF="README.MINGW32">README.MINGW32</A> - Mingw32
401<LI><A HREF="README.NeXT">README.NeXT</A> - NeXT
402<LI><A HREF="README.OpenStep">README.OpenStep</A> - OpenStep
403<LI><A HREF="README.OS2">README.OS2</A> - OS/2
404<LI><A HREF="README.WINDML">README.WINDML</A> - WindML
405</UL>
406
407
408
409
Brian Paul0b27ace2003-03-08 17:38:57 +0000410</body>
411</html>