Annotation of htdocs/docs/pkgsrc/configuring.html, revision 1.25

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>Chapter 5. Configuring pkgsrc</title>
1.19      spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.11      rillig      8: <link rel="home" href="index.html" title="The pkgsrc guide">
1.1       dsieger     9: <link rel="up" href="users-guide.html" title="Part I. The pkgsrc user's guide">
                     10: <link rel="prev" href="using.html" title="Chapter 4. Using pkgsrc">
                     11: <link rel="next" href="binary.html" title="Chapter 6. Creating binary packages">
                     12: </head>
                     13: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
                     14: <div class="navheader">
                     15: <table width="100%" summary="Navigation header">
                     16: <tr><th colspan="3" align="center">Chapter 5. Configuring pkgsrc</th></tr>
                     17: <tr>
                     18: <td width="20%" align="left">
                     19: <a accesskey="p" href="using.html">Prev</a> </td>
                     20: <th width="60%" align="center">Part I. The pkgsrc user's guide</th>
                     21: <td width="20%" align="right"> <a accesskey="n" href="binary.html">Next</a>
                     22: </td>
                     23: </tr>
                     24: </table>
                     25: <hr>
                     26: </div>
1.21      asau       27: <div class="chapter">
1.1       dsieger    28: <div class="titlepage"><div><div><h2 class="title">
                     29: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                     30: <div class="toc">
                     31: <p><b>Table of Contents</b></p>
1.25    ! sevan      32: <dl>
1.1       dsieger    33: <dt><span class="sect1"><a href="configuring.html#general-configuration">5.1. General configuration</a></span></dt>
                     34: <dt><span class="sect1"><a href="configuring.html#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.6       rillig     35: <dt><span class="sect1"><a href="configuring.html#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.3       rillig     36: <dt><span class="sect1"><a href="configuring.html#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger    37: <dd><dl>
1.3       rillig     38: <dt><span class="sect2"><a href="configuring.html#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.17      wiz        39: <dt><span class="sect2"><a href="configuring.html#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                     40: <dt><span class="sect2"><a href="configuring.html#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger    41: </dl></dd>
1.3       rillig     42: <dt><span class="sect1"><a href="configuring.html#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                     43: <dt><span class="sect1"><a href="configuring.html#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger    44: </dl>
                     45: </div>
1.3       rillig     46: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger    47: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                     48: that file depends on the installation. On NetBSD, when you use
1.20      dholland   49: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1       dsieger    50: <code class="filename">/etc/</code>. In all other cases the default location is
                     51: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                     52: bootstrap program to install the binary packages.</p>
                     53: <p>During the bootstrap, an example configuration file is created. To
                     54: use that, you have to create the directory
                     55: <code class="filename">${PREFIX}/etc</code> and copy the example file
                     56: there.</p>
                     57: <p>The format of the configuration file is that of the usual
                     58: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                     59: is done by setting variables in this file. Note that you can define all
                     60: kinds of variables, and no special error checking (for example for
                     61: spelling mistakes) takes place, so you have to try it out to see if it
                     62: works.</p>
1.21      asau       63: <div class="sect1">
1.1       dsieger    64: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                     65: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                     66: <p>In this section, you can find some variables that apply to all
                     67:     pkgsrc packages. A complete list of the variables that can be
                     68:     configured by the user is available in
                     69:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                     70:     comments that describe each variable's intent.</p>
1.21      asau       71: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.17      wiz        72: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger    73:            packages will be installed. The default is
                     74:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                     75:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.17      wiz        76: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                     77:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.1       dsieger    78:            installed. The default is
                     79:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.17      wiz        80: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger    81:            X11 is installed on the system. The default is
1.24      wiz        82:            <code class="filename">/usr/X11R7</code>.</p></li>
1.17      wiz        83: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger    84:            downloaded copies of the original source distributions used
                     85:            for building pkgsrc packages. The default is
                     86:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.17      wiz        87: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger    88:            database about installed packages is stored.  The default is
                     89:            <code class="filename">/var/db/pkg</code>.</p></li>
1.17      wiz        90: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger    91:            If set, override the packages'
                     92:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.17      wiz        93: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger    94:            Backup location(s) for distribution files and patch files
                     95:            if not found locally or in
                     96:            <code class="filename">${MASTER_SITES}</code> or
                     97:            <code class="filename">${PATCH_SITES}</code> respectively.
                     98:            The defaults are
1.19      spz        99:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1       dsieger   100:            and
                    101:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.17      wiz       102: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger   103:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                    104:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.17      wiz       105:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                    106:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                    107: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.16      jakllsch  108:            List of acceptable licenses. License names are case-sensitive.
                    109:            Whenever you try to build a package whose license is not in this
                    110:            list, you will get an error message. If the license condition is
                    111:            simple enough, the error message will include specific
                    112:            instructions on how to change this variable.</p></li>
1.1       dsieger   113: </ul></div>
                    114: </div>
1.21      asau      115: <div class="sect1">
1.1       dsieger   116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    117: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                    118: <p>XXX
                    119:       </p>
1.21      asau      120: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.17      wiz       121: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger   122:            directory for the binary packages. The default is
                    123:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.17      wiz       124: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger   125:            The top level directory where, if defined, the separate
                    126:            working directories will get created, and symbolically
                    127:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                    128:            This is useful for building packages on several
                    129:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                    130:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                    131:            is local to every architecture. (It should be noted that
                    132:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.10      jmcneill  133:            &mdash; it is an internal definition which refers to the
1.1       dsieger   134:            root of the pkgsrc tree. It is possible to have many
                    135:            pkgsrc tree instances.)</p></li>
1.17      wiz       136: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger   137:            Directory for local patches that aren't part of pkgsrc.
1.7       hubertf   138:            See <a class="xref" href="components.html#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.1       dsieger   139:            information.</p></li>
1.17      wiz       140: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.7       hubertf   141:            the <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger   142:            BSD-style Makefile. If this is not set,
                    143:            <code class="varname">MAKECONF</code> is set to
                    144:            <code class="filename">/dev/null</code> to avoid picking up
                    145:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.17      wiz       146: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1       dsieger   147:            By default, dependencies are only installed, and no binary
                    148:            package is created for them. You can set this variable to
1.22      asau      149:            <code class="literal">package-install</code> to automatically create binary
1.23      wiz       150:            packages after installing dependencies. Please note that the
1.24      wiz       151:            <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.23      wiz       152:            <code class="literal">yes</code> to preserve binary packages when
                    153:            using the <code class="literal">install</code> as well.</p></li>
1.1       dsieger   154: </ul></div>
                    155: </div>
1.21      asau      156: <div class="sect1">
1.1       dsieger   157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig    158: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.18      wiz       159: <p>Most packages support installation into a
1.3       rillig    160:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                    161:     to be built, before the actual filesystem is touched. DESTDIR
                    162:     support exists in two variations:</p>
1.21      asau      163: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.17      wiz       164: <li class="listitem"><p>Basic DESTDIR support means that the package
1.18      wiz       165:       installation and packaging is still run as root.</p></li>
                    166: <li class="listitem"><p>Full DESTDIR support can run the complete
                    167:       build, installation and packaging as normal user. Root
                    168:       privileges are only needed to add packages.</p></li>
1.3       rillig    169: </ul></div>
1.18      wiz       170: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
                    171:     you can set
                    172:     <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
                    173:     so it's preferable to convert a package to DESTDIR instead.</p>
1.3       rillig    174: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                    175:     clean</code></strong> needs to be run as root.</p>
1.13      imil      176: <p>Considering the <code class="filename">foo/bar</code> package,
                    177:     DESTDIR full support can be tested using the following commands
                    178: 
                    179: </p>
                    180: <pre class="programlisting">
                    181: <code class="prompt">$</code> id
                    182: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                    183: <code class="prompt">$</code> mkdir $HOME/packages
                    184: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                    185: </pre>
                    186: <p>
                    187: 
                    188:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                    189:     should be needed
                    190: 
                    191: </p>
                    192: <pre class="programlisting">
1.22      asau      193: <code class="prompt">$</code> make stage-install
1.13      imil      194: </pre>
                    195: <p>
                    196: 
                    197:     Create a package without root privileges
                    198: 
                    199: </p>
                    200: <pre class="programlisting">
1.22      asau      201: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.13      imil      202: </pre>
                    203: <p>
                    204: 
                    205:     For the following command, you must be able to gain root
1.20      dholland  206:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.13      imil      207: 
                    208: </p>
                    209: <pre class="programlisting">
1.22      asau      210: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.13      imil      211: </pre>
                    212: <p>
                    213: 
                    214:     Then, as a simple user
                    215: 
                    216: </p>
                    217: <pre class="programlisting">
                    218: <code class="prompt">$</code> make clean
                    219: </pre>
                    220: <p>
                    221: 
                    222:     </p>
1.3       rillig    223: </div>
1.21      asau      224: <div class="sect1">
1.3       rillig    225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    226: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.21      asau      227: <div class="sect2">
1.1       dsieger   228: <div class="titlepage"><div><div><h3 class="title">
1.3       rillig    229: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger   230: <p>By default, pkgsrc will use GCC to build packages.  This may be
                    231:     overridden by setting the following variables in /etc/mk.conf:</p>
1.21      asau      232: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   233: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                    234: <dd>
                    235: <p>This is a list of values specifying the chain of
                    236:          compilers to invoke when building packages.  Valid values
                    237:          are:</p>
1.21      asau      238: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.22      asau      239: <li class="listitem"><p><code class="varname">ccc</code>:
                    240:            Compaq C Compilers (Tru64)</p></li>
                    241: <li class="listitem"><p><code class="varname">ccache</code>:
                    242:            compiler cache (chainable)</p></li>
                    243: <li class="listitem"><p><code class="varname">clang</code>:
                    244:            Clang C and Objective-C compiler</p></li>
1.17      wiz       245: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger   246:            distributed C/C++ (chainable)</p></li>
1.22      asau      247: <li class="listitem"><p><code class="varname">f2c</code>:
                    248:            Fortran 77 to C compiler (chainable)</p></li>
                    249: <li class="listitem"><p><code class="varname">icc</code>:
                    250:            Intel C++ Compiler (Linux)</p></li>
                    251: <li class="listitem"><p><code class="varname">ido</code>:
                    252:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.17      wiz       253: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger   254:            GNU C/C++ Compiler</p></li>
1.22      asau      255: <li class="listitem"><p><code class="varname">hp</code>:
                    256:            HP-UX C/aC++ compilers</p></li>
1.17      wiz       257: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger   258:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.22      asau      259: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1       dsieger   260:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.17      wiz       261: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger   262:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.22      asau      263: <li class="listitem"><p><code class="varname">xlc</code>:
                    264:            IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1       dsieger   265: </ul></div>
                    266: <p>The default is
1.17      wiz       267:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger   268:          <code class="varname">ccache</code> and/or
                    269:          <code class="varname">distcc</code> with an appropriate
                    270:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.17      wiz       271:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger   272:          variable should always be terminated with a value for
                    273:          a real compiler.  Note that only one real compiler
1.17      wiz       274:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger   275:          is not allowed).</p>
                    276: </dd>
                    277: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                    278: <dd><p>This specifies the minimum version of GCC to use
                    279:          when building packages.  If the system GCC doesn't
                    280:          satisfy this requirement, then pkgsrc will build and
                    281:          install one of the GCC packages to use instead.</p></dd>
                    282: </dl></div>
                    283: </div>
1.21      asau      284: <div class="sect2">
1.1       dsieger   285: <div class="titlepage"><div><div><h3 class="title">
1.3       rillig    286: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1       dsieger   287: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                    288:        please make sure to use the <code class="literal">+=</code> operator
                    289:        instead of the <code class="literal">=</code> operator:</p>
                    290: <pre class="programlisting">
                    291: CFLAGS+=        -your -flags
                    292: </pre>
                    293: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.17      wiz       294:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.12      jnemeth   295:        need to add their own flags.  You may want to take a look
                    296:        at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.17      wiz       297:        package if you're interested in optimization specifically
                    298:        for the current CPU. </p>
1.1       dsieger   299: </div>
1.21      asau      300: <div class="sect2">
1.1       dsieger   301: <div class="titlepage"><div><div><h3 class="title">
1.3       rillig    302: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1       dsieger   303: <p>If you want to pass flags to the linker, both in the configure
                    304: step and the build step, you can do this in two ways.  Either set
                    305: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                    306: between the two is that <code class="varname">LIBS</code> will be appended to
                    307: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                    308: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                    309: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                    310: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                    311: <code class="varname">CFLAGS</code>, if you do not wish to override these
                    312: settings, use the <code class="literal">+=</code> operator:</p>
                    313: <pre class="programlisting">
                    314: LDFLAGS+=        -your -linkerflags
                    315: </pre>
                    316: </div>
                    317: </div>
1.21      asau      318: <div class="sect1">
1.1       dsieger   319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3       rillig    320: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.24      wiz       321: <p>
1.1       dsieger   322:       </p>
1.21      asau      323: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.17      wiz       324: <li class="listitem">
1.1       dsieger   325: <p><code class="varname">PKG_DEVELOPER</code>:
                    326:            Run some sanity checks that package developers want:
                    327:            </p>
1.21      asau      328: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.17      wiz       329: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger   330:              fuzz</p></li>
1.17      wiz       331: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger   332:              binaries will find their shared libs.</p></li>
                    333: </ul></div>
                    334: <p>
                    335:        </p>
                    336: </li>
1.17      wiz       337: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger   338:        of debugging output which is displayed whilst making and
                    339:        installing the package.  The default value for this is 0,
                    340:        which will not display the commands as they are executed
                    341:        (normal, default, quiet operation); the value 1 will display
                    342:        all shell commands before their invocation, and the value 2
                    343:        will display both the shell commands before their invocation,
1.7       hubertf   344:        and their actual execution progress with <span class="command"><strong>set
1.1       dsieger   345:        -x</strong></span> will be displayed.</p></li>
                    346: </ul></div>
                    347: <p>
                    348:     </p>
                    349: </div>
1.21      asau      350: <div class="sect1">
1.1       dsieger   351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3       rillig    352: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger   353: <p>Some packages have build time options, usually to select
                    354:     between different dependencies, enable optional support for big
                    355:     dependencies or enable experimental features.</p>
                    356: <p>To see which options, if any, a package supports, and which
1.7       hubertf   357:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger   358:     show-options</strong></span>, for example:</p>
                    359: <pre class="programlisting">
                    360:     The following options are supported by this package:
                    361:         ssl      Enable SSL support.
                    362:     Exactly one of the following gecko options is required:
                    363:         firefox  Use firefox as gecko rendering engine.
                    364:         mozilla  Use mozilla as gecko rendering engine.
                    365:     At most one of the following database options may be selected:
                    366:         mysql    Enable support for MySQL database.
                    367:         pgsql    Enable support for PostgreSQL database.
                    368: 
                    369:     These options are enabled by default: firefox
                    370:     These options are currently enabled: mozilla ssl
                    371: </pre>
                    372: <p>The following variables can be defined in
1.7       hubertf   373:     <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger   374:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                    375:     which can be used to select or disable options for all packages
                    376:     that support them, and
                    377:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                    378:     which can be used to select or disable options specifically for
                    379:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.17      wiz       380:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger   381:     are disabled. A few examples:</p>
                    382: <pre class="screen">
1.7       hubertf   383: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1       dsieger   384: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                    385: PKG_OPTIONS.kdebase=    debug -sasl
                    386: PKG_OPTIONS.apache=     suexec </pre>
1.8       rillig    387: <p>It is important to note that options that were specifically
1.14      snj       388:     suggested by the package maintainer must be explicitly removed if
1.8       rillig    389:     you do not wish to include the option.  If you are unsure you can view
                    390:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger   391: <p>The following settings are consulted in the order given, and
                    392:     the last setting that selects or disables an option is
                    393:     used:</p>
1.17      wiz       394: <div class="orderedlist"><ol class="orderedlist" type="1">
                    395: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger   396:       maintainer</p></li>
1.17      wiz       397: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger   398:       variables (see below)</p></li>
1.17      wiz       399: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                    400: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1       dsieger   401: </ol></div>
                    402: <p>For groups of mutually exclusive options, the last option
                    403:     selected is used, all others are automatically disabled.  If an
                    404:     option of the group is explicitly disabled, the previously
                    405:     selected option, if any, is used.  It is an error if no option
                    406:     from a required group of options is selected, and building the
                    407:     package will fail.</p>
                    408: <p>Before the options framework was introduced, build options
                    409:     were selected by setting a variable (often named
                    410:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.7       hubertf   411:     <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger   412:     transition to the options framework for the user, these legacy
                    413:     variables are converted to the appropriate options setting
                    414:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                    415:     automatically.  A warning is issued to prompt the user to update
1.7       hubertf   416:     <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger   417:     directly.  Support for the legacy variables will be removed
                    418:     eventually.</p>
                    419: </div>
                    420: </div>
                    421: <div class="navfooter">
                    422: <hr>
                    423: <table width="100%" summary="Navigation footer">
                    424: <tr>
                    425: <td width="40%" align="left">
                    426: <a accesskey="p" href="using.html">Prev</a> </td>
                    427: <td width="20%" align="center"><a accesskey="u" href="users-guide.html">Up</a></td>
                    428: <td width="40%" align="right"> <a accesskey="n" href="binary.html">Next</a>
                    429: </td>
                    430: </tr>
                    431: <tr>
                    432: <td width="40%" align="left" valign="top">Chapter 4. Using pkgsrc </td>
                    433: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
                    434: <td width="40%" align="right" valign="top"> Chapter 6. Creating binary packages</td>
                    435: </tr>
                    436: </table>
                    437: </div>
                    438: </body>
                    439: </html>

CVSweb <webmaster@jp.NetBSD.org>