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