Annotation of htdocs/docs/pkgsrc/using.html, revision 1.7
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 4. Using pkgsrc</title>
1.2 rillig 6: <link rel="stylesheet" href="/global.css" type="text/css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <link rel="start" href="index.html" title="The pkgsrc guide">
9: <link rel="up" href="users-guide.html" title="Part I. The pkgsrc user's guide">
10: <link rel="prev" href="platforms.html" title="Chapter 3. Using pkgsrc on systems other than NetBSD">
11: <link rel="next" href="configuring.html" title="Chapter 5. Configuring pkgsrc">
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 4. Using pkgsrc</th></tr>
17: <tr>
18: <td width="20%" align="left">
19: <a accesskey="p" href="platforms.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="configuring.html">Next</a>
22: </td>
23: </tr>
24: </table>
25: <hr>
26: </div>
27: <div class="chapter" lang="en">
28: <div class="titlepage"><div><div><h2 class="title">
29: <a name="using"></a>Chapter 4. Using 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="using.html#using-pkg">4.1. Using binary packages</a></span></dt>
34: <dd><dl>
35: <dt><span class="sect2"><a href="using.html#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
36: <dt><span class="sect2"><a href="using.html#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
37: <dt><span class="sect2"><a href="using.html#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
38: <dt><span class="sect2"><a href="using.html#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
39: <dt><span class="sect2"><a href="using.html#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
40: <dt><span class="sect2"><a href="using.html#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
41: <dt><span class="sect2"><a href="using.html#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
42: <dt><span class="sect2"><a href="using.html#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
43: </dl></dd>
44: <dt><span class="sect1"><a href="using.html#building-packages-from-source">4.2. Building packages from source</a></span></dt>
45: <dd><dl>
46: <dt><span class="sect2"><a href="using.html#requirements">4.2.1. Requirements</a></span></dt>
47: <dt><span class="sect2"><a href="using.html#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
48: <dt><span class="sect2"><a href="using.html#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
49: </dl></dd>
50: </dl>
51: </div>
52: <p>Basically, there are two ways of using pkgsrc. The first
53: is to only install the package tools and to use binary packages
54: that someone else has prepared. This is the “<span class="quote">pkg</span>”
55: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
56: of pkgsrc, too. Then you are able to build your own packages,
57: and you can still use binary packages from someone else.</p>
58: <div class="sect1" lang="en">
59: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
60: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.6 hubertf 61: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.5 rillig 62: server and its mirrors, there are collections of binary packages,
63: ready to be installed. These binary packages have been built using the
64: default settings for the directories, that is:</p>
65: <div class="itemizedlist"><ul type="disc">
66: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
67: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
68: <li><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
69: </ul></div>
70: <p>If you cannot use these directories for whatever reasons (maybe
71: because you're not root), you cannot use these binary packages, but
1.6 hubertf 72: have to build the packages yourself, which is explained in <a class="xref" href="platforms.html#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.1 dsieger 73: <div class="sect2" lang="en">
74: <div class="titlepage"><div><div><h3 class="title">
75: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.4 weinem 76: <p>To install binary packages, you first need to know from where
77: to get them. The first place where you should look is on the main
1.6 hubertf 78: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.4 weinem 79: <p>This directory contains binary packages for multiple
80: platforms. First, select your operating system. (Ignore the
81: directories with version numbers attached to it, they just exist for
82: legacy reasons.) Then, select your hardware architecture, and in the
1.5 rillig 83: third step, the OS version and the “<span class="quote">version</span>” of pkgsrc.</p>
84: <p>In this directory, you often find a file called
85: <code class="filename">bootstrap.tar.gz</code> which contains the package
86: management tools. If the file is missing, it is likely that your
87: operating system already provides those tools. Download the file and
88: extract it in the <code class="filename">/</code> directory. It will create
89: the directories <code class="filename">/usr/pkg</code> (containing the tools
90: for managing binary packages) and <code class="filename">/var/db/pkg</code>
91: (the database of installed packages).</p>
1.1 dsieger 92: </div>
93: <div class="sect2" lang="en">
94: <div class="titlepage"><div><div><h3 class="title">
95: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.5 rillig 96: <p>In the directory from the last section, there is a
97: subdirectory called <code class="filename">All</code>, which contains all the
98: binary packages that are available for the platform, excluding those
99: that may not be distributed via FTP or CDROM (depending on which
100: medium you are using), and the ones that have vulnerabilities and
101: therefore are considered insecure to install without thinking
102: before.</p>
103: <p>To install packages directly from an FTP or HTTP server, run
104: the following commands in a Bourne-compatible shell (be sure to
1.6 hubertf 105: <span class="command"><strong>su</strong></span> to root first):</p>
1.5 rillig 106: <pre class="screen">
107: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
108: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All"</code></strong>
109: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
110: </pre>
111: <p>Instead of URLs, you can also use local paths, for example if
112: you are installing from a set of CDROMs, DVDs or an NFS-mounted
113: repository. If you want to install packages from multiple sources,
114: you can separate them by a semicolon in
115: <code class="varname">PKG_PATH</code>.</p>
116: <p>After these preparations, installing a package is very
117: easy:</p>
118: <pre class="screen">
119: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
120: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
121: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
122: </pre>
1.1 dsieger 123: <p>Note that any prerequisite packages needed to run the
124: package in question will be installed, too, assuming they are
125: present where you install from.</p>
1.5 rillig 126: <p>As mentioned above, packages for which vulnerabilities get
127: known are not stored in the <code class="filename">All</code> subdirectory.
128: They don't get deleted since that could be very frustrating if many
129: other packages depend on it. Instead, they are moved to the
130: <code class="filename">vulnerable</code> subdirectory. So you may need to add
131: this directory to the <code class="varname">PKG_PATH</code> variable.
132: However, you should run <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> regularly, especially
133: after installing new packages, and verify that the vulnerabilities
134: are acceptable for your configuration.</p>
1.1 dsieger 135: <p>After you've installed packages, be sure to have
136: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
137: <code class="varname">PATH</code> so you can actually start the just
138: installed program.</p>
139: </div>
140: <div class="sect2" lang="en">
141: <div class="titlepage"><div><div><h3 class="title">
142: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
143: <p>To deinstall a package, it does not matter whether it was
144: installed from source code or from a binary package. The
1.6 hubertf 145: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
146: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 147: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
148: name can be given with or without version number. Wildcards can
149: also be used to deinstall a set of packages, for example
150: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
151: so that the shell does not expand them before
152: <code class="literal">pkg_delete</code> sees them.</p>
153: <p>The <code class="option">-r</code> option is very powerful: it
154: removes all the packages that require the package in question
155: and then removes the package itself. For example:
156:
157: </p>
158: <pre class="screen">
159: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
160: </pre>
161: <p>
162:
163: will remove jpeg and all the packages that used it; this allows
164: upgrading the jpeg package.</p>
165: </div>
166: <div class="sect2" lang="en">
167: <div class="titlepage"><div><div><h3 class="title">
168: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.6 hubertf 169: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 170: installed packages or binary package files.</p>
171: </div>
172: <div class="sect2" lang="en">
173: <div class="titlepage"><div><div><h3 class="title">
174: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
175: <p>
176: The NetBSD Security-Officer and Packages Groups maintain a list of
177: known security vulnerabilities to packages which are (or have been)
178: included in pkgsrc. The list is available from the NetBSD
1.6 hubertf 179: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1 dsieger 180: </p>
181: <p>
182: Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
183: this list can be downloaded
184: automatically, and a security audit of all packages installed on a system
185: can take place.
186: </p>
187: <p>
188: There are two components to
189: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>. The first
190: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
191: the list of vulnerabilities from the NetBSD FTP site. The second
192: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
193: installed packages are vulnerable. If a package is vulnerable, you
194: will see output similar to the following:
195: </p>
196: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
197: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
198: <p>
199: One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.6 hubertf 200: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.1 dsieger 201: file daily, and include a package audit in the daily security script.
1.6 hubertf 202: Details on this are located in the <a class="ulink" href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.1 dsieger 203: file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
204: </p>
205: </div>
206: <div class="sect2" lang="en">
207: <div class="titlepage"><div><div><h3 class="title">
208: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
209: <p>
1.7 ! weinem 210: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.6 hubertf 211: <span class="command"><strong>lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
1.1 dsieger 212: argument to check if your packages are up-to-date, e.g.
213: </p>
214: <pre class="screen">
215: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
216: ...
217: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
218: </pre>
1.6 hubertf 219: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 220: package on your system and rebuild any dependencies.
221: </p>
222: </div>
223: <div class="sect2" lang="en">
224: <div class="titlepage"><div><div><h3 class="title">
225: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.6 hubertf 226: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 227: administrative functions on the package system.</p>
228: </div>
229: <div class="sect2" lang="en">
230: <div class="titlepage"><div><div><h3 class="title">
231: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
232: <p>Please pay very careful attention to the warnings
1.6 hubertf 233: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.1 dsieger 234: inherent dangers of installing binary packages which you did
235: not create yourself, and the security holes that can be
236: introduced onto your system by indiscriminate adding of such
237: files.</p>
238: <p>The same warning of course applies to every package you
239: install from source when you haven't completely read and
240: understood the source code of the package, the compiler that
241: is used to build the package and all the other tools that are
242: involved.</p>
243: </div>
244: </div>
245: <div class="sect1" lang="en">
246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
247: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
248: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
249: directory now contains a set of packages, organized into
250: categories. You can browse the online index of packages, or run
1.6 hubertf 251: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 252: directory to build local <code class="filename">README.html</code> files for
253: all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
254: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
255: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
256: should do so by setting <code class="varname">LOCALBASE</code> in
1.6 hubertf 257: <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 258: different <code class="varname">LOCALBASE</code> definitions on the same
259: system (inside a chroot is an exception). </p>
260: <p>The rest of this chapter assumes that the package is already
1.6 hubertf 261: in pkgsrc. If it is not, see <a class="xref" href="developers-guide.html" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 262: instructions how to create your own packages.</p>
263: <div class="sect2" lang="en">
264: <div class="titlepage"><div><div><h3 class="title">
265: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
266: <p>To build packages from source, you need a working C
267: compiler. On NetBSD, you need to install the
268: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
269: sets. If you want to build X11-related packages, the
270: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
271: sets are required, too.</p>
272: </div>
273: <div class="sect2" lang="en">
274: <div class="titlepage"><div><div><h3 class="title">
275: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
276: <p>The first step for building a package is downloading the
277: distfiles (i.e. the unmodified source). If they have not yet been
278: downloaded, pkgsrc will fetch them automatically.</p>
279: <p>If you have all files that you need in the
280: <code class="filename">distfiles</code> directory,
281: you don't need to connect. If the distfiles are on CD-ROM, you can
282: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
283: </p>
284: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
285: <p>
1.6 hubertf 286: to your <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 287: <p>By default a list of distribution sites will be randomly
288: intermixed to prevent huge load on servers which holding popular
289: packages (for example, SourceForge.net mirrors). Thus, every
290: time when you need to fetch yet another distfile all the mirrors
291: will be tried in new (random) order. You can turn this feature
292: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
293: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
294: <p>You can overwrite some of the major distribution sites to
295: fit to sites that are close to your own. By setting one or two
296: variables you can modify the order in which the master sites are
297: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
298: delimited list of domain suffixes.
299: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
300: contains a whitespace delimited list of regular expressions. It
301: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
302: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
303: some examples. This may save some of your bandwidth and
304: time.</p>
305: <p>You can change these settings either in your shell's environment, or,
306: if you want to keep the settings, by editing the
1.6 hubertf 307: <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 308: and adding the definitions there.</p>
309: <p>
310: If a package depends on many other packages (such as
311: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
312: alternate between periods of
313: downloading source, and compiling. To ensure you have all the source
314: downloaded initially you can run the command:
315: </p>
316: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
317: <p>
318: which will output and run a set of shell commands to fetch the
319: necessary files into the <code class="filename">distfiles</code> directory. You can
320: also choose to download the files manually.
321: </p>
322: </div>
323: <div class="sect2" lang="en">
324: <div class="titlepage"><div><div><h3 class="title">
325: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
326: <p>
327: Once the software has downloaded, any patches will be applied, then it
328: will be compiled for you. This may take some time depending on your
329: computer, and how many other packages the software depends on and their
330: compile time.
331: </p>
332: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
333: <h3 class="title">Note</h3>
334: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.6 hubertf 335: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.1 dsieger 336: “<span class="quote">make</span>” in the examples in this guide.</p>
337: </div>
338: <p>For example, type</p>
339: <pre class="screen">
340: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
341: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
342: </pre>
343: <p>at the shell prompt to build the various components of the
344: package.</p>
345: <p>The next stage is to actually install the newly compiled
346: program onto your system. Do this by entering:
347:
348: </p>
349: <pre class="screen">
350: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
351: </pre>
352: <p>
353:
354: while you are still in the directory for whatever package you
355: are installing.</p>
356: <p>Installing the package on your system may require you to
357: be root. However, pkgsrc has a
358: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
359: to only become root for the actual installation step.</p>
360: <p>That's it, the software should now be installed and setup for use.
361: You can now enter:
362:
363: </p>
364: <pre class="screen">
365: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
366: </pre>
367: <p>
368:
369: to remove the compiled files in the work directory, as you shouldn't need
370: them any more. If other packages were also added to your system
371: (dependencies) to allow your program to compile, you can tidy these up
372: also with the command:</p>
373: <pre class="screen">
374: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
375: </pre>
376: <p>Taking the figlet utility as an example, we can install it on our
1.6 hubertf 377: system by building as shown in <a class="xref" href="logs.html" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1 dsieger 378: <p>The program is installed under the default root of the
379: packages tree - <code class="filename">/usr/pkg</code>. Should this not
380: conform to your tastes, set the <code class="varname">LOCALBASE</code>
381: variable in your environment, and it will use that value as the
382: root of your packages tree. So, to use
383: <code class="filename">/usr/local</code>, set
384: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
385: Please note that you should use a directory which is dedicated to
386: packages and not shared with other programs (i.e., do not try and
387: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
388: to add any of your own files or directories (such as
389: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
390: <code class="filename">pkgsrc/</code>) below the
391: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
392: conflicts between programs and other files installed by the
393: package system and whatever else may have been installed
394: there.</p>
1.6 hubertf 395: <p>Some packages look in <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 396: alter some configuration options at build time. Have a look at
397: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
398: of what will be set there by default. Environment variables such
399: as <code class="varname">LOCALBASE</code> can be set in
1.6 hubertf 400: <a class="link" href="configuring.html#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 401: set them each time you want to use pkgsrc.</p>
402: <p>Occasionally, people want to “<span class="quote">look under the
403: covers</span>” to see what is going on when a package is building
404: or being installed. This may be for debugging purposes, or out of
405: simple curiosity. A number of utility values have been added to
406: help with this.</p>
407: <div class="orderedlist"><ol type="1">
408: <li>
1.6 hubertf 409: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 410: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
411: information will be displayed. For example,</p>
412: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
413: <p>will show all the commands that are invoked, up to and
414: including the “<span class="quote">patch</span>” stage.</p>
415: </li>
416: <li>
1.6 hubertf 417: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 418: definition, then the <code class="varname">VARNAME</code> definition
419: should be used, in conjunction with the show-var
1.6 hubertf 420: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 421: variable <code class="varname">LOCALBASE</code>:</p>
422: <pre class="screen">
423: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
424: /usr/pkg
425: <code class="prompt">%</code>
426: </pre>
427: </li>
428: </ol></div>
429: <p>If you want to install a binary package that you've either
430: created yourself (see next section), that you put into
431: pkgsrc/packages manually or that is located on a remote FTP
432: server, you can use the "bin-install" target. This target will
1.6 hubertf 433: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
434: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 435: sites searched is kept in the variable
436: <code class="varname">BINPKG_SITES</code>, which defaults to
1.6 hubertf 437: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 438: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
439: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
440: details.</p>
441: <p>A final word of warning: If you set up a system that has a
442: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
443: set that before any packages are installed, as you cannot use
444: several directories for the same purpose. Doing so will result in
445: pkgsrc not being able to properly detect your installed packages,
446: and fail miserably. Note also that precompiled binary packages are
447: usually built with the default <code class="varname">LOCALBASE</code> of
448: <code class="filename">/usr/pkg</code>, and that you should
449: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
450: <code class="varname">LOCALBASE</code>.</p>
451: </div>
452: </div>
453: </div>
454: <div class="navfooter">
455: <hr>
456: <table width="100%" summary="Navigation footer">
457: <tr>
458: <td width="40%" align="left">
459: <a accesskey="p" href="platforms.html">Prev</a> </td>
460: <td width="20%" align="center"><a accesskey="u" href="users-guide.html">Up</a></td>
461: <td width="40%" align="right"> <a accesskey="n" href="configuring.html">Next</a>
462: </td>
463: </tr>
464: <tr>
465: <td width="40%" align="left" valign="top">Chapter 3. Using pkgsrc on systems other than NetBSD </td>
466: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
467: <td width="40%" align="right" valign="top"> Chapter 5. Configuring pkgsrc</td>
468: </tr>
469: </table>
470: </div>
471: </body>
472: </html>
CVSweb <webmaster@jp.NetBSD.org>