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 </li>
  42 <li>python - Python is needed for building the Gallium components.
  43 Version 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>
  52 The 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>
  59 version 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>
  69 Mesa may be <a href="autoconf.html">built using autoconf</a>.
  70 This should work well on most GNU-based systems.
  71 If 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>
  79 The traditional Mesa build system is based on a collection of pre-defined
  80 system configurations.
  81 </p>
  82 <p>
  83 To see the list of configurations, just type <code>make</code>.
  84 Then choose a configuration from the list and type <code>make</code>
  85 <em>configname</em>.
  86 </p>
  87
  88 <p>
  89 Mesa 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
  93 a software renderer using Xlib to do all rendering.
  94 The libGL.so library will be a self-contained rendering library that will
  95 allow you to run OpenGL/GLX applications on any X server (regardless of
  96 whether it supports the GLX X server extension).
  97 You will <em>not</em> be able to use hardware 3D acceleration.
  98 <p>
  99 To compile stand-alone Mesa type <code>make</code> in the top-level directory.
 100 You'll see a list of supported system configurations.
 101 Choose 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
 110 accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built.
 111 The libGL.so library will support the GLX extension and will load/use
 112 the DRI hardware drivers.
 113
 114
 115 <p>
 116 Build Mesa and the DRI hardware drivers by running
 117 </p>
 118 <pre>
 119    make linux-dri
 120 </pre>
 121 <p>
 122 There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>,
 123 and <code>linux-ppc</code> configurations which are optimized for those
 124 architectures.
 125 </p>
 126 <p>
 127 Make sure you have the prerequisite versions of DRM and Xserver mentioned
 128 above.
 129 </p>
 130
 131 </li>
 132
 133 </ul>
 134
 135
 136 <p>
 137 Later, 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>
 146 When compilation has finished, look in the top-level <code>lib/</code>
 147 (or <code>lib64/</code>) directory.
 148 You'll see a set of library files similar to this:
 149 </p>
 150 <pre>
 151 lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -> libGL.so.1*
 152 lrwxrwxrwx    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*
 154 lrwxrwxrwx    1 brian    users          11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
 155 lrwxrwxrwx    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*
 157 lrwxrwxrwx    1 brian    users          12 Mar 26 07:53 libglut.so -> libglut.so.3*
 158 lrwxrwxrwx    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*
 160 lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
 161 lrwxrwxrwx    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>
 176 If 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>
 186 If you built with Gallium support, look in lib/gallium/ for Gallium-based
 187 versions 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>
 196 The standard location for the OpenGL header files on Unix-type systems is
 197 in <code>/usr/include/GL/</code>.
 198 The standard location for the libraries is <code>/usr/lib/</code>.
 199 For more information see, the
 200 <a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent">
 201 Linux/OpenGL ABI specification</a>.
 202 </p>
 203
 204 <p>
 205 If you'd like Mesa to co-exist with another implementation of OpenGL that's
 206 already 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>
 211 To install Mesa's headers and libraries, run <code>make install</code>.
 212 But first, check the Mesa/configs/default file and examine the values
 213 of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
 214 Change them if needed, then run <code>make install</code>.
 215 </p>
 216
 217 <p>
 218 The variable
 219 <b>DESTDIR</b> may also be used to install the contents to a temporary
 220 staging directory.
 221 This can be useful for package management.
 222 For example: <code>make install DESTDIR=/somepath/</code>
 223 </p>
 224
 225 <p>
 226 Note: at runtime you can use the LD_LIBRARY_PATH environment variable
 227 (on Linux at least) to switch
 228 between the Mesa libraries and other vendor's libraries whenever you want.
 229 This 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>
 237 Running <code>make install</code> will install package configuration files
 238 for the pkg-config utility.
 239 </p>
 240
 241 <p>
 242 When compiling your OpenGL application you can use pkg-config to determine
 243 the proper compiler and linker flags.
 244 </p>
 245
 246 <p>
 247 For 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>
 259 Please 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>
 268 To build Mesa with SCons on Linux or Windows do
 269 </p>
 270 <pre>
 271     scons
 272 </pre>
 273 <p>
 274 The build output will be placed in
 275 build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
 276 example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
 277 by -debug for debug builds.
 278 </p>
 279
 280 <p>
 281 To 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 statetrackers=mesa drivers=softpipe,trace winsys=gdi
 285 </pre>
 286 <p>
 287 This will create:
 288 </p>
 289 <ul>
 290 <li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe, binary compatible with Windows's opengl32.dll
 291 <li>build/windows-x86-debug/glut/glx/glut32.dll
 292 <li>progs/build/windows-x86-debug/wgl/wglinfo.exe
 293 <li>progs/build/windows-x86-debug/trivial/tri.exe
 294 <li>and many other samples in progs/build/windows-x86-debug/...
 295 </ul>
 296 <p>
 297 Put them all in the same directory to test them.
 298 </p>
 299
 300
 301 <a name="other">
 302 <H2>4. Other systems</H1>
 303
 304 <p>
 305 Documentation for other environments (some may be very out of date):
 306 </p>
 307
 308 <UL>
 309 <li><A HREF="README.VMS">README.VMS</A> - VMS
 310 <LI><A HREF="README.GGI">README.GGI</A> - GGI
 311 <LI><A HREF="README.3DFX">README.3DFX</A> - 3Dfx/Glide driver
 312 <LI><A HREF="README.AMIWIN">README.AMIWIN</A> - Amiga Amiwin
 313 <LI><A HREF="README.D3D">README.D3D</A> - Direct3D driver
 314 <LI><A HREF="README.DJ">README.DJ</A> - DJGPP
 315 <LI><A HREF="README.LYNXOS">README.LYNXOS</A> - LynxOS
 316 <LI><A HREF="README.MINGW32">README.MINGW32</A> - Mingw32
 317 <LI><A HREF="README.NeXT">README.NeXT</A> - NeXT
 318 <LI><A HREF="README.OpenStep">README.OpenStep</A> - OpenStep
 319 <LI><A HREF="README.OS2">README.OS2</A> - OS/2
 320 <LI><A HREF="README.WINDML">README.WINDML</A> - WindML
 321 </UL>
 322
 323
 324
 325
 326 </body>
 327 </html>