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 DRM kernel modules and header files from the
  61 <a href="http://dri.sf.net/" target="_parent">DRI</a> project.
  62 </p>
  63
  64 <p>
  65 If you don't already have the DRM file, you can get the sources from
  66 CVS by doing:
  67 <pre>
  68 cvs -z3 -d:pserver:anonymous@anoncvs.freedesktop.org:/cvs/dri co drm
  69 </pre>
  70 <p>
  71 See the <a href="http://dri.freedesktop.org/wiki/Building" target="_parent">
  72 DRI Building Instructions</a> for the steps to build the DRM modules.  Mesa
  73 6.5 requires at least libdrm 2.0.1 or greater.
  74 </p>
  75 <p>
  76 You can verify that the DRM files have been properly installed by
  77 running <code>pkg-config --modversion libdrm</code>
  78
  79 </li>
  80
  81 <li>
  82 Recent /usr/include/GL/glxproto.h file.
  83 <p>You'll need this if you get any errors about _GLXvop_BindTexImageEXT
  84 being undefined.
  85 </p>
  86 <p>The latest version can be
  87 obtained from <A href="http://webcvs.freedesktop.org/*checkout*/xorg/proto/GL/glxproto.h?rev=1.9&content-type=text%2Fplain">freedesktop.org CVS</a>
  88 </p>
  89 </li>
  90
  91 <li>DRI-enabled X server.
  92 <p>Visit
  93 <a href="http://www.xfree86.org" target="_parent">XFree86</a>
  94 or
  95 <a href="http://freedesktop.org/wiki/Software_2fXserver" target="_parent">
  96 X.org</a>
  97 for more information.
  98 </p>
  99 </li>
 100
 101 </ol>
 102
 103
 104 <p>
 105 Build Mesa and the DRI hardware drivers by running
 106 </p>
 107 <pre>
 108    make linux-dri
 109 </pre>
 110 <p>
 111 There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>,
 112 and <code>linux-ppc</code> configurations which are optimized for those
 113 architectures.
 114 </p>
 115
 116 </li>
 117 </ul>
 118
 119
 120 <p>
 121 Later, if you want to rebuild for a different configuration run
 122 <code>make realclean</code> before rebuilding.
 123 </p>
 124
 125
 126 <h3>1.2 The libraries</h3>
 127
 128 <p>
 129 When compilation has finished, look in the top-level <code>lib/</code>
 130 (or <code>lib64/</code>) directory.
 131 You'll see a set of library files similar to this:
 132 </p>
 133 <pre>
 134 lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -> libGL.so.1*
 135 lrwxrwxrwx    1 brian    users          19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
 136 -rwxr-xr-x    1 brian    users     3375861 Mar 26 07:53 libGL.so.1.5.060100*
 137 lrwxrwxrwx    1 brian    users          11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
 138 lrwxrwxrwx    1 brian    users          20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100*
 139 -rwxr-xr-x    1 brian    users      549269 Mar 26 07:53 libGLU.so.1.3.060100*
 140 lrwxrwxrwx    1 brian    users          12 Mar 26 07:53 libglut.so -> libglut.so.3*
 141 lrwxrwxrwx    1 brian    users          16 Mar 26 07:53 libglut.so.3 -> libglut.so.3.7.1*
 142 -rwxr-xr-x    1 brian    users      597754 Mar 26 07:53 libglut.so.3.7.1*
 143 lrwxrwxrwx    1 brian    users          11 Mar 26 08:04 libGLw.so -> libGLw.so.1*
 144 lrwxrwxrwx    1 brian    users          15 Mar 26 08:04 libGLw.so.1 -> libGLw.so.1.0.0*
 145 -rwxr-xr-x    1 brian    users       20750 Mar 26 08:04 libGLw.so.1.0.0*
 146 lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
 147 lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
 148 -rwxr-xr-x    1 brian    users       23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
 149 </pre>
 150
 151 <p>
 152 <b>libGL</b> is the main OpenGL library (i.e. Mesa).
 153 <br>
 154 <b>libGLU</b> is the OpenGL Utility library.
 155 <br>
 156 <b>libglut</b> is the GLUT library.
 157 <br>
 158 <b>libGLw</b> is the Xt/Motif OpenGL drawing area widget library.
 159 <br>
 160 <b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
 161 </p>
 162
 163 <p>
 164 If you built the DRI hardware drivers, you'll also see the DRI drivers:
 165 </p>
 166 <pre>
 167 -rwxr-xr-x   1 brian users 15607851 Jul 21 12:11 ffb_dri.so*
 168 -rwxr-xr-x   1 brian users 15148747 Jul 21 12:11 i810_dri.so*
 169 -rwxr-xr-x   1 brian users 14497814 Jul 21 12:11 i830_dri.so*
 170 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i915_dri.so*
 171 -rwxr-xr-x   1 brian users 11320803 Jul 21 12:11 mach64_dri.so
 172 -rwxr-xr-x   1 brian users 11418014 Jul 21 12:12 mga_dri.so
 173 -rwxr-xr-x   1 brian users 11064426 Jul 21 12:12 r128_dri.so
 174 -rwxr-xr-x   1 brian users 11849858 Jul 21 12:12 r200_dri.so
 175 -rwxr-xr-x   1 brian users 16050488 Jul 21 12:11 r300_dri.so*
 176 -rwxr-xr-x   1 brian users 11757388 Jul 21 12:12 radeon_dri.so
 177 -rwxr-xr-x   1 brian users 11232304 Jul 21 12:13 s3v_dri.so
 178 -rwxr-xr-x   1 brian users 11062970 Jul 21 12:13 savage_dri.so
 179 -rwxr-xr-x   1 brian users 11214212 Jul 21 12:13 sis_dri.so
 180 -rwxr-xr-x   1 brian users 11368736 Jul 21 12:13 tdfx_dri.so
 181 -rwxr-xr-x   1 brian users 10598868 Jul 21 12:13 trident_dri.so
 182 -rwxr-xr-x   1 brian users 10997120 Jul 21 12:13 unichrome_dri.so
 183 </pre>
 184
 185
 186 <h3>1.3 Running the demos</h3>
 187
 188 <p>
 189 If you downloaded/unpacked the MesaDemos-x.y.z.tar.gz archive or
 190 obtained Mesa from CVS, the <b>progs/</b> directory will contain a
 191 bunch of demonstration programs.
 192 </p>
 193
 194 <p>
 195 Before running a demo, you may have to set an environment variable
 196 (such as <b>LD_LIBRARY_PATH</b> on Linux) to indicate where the
 197 libraries are located.  For example:
 198 <p>
 199 <blockquote>
 200 <b>cd</b> into the Mesa <b>lib/</b> directory.
 201 <br>
 202 <b>setenv LD_LIBRARY_PATH ${cwd}</b>   (if using csh or tcsh shell)
 203 <br>
 204 or,
 205 <br>
 206 <b>export LD_LIBRARY_PATH=${PWD}</b>   (if using bash or sh shell)
 207 </blockquote>
 208
 209 <p>
 210 Next, change to the Mesa/demos/ directory:
 211 </p>
 212 <blockquote>
 213 <b>cd ../progs/demos</b>
 214 </blockquote>
 215
 216 <p>
 217 Run a demo such as gears:
 218 </p>
 219 <blockquote>
 220 <b>./gears</b>
 221 </blockquote>
 222
 223 <p>
 224 If this doesn't work, try the <b>Mesa/progs/xdemos/glxinfo</b> program
 225 and see that it prints the expected Mesa version number.
 226 </p>
 227
 228 <p>
 229 If you're using Linux or a similar OS, verify that the demo program is
 230 being linked with the proper library files:
 231 </p>
 232 <blockquote>
 233 <b>ldd gears</b>
 234 </blockquote>
 235
 236 <p>
 237 You should see something like this:
 238 </p>
 239 <pre>
 240         libglut.so.3 => /home/brian/Mesa/lib/libglut.so.3 (0x40013000)
 241         libGLU.so.1 => /home/brian/Mesa/lib/libGLU.so.1 (0x40051000)
 242         libGL.so.1 => /home/brian/Mesa/lib/libGL.so.1 (0x400e0000)
 243         libc.so.6 => /lib/i686/libc.so.6 (0x42000000)
 244         libm.so.6 => /lib/i686/libm.so.6 (0x403da000)
 245         libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x403fc000)
 246         libXmu.so.6 => /usr/X11R6/lib/libXmu.so.6 (0x404da000)
 247         libXt.so.6 => /usr/X11R6/lib/libXt.so.6 (0x404f1000)
 248         libXi.so.6 => /usr/X11R6/lib/libXi.so.6 (0x40543000)
 249         libstdc++.so.5 => /usr/lib/libstdc++.so.5 (0x4054b000)
 250         libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x405fd000)
 251         libXext.so.6 => /usr/X11R6/lib/libXext.so.6 (0x40605000)
 252         libpthread.so.0 => /lib/i686/libpthread.so.0 (0x40613000)
 253         /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)
 254         libdl.so.2 => /lib/libdl.so.2 (0x40644000)
 255         libSM.so.6 => /usr/X11R6/lib/libSM.so.6 (0x40647000)
 256         libICE.so.6 => /usr/X11R6/lib/libICE.so.6 (0x40650000)
 257 </pre>
 258
 259 <p>
 260 Retrace your steps if this doesn't look right.
 261 </p>
 262
 263
 264 <H3>1.4 Installing the header and library files</H3>
 265
 266 <p>
 267 The standard location for the OpenGL header files on Unix-type systems is
 268 in <code>/usr/include/GL/</code>.
 269 The standard location for the libraries is <code>/usr/lib/</code>.
 270 For more information see, the
 271 <a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent">
 272 Linux/OpenGL ABI specification</a>.
 273 </p>
 274
 275 <p>
 276 If you'd like Mesa to co-exist with another implementation of OpenGL that's
 277 already installed, you'll have to choose different directories, like
 278 <code>/usr/local/include/GL/</code> and <code>/usr/local/lib/</code>.
 279 </p>
 280
 281 <p>
 282 To install Mesa's headers and libraries, run <code>make install</code>.
 283 But first, check the Mesa/configs/default file and examine the values
 284 of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
 285 Change them if needed, then run <code>make install</code>
 286 </p>
 287
 288 <p>
 289 Note: at runtime you can use the LD_LIBRARY_PATH environment variable
 290 (on Linux at least) to switch
 291 between the Mesa libraries and other vendor's libraries whenever you want.
 292 This is a handy way to compare multiple OpenGL implementations.
 293 </p>
 294
 295
 296
 297 <a name="windows">
 298 <H2>2. Windows Compilation and Installation</H1>
 299
 300 <p>
 301 Please see the <a href="README.WIN32">README.WIN32</a> file.
 302 </p>
 303
 304
 305
 306
 307 <a name="vms">
 308 <H2>3. VMS Compilation and Installation</H1>
 309
 310 <p>
 311 Please see the <a href="README.VMS">README.VMS</a> file.
 312 </p>
 313
 314
 315
 316
 317 <a name="other">
 318 <H2>4. Other systems</H1>
 319
 320 <p>
 321 Documentation for other environments (some may be very out of date):
 322 </p>
 323
 324 <UL>
 325 <LI><A HREF="README.GGI">README.GGI</A> - GGI
 326 <LI><A HREF="README.3DFX">README.3DFX</A> - 3Dfx/Glide driver
 327 <LI><A HREF="README.AMIWIN">README.AMIWIN</A> - Amiga Amiwin
 328 <LI><A HREF="README.BEOS">README.BEOS</A> - BeOS
 329 <LI><A HREF="README.D3D">README.D3D</A> - Direct3D driver
 330 <LI><A HREF="README.DJ">README.DJ</A> - DJGPP
 331 <LI><A HREF="README.LYNXOS">README.LYNXOS</A> - LynxOS
 332 <LI><A HREF="README.MINGW32">README.MINGW32</A> - Mingw32
 333 <LI><A HREF="README.NeXT">README.NeXT</A> - NeXT
 334 <LI><A HREF="README.OpenStep">README.OpenStep</A> - OpenStep
 335 <LI><A HREF="README.OS2">README.OS2</A> - OS/2
 336 <LI><A HREF="README.WINDML">README.WINDML</A> - WindML
 337 </UL>
 338
 339
 340
 341
 342 </body>
 343 </html>