pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc regen
details: https://anonhg.NetBSD.org/pkgsrc/rev/4d6210417d80
branches: trunk
changeset: 535729:4d6210417d80
user: hubertf <hubertf%pkgsrc.org@localhost>
date: Mon Nov 26 23:22:50 2007 +0000
description:
regen
diffstat:
doc/pkgsrc.html | 932 ++++++++++++++++++++++++++++---------------------------
doc/pkgsrc.txt | 5 +-
2 files changed, 470 insertions(+), 467 deletions(-)
diffs (truncated from 3270 to 300 lines):
diff -r 7f2244237651 -r 4d6210417d80 doc/pkgsrc.html
--- a/doc/pkgsrc.html Mon Nov 26 23:16:03 2007 +0000
+++ b/doc/pkgsrc.html Mon Nov 26 23:22:50 2007 +0000
@@ -18,13 +18,13 @@
<h3 class="author">
<span class="firstname">Alistair</span> <span class="surname">Crooks</span>
</h3>
-<div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:agc%NetBSD.org@localhost";>agc%NetBSD.org@localhost</a>></code></p></div></div>
+<div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc%NetBSD.org@localhost";>agc%NetBSD.org@localhost</a>></code></p></div></div>
</div>
<div class="author">
<h3 class="author">
<span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
</h3>
-<div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:hubertf%NetBSD.org@localhost";>hubertf%NetBSD.org@localhost</a>></code></p></div></div>
+<div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf%NetBSD.org@localhost";>hubertf%NetBSD.org@localhost</a>></code></p></div></div>
</div>
<h3 class="corpauthor">
The pkgsrc Developers
@@ -163,7 +163,7 @@
<dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
<dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
<dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
-<dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
+<dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
<dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
<dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
/usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
@@ -228,7 +228,7 @@
<dd><dl>
<dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
<dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
-<dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
+<dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
<dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
<dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
<dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
@@ -442,7 +442,7 @@
<dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
<dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
<dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
-<dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
+<dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
</dl></dd>
@@ -562,14 +562,14 @@
<p>The following principles are basic to pkgsrc:</p>
<div class="itemizedlist"><ul type="disc">
<li><p>“<span class="quote">It should only work if it's right.</span>”
-— That means, if a package contains bugs, it's better to find
+— That means, if a package contains bugs, it's better to find
them and to complain about them rather than to just install the package
and hope that it works. There are numerous checks in pkgsrc that try to
find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html"; target="_top"><code class="filename">pkgtools/pkglint</code></a>),
build-time checks (portability
of shell scripts), and post-installation checks (installed files,
references to shared libraries, script interpreters).</p></li>
<li><p>“<span class="quote">If it works, it should work everywhere</span>”
-— Like NetBSD has been ported to many hardware architectures,
+— Like NetBSD has been ported to many hardware architectures,
pkgsrc has been ported to many operating systems. Care is taken that
packages behave the same on all platforms.</p></li>
</ul></div>
@@ -597,34 +597,34 @@
</tr></thead>
<tbody>
<tr>
-<td><a href="http://www.NetBSD.org/"; target="_top">NetBSD</a></td>
+<td><a class="ulink" href="http://www.NetBSD.org/"; target="_top">NetBSD</a></td>
<td align="center">Aug 1997</td>
</tr>
<tr>
-<td><a href="http://wwws.sun.com/software/solaris/"; target="_top">Solaris</a></td>
+<td><a class="ulink" href="http://wwws.sun.com/software/solaris/"; target="_top">Solaris</a></td>
<td align="center">Mar 1999</td>
</tr>
<tr>
-<td><a href="http://www.kernel.org/"; target="_top">Linux</a></td>
+<td><a class="ulink" href="http://www.kernel.org/"; target="_top">Linux</a></td>
<td align="center">Jun 1999</td>
</tr>
<tr>
<td>
- <a href="http://developer.apple.com/darwin/"; target="_top">Darwin</a>
- (<a href="http://developer.apple.com/macosx/"; target="_top">Mac OS X</a>)
+ <a class="ulink" href="http://developer.apple.com/darwin/"; target="_top">Darwin</a>
+ (<a class="ulink" href="http://developer.apple.com/macosx/"; target="_top">Mac OS X</a>)
</td>
<td align="center">Oct 2001</td>
</tr>
<tr>
-<td><a href="http://www.freebsd.org/"; target="_top">FreeBSD</a></td>
+<td><a class="ulink" href="http://www.freebsd.org/"; target="_top">FreeBSD</a></td>
<td align="center">Nov 2002</td>
</tr>
<tr>
-<td><a href="http://www.openbsd.org/"; target="_top">OpenBSD</a></td>
+<td><a class="ulink" href="http://www.openbsd.org/"; target="_top">OpenBSD</a></td>
<td align="center">Nov 2002</td>
</tr>
<tr>
-<td><a href="http://www.sgi.com/software/irix/"; target="_top">IRIX</a></td>
+<td><a class="ulink" href="http://www.sgi.com/software/irix/"; target="_top">IRIX</a></td>
<td align="center">Dec 2002</td>
</tr>
<tr>
@@ -632,26 +632,26 @@
<td align="center">Dec 2003</td>
</tr>
<tr>
-<td><a href="http://www-1.ibm.com/servers/aix/"; target="_top">AIX</a></td>
+<td><a class="ulink" href="http://www-1.ibm.com/servers/aix/"; target="_top">AIX</a></td>
<td align="center">Dec 2003</td>
</tr>
<tr>
<td>
- <a href="http://www.microsoft.com/windows/sfu/"; target="_top">Interix</a>
+ <a class="ulink" href="http://www.microsoft.com/windows/sfu/"; target="_top">Interix</a>
(Microsoft Windows Services for Unix)
</td>
<td align="center">Mar 2004</td>
</tr>
<tr>
-<td><a href="http://www.dragonflybsd.org/"; target="_top">DragonFlyBSD</a></td>
+<td><a class="ulink" href="http://www.dragonflybsd.org/"; target="_top">DragonFlyBSD</a></td>
<td align="center">Oct 2004</td>
</tr>
<tr>
-<td><a href="http://www.tru64.org/"; target="_top">OSF/1</a></td>
+<td><a class="ulink" href="http://www.tru64.org/"; target="_top">OSF/1</a></td>
<td align="center">Nov 2004</td>
</tr>
<tr>
-<td><a href="http://www.hp.com/products1/unix/"; target="_top">HP-UX</a></td>
+<td><a class="ulink" href="http://www.hp.com/products1/unix/"; target="_top">HP-UX</a></td>
<td align="center">Apr 2007</td>
</tr>
</tbody>
@@ -664,18 +664,18 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="overview"></a>1.2. Overview</h2></div></div></div>
<p>This document is divided into three parts. The first,
- <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
+ <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
describes how one can use one of the packages in the Package
Collection, either by installing a precompiled binary package,
or by building one's own copy using the NetBSD package system.
- The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
+ The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
package so it can be easily built by other NetBSD users without
knowing about the package's building details. The third part,
- <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
+ <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
is intended for those who want to understand how pkgsrc is
implemented.</p>
<p>This document is available in various formats:
- <span class="simplelist"><a href="index.html" target="_top">HTML</a>, <a href="pkgsrc.pdf" target="_top">PDF</a>, <a href="pkgsrc.ps" target="_top">PS</a>, <a href="pkgsrc.txt"
target="_top">TXT</a></span>.</p>
+ <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps"
target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
</div>
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -718,7 +718,7 @@
machine architecture without the need to
recompile. Packages are usually generated in
<code class="filename">/usr/pkgsrc/packages</code>; there is also
- an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/"; target="_top">ftp.NetBSD.org</a>.</p>
+ an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/"; target="_top">ftp.NetBSD.org</a>.</p>
<p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
especially in the context of precompiled packages.</p>
</dd>
@@ -741,16 +741,16 @@
<p>There are two kinds of pkgsrc users: Some only want to
install pre-built binary packages. Others build the pkgsrc
packages from source, either for installing them directly or for
- building binary packages themselves. For pkgsrc users <a href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all
necessary
+ building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should
provide all necessary
documentation.</p>
</dd>
<dt><span class="term">package maintainers</span></dt>
<dd><p>A
- package maintainer creates packages as described in <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
+ package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's
guide”</a>.</p></dd>
<dt><span class="term">infrastructure developers</span></dt>
<dd><p>These people are involved in all those files
that live in the <code class="filename">mk/</code> directory and below.
- Only these people should need to read through <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>,
though others might be curious,
+ Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure
internals”</a>, though others might be curious,
too.</p></dd>
</dl></div>
</div>
@@ -874,7 +874,7 @@
<dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
<dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
<dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
-<dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
+<dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
<dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
<dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
/usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
@@ -932,17 +932,17 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
<p>The primary download location for all pkgsrc files is
- <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/"; target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
+ <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/"; target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
number of subdirectories for different purposes, which are
- described in detail in <a href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
+ described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
<p>The tar file for the current branch is in the directory
- <code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz"; target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
+ <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz"; target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
It is autogenerated daily.</p>
<p>The tar file for the stable branch 2007Q1 is in the
- directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q1/pkgsrc-2007Q1.tar.gz"; target="_top"><code
class="filename">pkgsrc-2007Q1.tar.gz</code></a>.</p>
+ directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q1/pkgsrc-2007Q1.tar.gz"; target="_top"><code
class="filename">pkgsrc-2007Q1.tar.gz</code></a>.</p>
<p>After downloading the tar file, change to the directory
where you want to have pkgsrc. This is usually
- <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
+ <code class="filename">/usr</code>. Then, run <span class="command"><strong>gzcat
pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
</div>
<div class="sect2" lang="en">
@@ -961,13 +961,13 @@
in it, see the examples in
<code class="filename">/usr/share/examples/supfiles</code>, and that the
<code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
- run <span><strong class="command">sup -v
+ run <span class="command"><strong>sup -v
<em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
</div>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
-<p>To get pkgsrc via CVS, make sure you have <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current";><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
+<p>To get pkgsrc via CVS, make sure you have <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current";><span class="citerefentry"><span
class="refentrytitle">cvs</span>(1)</span></a>
installed. To do an initial (full) checkout of pkgsrc, you first
have to set some environment variables. For the C-Shell,
type:</p>
@@ -1001,8 +1001,8 @@
<p>Then, you change to the directory where you want to have
your copy of pkgsrc. In most cases this is
<code class="filename">/usr</code>. In that directory you run the
- checkout command, which is <span><strong class="command">cvs -q checkout -P
- pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
+ checkout command, which is <span class="command"><strong>cvs -q checkout -P
+ pkgsrc</strong></span> for the current branch and <span class="command"><strong>cvs -q
checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
branch. This command will create a directory called
<code class="filename">pkgsrc</code> with all the pkgsrc files in
@@ -1034,7 +1034,7 @@
before updating. You can also configure pkgsrc to use other than
the default directories by setting the
<code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
- variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
+ variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
<p>To update pkgsrc from a tar file, download the tar file as
explained above. Then, make sure that you have not made any
changes to the files in the pkgsrc directory. Remove the pkgsrc
@@ -1045,7 +1045,7 @@
<a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
<p>To update pkgsrc via CVS, make sure the environment
variable <code class="varname">CVS_RSH</code> is set as above. Then,
- change to the pkgsrc directory and run <span><strong class="command">cvs -q update
+ change to the pkgsrc directory and run <span class="command"><strong>cvs -q update
-dP</strong></span>.</p>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
@@ -1095,7 +1095,7 @@
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
-<p>See <a href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
+<p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
</div>
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -1106,9 +1106,9 @@
<code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
<code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
</pre>
-<p>See <a href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
+<p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to
get
pkgsrc before bootstrapping. The given
- <span><strong class="command">bootstrap</strong></span> command will use the defaults of
+ <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
<code class="filename">/usr/pkg</code> for the
<span class="emphasis"><em>prefix</em></span> where programs will be installed in,
and <code class="filename">/var/db/pkg</code> for the package database
@@ -1117,9 +1117,9 @@
arguments.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-<p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
- Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
- For examples in this guide, use <span><strong class="command">bmake</strong></span>
+<p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
+ Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
+ For examples in this guide, use <span class="command"><strong>bmake</strong></span>
instead of “<span class="quote">make</span>”.</p>
</div>
Home |
Main Index |
Thread Index |
Old Index