docs/autoconf.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html lang="en">
   3 <head>
   4   <meta http-equiv="content-type" content="text/html; charset=utf-8">
   5   <title>Compilation and Installation using Autoconf</title>
   6   <link rel="stylesheet" type="text/css" href="mesa.css">
   7 </head>
   8 <body>
   9
  10 <div class="header">
  11   <h1>The Mesa 3D Graphics Library</h1>
  12 </div>
  13
  14 <iframe src="contents.html"></iframe>
  15 <div class="content">
  16
  17 <h1>Compilation and Installation using Autoconf</h1>
  18
  19 <ol>
  20 <li><p><a href="#basic">Basic Usage</a></li>
  21 <li><p><a href="#driver">Driver Options</a>
  22   <ul>
  23   <li><a href="#xlib">Xlib Driver Options</a></li>
  24   <li><a href="#dri">DRI Driver Options</a></li>
  25   <li><a href="#osmesa">OSMesa Driver Options</a></li>
  26   </ul>
  27 </ol>
  28
  29
  30 <h2 id="basic">1. Basic Usage</h2>
  31
  32 <p>
  33 The autoconf generated configure script can be used to guess your
  34 platform and change various options for building Mesa. To use the
  35 configure script, type:
  36 </p>
  37
  38 <pre>
  39     ./configure
  40 </pre>
  41
  42 <p>
  43 To see a short description of all the options, type <code>./configure
  44 --help</code>. If you are using a development snapshot and the configure
  45 script does not exist, type <code>./autogen.sh</code> to generate it
  46 first. If you know the options you want to pass to
  47 <code>configure</code>, you can pass them to <code>autogen.sh</code>. It
  48 will run <code>configure</code> with these options after it is
  49 generated. Once you have run <code>configure</code> and set the options
  50 to your preference, type:
  51 </p>
  52
  53 <pre>
  54     make
  55 </pre>
  56
  57 <p>
  58 This will produce libGL.so and several other libraries depending on the
  59 options you have chosen. Later, if you want to rebuild for a different
  60 configuration run <code>make realclean</code> before rebuilding.
  61 </p>
  62
  63 <p>
  64 Some of the generic autoconf options are used with Mesa:
  65 </p>
  66 <dl>
  67 <dt><code>--prefix=PREFIX</code></dt>
  68 <dd><p>This is the root directory where
  69 files will be installed by <code>make install</code>. The default is
  70 <code>/usr/local</code>.</p>
  71 </dd>
  72
  73 <dt><code>--exec-prefix=EPREFIX</code></dt>
  74 <dd><p>This is the root directory
  75 where architecture-dependent files will be installed. In Mesa, this is
  76 only used to derive the directory for the libraries. The default is
  77 <code>${prefix}</code>.</p>
  78 </dd>
  79
  80 <dt><code>--libdir=LIBDIR</code></dt>
  81 <dd><p>This option specifies the directory
  82 where the GL libraries will be installed. The default is
  83 <code>${exec_prefix}/lib</code>. It also serves as the name of the
  84 library staging area in the source tree. For instance, if the option
  85 <code>--libdir=/usr/local/lib64</code> is used, the libraries will be
  86 created in a <code>lib64</code> directory at the top of the Mesa source
  87 tree.</p>
  88 </dd>
  89
  90 <dt><code>--enable-static, --disable-shared</code></dt>
  91 <dd><p>By default, Mesa
  92 will build shared libraries. Either of these options will force static
  93 libraries to be built. It is not currently possible to build static and
  94 shared libraries in a single pass.</p>
  95 </dd>
  96
  97 <dt><code>CC, CFLAGS, CXX, CXXFLAGS</code></dt>
  98 <dd><p>These environment variables
  99 control the C and C++ compilers used during the build. By default,
 100 <code>gcc</code> and <code>g++</code> are used with the options
 101 <code>"-g -O2"</code>.</p>
 102 </dd>
 103
 104 <dt><code>LDFLAGS</code></dt>
 105 <dd><p>An environment variable specifying flags to
 106 pass when linking programs. These are normally empty, but can be used
 107 to direct the linker to use libraries in nonstandard directories. For
 108 example, <code>LDFLAGS="-L/usr/X11R6/lib"</code>.</p>
 109 </dd>
 110
 111 <dt><code>PKG_CONFIG_PATH</code></dt>
 112 <dd><p>When available, the
 113 <code>pkg-config</code> utility is used to search for external libraries
 114 on the system. This environment variable is used to control the search
 115 path for <code>pkg-config</code>. For instance, setting
 116 <code>PKG_CONFIG_PATH=/usr/X11R6/lib/pkgconfig</code> will search for
 117 package metadata in <code>/usr/X11R6</code> before the standard
 118 directories.</p>
 119 </dd>
 120 </dl>
 121
 122 <p>
 123 There are also a few general options for altering the Mesa build:
 124 </p>
 125 <dl>
 126 <dt><code>--enable-debug</code></dt>
 127 <dd><p>This option will enable compiler
 128 options and macros to aid in debugging the Mesa libraries.</p>
 129 </dd>
 130
 131 <dt><code>--disable-asm</code></dt>
 132 <dd><p>There are assembly routines
 133 available for a few architectures. These will be used by default if
 134 one of these architectures is detected. This option ensures that
 135 assembly will not be used.</p>
 136 </dd>
 137
 138 <dt><code>--enable-32-bit</code></dt>
 139 <dt><code>--enable-64-bit</code></dt>
 140 <dd><p>By default, the build will compile code as directed by the environment
 141 variables
 142 <code>CC</code>, <code>CFLAGS</code>, etc. If the compiler is
 143 <code>gcc</code>, these options offer a helper to add the compiler flags
 144 to force 32- or 64-bit code generation as used on the x86 and x86_64
 145 architectures. Note that these options are mutually exclusive.</p>
 146 </dd>
 147 </dl>
 148
 149
 150 <h2 id="driver">2. Driver Options</h2>
 151
 152 <p>
 153 There are several different driver modes that Mesa can use. These are
 154 described in more detail in the <a href="install.html">basic
 155 installation instructions</a>. The Mesa driver is controlled through the
 156 configure options <code>--enable-xlib-glx</code>, <code>--enable-osmesa</code>,
 157 and <code>--enable-dri</code>.
 158 </p>
 159
 160 <h3 id="xlib">Xlib</h3><p>
 161 It uses Xlib as a software renderer to do all rendering. It corresponds
 162 to the option <code>--enable-xlib-glx</code>. The libX11 and libXext
 163 libraries, as well as the X11 development headers, will be need to
 164 support the Xlib driver.
 165
 166 <h3 id="dri">DRI</h3><p>This mode uses the DRI hardware drivers for
 167 accelerated OpenGL rendering. Enable the DRI drivers with the option
 168 <code>--enable-dri</code>. See the <a href="install.html">basic
 169 installation instructions</a> for details on prerequisites for the DRI
 170 drivers.
 171
 172 <!-- DRI specific options -->
 173 <dl>
 174 <dt><code>--with-dri-driverdir=DIR</code>
 175 <dd><p> This option specifies the
 176 location the DRI drivers will be installed to and the location libGL
 177 will search for DRI drivers. The default is <code>${libdir}/dri</code>.
 178 <dt><code>--with-dri-drivers=DRIVER,DRIVER,...</code>
 179 <dd><p> This option
 180 allows a specific set of DRI drivers to be built. For example,
 181 <code>--with-dri-drivers="swrast,i965,radeon,nouveau"</code>. By
 182 default, the drivers will be chosen depending on the target platform.
 183 See the directory <code>src/mesa/drivers/dri</code> in the source tree
 184 for available drivers. Beware that the swrast DRI driver is used by both
 185 libGL and the X.Org xserver GLX module to do software rendering, so you
 186 may run into problems if it is not available.
 187 <!-- This explanation might be totally bogus. Kristian? -->
 188 <dt><code>--disable-driglx-direct</code>
 189 <dd><p> Disable direct rendering in
 190 GLX. Normally, direct hardware rendering through the DRI drivers and
 191 indirect software rendering are enabled in GLX. This option disables
 192 direct rendering entirely. It can be useful on architectures where
 193 kernel DRM modules are not available.
 194 <dt><code>--enable-glx-tls</code> <dd><p>
 195 Enable Thread Local Storage (TLS) in
 196 GLX.
 197 <dt><code>--with-expat=DIR</code> <dd> The DRI-enabled libGL uses expat to
 198 parse the DRI configuration files in <code>/etc/drirc</code> and
 199 <code>~/.drirc</code>. This option allows a specific expat installation
 200 to be used. For example, <code>--with-expat=/usr/local</code> will
 201 search for expat headers and libraries in <code>/usr/local/include</code>
 202 and <code>/usr/local/lib</code>, respectively.
 203 </dl>
 204
 205 <h3 id="osmesa">OSMesa </h3><p> No libGL is built in this
 206 mode. Instead, the driver code is built into the Off-Screen Mesa
 207 (OSMesa) library. See the <a href="osmesa.html">Off-Screen Rendering</a>
 208 page for more details.  It corresponds to the option
 209 <code>--enable-osmesa</code>.
 210
 211 <!-- OSMesa specific options -->
 212 <dl>
 213 <dt><code>--with-osmesa-bits=BITS</code>
 214 <dd><p> This option allows the size
 215 of the color channel in bits to be specified. By default, an 8-bit
 216 channel will be used, and the driver will be named libOSMesa. Other
 217 options are 16- and 32-bit color channels, which will add the bit size
 218 to the library name. For example, <code>--with-osmesa-bits=16</code>
 219 will create the libOSMesa16 library with a 16-bit color channel.
 220 </dl>
 221
 222
 223 <h2 id="library">3. Library Options</h2>
 224
 225 <p>
 226 The configure script provides more fine grained control over the GL
 227 libraries that will be built. More details on the specific GL libraries
 228 can be found in the <a href="install.html">basic installation
 229 instructions</a>.
 230
 231 </div>
 232 </body>
 233 </html>