Annotation of htdocs/docs/pkgsrc/users-guide.html, revision 1.35

1.31      sevan       1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
1.1       dsieger     2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>Part I. The pkgsrc user's guide</title>
1.9       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.7       rillig      8: <link rel="home" href="index.html" title="The pkgsrc guide">
1.1       dsieger     9: <link rel="up" href="index.html" title="The pkgsrc guide">
                     10: <link rel="prev" href="introduction.html" title="Chapter 1. What is pkgsrc?">
1.32      rillig     11: <link rel="next" href="help-user.html" title="Chapter 2. Getting help">
1.1       dsieger    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">Part I. The pkgsrc user's guide</th></tr>
                     17: <tr>
                     18: <td width="20%" align="left">
                     19: <a accesskey="p" href="introduction.html">Prev</a> </td>
                     20: <th width="60%" align="center"> </th>
1.32      rillig     21: <td width="20%" align="right"> <a accesskey="n" href="help-user.html">Next</a>
1.1       dsieger    22: </td>
                     23: </tr>
                     24: </table>
                     25: <hr>
                     26: </div>
1.10      asau       27: <div class="part">
1.1       dsieger    28: <div class="titlepage"><div><div><h1 class="title">
                     29: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                     30: <div class="toc">
                     31: <p><b>Table of Contents</b></p>
1.27      leot       32: <dl class="toc">
1.32      rillig     33: <dt><span class="chapter"><a href="help-user.html">2. Getting help</a></span></dt>
                     34: <dt><span class="chapter"><a href="getting.html">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1       dsieger    35: <dd><dl>
1.32      rillig     36: <dt><span class="sect1"><a href="getting.html#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger    37: <dd><dl>
1.32      rillig     38: <dt><span class="sect2"><a href="getting.html#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                     39: <dt><span class="sect2"><a href="getting.html#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger    40: </dl></dd>
1.32      rillig     41: <dt><span class="sect1"><a href="getting.html#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger    42: <dd><dl>
1.32      rillig     43: <dt><span class="sect2"><a href="getting.html#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                     44: <dt><span class="sect2"><a href="getting.html#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1       dsieger    45: </dl></dd>
                     46: </dl></dd>
1.32      rillig     47: <dt><span class="chapter"><a href="platforms.html">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1       dsieger    48: <dd><dl>
1.32      rillig     49: <dt><span class="sect1"><a href="platforms.html#binarydist">4.1. Binary distribution</a></span></dt>
                     50: <dt><span class="sect1"><a href="platforms.html#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1       dsieger    51: </dl></dd>
1.32      rillig     52: <dt><span class="chapter"><a href="using.html">5. Using pkgsrc</a></span></dt>
1.1       dsieger    53: <dd><dl>
1.32      rillig     54: <dt><span class="sect1"><a href="using.html#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger    55: <dd><dl>
1.32      rillig     56: <dt><span class="sect2"><a href="using.html#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                     57: <dt><span class="sect2"><a href="using.html#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                     58: <dt><span class="sect2"><a href="using.html#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                     59: <dt><span class="sect2"><a href="using.html#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                     60: <dt><span class="sect2"><a href="using.html#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                     61: <dt><span class="sect2"><a href="using.html#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                     62: <dt><span class="sect2"><a href="using.html#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.1       dsieger    63: </dl></dd>
1.32      rillig     64: <dt><span class="sect1"><a href="using.html#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1       dsieger    65: <dd><dl>
1.32      rillig     66: <dt><span class="sect2"><a href="using.html#requirements">5.2.1. Requirements</a></span></dt>
                     67: <dt><span class="sect2"><a href="using.html#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                     68: <dt><span class="sect2"><a href="using.html#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1       dsieger    69: </dl></dd>
                     70: </dl></dd>
1.32      rillig     71: <dt><span class="chapter"><a href="configuring.html">6. Configuring pkgsrc</a></span></dt>
1.1       dsieger    72: <dd><dl>
1.32      rillig     73: <dt><span class="sect1"><a href="configuring.html#general-configuration">6.1. General configuration</a></span></dt>
                     74: <dt><span class="sect1"><a href="configuring.html#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                     75: <dt><span class="sect1"><a href="configuring.html#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                     76: <dt><span class="sect1"><a href="configuring.html#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger    77: <dd><dl>
1.32      rillig     78: <dt><span class="sect2"><a href="configuring.html#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                     79: <dt><span class="sect2"><a href="configuring.html#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                     80: <dt><span class="sect2"><a href="configuring.html#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger    81: </dl></dd>
1.32      rillig     82: <dt><span class="sect1"><a href="configuring.html#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                     83: <dt><span class="sect1"><a href="configuring.html#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1       dsieger    84: </dl></dd>
1.32      rillig     85: <dt><span class="chapter"><a href="binary.html">7. Creating binary packages</a></span></dt>
1.1       dsieger    86: <dd><dl>
1.32      rillig     87: <dt><span class="sect1"><a href="binary.html#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                     88: <dt><span class="sect1"><a href="binary.html#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.4       rillig     89: </dl></dd>
1.32      rillig     90: <dt><span class="chapter"><a href="bulk.html">8. Creating binary packages for everything in pkgsrc (bulk
1.4       rillig     91: builds)</a></span></dt>
                     92: <dd><dl>
1.32      rillig     93: <dt><span class="sect1"><a href="bulk.html#bulk.pre">8.1. Preparations</a></span></dt>
1.35    ! rillig     94: <dt><span class="sect1"><a href="bulk.html#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.32      rillig     95: <dd><dl><dt><span class="sect2"><a href="bulk.html#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                     96: <dt><span class="sect1"><a href="bulk.html#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.33      rillig     97: <dt><span class="sect1"><a href="bulk.html#bulk.var">8.4. Bulk build variants</a></span></dt>
                     98: <dd><dl>
1.34      rillig     99: <dt><span class="sect2"><a href="bulk.html#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    100: <dt><span class="sect2"><a href="bulk.html#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
                    101: <dt><span class="sect2"><a href="bulk.html#bulk.var.dirs">8.4.3. Use custom directories</a></span></dt>
                    102: <dt><span class="sect2"><a href="bulk.html#bulk.var.warn">8.4.4. Turn warnings into errors</a></span></dt>
                    103: <dt><span class="sect2"><a href="bulk.html#bulk.var.pkglint">8.4.5. Reject packages for which pkglint reports errors</a></span></dt>
                    104: <dt><span class="sect2"><a href="bulk.html#bulk.var.strings">8.4.6. Reject packages that contain forbidden strings</a></span></dt>
                    105: <dt><span class="sect2"><a href="bulk.html#bulk.var.test">8.4.7. Reject packages whose self-test fails</a></span></dt>
                    106: <dt><span class="sect2"><a href="bulk.html#bulk.var.shvar">8.4.8. Reject packages that use undefined shell variables</a></span></dt>
                    107: <dt><span class="sect2"><a href="bulk.html#bulk.var.quiet">8.4.9. Turn off verbose logging</a></span></dt>
1.33      rillig    108: </dl></dd>
                    109: <dt><span class="sect1"><a href="bulk.html#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    110: <dd><dl><dt><span class="sect2"><a href="bulk.html#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.32      rillig    111: </dl></dd>
                    112: <dt><span class="chapter"><a href="files.html">9. Directory layout of the installed files</a></span></dt>
                    113: <dd><dl>
                    114: <dt><span class="sect1"><a href="files.html#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    115: <dt><span class="sect1"><a href="files.html#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    116: </dl></dd>
                    117: <dt><span class="chapter"><a href="faq.html">10. Frequently Asked Questions</a></span></dt>
                    118: <dd><dl>
                    119: <dt><span class="sect1"><a href="faq.html#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    120: <dt><span class="sect1"><a href="faq.html#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    121: <dt><span class="sect1"><a href="faq.html#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    122: <dt><span class="sect1"><a href="faq.html#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    123: <dt><span class="sect1"><a href="faq.html#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    124: <dt><span class="sect1"><a href="faq.html#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    125: <dt><span class="sect1"><a href="faq.html#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    126: <dt><span class="sect1"><a href="faq.html#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    127: <dt><span class="sect1"><a href="faq.html#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    128: <dt><span class="sect1"><a href="faq.html#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.8       wiz       129: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.32      rillig    130: <dt><span class="sect1"><a href="faq.html#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    131: <dt><span class="sect1"><a href="faq.html#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    132: <dt><span class="sect1"><a href="faq.html#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    133: <dt><span class="sect1"><a href="faq.html#audit-packages">10.14. Automated security checks</a></span></dt>
                    134: <dt><span class="sect1"><a href="faq.html#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    135: <dt><span class="sect1"><a href="faq.html#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    136: <dt><span class="sect1"><a href="faq.html#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.1       dsieger   137: </dl></dd>
                    138: </dl>
                    139: </div>
                    140: </div>
                    141: <div class="navfooter">
                    142: <hr>
                    143: <table width="100%" summary="Navigation footer">
                    144: <tr>
                    145: <td width="40%" align="left">
                    146: <a accesskey="p" href="introduction.html">Prev</a> </td>
                    147: <td width="20%" align="center"> </td>
1.32      rillig    148: <td width="40%" align="right"> <a accesskey="n" href="help-user.html">Next</a>
1.1       dsieger   149: </td>
                    150: </tr>
                    151: <tr>
                    152: <td width="40%" align="left" valign="top">Chapter 1. What is pkgsrc? </td>
                    153: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
1.32      rillig    154: <td width="40%" align="right" valign="top"> Chapter 2. Getting help</td>
1.1       dsieger   155: </tr>
                    156: </table>
                    157: </div>
                    158: </body>
                    159: </html>

CVSweb <webmaster@jp.NetBSD.org>