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">Prerequisites for DRI and hardware acceleration</a>
  16   <li><a href="#autoconf">Building with autoconf</a>
  17   <li><a href="#traditional">Building with traditional Makefiles</a>
  18   <li><a href="#libs">The Libraries</a>
  19   <li><a href="#demos">Running the demos
  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">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">
  35 <h3>1.1 Prerequisites for DRI and hardware acceleration</h3>
  36
  37 <p>
  38 The following are required for DRI-based hardware acceleration with Mesa:
  39 </p>
  40
  41 <ul>
  42 <li><a href="http://xorg.freedesktop.org/releases/individual/proto/">dri2proto</a> version 1.99.3 or later
  43 <li>Linux 2.6.28
  44 <li><a href="http://dri.freedesktop.org/libdrm/" target="_parent">libDRM</a>
  45 version 2.4.15 or later
  46 <li>Xorg server version 1.5 or later
  47 </ul>
  48 </p>
  49
  50
  51 <a name="autoconf">
  52 <h3>1.2 Building with Autoconf</h3>
  53
  54 <p>
  55 Mesa may be <a href="autoconf.html">built using autoconf</a>.
  56 This should work well on most GNU-based systems.
  57 If that fails the traditional Mesa build system is available.
  58
  59
  60
  61 <a name="traditional">
  62 <h3>1.3 Building with traditional Makefiles</h3>
  63
  64 <p>
  65 The traditional Mesa build system is based on a collection of pre-defined
  66 system configurations.
  67 </p>
  68 <p>
  69 To see the list of configurations, just type <code>make</code>.
  70 Then choose a configuration from the list and type <code>make</code>
  71 <em>configname</em>.
  72 </p>
  73
  74 <p>
  75 Mesa may be built in several different ways using the predefined configurations:
  76 </p>
  77 <ul>
  78 <li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as
  79 a software renderer using Xlib to do all rendering.
  80 The libGL.so library will be a self-contained rendering library that will
  81 allow you to run OpenGL/GLX applications on any X server (regardless of
  82 whether it supports the GLX X server extension).
  83 You will <em>not</em> be able to use hardware 3D acceleration.
  84 <p>
  85 To compile stand-alone Mesa type <code>make</code> in the top-level directory.
  86 You'll see a list of supported system configurations.
  87 Choose one from the list (such as linux-x86), and type:
  88 </p>
  89 <pre>
  90     make linux-x86
  91 </pre>
  92 <p>This will produce libGL.so and several other libraries</p>
  93 </li>
  94
  95 <li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers for
  96 accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built.
  97 The libGL.so library will support the GLX extension and will load/use
  98 the DRI hardware drivers.
  99
 100
 101 <p>
 102 Build Mesa and the DRI hardware drivers by running
 103 </p>
 104 <pre>
 105    make linux-dri
 106 </pre>
 107 <p>
 108 There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>,
 109 and <code>linux-ppc</code> configurations which are optimized for those
 110 architectures.
 111 </p>
 112 <p>
 113 Make sure you have the prerequisite versions of DRM and Xserver mentioned
 114 above.
 115 </p>
 116
 117 </li>
 118
 119 </ul>
 120
 121
 122 <p>
 123 Later, if you want to rebuild for a different configuration run
 124 <code>make realclean</code> before rebuilding.
 125 </p>
 126
 127
 128 <a name="libs">
 129 <h3>1.4 The libraries</h3>
 130
 131 <p>
 132 When compilation has finished, look in the top-level <code>lib/</code>
 133 (or <code>lib64/</code>) directory.
 134 You'll see a set of library files similar to this:
 135 </p>
 136 <pre>
 137 lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -> libGL.so.1*
 138 lrwxrwxrwx    1 brian    users          19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
 139 -rwxr-xr-x    1 brian    users     3375861 Mar 26 07:53 libGL.so.1.5.060100*
 140 lrwxrwxrwx    1 brian    users          11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
 141 lrwxrwxrwx    1 brian    users          20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100*
 142 -rwxr-xr-x    1 brian    users      549269 Mar 26 07:53 libGLU.so.1.3.060100*
 143 lrwxrwxrwx    1 brian    users          12 Mar 26 07:53 libglut.so -> libglut.so.3*
 144 lrwxrwxrwx    1 brian    users          16 Mar 26 07:53 libglut.so.3 -> libglut.so.3.7.1*
 145 -rwxr-xr-x    1 brian    users      597754 Mar 26 07:53 libglut.so.3.7.1*
 146 lrwxrwxrwx    1 brian    users          11 Mar 26 08:04 libGLw.so -> libGLw.so.1*
 147 lrwxrwxrwx    1 brian    users          15 Mar 26 08:04 libGLw.so.1 -> libGLw.so.1.0.0*
 148 -rwxr-xr-x    1 brian    users       20750 Mar 26 08:04 libGLw.so.1.0.0*
 149 lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
 150 lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
 151 -rwxr-xr-x    1 brian    users       23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
 152 </pre>
 153
 154 <p>
 155 <b>libGL</b> is the main OpenGL library (i.e. Mesa).
 156 <br>
 157 <b>libGLU</b> is the OpenGL Utility library.
 158 <br>
 159 <b>libglut</b> is the GLUT library.
 160 <br>
 161 <b>libGLw</b> is the Xt/Motif OpenGL drawing area widget library.
 162 <br>
 163 <b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
 164 </p>
 165
 166 <p>
 167 If you built the DRI hardware drivers, you'll also see the DRI drivers:
 168 </p>
 169 <pre>
 170 -rwxr-xr-x   1 brian users 15607851 Jul 21 12:11 ffb_dri.so
 171 -rwxr-xr-x   1 brian users 15148747 Jul 21 12:11 i810_dri.so
 172 -rwxr-xr-x   1 brian users 14497814 Jul 21 12:11 i830_dri.so
 173 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i915_dri.so
 174 -rwxr-xr-x   1 brian users 11320803 Jul 21 12:11 mach64_dri.so
 175 -rwxr-xr-x   1 brian users 11418014 Jul 21 12:12 mga_dri.so
 176 -rwxr-xr-x   1 brian users 11064426 Jul 21 12:12 r128_dri.so
 177 -rwxr-xr-x   1 brian users 11849858 Jul 21 12:12 r200_dri.so
 178 -rwxr-xr-x   1 brian users 16050488 Jul 21 12:11 r300_dri.so
 179 -rwxr-xr-x   1 brian users 11757388 Jul 21 12:12 radeon_dri.so
 180 -rwxr-xr-x   1 brian users 11232304 Jul 21 12:13 s3v_dri.so
 181 -rwxr-xr-x   1 brian users 11062970 Jul 21 12:13 savage_dri.so
 182 -rwxr-xr-x   1 brian users 11214212 Jul 21 12:13 sis_dri.so
 183 -rwxr-xr-x   1 brian users 11368736 Jul 21 12:13 tdfx_dri.so
 184 -rwxr-xr-x   1 brian users 10598868 Jul 21 12:13 trident_dri.so
 185 -rwxr-xr-x   1 brian users 10997120 Jul 21 12:13 unichrome_dri.so
 186 </pre>
 187
 188
 189 <a name="demos">
 190 <h3>1.5 Running the demos</h3>
 191
 192 <p>
 193 If you downloaded/unpacked the MesaDemos-x.y.z.tar.gz archive or
 194 obtained Mesa from CVS, the <b>progs/</b> directory will contain a
 195 bunch of demonstration programs.
 196 </p>
 197
 198 <p>
 199 Before running a demo, you'll probably have to set two environment variables
 200 to indicate where the libraries are located.  For example:
 201 <p>
 202 <blockquote>
 203 <b>cd lib/</b>
 204 <br>
 205 <b>export LD_LIBRARY_PATH=${PWD}</b>
 206 <br>
 207 <b>export LIBGL_DRIVERS_PATH=${PWD}</b> (if using DRI drivers)
 208 </blockquote>
 209
 210 <p>
 211 Next, change to the Mesa/demos/ directory:
 212 </p>
 213 <blockquote>
 214 <b>cd ../progs/demos</b>
 215 </blockquote>
 216
 217 <p>
 218 Run a demo such as gears:
 219 </p>
 220 <blockquote>
 221 <b>./gears</b>
 222 </blockquote>
 223
 224 <p>
 225 If this doesn't work, try the <b>Mesa/progs/xdemos/glxinfo</b> program
 226 and see that it prints the expected Mesa version number.
 227 </p>
 228
 229 <p>
 230 If you're using Linux or a similar OS, verify that the demo program is
 231 being linked with the proper library files:
 232 </p>
 233 <blockquote>
 234 <b>ldd gears</b>
 235 </blockquote>
 236
 237 <p>
 238 You should see something like this:
 239 </p>
 240 <pre>
 241         libglut.so.3 => /home/brian/Mesa/lib/libglut.so.3 (0x40013000)
 242         libGLU.so.1 => /home/brian/Mesa/lib/libGLU.so.1 (0x40051000)
 243         libGL.so.1 => /home/brian/Mesa/lib/libGL.so.1 (0x400e0000)
 244         libc.so.6 => /lib/i686/libc.so.6 (0x42000000)
 245         libm.so.6 => /lib/i686/libm.so.6 (0x403da000)
 246         libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x403fc000)
 247         libXmu.so.6 => /usr/X11R6/lib/libXmu.so.6 (0x404da000)
 248         libXt.so.6 => /usr/X11R6/lib/libXt.so.6 (0x404f1000)
 249         libXi.so.6 => /usr/X11R6/lib/libXi.so.6 (0x40543000)
 250         libstdc++.so.5 => /usr/lib/libstdc++.so.5 (0x4054b000)
 251         libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x405fd000)
 252         libXext.so.6 => /usr/X11R6/lib/libXext.so.6 (0x40605000)
 253         libpthread.so.0 => /lib/i686/libpthread.so.0 (0x40613000)
 254         /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)
 255         libdl.so.2 => /lib/libdl.so.2 (0x40644000)
 256         libSM.so.6 => /usr/X11R6/lib/libSM.so.6 (0x40647000)
 257         libICE.so.6 => /usr/X11R6/lib/libICE.so.6 (0x40650000)
 258 </pre>
 259
 260 <p>
 261 Retrace your steps if this doesn't look right.
 262 </p>
 263
 264
 265 <a name="install">
 266 <H3>1.6 Installing the header and library files</H3>
 267
 268 <p>
 269 The standard location for the OpenGL header files on Unix-type systems is
 270 in <code>/usr/include/GL/</code>.
 271 The standard location for the libraries is <code>/usr/lib/</code>.
 272 For more information see, the
 273 <a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent">
 274 Linux/OpenGL ABI specification</a>.
 275 </p>
 276
 277 <p>
 278 If you'd like Mesa to co-exist with another implementation of OpenGL that's
 279 already installed, you'll have to choose different directories, like
 280 <code>/usr/local/include/GL/</code> and <code>/usr/local/lib/</code>.
 281 </p>
 282
 283 <p>
 284 To install Mesa's headers and libraries, run <code>make install</code>.
 285 But first, check the Mesa/configs/default file and examine the values
 286 of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
 287 Change them if needed, then run <code>make install</code>.
 288 </p>
 289
 290 <p>
 291 The variable
 292 <b>DESTDIR</b> may also be used to install the contents to a temporary
 293 staging directory.
 294 This can be useful for package management.
 295 For example: <code>make install DESTDIR=/somepath/</code>
 296 </p>
 297
 298 <p>
 299 Note: at runtime you can use the LD_LIBRARY_PATH environment variable
 300 (on Linux at least) to switch
 301 between the Mesa libraries and other vendor's libraries whenever you want.
 302 This is a handy way to compare multiple OpenGL implementations.
 303 </p>
 304
 305
 306 <a name="pkg-config">
 307 <H3>1.7 Building OpenGL programs with pkg-config</H3>
 308
 309 <p>
 310 Running <code>make install</code> will install package configuration files
 311 for the pkg-config utility.
 312 </p>
 313
 314 <p>
 315 When compiling your OpenGL application you can use pkg-config to determine
 316 the proper compiler and linker flags.
 317 </p>
 318
 319 <p>
 320 For example, compiling and linking a GLUT application can be done with:
 321 </p>
 322 <pre>
 323    gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
 324 </pre>
 325
 326 <br>
 327
 328 <a name="windows">
 329 <H2>2. Windows Compilation and Installation</H1>
 330
 331 <p>
 332 Please see the <a href="#scons">instructions on building with SCons</a>.
 333 Alternatively see <a href="README.WIN32">README.WIN32</a> file.
 334 </p>
 335
 336
 337
 338 <a name="scons">
 339 <H2>3. Building with SCons</H1>
 340
 341 <p>
 342 To build Mesa with SCons on Linux or Windows do
 343 </p>
 344 <pre>
 345     scons
 346 </pre>
 347 <p>
 348 The build output will be placed in
 349 build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
 350 example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
 351 by -debug for debug builds.
 352 </p>
 353
 354 <p>
 355 To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
 356 </p>
 357 <pre>
 358     scons platform=windows toolchain=crossmingw machine=x86 statetrackers=mesa drivers=softpipe,trace winsys=gdi
 359 </pre>
 360 <p>
 361 This will create:
 362 </p>
 363 <ul>
 364 <li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe, binary compatible with Windows's opengl32.dll
 365 <li>build/windows-x86-debug/glut/glx/glut32.dll
 366 <li>progs/build/windows-x86-debug/wgl/wglinfo.exe
 367 <li>progs/build/windows-x86-debug/trivial/tri.exe
 368 <li>and many other samples in progs/build/windows-x86-debug/...
 369 </ul>
 370 <p>
 371 Put them all in the same directory to test them.
 372 </p>
 373
 374
 375 <a name="other">
 376 <H2>4. Other systems</H1>
 377
 378 <p>
 379 Documentation for other environments (some may be very out of date):
 380 </p>
 381
 382 <UL>
 383 <li><A HREF="README.VMS">README.VMS</A> - VMS
 384 <LI><A HREF="README.GGI">README.GGI</A> - GGI
 385 <LI><A HREF="README.3DFX">README.3DFX</A> - 3Dfx/Glide driver
 386 <LI><A HREF="README.AMIWIN">README.AMIWIN</A> - Amiga Amiwin
 387 <LI><A HREF="README.BEOS">README.BEOS</A> - BeOS
 388 <LI><A HREF="README.D3D">README.D3D</A> - Direct3D driver
 389 <LI><A HREF="README.DJ">README.DJ</A> - DJGPP
 390 <LI><A HREF="README.LYNXOS">README.LYNXOS</A> - LynxOS
 391 <LI><A HREF="README.MINGW32">README.MINGW32</A> - Mingw32
 392 <LI><A HREF="README.NeXT">README.NeXT</A> - NeXT
 393 <LI><A HREF="README.OpenStep">README.OpenStep</A> - OpenStep
 394 <LI><A HREF="README.OS2">README.OS2</A> - OS/2
 395 <LI><A HREF="README.WINDML">README.WINDML</A> - WindML
 396 </UL>
 397
 398
 399
 400
 401 </body>
 402 </html>