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/fd6da8aab78c
branches:  trunk
changeset: 518484:fd6da8aab78c
user:      wiz <wiz%pkgsrc.org@localhost>
date:      Sun Sep 10 19:55:23 2006 +0000

description:
regen

diffstat:

 doc/pkgsrc.html |  5574 +++++++++++++++++++++++++++---------------------------
 doc/pkgsrc.txt  |  1084 ++++++----
 2 files changed, 3484 insertions(+), 3174 deletions(-)

diffs (truncated from 9217 to 300 lines):

diff -r 2563938236d6 -r fd6da8aab78c doc/pkgsrc.html
--- a/doc/pkgsrc.html   Sun Sep 10 19:51:49 2006 +0000
+++ b/doc/pkgsrc.html   Sun Sep 10 19:55:23 2006 +0000
@@ -307,34 +307,44 @@
 <dt><span class="sect2"><a href="#using-libtool">17.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
 <dt><span class="sect2"><a href="#autoconf-automake">17.3.3. GNU Autoconf/Automake</a></span></dt>
 </dl></dd>
-<dt><span class="sect1"><a href="#fixes.build">17.4. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#fixes.build.cpp">17.4.1. Compiling C and C++ code conditionally</a></span></dt>
-<dt><span class="sect2"><a href="#compiler-bugs">17.4.2. How to handle compiler bugs</a></span></dt>
-<dt><span class="sect2"><a href="#undefined-reference">17.4.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
-</dl></dd>
-<dt><span class="sect1"><a href="#fixes.install">17.5. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#install-scripts">17.5.1. Creating needed directories</a></span></dt>
-<dt><span class="sect2"><a href="#where-to-install-documentation">17.5.2. Where to install documentation</a></span></dt>
-<dt><span class="sect2"><a href="#installing-score-files">17.5.3. Installing score files</a></span></dt>
-<dt><span class="sect2"><a href="#perl-scripts">17.5.4. Packages containing perl scripts</a></span></dt>
-<dt><span class="sect2"><a href="#hardcoded-paths">17.5.5. Packages with hardcoded paths to other interpreters</a></span></dt>
-<dt><span class="sect2"><a href="#perl-modules">17.5.6. Packages installing perl modules</a></span></dt>
-<dt><span class="sect2"><a href="#faq.info-files">17.5.7. Packages installing info files</a></span></dt>
-<dt><span class="sect2"><a href="#manpages">17.5.8. Packages installing man pages</a></span></dt>
-<dt><span class="sect2"><a href="#gconf2-data-files">17.5.9. Packages installing GConf2 data files</a></span></dt>
-<dt><span class="sect2"><a href="#scrollkeeper-data-files">17.5.10. Packages installing scrollkeeper data files</a></span></dt>
-<dt><span class="sect2"><a href="#x11-fonts">17.5.11. Packages installing X11 fonts</a></span></dt>
-<dt><span class="sect2"><a href="#gtk2-modules">17.5.12. Packages installing GTK2 modules</a></span></dt>
-<dt><span class="sect2"><a href="#sgml-xml-data">17.5.13. Packages installing SGML or XML data</a></span></dt>
-<dt><span class="sect2"><a href="#mime-database">17.5.14. Packages installing extensions to the MIME database</a></span></dt>
-<dt><span class="sect2"><a href="#intltool">17.5.15. Packages using intltool</a></span></dt>
-<dt><span class="sect2"><a href="#startup-scripts">17.5.16. Packages installing startup scripts</a></span></dt>
-<dt><span class="sect2"><a href="#tex-packages">17.5.17. Packages installing TeX modules</a></span></dt>
-<dt><span class="sect2"><a href="#hicolor-theme">17.5.18. Packages installing hicolor theme icons</a></span></dt>
-<dt><span class="sect2"><a href="#desktop-files">17.5.19. Packages installing desktop files</a></span></dt>
-</dl></dd>
+<dt><span class="sect1"><a href="#programming-languages">17.4. Programming languages</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#basic-programming-languages">17.4.1. C, C++, and Fortran</a></span></dt>
+<dt><span class="sect2"><a href="#java-programming-language">17.4.2. Java</a></span></dt>
+<dt><span class="sect2"><a href="#perl-scripts">17.4.3. Packages containing perl scripts</a></span></dt>
+<dt><span class="sect2"><a href="#other-programming-languages">17.4.4. Other programming languages</a></span></dt>
+</dl></dd>
+<dt><span class="sect1"><a href="#fixes.build">17.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#fixes.build.cpp">17.5.1. Compiling C and C++ code conditionally</a></span></dt>
+<dt><span class="sect2"><a href="#compiler-bugs">17.5.2. How to handle compiler bugs</a></span></dt>
+<dt><span class="sect2"><a href="#undefined-reference">17.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
+<dt><span class="sect2"><a href="#out-of-memory">17.5.4. Running out of memory</a></span></dt>
+</dl></dd>
+<dt><span class="sect1"><a href="#fixes.install">17.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#install-scripts">17.6.1. Creating needed directories</a></span></dt>
+<dt><span class="sect2"><a href="#where-to-install-documentation">17.6.2. Where to install documentation</a></span></dt>
+<dt><span class="sect2"><a href="#installing-score-files">17.6.3. Installing score files</a></span></dt>
+<dt><span class="sect2"><a href="#hardcoded-paths">17.6.4. Packages with hardcoded paths to other interpreters</a></span></dt>
+<dt><span class="sect2"><a href="#perl-modules">17.6.5. Packages installing perl modules</a></span></dt>
+<dt><span class="sect2"><a href="#faq.info-files">17.6.6. Packages installing info files</a></span></dt>
+<dt><span class="sect2"><a href="#manpages">17.6.7. Packages installing man pages</a></span></dt>
+<dt><span class="sect2"><a href="#gconf2-data-files">17.6.8. Packages installing GConf2 data files</a></span></dt>
+<dt><span class="sect2"><a href="#scrollkeeper-data-files">17.6.9. Packages installing scrollkeeper data files</a></span></dt>
+<dt><span class="sect2"><a href="#x11-fonts">17.6.10. Packages installing X11 fonts</a></span></dt>
+<dt><span class="sect2"><a href="#gtk2-modules">17.6.11. Packages installing GTK2 modules</a></span></dt>
+<dt><span class="sect2"><a href="#sgml-xml-data">17.6.12. Packages installing SGML or XML data</a></span></dt>
+<dt><span class="sect2"><a href="#mime-database">17.6.13. Packages installing extensions to the MIME database</a></span></dt>
+<dt><span class="sect2"><a href="#intltool">17.6.14. Packages using intltool</a></span></dt>
+<dt><span class="sect2"><a href="#startup-scripts">17.6.15. Packages installing startup scripts</a></span></dt>
+<dt><span class="sect2"><a href="#tex-packages">17.6.16. Packages installing TeX modules</a></span></dt>
+<dt><span class="sect2"><a href="#emulation-packages">17.6.17. Packages supporting running binaries in
+    emulation</a></span></dt>
+<dt><span class="sect2"><a href="#hicolor-theme">17.6.18. Packages installing hicolor theme icons</a></span></dt>
+<dt><span class="sect2"><a href="#desktop-files">17.6.19. Packages installing desktop files</a></span></dt>
+</dl></dd>
+<dt><span class="sect1"><a href="#punting">17.7. Marking packages as having problems</a></span></dt>
 </dl></dd>
 <dt><span class="chapter"><a href="#debug">18. Debugging</a></span></dt>
 <dt><span class="chapter"><a href="#submit">19. Submitting and Committing</a></span></dt>
@@ -636,13 +646,11 @@
             pkgsrc. Packages are traditionally stored under
            <code class="filename">/usr/pkgsrc</code>.</p></dd>
 <dt><span class="term">The NetBSD package system</span></dt>
-<dd><p>
-           This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It is
-           part of the NetBSD operating system and can be bootstrapped to
-           run on non-NetBSD operating systems as well.  It handles
-           building (compiling), installing, and removing of
-           packages.
-           </p></dd>
+<dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
+         is part of the NetBSD operating system and can be bootstrapped
+         to run on non-NetBSD operating systems as well.  It handles
+         building (compiling), installing, and removing of
+         packages.</p></dd>
 <dt><span class="term">Distfile</span></dt>
 <dd><p>This term describes the file or files that are
            provided by the author of the piece of software to
@@ -1226,27 +1234,28 @@
 <pre class="screen">
 <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs%anoncvs.NetBSD.org@localhost:/cvsroot checkout pkgsrc</code></strong>
 <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>
+<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
-      pkgsrc before bootstrapping. The given
-      <span><strong class="command">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
-      directory where pkgsrc will do its internal bookkeeping.
-      However, these can also be set using command-line
-      arguments.</p>
+    pkgsrc before bootstrapping. The given
+    <span><strong class="command">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
+    directory where pkgsrc will do its internal bookkeeping.
+    However, these can also be set using command-line
+    arguments.</p>
 <p>Binary packages for the pkgsrc tools and an initial set of packages is
-      available for supported platforms. An up-to-date list of these can be
-      found on <a href="http://www.pkgsrc.org/"; target="_top">www.pkgsrc.org</a>.
-      Note that this only works for privileged builds that install
-      into <code class="filename">/usr/pkg</code>.</p>
+    available for supported platforms. An up-to-date list of these can be
+    found on <a href="http://www.pkgsrc.org/"; target="_top">www.pkgsrc.org</a>.
+    Note that this only works for privileged builds that install
+    into <code class="filename">/usr/pkg</code>.</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>
-       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
+      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>
+      instead of &#8220;<span class="quote">make</span>&#8221;.</p>
 </div>
 </div>
 <div class="sect1" lang="en">
@@ -1261,14 +1270,14 @@
          image</a>, or a <a href="#platform.osx-ufs" title="3.3.1.2. Using a UFS partition">UFS
          partition</a>.</p>
 <p>Before you start, you will need to download and install the Mac OS X Developer
-       Tools from Apple's Developer Connection.  See <a href="http://developer.apple.com/macosx/"; target="_top">http://developer.apple.com/macosx/</a>
-       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
-       from <a href="http://www.apple.com/macosx/x11/download/"; target="_top">http://www.apple.com/macosx/x11/download/</a>
-       if you intend to build packages that use the X11 Window System.</p>
+      Tools from Apple's Developer Connection.  See <a href="http://developer.apple.com/macosx/"; target="_top">http://developer.apple.com/macosx/</a>
+      for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
+      from <a href="http://www.apple.com/macosx/x11/download/"; target="_top">http://www.apple.com/macosx/x11/download/</a>
+      if you intend to build packages that use the X11 Window System.</p>
 <p>If you already have a UFS partition, or have a spare partition
-       that you can format as UFS, it is recommended to use that instead of
-       the disk image. It'll be somewhat faster and will mount automatically
-       at boot time, where you must manually mount a disk image.</p>
+      that you can format as UFS, it is recommended to use that instead of
+      the disk image. It'll be somewhat faster and will mount automatically
+      at boot time, where you must manually mount a disk image.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 <h3 class="title">Note</h3>
 <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
@@ -1293,80 +1302,81 @@
 <div class="titlepage"><div><div><h4 class="title">
 <a name="platform.osx-ufs"></a>3.3.1.2. Using a UFS partition</h4></div></div></div>
 <p>By default, <code class="filename">/usr</code> will be on your root file
-         system, normally HFS+. It is possible to use the default
-         <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
-         by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
-         file system. Obviously, another symlink is required if you want to
-         place the package database directory outside the
-         <span class="emphasis"><em>prefix</em></span>. e.g.</p>
+       system, normally HFS+. It is possible to use the default
+       <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
+       by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
+       file system. Obviously, another symlink is required if you want to
+       place the package database directory outside the
+       <span class="emphasis"><em>prefix</em></span>. e.g.</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
 <p>If you created your partitions at the time of installing Mac OS X
-         and formatted the target partition as UFS, it should automatically
-         mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
-         machine boots. If you are (re)formatting a partition as UFS, you need
-         to ensure that the partition map correctly reflects
-         &#8220;<span class="quote">Apple_UFS</span>&#8221; and not &#8220;<span class="quote">Apple_HFS</span>&#8221;.</p>
+       and formatted the target partition as UFS, it should automatically
+       mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
+       machine boots. If you are (re)formatting a partition as UFS, you need
+       to ensure that the partition map correctly reflects
+       &#8220;<span class="quote">Apple_UFS</span>&#8221; and not &#8220;<span class="quote">Apple_HFS</span>&#8221;.</p>
 <p>The problem is that none of the disk tools will let you touch a
-         disk that is booted from. You can unmount the partition, but even if
-         you newfs it, the partition type will be incorrect and the
-         automounter won't mount it. It can be mounted manually, but it won't
-         appear in Finder.</p>
+       disk that is booted from. You can unmount the partition, but even if
+       you newfs it, the partition type will be incorrect and the
+       automounter won't mount it. It can be mounted manually, but it won't
+       appear in Finder.</p>
 <p>You'll need to boot off of the OS X Installation (User) CD.  When
-         the Installation program starts, go up to the menu and select Disk
-         Utility.  Now, you will be able to select the partition you want
-         to be UFS, and Format it Apple UFS. Quit the Disk Utility, quit the
-         installer which will reboot your machine. The new UFS file system
-         will appear in Finder.</p>
+       the Installation program starts, go up to the menu and select Disk
+       Utility.  Now, you will be able to select the partition you want
+       to be UFS, and Format it Apple UFS. Quit the Disk Utility, quit the
+       installer which will reboot your machine. The new UFS file system
+       will appear in Finder.</p>
 <p>Be aware that the permissions on the new file system will be writable
-         by root only.</p>
+       by root only.</p>
 <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
-         Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
+       Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
 </div>
 </div>
 <div class="sect2" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
-<p>
-       FreeBSD 4.7 and 5.0 have been tested and are supported, other versions
-       may work.</p>
+<p>FreeBSD 4.7 and 5.0 have been tested and are supported,
+      other versions may work.</p>
 <p>Care should be taken so that the tools that this kit installs do not conflict
-       with the FreeBSD userland tools. There are several steps:</p>
+      with the FreeBSD userland tools. There are several steps:</p>
 <div class="orderedlist"><ol type="1">
 <li><p>FreeBSD stores its ports pkg database in
-           <code class="filename">/var/db/pkg</code>. It is therefore
-           recommended that you choose a different location (e.g.
-           <code class="filename">/usr/pkgdb</code>) by
-           using the --pkgdbdir option to the bootstrap script.</p></li>
+         <code class="filename">/var/db/pkg</code>. It is therefore
+         recommended that you choose a different location (e.g.
+         <code class="filename">/usr/pkgdb</code>) by
+         using the --pkgdbdir option to the bootstrap script.</p></li>
 <li>
 <p>If you do not intend to use the FreeBSD ports tools, it's probably a
-           good idea to move them out of the way to avoid confusion, e.g.</p>
-<pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
+         good idea to move them out of the way to avoid confusion, e.g.</p>
+<pre class="screen">
+<code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
-<code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong></pre>
+<code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
+         </pre>
 </li>
 <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
-           <code class="filename">/etc/mk.conf.example</code> file
-           when you use the bootstrap script.</p></li>
+         <code class="filename">/etc/mk.conf.example</code> file
+         when you use the bootstrap script.</p></li>
 </ol></div>
 </div>
 <div class="sect2" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
 <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
-       providing a Unix-like environment with a tighter kernel integration than
-       available with Cygwin.  It is part of the Windows Services for Unix
-       package, available for free for any licensed copy of Windows 2000, XP
-       (not including XP Home), or 2003.  SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/"; target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
+      providing a Unix-like environment with a tighter kernel integration than
+      available with Cygwin.  It is part of the Windows Services for Unix
+      package, available for free for any licensed copy of Windows 2000, XP
+      (not including XP Home), or 2003.  SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/"; target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
 <p>Services for Unix 3.5, current as of this writing, has been tested.  3.0
-       or 3.1 may work, but are not officially supported.  (The main difference
-       in 3.0/3.1 is lack of pthreads.)</p>
+      or 3.1 may work, but are not officially supported.  (The main difference
+      in 3.0/3.1 is lack of pthreads.)</p>
 <div class="sect3" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
 <p>At an absolute minimum, the following packages must be installed from
-         the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
+       the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
 <div class="itemizedlist"><ul type="disc">
 <li><p>Utilities -&gt; Base Utilities</p></li>
 <li><p>Interix GNU Components -&gt; (all)</p></li>
@@ -1374,43 +1384,43 @@
 <li><p>Interix SDK</p></li>
 </ul></div>
 <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
-         "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
-         /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
-         pkgsrc (or from a binary package).</p>
+       "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
+       /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
+       pkgsrc (or from a binary package).</p>
 <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
-         not need to be installed, but Remote Connectivity itself should be
-         installed in order to have a working inetd.</p>
+       not need to be installed, but Remote Connectivity itself should be



Home | Main Index | Thread Index | Old Index