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