docs/install.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html lang="en">
   3 <head>
   4   <meta http-equiv="content-type" content="text/html; charset=utf-8">
   5   <title>Compiling and Installing</title>
   6   <link rel="stylesheet" type="text/css" href="mesa.css">
   7 </head>
   8 <body>
   9
  10 <div class="header">
  11   <h1>The Mesa 3D Graphics Library</h1>
  12 </div>
  13
  14 <iframe src="contents.html"></iframe>
  15 <div class="content">
  16
  17 <h1>Compiling and Installing</h1>
  18
  19 <ol>
  20 <li><a href="#prereq-general">Prerequisites for building</a>
  21   <ul>
  22   <li><a href="#prereq-general">General prerequisites</a>
  23   <li><a href="#prereq-dri">For DRI and hardware acceleration</a>
  24   </ul>
  25 <li><a href="#autoconf">Building with autoconf (Linux/Unix/X11)</a>
  26 <li><a href="#scons">Building with SCons (Windows/Linux)</a>
  27 <li><a href="#other">Building for other systems</a>
  28 <li><a href="#libs">Library Information</a>
  29 <li><a href="#pkg-config">Building OpenGL programs with pkg-config</a>
  30 </ol>
  31
  32
  33 <h1 id="prereq-general">1. Prerequisites for building</h1>
  34
  35 <h2>1.1 General</h2>
  36 <ul>
  37 <li><a href="http://www.python.org/">Python</a> - Python is required.
  38 Version 2.6.4 or later should work.
  39 </li>
  40 <br>
  41 <li><a href="http://www.scons.org/">SCons</a> is required for building on
  42 Windows and optional for Linux (it's an alternative to autoconf/automake.)
  43 </li>
  44 <br>
  45 <li>lex / yacc - for building the GLSL compiler.
  46 <br>
  47 <br>
  48 On Linux systems, flex and bison are used.
  49 Versions 2.5.35 and 2.4.1, respectively, (or later) should work.
  50 <br>
  51 <br>
  52 On Windows with MinGW, install flex and bison with:
  53 <pre>mingw-get install msys-flex msys-bison</pre>
  54 For MSVC on Windows, you can find flex/bison programs on the
  55 <a href="ftp://ftp.freedesktop.org/pub/mesa/windows-utils/">Mesa ftp site</a>.
  56 </li>
  57 </ul>
  58
  59
  60 <h3 id="prereq-dri">1.2 For DRI and hardware acceleration</h3>
  61
  62 <p>
  63 The following are required for DRI-based hardware acceleration with Mesa:
  64 </p>
  65
  66 <ul>
  67 <li><a href="http://xorg.freedesktop.org/releases/individual/proto/">
  68 dri2proto</a> version 2.6 or later
  69 <li><a href="http://dri.freedesktop.org/libdrm/">libDRM</a>
  70 version 2.4.33 or later
  71 <li>Xorg server version 1.5 or later
  72 <li>Linux 2.6.28 or later
  73 </ul>
  74 <p>
  75 If you're using a fedora distro the following command should install all
  76 the needed dependencies:
  77 </p>
  78 <pre>
  79   sudo yum install flex bison imake libtool xorg-x11-proto-devel libdrm-devel \
  80   gcc-c++ xorg-x11-server-devel libXi-devel libXmu-devel libXdamage-devel git \
  81   expat-devel llvm-devel
  82 </pre>
  83
  84
  85
  86 <h1 id="autoconf">2. Building with autoconf (Linux/Unix/X11)</h1>
  87
  88 <p>
  89 The primary method to build Mesa on Unix systems is with autoconf.
  90 </p>
  91
  92 <p>
  93 The general approach is the standard:
  94 </p>
  95 <pre>
  96   ./configure
  97   make
  98   sudo make install
  99 </pre>
 100 <p>
 101 But please read the <a href="autoconf.html">detailed autoconf instructions</a>
 102 for more details.
 103 </p>
 104
 105
 106
 107 <h1 id="scons">3. Building with SCons (Windows/Linux)</h1>
 108
 109 <p>
 110 To build Mesa with SCons on Linux or Windows do
 111 </p>
 112 <pre>
 113     scons
 114 </pre>
 115 <p>
 116 The build output will be placed in
 117 build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
 118 example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
 119 by -debug for debug builds.
 120 </p>
 121
 122 <p>
 123 To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
 124 </p>
 125 <pre>
 126     scons platform=windows toolchain=crossmingw machine=x86 mesagdi libgl-gdi
 127 </pre>
 128 <p>
 129 This will create:
 130 </p>
 131 <ul>
 132 <li>build/windows-x86-debug/mesa/drivers/windows/gdi/opengl32.dll &mdash; Mesa + swrast, binary compatible with Windows's opengl32.dll
 133 <li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe, binary compatible with Windows's opengl32.dll
 134 </ul>
 135 <p>
 136 Put them all in the same directory to test them.
 137 </p>
 138
 139
 140
 141 <h1 id="other">4. Building for other systems</h1>
 142
 143 <p>
 144 Documentation for other environments (some may be very out of date):
 145 </p>
 146
 147 <ul>
 148 <li><a href="README.VMS">README.VMS</a> - VMS
 149 <li><a href="README.CYGWIN">README.CYGWIN</a> - Cygwin
 150 <li><a href="README.WIN32">README.WIN32</a> - Win32
 151 </ul>
 152
 153
 154
 155 <h1 id="libs">5. Library Information</h1>
 156
 157 <p>
 158 When compilation has finished, look in the top-level <code>lib/</code>
 159 (or <code>lib64/</code>) directory.
 160 You'll see a set of library files similar to this:
 161 </p>
 162 <pre>
 163 lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -> libGL.so.1*
 164 lrwxrwxrwx    1 brian    users          19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
 165 -rwxr-xr-x    1 brian    users     3375861 Mar 26 07:53 libGL.so.1.5.060100*
 166 lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
 167 lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
 168 -rwxr-xr-x    1 brian    users       23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
 169 </pre>
 170
 171 <p>
 172 <b>libGL</b> is the main OpenGL library (i.e. Mesa).
 173 <br>
 174 <b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
 175 </p>
 176
 177 <p>
 178 If you built the DRI hardware drivers, you'll also see the DRI drivers:
 179 </p>
 180 <pre>
 181 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i915_dri.so
 182 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i965_dri.so
 183 -rwxr-xr-x   1 brian users 11849858 Jul 21 12:12 r200_dri.so
 184 -rwxr-xr-x   1 brian users 11757388 Jul 21 12:12 radeon_dri.so
 185 </pre>
 186
 187 <p>
 188 If you built with Gallium support, look in lib/gallium/ for Gallium-based
 189 versions of libGL and device drivers.
 190 </p>
 191
 192
 193 <h1 id="pkg-config">6. Building OpenGL programs with pkg-config</h1>
 194
 195 <p>
 196 Running <code>make install</code> will install package configuration files
 197 for the pkg-config utility.
 198 </p>
 199
 200 <p>
 201 When compiling your OpenGL application you can use pkg-config to determine
 202 the proper compiler and linker flags.
 203 </p>
 204
 205 <p>
 206 For example, compiling and linking a GLUT application can be done with:
 207 </p>
 208 <pre>
 209    gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
 210 </pre>
 211
 212 <br>
 213
 214 </div>
 215 </body>
 216 </html>