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