docs/install.html

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