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