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