pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc regen (various improvements and additional documen...
details: https://anonhg.NetBSD.org/pkgsrc/rev/6295b0c63728
branches: trunk
changeset: 518595:6295b0c63728
user: wiz <wiz%pkgsrc.org@localhost>
date: Wed Sep 13 23:46:55 2006 +0000
description:
regen (various improvements and additional documentation).
diffstat:
doc/pkgsrc.html | 2053 ++++++++++++++++++++++++++++++------------------------
doc/pkgsrc.txt | 333 ++++++--
2 files changed, 1364 insertions(+), 1022 deletions(-)
diffs (truncated from 3532 to 300 lines):
diff -r 9e4ead2185d6 -r 6295b0c63728 doc/pkgsrc.html
--- a/doc/pkgsrc.html Wed Sep 13 23:39:07 2006 +0000
+++ b/doc/pkgsrc.html Wed Sep 13 23:46:55 2006 +0000
@@ -55,10 +55,7 @@
</dl></dd>
<dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
<dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#term.abbrev">1.3.1. Commonly used abbreviations</a></span></dt>
-<dt><span class="sect2"><a href="#term.roles">1.3.2. Roles involved in pkgsrc</a></span></dt>
-</dl></dd>
+<dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
<dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
</dl></dd>
<dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
@@ -118,7 +115,10 @@
<dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
<dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
<dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
-<dd><dl><dt><span class="sect2"><a href="#conf.cflags">5.3.1. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt></dl></dd>
+<dd><dl>
+<dt><span class="sect2"><a href="#conf.cflags">5.3.1. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
+<dt><span class="sect2"><a href="#conf.ldflags">5.3.2. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
+</dl></dd>
<dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
<dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
</dl></dd>
@@ -159,7 +159,8 @@
<dt><span class="sect1"><a href="#faq.conf">7.14. How do I change the location of configuration files?</a></span></dt>
<dt><span class="sect1"><a href="#audit-packages">7.15. Automated security checks</a></span></dt>
<dt><span class="sect1"><a href="#ufaq-cflags">7.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
-<dt><span class="sect1"><a href="#ufaq-fail">7.17. A package does not build. What shall I do?</a></span></dt>
+<dt><span class="sect1"><a href="#ufaq-fail">7.17. A package does not build. What shall I do?</a></span></dt>
+<dt><span class="sect1"><a href="#too-much-time">7.18. I have a little time to kill. What shall I do?</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
@@ -271,7 +272,8 @@
<dt><span class="sect1"><a href="#build.test">15.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
<dt><span class="sect1"><a href="#build.install">15.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
<dt><span class="sect1"><a href="#build.package">15.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
-<dt><span class="sect1"><a href="#build.helpful-targets">15.16. Other helpful targets</a></span></dt>
+<dt><span class="sect1"><a href="#build.clean">15.16. Cleaning up</a></span></dt>
+<dt><span class="sect1"><a href="#build.helpful-targets">15.17. Other helpful targets</a></span></dt>
</dl></dd>
<dt><span class="chapter"><a href="#tools">16. Tools needed for building or running</a></span></dt>
<dd><dl>
@@ -464,10 +466,7 @@
</dl></dd>
<dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
<dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#term.abbrev">1.3.1. Commonly used abbreviations</a></span></dt>
-<dt><span class="sect2"><a href="#term.roles">1.3.2. Roles involved in pkgsrc</a></span></dt>
-</dl></dd>
+<dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
<dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
</dl>
</div>
@@ -678,22 +677,13 @@
especially in the context of precompiled packages.</p>
</dd>
<dt><span class="term">Program</span></dt>
-<dd><p>The piece of software to be installed which will be constructed from
- all the files in the distfile by the actions defined in the
- corresponding package.</p></dd>
+<dd><p>The piece of software to be installed which will be
+ constructed from all the files in the distfile by the
+ actions defined in the corresponding package.</p></dd>
</dl></div>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="term.abbrev"></a>1.3.1. Commonly used abbreviations</h3></div></div></div>
-<div class="variablelist"><dl>
-<dt><span class="term">ICE</span></dt>
-<dd><p>Internal Compiler
- Error</p></dd>
-</dl></div>
-</div>
-<div class="sect2" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="term.roles"></a>1.3.2. Roles involved in pkgsrc</h3></div></div></div>
+<a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
<div class="variablelist"><dl>
<dt><span class="term">pkgsrc users</span></dt>
<dd>
@@ -790,7 +780,10 @@
<dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
<dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
<dt><span class="sect1"><a href="#conf.compiler">5.3. Selecting and configuring the compiler</a></span></dt>
-<dd><dl><dt><span class="sect2"><a href="#conf.cflags">5.3.1. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt></dl></dd>
+<dd><dl>
+<dt><span class="sect2"><a href="#conf.cflags">5.3.1. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
+<dt><span class="sect2"><a href="#conf.ldflags">5.3.2. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
+</dl></dd>
<dt><span class="sect1"><a href="#developer-advanced-settings">5.4. Developer/advanced settings</a></span></dt>
<dt><span class="sect1"><a href="#selecting-build-options">5.5. Selecting Build Options</a></span></dt>
</dl></dd>
@@ -831,7 +824,8 @@
<dt><span class="sect1"><a href="#faq.conf">7.14. How do I change the location of configuration files?</a></span></dt>
<dt><span class="sect1"><a href="#audit-packages">7.15. Automated security checks</a></span></dt>
<dt><span class="sect1"><a href="#ufaq-cflags">7.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
-<dt><span class="sect1"><a href="#ufaq-fail">7.17. A package does not build. What shall I do?</a></span></dt>
+<dt><span class="sect1"><a href="#ufaq-fail">7.17. A package does not build. What shall I do?</a></span></dt>
+<dt><span class="sect1"><a href="#too-much-time">7.18. I have a little time to kill. What shall I do?</a></span></dt>
</dl></dd>
</dl>
</div>
@@ -1818,20 +1812,20 @@
</dl>
</div>
<p>Basically, there are two ways of using pkgsrc. The first
- is to only install the package tools and to use binary packages
- that someone else has prepared. This is the “<span class="quote">pkg</span>”
- in pkgsrc. The second way is to install the “<span class="quote">src</span>”
- of pkgsrc, too. Then you are able to build your own packages,
- and you can still use binary packages from someone else.</p>
+is to only install the package tools and to use binary packages
+that someone else has prepared. This is the “<span class="quote">pkg</span>”
+in pkgsrc. The second way is to install the “<span class="quote">src</span>”
+of pkgsrc, too. Then you are able to build your own packages,
+and you can still use binary packages from someone else.</p>
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
<p>To use binary packages, you need some tools to manage
- them. On NetBSD, these tools are already installed. On all other
- operating systems, you need to install them first. For the
- following platforms, prebuilt versions of the package tools
- are available and can simply be downloaded and unpacked in the
- <code class="filename">/</code> directory:</p>
+ them. On NetBSD, these tools are already installed. On all other
+ operating systems, you need to install them first. For the
+ following platforms, prebuilt versions of the package tools
+ are available and can simply be downloaded and unpacked in the
+ <code class="filename">/</code> directory:</p>
<div class="informaltable">
<a name="binary-bootstrap-kits"></a><table border="1">
<colgroup>
@@ -1855,19 +1849,19 @@
</table>
</div>
<p>These pre-built package tools use
- <code class="filename">/usr/pkg</code> for the base directory, and
- <code class="filename">/var/db/pkg</code> for the database of installed
- packages. If you cannot use these directories for whatever
- reasons (maybe because you're not root), you have to build the
- package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
+ <code class="filename">/usr/pkg</code> for the base directory, and
+ <code class="filename">/var/db/pkg</code> for the database of installed
+ packages. If you cannot use these directories for whatever
+ reasons (maybe because you're not root), you have to build the
+ package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
<p>To install binary packages, you first need to know from
- where to get them. You can get them on CD-ROMs, DVDs, or via FTP
- or HTTP.</p>
+ where to get them. You can get them on CD-ROMs, DVDs, or via FTP
+ or HTTP.</p>
<p>The binary packages can be found at the following
- locations.</p>
+ locations.</p>
<div class="informaltable">
<a name="binary-packages"></a><table border="1">
<colgroup>
@@ -1895,382 +1889,396 @@
</table>
</div>
<p>Most of these directories contain binary packages for
- multiple platforms. Select the appropriate subdirectories,
- according to your machine architecture and operating system,
- until you find a directory called <code class="filename">All</code>. This
- directory contains all the binary packages. Further, there are
- subdirectories for categories that contain symbolic links that
- point to the actual binary package in
- <code class="filename">../All</code>. This directory layout is used for
- all package repositories, no matter if they are accessed via
- HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
+ multiple platforms. Select the appropriate subdirectories,
+ according to your machine architecture and operating system,
+ until you find a directory called <code class="filename">All</code>. This
+ directory contains all the binary packages. Further, there are
+ subdirectories for categories that contain symbolic links that
+ point to the actual binary package in
+ <code class="filename">../All</code>. This directory layout is used for
+ all package repositories, no matter if they are accessed via
+ HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
</div>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
<p>If you have the files on a CD-ROM or downloaded them to
- your hard disk, you can install them with the following command
- (be sure to <span><strong class="command">su</strong></span> to root first):</p>
+ your hard disk, you can install them with the following command
+ (be sure to <span><strong class="command">su</strong></span> to root first):</p>
<pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
<p>If you have FTP access and you don't want to download the
- packages via FTP prior to installation, you can do this
- automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
+ packages via FTP prior to installation, you can do this
+ automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
<pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All/package</code></strong></pre>
<p>Note that any prerequisite packages needed to run the
- package in question will be installed, too, assuming they are
- present where you install from.</p>
+ package in question will be installed, too, assuming they are
+ present where you install from.</p>
<p>To save some typing, you can set the
- <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
- list of paths (including remote URLs); trailing slashes are not allowed.
- </p>
+ <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
+ list of paths (including remote URLs); trailing slashes are not allowed.
+ </p>
<p>Additionally to the <code class="filename">All</code> directory
- there exists a <code class="filename">vulnerable</code> directory to
- which binary packages with known vulnerabilities are
- moved, since removing them could cause missing dependencies. To
- use these packages, add the <code class="filename">vulnerable</code>
- directory to your <code class="varname">PKG_PATH</code>. However, you should run
- <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/audit-packages/README.html"; target="_top"><code class="filename">security/audit-packages</code></a> regularly,
- especially after installing new packages, and verify that the
- vulnerabilities are acceptable for your configuration. An example
- <code class="varname">PKG_PATH</code> would be:
- <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
- Please note that semicolon (';') is a shell meta-character, so
- you'll probably have to quote it.</p>
+ there exists a <code class="filename">vulnerable</code> directory to
+ which binary packages with known vulnerabilities are
+ moved, since removing them could cause missing dependencies. To
+ use these packages, add the <code class="filename">vulnerable</code>
+ directory to your <code class="varname">PKG_PATH</code>. However, you should run
+ <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/audit-packages/README.html"; target="_top"><code class="filename">security/audit-packages</code></a> regularly,
+ especially after installing new packages, and verify that the
+ vulnerabilities are acceptable for your configuration. An example
+ <code class="varname">PKG_PATH</code> would be:
+ <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
+ Please note that semicolon (';') is a shell meta-character, so
+ you'll probably have to quote it.</p>
<p>After you've installed packages, be sure to have
- <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
- <code class="varname">PATH</code> so you can actually start the just
- installed program.</p>
+ <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
+ <code class="varname">PATH</code> so you can actually start the just
+ installed program.</p>
</div>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
<p>To deinstall a package, it does not matter whether it was
- installed from source code or from a binary package. The
- <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
- To delete a package, you can just run <span><strong class="command">pkg_delete
- <em class="replaceable"><code>package-name</code></em></strong></span>. The package
- name can be given with or without version number. Wildcards can
- also be used to deinstall a set of packages, for example
- <code class="literal">*emacs*</code>. Be sure to include them in quotes,
- so that the shell does not expand them before
- <code class="literal">pkg_delete</code> sees them.</p>
+ installed from source code or from a binary package. The
+ <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
+ To delete a package, you can just run <span><strong class="command">pkg_delete
+ <em class="replaceable"><code>package-name</code></em></strong></span>. The package
+ name can be given with or without version number. Wildcards can
+ also be used to deinstall a set of packages, for example
+ <code class="literal">*emacs*</code>. Be sure to include them in quotes,
+ so that the shell does not expand them before
+ <code class="literal">pkg_delete</code> sees them.</p>
<p>The <code class="option">-r</code> option is very powerful: it
- removes all the packages that require the package in question
- and then removes the package itself. For example:
+ removes all the packages that require the package in question
+ and then removes the package itself. For example:
-</p>
+ </p>
<pre class="screen">
- <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
-</pre>
+<code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
+ </pre>
<p>
- will remove jpeg and all the packages that used it; this allows
- upgrading the jpeg package.</p>
+ will remove jpeg and all the packages that used it; this allows
+ upgrading the jpeg package.</p>
</div>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
<p>The <span><strong class="command">pkg_info</strong></span> shows information about
- installed packages or binary package files.</p>
+ installed packages or binary package files.</p>
</div>
<div class="sect2" lang="en">
Home |
Main Index |
Thread Index |
Old Index