docs/install.html

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