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