install.html revision 963727aec7cb19a101fbae8f71d11876724f07ac
1<HTML> 2 3<TITLE>Compiling and Installing</TITLE> 4 5<link rel="stylesheet" type="text/css" href="mesa.css"></head> 6 7<BODY> 8 9 10<H1>Compiling and Installing</H1> 11 12<ol> 13<li><a href="#unix-x11">Unix / X11</a> 14 <ul> 15 <li><a href="#prereq-general">General prerequisites for building</a> 16 <li><a href="#prereq-dri">Prerequisites for DRI and hardware acceleration</a> 17 <li><a href="#autoconf">Building with autoconf</a> 18 <li><a href="#traditional">Building with traditional Makefiles</a> 19 <li><a href="#libs">The Libraries</a> 20 <li><a href="#install">Installing the header and library files 21 <li><a href="#pkg-config">Building OpenGL programs with pkg-config 22 </ul> 23<li><a href="#windows">Windows</a> 24<li><a href="#scons">Building with SCons</a> 25<li><a href="#other">Other</a> 26</ol> 27<br> 28 29 30<a name="unix-x11"> 31<H2>1. Unix/X11 Compilation and Installation</H1> 32 33 34<a name="prereq-general"> 35<h3>1.1 General prerequisites for building</h3> 36 37<ul> 38<li>lex / yacc - for building the GLSL compiler. 39On Linux systems, flex and bison are used. 40Versions 2.5.35 and 2.4.1, respectively, (or later) should work. 41</li> 42<li>python - Python is needed for building the Gallium components. 43Version 2.6.4 or later should work. 44</li> 45</ul> 46 47 48<a name="prereq-dri"> 49<h3>1.2 Prerequisites for DRI and hardware acceleration</h3> 50 51<p> 52The following are required for DRI-based hardware acceleration with Mesa: 53</p> 54 55<ul> 56<li><a href="http://xorg.freedesktop.org/releases/individual/proto/">dri2proto</a> version 1.99.3 or later 57<li>Linux 2.6.28 58<li><a href="http://dri.freedesktop.org/libdrm/" target="_parent">libDRM</a> 59version 2.4.15 or later 60<li>Xorg server version 1.5 or later 61</ul> 62</p> 63 64 65<a name="autoconf"> 66<h3>1.3 Building with Autoconf</h3> 67 68<p> 69Mesa may be <a href="autoconf.html">built using autoconf</a>. 70This should work well on most GNU-based systems. 71If that fails the traditional Mesa build system is available. 72 73 74 75<a name="traditional"> 76<h3>1.4 Building with traditional Makefiles</h3> 77 78<p> 79The traditional Mesa build system is based on a collection of pre-defined 80system configurations. 81</p> 82<p> 83To see the list of configurations, just type <code>make</code>. 84Then choose a configuration from the list and type <code>make</code> 85<em>configname</em>. 86</p> 87 88<p> 89Mesa may be built in several different ways using the predefined configurations: 90</p> 91<ul> 92<li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as 93a software renderer using Xlib to do all rendering. 94The libGL.so library will be a self-contained rendering library that will 95allow you to run OpenGL/GLX applications on any X server (regardless of 96whether it supports the GLX X server extension). 97You will <em>not</em> be able to use hardware 3D acceleration. 98<p> 99To compile stand-alone Mesa type <code>make</code> in the top-level directory. 100You'll see a list of supported system configurations. 101Choose one from the list (such as linux-x86), and type: 102</p> 103<pre> 104 make linux-x86 105</pre> 106<p>This will produce libGL.so and several other libraries</p> 107</li> 108 109<li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers for 110accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built. 111The libGL.so library will support the GLX extension and will load/use 112the DRI hardware drivers. 113 114 115<p> 116Build Mesa and the DRI hardware drivers by running 117</p> 118<pre> 119 make linux-dri 120</pre> 121<p> 122There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>, 123and <code>linux-ppc</code> configurations which are optimized for those 124architectures. 125</p> 126<p> 127Make sure you have the prerequisite versions of DRM and Xserver mentioned 128above. 129</p> 130 131</li> 132 133</ul> 134 135 136<p> 137Later, if you want to rebuild for a different configuration run 138<code>make realclean</code> before rebuilding. 139</p> 140 141 142<a name="libs"> 143<h3>1.5 The libraries</h3> 144 145<p> 146When compilation has finished, look in the top-level <code>lib/</code> 147(or <code>lib64/</code>) directory. 148You'll see a set of library files similar to this: 149</p> 150<pre> 151lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -> libGL.so.1* 152lrwxrwxrwx 1 brian users 19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100* 153-rwxr-xr-x 1 brian users 3375861 Mar 26 07:53 libGL.so.1.5.060100* 154lrwxrwxrwx 1 brian users 11 Mar 26 07:53 libGLU.so -> libGLU.so.1* 155lrwxrwxrwx 1 brian users 20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100* 156-rwxr-xr-x 1 brian users 549269 Mar 26 07:53 libGLU.so.1.3.060100* 157lrwxrwxrwx 1 brian users 12 Mar 26 07:53 libglut.so -> libglut.so.3* 158lrwxrwxrwx 1 brian users 16 Mar 26 07:53 libglut.so.3 -> libglut.so.3.7.1* 159-rwxr-xr-x 1 brian users 597754 Mar 26 07:53 libglut.so.3.7.1* 160lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6* 161lrwxrwxrwx 1 brian users 23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100* 162-rwxr-xr-x 1 brian users 23871 Mar 26 07:53 libOSMesa.so.6.1.060100* 163</pre> 164 165<p> 166<b>libGL</b> is the main OpenGL library (i.e. Mesa). 167<br> 168<b>libGLU</b> is the OpenGL Utility library. 169<br> 170<b>libglut</b> is the GLUT library. 171<br> 172<b>libOSMesa</b> is the OSMesa (Off-Screen) interface library. 173</p> 174 175<p> 176If you built the DRI hardware drivers, you'll also see the DRI drivers: 177</p> 178<pre> 179-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i915_dri.so 180-rwxr-xr-x 1 brian users 11849858 Jul 21 12:12 r200_dri.so 181-rwxr-xr-x 1 brian users 16050488 Jul 21 12:11 r300_dri.so 182-rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so 183</pre> 184 185<p> 186If you built with Gallium support, look in lib/gallium/ for Gallium-based 187versions of libGL and device drivers. 188</p> 189 190 191 192<a name="install"> 193<H3>1.6 Installing the header and library files</H3> 194 195<p> 196The standard location for the OpenGL header files on Unix-type systems is 197in <code>/usr/include/GL/</code>. 198The standard location for the libraries is <code>/usr/lib/</code>. 199For more information see, the 200<a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent"> 201Linux/OpenGL ABI specification</a>. 202</p> 203 204<p> 205If you'd like Mesa to co-exist with another implementation of OpenGL that's 206already installed, you'll have to choose different directories, like 207<code>/usr/local/include/GL/</code> and <code>/usr/local/lib/</code>. 208</p> 209 210<p> 211To install Mesa's headers and libraries, run <code>make install</code>. 212But first, check the Mesa/configs/default file and examine the values 213of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables. 214Change them if needed, then run <code>make install</code>. 215</p> 216 217<p> 218The variable 219<b>DESTDIR</b> may also be used to install the contents to a temporary 220staging directory. 221This can be useful for package management. 222For example: <code>make install DESTDIR=/somepath/</code> 223</p> 224 225<p> 226Note: at runtime you can use the LD_LIBRARY_PATH environment variable 227(on Linux at least) to switch 228between the Mesa libraries and other vendor's libraries whenever you want. 229This is a handy way to compare multiple OpenGL implementations. 230</p> 231 232 233<a name="pkg-config"> 234<H3>1.7 Building OpenGL programs with pkg-config</H3> 235 236<p> 237Running <code>make install</code> will install package configuration files 238for the pkg-config utility. 239</p> 240 241<p> 242When compiling your OpenGL application you can use pkg-config to determine 243the proper compiler and linker flags. 244</p> 245 246<p> 247For example, compiling and linking a GLUT application can be done with: 248</p> 249<pre> 250 gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo 251</pre> 252 253<br> 254 255<a name="windows"> 256<H2>2. Windows Compilation and Installation</H1> 257 258<p> 259Please see the <a href="#scons">instructions on building with SCons</a>. 260</p> 261 262 263 264<a name="scons"> 265<H2>3. Building with SCons</H1> 266 267<p> 268To build Mesa with SCons on Linux or Windows do 269</p> 270<pre> 271 scons 272</pre> 273<p> 274The build output will be placed in 275build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for 276example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed 277by -debug for debug builds. 278</p> 279 280<p> 281To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do 282</p> 283<pre> 284 scons platform=windows toolchain=crossmingw machine=x86 mesagdi libgl-gdi 285</pre> 286<p> 287This will create: 288</p> 289<ul> 290<li>build/windows-x86-debug/mesa/drivers/windows/gdi/opengl32.dll — Mesa + swrast, binary compatible with Windows's opengl32.dll 291<li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll — Mesa + Gallium + softpipe, binary compatible with Windows's opengl32.dll 292</ul> 293<p> 294Put them all in the same directory to test them. 295</p> 296 297 298<a name="other"> 299<H2>4. Other systems</H1> 300 301<p> 302Documentation for other environments (some may be very out of date): 303</p> 304 305<UL> 306<li><A HREF="README.VMS">README.VMS</A> - VMS 307<LI><A HREF="README.GGI">README.GGI</A> - GGI 308<LI><A HREF="README.AMIWIN">README.AMIWIN</A> - Amiga Amiwin 309<LI><A HREF="README.D3D">README.D3D</A> - Direct3D driver 310<LI><A HREF="README.DJ">README.DJ</A> - DJGPP 311<LI><A HREF="README.LYNXOS">README.LYNXOS</A> - LynxOS 312<LI><A HREF="README.MINGW32">README.MINGW32</A> - Mingw32 313<LI><A HREF="README.NeXT">README.NeXT</A> - NeXT 314<LI><A HREF="README.OpenStep">README.OpenStep</A> - OpenStep 315<LI><A HREF="README.OS2">README.OS2</A> - OS/2 316<LI><A HREF="README.WINDML">README.WINDML</A> - WindML 317</UL> 318 319 320 321 322</body> 323</html> 324