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/or 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>--sysconfdir=DIR</code></dt>
  91 <dd><p>This option specifies the directory where the configuration
  92 files will be installed. The default is <code>${prefix}/etc</code>.
  93 Currently there's only one config file provided when dri drivers are
  94 enabled - it's <code>drirc</code>.</p>
  95 </dd>
  96
  97 <dt><code>--datadir=DIR</code></dt>
  98 <dd><p>This option specifies the directory where the data files will
  99 be installed. The default is <code>${prefix}/share</code>.
 100 Currently when dri drivers are enabled, <code>drirc.d/</code> is at
 101 this place.</p>
 102 </dd>
 103
 104 <dt><code>--enable-static, --disable-shared</code></dt>
 105 <dd><p>By default, Mesa
 106 will build shared libraries. Either of these options will force static
 107 libraries to be built. It is not currently possible to build static and
 108 shared libraries in a single pass.</p>
 109 </dd>
 110
 111 <dt><code>CC, CFLAGS, CXX, CXXFLAGS</code></dt>
 112 <dd><p>These environment variables
 113 control the C and C++ compilers used during the build. By default,
 114 <code>gcc</code> and <code>g++</code> are used and the debug/optimisation
 115 level is left unchanged.</p>
 116 </dd>
 117
 118 <dt><code>LDFLAGS</code></dt>
 119 <dd><p>An environment variable specifying flags to
 120 pass when linking programs. These should be empty and
 121 <code>PKG_CONFIG_PATH</code> is recommended to be used instead. If needed
 122 it can be used to direct the linker to use libraries in nonstandard
 123 directories. For example, <code>LDFLAGS="-L/usr/X11R6/lib"</code>.</p>
 124 </dd>
 125
 126 <dt><code>PKG_CONFIG_PATH</code></dt>
 127 <dd><p>The
 128 <code>pkg-config</code> utility is a hard requirement for configuring and
 129 building mesa. It is used to search for external libraries
 130 on the system. This environment variable is used to control the search
 131 path for <code>pkg-config</code>. For instance, setting
 132 <code>PKG_CONFIG_PATH=/usr/X11R6/lib/pkgconfig</code> will search for
 133 package metadata in <code>/usr/X11R6</code> before the standard
 134 directories.</p>
 135 </dd>
 136 </dl>
 137
 138 <p>
 139 There are also a few general options for altering the Mesa build:
 140 </p>
 141 <dl>
 142 <dt><code>--enable-debug</code></dt>
 143 <dd><p>This option will set the compiler debug/optimisation levels (if the user
 144 hasn't already set them via the CFLAGS/CXXFLAGS) and macros to aid in
 145 debugging the Mesa libraries.</p>
 146
 147 <p>Note that enabling this option can lead to noticeable loss of performance.</p>
 148
 149 <dt><code>--disable-asm</code></dt>
 150 <dd><p>There are assembly routines
 151 available for a few architectures. These will be used by default if
 152 one of these architectures is detected. This option ensures that
 153 assembly will not be used.</p>
 154 </dd>
 155
 156 <dt><code>--build=</code></dt>
 157 <dt><code>--host=</code></dt>
 158 <dd><p>By default, the build will compile code for the architecture that
 159 it's running on. In order to build cross-compile Mesa on a x86-64 machine
 160 that is to run on a i686, one would need to set the options to:</p>
 161
 162 <p><code>--build=x86_64-pc-linux-gnu --host=i686-pc-linux-gnu</code></p>
 163
 164 Note that these can vary from distribution to distribution. For more
 165 information check with the
 166 <a href="https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Specifying-Target-Triplets.html">
 167 autoconf manual</a>.
 168 Note that you will need to correctly set <code>PKG_CONFIG_PATH</code> as well.
 169
 170
 171 <p>In some cases a single compiler is capable of handling both architectures
 172 (multilib) in that case one would need to set the <code>CC,CXX</code> variables
 173 appending the correct machine options. Seek your compiler documentation for
 174 further information -
 175 <a href="https://gcc.gnu.org/onlinedocs/gcc/Submodel-Options.html"> gcc
 176 machine dependent options</a></p>
 177
 178 <p>In addition to specifying correct <code>PKG_CONFIG_PATH</code> for the target
 179 architecture, the following should be sufficient to configure multilib Mesa</p>
 180
 181 <code>./configure CC="gcc -m32" CXX="g++ -m32" --build=x86_64-pc-linux-gnu --host=i686-pc-linux-gnu ...</code>
 182 </dd>
 183 </dl>
 184
 185
 186 <h2 id="driver">2. GL Driver Options</h2>
 187
 188 <p>
 189 There are several different driver modes that Mesa can use. These are
 190 described in more detail in the <a href="install.html">basic
 191 installation instructions</a>. The Mesa driver is controlled through the
 192 configure options <code>--enable-glx</code> and <code>--enable-osmesa</code>
 193 </p>
 194
 195 <h3 id="xlib">Xlib</h3><p>
 196 It uses Xlib as a software renderer to do all rendering. It corresponds
 197 to the option <code>--enable-glx=xlib</code> or <code>--enable-glx=gallium-xlib</code>.
 198
 199 <h3 id="dri">DRI</h3><p>This mode uses the DRI hardware drivers for
 200 accelerated OpenGL rendering. To enable use <code>--enable-glx=dri
 201 --enable-dri</code>.
 202
 203 <!-- DRI specific options -->
 204 <dl>
 205 <dt><code>--with-dri-driverdir=DIR</code>
 206 <dd><p> This option specifies the
 207 location the DRI drivers will be installed to and the location libGL
 208 will search for DRI drivers. The default is <code>${libdir}/dri</code>.
 209 <dt><code>--with-dri-drivers=DRIVER,DRIVER,...</code>
 210 <dd><p> This option
 211 allows a specific set of DRI drivers to be built. For example,
 212 <code>--with-dri-drivers="swrast,i965,radeon,nouveau"</code>. By
 213 default, the drivers will be chosen depending on the target platform.
 214 See the directory <code>src/mesa/drivers/dri</code> in the source tree
 215 for available drivers. Beware that the swrast DRI driver is used by both
 216 libGL and the X.Org xserver GLX module to do software rendering, so you
 217 may run into problems if it is not available.
 218 <!-- This explanation might be totally bogus. Kristian? -->
 219 <dt><code>--disable-driglx-direct</code>
 220 <dd><p> Disable direct rendering in
 221 GLX. Normally, direct hardware rendering through the DRI drivers and
 222 indirect software rendering are enabled in GLX. This option disables
 223 direct rendering entirely. It can be useful on architectures where
 224 kernel DRM modules are not available.
 225 <dt><code>--enable-glx-tls</code> <dd><p>
 226 Enable Thread Local Storage (TLS) in
 227 GLX.
 228 <dt><code>--with-expat=DIR</code>
 229 <dd><p><strong>DEPRECATED</strong>, use <code>PKG_CONFIG_PATH</code> instead.</p>
 230 <p>The DRI-enabled libGL uses expat to
 231 parse the DRI configuration files in <code>${sysconfdir}/drirc</code> and
 232 <code>~/.drirc</code>. This option allows a specific expat installation
 233 to be used. For example, <code>--with-expat=/usr/local</code> will
 234 search for expat headers and libraries in <code>/usr/local/include</code>
 235 and <code>/usr/local/lib</code>, respectively.
 236 </dl>
 237
 238 <h3 id="osmesa">OSMesa </h3><p> No libGL is built in this
 239 mode. Instead, the driver code is built into the Off-Screen Mesa
 240 (OSMesa) library. See the <a href="osmesa.html">Off-Screen Rendering</a>
 241 page for more details.  It corresponds to the option
 242 <code>--enable-osmesa</code>.
 243
 244 <!-- OSMesa specific options -->
 245 <dl>
 246 <dt><code>--with-osmesa-bits=BITS</code>
 247 <dd><p> This option allows the size
 248 of the color channel in bits to be specified. By default, an 8-bit
 249 channel will be used, and the driver will be named libOSMesa. Other
 250 options are 16- and 32-bit color channels, which will add the bit size
 251 to the library name. For example, <code>--with-osmesa-bits=16</code>
 252 will create the libOSMesa16 library with a 16-bit color channel.
 253 </dl>
 254
 255
 256 <h2 id="library">3. Library Options</h2>
 257
 258 <p>
 259 The configure script provides more fine grained control over the libraries
 260 that will be built.
 261
 262 </div>
 263 </body>
 264 </html>