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