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