Annotation of htdocs/docs/pkgsrc/configuring.html, revision 1.22
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>
32: <dl>
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">“<span class="quote">cross</span>”</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
82: <code class="filename">/usr/X11R6</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">“<span class="quote">2.0</span>”</span>, etc.) and architecture
106: (<span class="quote">“<span class="quote">mipsel</span>”</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: — 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, “patches/*”</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.1 dsieger 150: packages after installing dependencies.</p></li>
151: </ul></div>
152: </div>
1.21 asau 153: <div class="sect1">
1.1 dsieger 154: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 155: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.18 wiz 156: <p>Most packages support installation into a
1.3 rillig 157: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
158: to be built, before the actual filesystem is touched. DESTDIR
159: support exists in two variations:</p>
1.21 asau 160: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.17 wiz 161: <li class="listitem"><p>Basic DESTDIR support means that the package
1.18 wiz 162: installation and packaging is still run as root.</p></li>
163: <li class="listitem"><p>Full DESTDIR support can run the complete
164: build, installation and packaging as normal user. Root
165: privileges are only needed to add packages.</p></li>
1.3 rillig 166: </ul></div>
1.18 wiz 167: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
168: you can set
169: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
170: so it's preferable to convert a package to DESTDIR instead.</p>
1.3 rillig 171: <p>With basic DESTDIR support, <strong class="userinput"><code>make
172: clean</code></strong> needs to be run as root.</p>
1.13 imil 173: <p>Considering the <code class="filename">foo/bar</code> package,
174: DESTDIR full support can be tested using the following commands
175:
176: </p>
177: <pre class="programlisting">
178: <code class="prompt">$</code> id
179: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
180: <code class="prompt">$</code> mkdir $HOME/packages
181: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
182: </pre>
183: <p>
184:
185: Verify <code class="varname">DESTDIR</code> full support, no root privileges
186: should be needed
187:
188: </p>
189: <pre class="programlisting">
1.22 ! asau 190: <code class="prompt">$</code> make stage-install
1.13 imil 191: </pre>
192: <p>
193:
194: Create a package without root privileges
195:
196: </p>
197: <pre class="programlisting">
1.22 ! asau 198: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.13 imil 199: </pre>
200: <p>
201:
202: For the following command, you must be able to gain root
1.20 dholland 203: 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 204:
205: </p>
206: <pre class="programlisting">
1.22 ! asau 207: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.13 imil 208: </pre>
209: <p>
210:
211: Then, as a simple user
212:
213: </p>
214: <pre class="programlisting">
215: <code class="prompt">$</code> make clean
216: </pre>
217: <p>
218:
219: </p>
1.3 rillig 220: </div>
1.21 asau 221: <div class="sect1">
1.3 rillig 222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
223: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.21 asau 224: <div class="sect2">
1.1 dsieger 225: <div class="titlepage"><div><div><h3 class="title">
1.3 rillig 226: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 227: <p>By default, pkgsrc will use GCC to build packages. This may be
228: overridden by setting the following variables in /etc/mk.conf:</p>
1.21 asau 229: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 230: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
231: <dd>
232: <p>This is a list of values specifying the chain of
233: compilers to invoke when building packages. Valid values
234: are:</p>
1.21 asau 235: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.22 ! asau 236: <li class="listitem"><p><code class="varname">ccc</code>:
! 237: Compaq C Compilers (Tru64)</p></li>
! 238: <li class="listitem"><p><code class="varname">ccache</code>:
! 239: compiler cache (chainable)</p></li>
! 240: <li class="listitem"><p><code class="varname">clang</code>:
! 241: Clang C and Objective-C compiler</p></li>
1.17 wiz 242: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 243: distributed C/C++ (chainable)</p></li>
1.22 ! asau 244: <li class="listitem"><p><code class="varname">f2c</code>:
! 245: Fortran 77 to C compiler (chainable)</p></li>
! 246: <li class="listitem"><p><code class="varname">icc</code>:
! 247: Intel C++ Compiler (Linux)</p></li>
! 248: <li class="listitem"><p><code class="varname">ido</code>:
! 249: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.17 wiz 250: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 251: GNU C/C++ Compiler</p></li>
1.22 ! asau 252: <li class="listitem"><p><code class="varname">hp</code>:
! 253: HP-UX C/aC++ compilers</p></li>
1.17 wiz 254: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 255: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.22 ! asau 256: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 257: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.17 wiz 258: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 259: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.22 ! asau 260: <li class="listitem"><p><code class="varname">xlc</code>:
! 261: IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.1 dsieger 262: </ul></div>
263: <p>The default is
1.17 wiz 264: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 265: <code class="varname">ccache</code> and/or
266: <code class="varname">distcc</code> with an appropriate
267: <code class="varname">PKGSRC_COMPILER</code> setting,
1.17 wiz 268: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 269: variable should always be terminated with a value for
270: a real compiler. Note that only one real compiler
1.17 wiz 271: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 272: is not allowed).</p>
273: </dd>
274: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
275: <dd><p>This specifies the minimum version of GCC to use
276: when building packages. If the system GCC doesn't
277: satisfy this requirement, then pkgsrc will build and
278: install one of the GCC packages to use instead.</p></dd>
279: </dl></div>
280: </div>
1.21 asau 281: <div class="sect2">
1.1 dsieger 282: <div class="titlepage"><div><div><h3 class="title">
1.3 rillig 283: <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 284: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
285: please make sure to use the <code class="literal">+=</code> operator
286: instead of the <code class="literal">=</code> operator:</p>
287: <pre class="programlisting">
288: CFLAGS+= -your -flags
289: </pre>
290: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.17 wiz 291: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.12 jnemeth 292: need to add their own flags. You may want to take a look
293: 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 294: package if you're interested in optimization specifically
295: for the current CPU. </p>
1.1 dsieger 296: </div>
1.21 asau 297: <div class="sect2">
1.1 dsieger 298: <div class="titlepage"><div><div><h3 class="title">
1.3 rillig 299: <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 300: <p>If you want to pass flags to the linker, both in the configure
301: step and the build step, you can do this in two ways. Either set
302: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
303: between the two is that <code class="varname">LIBS</code> will be appended to
304: the command line, while <code class="varname">LDFLAGS</code> come earlier.
305: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
306: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
307: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
308: <code class="varname">CFLAGS</code>, if you do not wish to override these
309: settings, use the <code class="literal">+=</code> operator:</p>
310: <pre class="programlisting">
311: LDFLAGS+= -your -linkerflags
312: </pre>
313: </div>
314: </div>
1.21 asau 315: <div class="sect1">
1.1 dsieger 316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3 rillig 317: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1 dsieger 318: <p>XXX
319: </p>
1.21 asau 320: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.17 wiz 321: <li class="listitem">
1.1 dsieger 322: <p><code class="varname">PKG_DEVELOPER</code>:
323: Run some sanity checks that package developers want:
324: </p>
1.21 asau 325: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.17 wiz 326: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 327: fuzz</p></li>
1.17 wiz 328: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 329: binaries will find their shared libs.</p></li>
330: </ul></div>
331: <p>
332: </p>
333: </li>
1.17 wiz 334: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 335: of debugging output which is displayed whilst making and
336: installing the package. The default value for this is 0,
337: which will not display the commands as they are executed
338: (normal, default, quiet operation); the value 1 will display
339: all shell commands before their invocation, and the value 2
340: will display both the shell commands before their invocation,
1.7 hubertf 341: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 342: -x</strong></span> will be displayed.</p></li>
343: </ul></div>
344: <p>
345: </p>
346: </div>
1.21 asau 347: <div class="sect1">
1.1 dsieger 348: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3 rillig 349: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 350: <p>Some packages have build time options, usually to select
351: between different dependencies, enable optional support for big
352: dependencies or enable experimental features.</p>
353: <p>To see which options, if any, a package supports, and which
1.7 hubertf 354: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 355: show-options</strong></span>, for example:</p>
356: <pre class="programlisting">
357: The following options are supported by this package:
358: ssl Enable SSL support.
359: Exactly one of the following gecko options is required:
360: firefox Use firefox as gecko rendering engine.
361: mozilla Use mozilla as gecko rendering engine.
362: At most one of the following database options may be selected:
363: mysql Enable support for MySQL database.
364: pgsql Enable support for PostgreSQL database.
365:
366: These options are enabled by default: firefox
367: These options are currently enabled: mozilla ssl
368: </pre>
369: <p>The following variables can be defined in
1.7 hubertf 370: <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 371: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
372: which can be used to select or disable options for all packages
373: that support them, and
374: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
375: which can be used to select or disable options specifically for
376: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.17 wiz 377: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 378: are disabled. A few examples:</p>
379: <pre class="screen">
1.7 hubertf 380: <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 381: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
382: PKG_OPTIONS.kdebase= debug -sasl
383: PKG_OPTIONS.apache= suexec </pre>
1.8 rillig 384: <p>It is important to note that options that were specifically
1.14 snj 385: suggested by the package maintainer must be explicitly removed if
1.8 rillig 386: you do not wish to include the option. If you are unsure you can view
387: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 388: <p>The following settings are consulted in the order given, and
389: the last setting that selects or disables an option is
390: used:</p>
1.17 wiz 391: <div class="orderedlist"><ol class="orderedlist" type="1">
392: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 393: maintainer</p></li>
1.17 wiz 394: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 395: variables (see below)</p></li>
1.17 wiz 396: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
397: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 398: </ol></div>
399: <p>For groups of mutually exclusive options, the last option
400: selected is used, all others are automatically disabled. If an
401: option of the group is explicitly disabled, the previously
402: selected option, if any, is used. It is an error if no option
403: from a required group of options is selected, and building the
404: package will fail.</p>
405: <p>Before the options framework was introduced, build options
406: were selected by setting a variable (often named
407: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.7 hubertf 408: <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 409: transition to the options framework for the user, these legacy
410: variables are converted to the appropriate options setting
411: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
412: automatically. A warning is issued to prompt the user to update
1.7 hubertf 413: <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 414: directly. Support for the legacy variables will be removed
415: eventually.</p>
416: </div>
417: </div>
418: <div class="navfooter">
419: <hr>
420: <table width="100%" summary="Navigation footer">
421: <tr>
422: <td width="40%" align="left">
423: <a accesskey="p" href="using.html">Prev</a> </td>
424: <td width="20%" align="center"><a accesskey="u" href="users-guide.html">Up</a></td>
425: <td width="40%" align="right"> <a accesskey="n" href="binary.html">Next</a>
426: </td>
427: </tr>
428: <tr>
429: <td width="40%" align="left" valign="top">Chapter 4. Using pkgsrc </td>
430: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
431: <td width="40%" align="right" valign="top"> Chapter 6. Creating binary packages</td>
432: </tr>
433: </table>
434: </div>
435: </body>
436: </html>
CVSweb <webmaster@jp.NetBSD.org>