Annotation of htdocs/docs/pkgsrc/using.html, revision 1.11

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

CVSweb <webmaster@jp.NetBSD.org>