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/79737fb18e32
branches:  trunk
changeset: 356890:79737fb18e32
user:      sevan <sevan%pkgsrc.org@localhost>
date:      Sat Jan 07 04:54:05 2017 +0000

description:
regen

diffstat:

 doc/pkgsrc.html |  94 +++++++++++++++++++++++++++-----------------------------
 doc/pkgsrc.txt  |  75 ++++++++++++++++++++++-----------------------
 2 files changed, 83 insertions(+), 86 deletions(-)

diffs (truncated from 522 to 300 lines):

diff -r 520f777cf482 -r 79737fb18e32 doc/pkgsrc.html
--- a/doc/pkgsrc.html   Sat Jan 07 04:50:50 2017 +0000
+++ b/doc/pkgsrc.html   Sat Jan 07 04:54:05 2017 +0000
@@ -77,7 +77,6 @@
 <dd><dl>
 <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
 <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
-<dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
 </dl></dd>
 <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
 <dd><dl>
@@ -593,8 +592,7 @@
 </tr>
 <tr>
 <td>
-          <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>)
+          <a class="ulink" href="https://developer.apple.com/macos/"; target="_top">Darwin / Mac OS X / OS X / macOS</a>
         </td>
 <td align="center">Oct 2001</td>
 <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX"; target="_top">README.MacOSX</a></td>
@@ -815,7 +813,6 @@
 <dd><dl>
 <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
 <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
-<dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
 </dl></dd>
 <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
 <dd><dl>
@@ -928,7 +925,7 @@
        quarterly basis from the current branch and only gets modified
        for security updates. The names of the stable branches are built
        from the year and the quarter, for example
-       <code class="literal">2014Q3</code>.</p>
+       <code class="literal">2016Q4</code>.</p>
 <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
        want to download pkgsrc. You can get it as a tar file or via CVS.
        Both ways are described here.</p>
@@ -945,7 +942,7 @@
        which are 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 archive for the current branch is in the directory
        <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz"; target="_top"><code 
class="filename">pkgsrc.tar.gz</code></a>.
-       It is autogenerated daily.</p>
+       It is autogenerated weekly.</p>
 <p>To save download time we provide bzip2- and
        xz-compressed archives which are published at
        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2"; target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
@@ -954,14 +951,14 @@
        respectively.
        </p>
 <p>You can fetch the same files using FTP.</p>
-<p>The tar file for the stable branch 2014Q3 is in the
-       directory <code class="filename">pkgsrc-2014Q3</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2014Q3/pkgsrc.tar.gz"; target="_top"><code 
class="filename">pkgsrc.tar.gz</code></a>.</p>
+<p>The tar file for the stable branch 2016Q4 is in the
+       directory <code class="filename">pkgsrc-2016Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2016Q4/pkgsrc.tar.gz"; target="_top"><code 
class="filename">pkgsrc.tar.gz</code></a>.</p>
 <p>To download a pkgsrc stable tarball, run:</p>
 <pre class="screen">
 <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
 <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
        stable branch to be downloaded, for example, 
-       <span class="quote">&#8220;<span class="quote">pkgsrc-2014Q3</span>&#8221;</span>.</p>
+       <span class="quote">&#8220;<span class="quote">pkgsrc-2016Q4</span>&#8221;</span>.</p>
 <p>If you prefer, you can also fetch it using "wget", "curl",
        or your web browser.</p>
 <p>Then, extract it with:</p>
@@ -979,7 +976,7 @@
 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs%anoncvs.NetBSD.org@localhost:/cvsroot checkout -r <em 
class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
 </pre>
 <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
-       branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2014Q3</span>&#8221;</span></p>
+       branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2016Q4</span>&#8221;</span></p>
 <p>This will create the directory <code class="filename">pkgsrc/</code> 
        in your <code class="filename">/usr/</code> directory and all the package source 
        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
@@ -1063,7 +1060,7 @@
        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
        back to the stable branch, add the
-       <span class="quote">&#8220;<span class="quote">-rpkgsrc-2014Q3</span>&#8221;</span> option.</p>
+       <span class="quote">&#8220;<span class="quote">-rpkgsrc-2016Q4</span>&#8221;</span> option.</p>
 </div>
 <div class="sect3">
 <div class="titlepage"><div><div><h4 class="title">
@@ -1087,7 +1084,6 @@
 <dl class="toc">
 <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
 <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
-<dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
 </dl>
 </div>
 <div class="sect1">
@@ -1114,13 +1110,13 @@
 <p>By default, in privileged mode pkgsrc uses
     <code class="filename">/usr/pkg</code> for <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
+    and <code class="filename">/usr/pkg/pkgdb</code> for the package database
     directory where pkgsrc will do its internal bookkeeping,
     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
     where packages install their persistent data.
     In unprivileged mode pkgsrc uses
     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
-    <code class="filename">~/pkg/var/db/pkg</code> for the package database,
+    <code class="filename">~/pkg/pkgdb</code> for the package database,
     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
     </p>
 <p>You can change default layout using command-line arguments.
@@ -1142,12 +1138,6 @@
       </p>
 </div>
 </div>
-<div class="sect1">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
-<p>For platform-specific notes consult the <code class="filename">README</code>
-    files found in the notes column of <a class="xref" href="#supported-platforms" title="Table 1.1. Platforms supported by pkgsrc">Table 1.1, &#8220;Platforms supported by pkgsrc&#8221;</a></p>
-</div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
@@ -1211,8 +1201,7 @@
     operating system already provides those tools. Download the file and
     extract it in the <code class="filename">/</code> directory. It will create
     the directories <code class="filename">/usr/pkg</code> (containing the tools
-    for managing binary packages) and <code class="filename">/var/db/pkg</code>
-    (the database of installed packages).</p>
+    for managing binary packages and the database of installed packages).</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
@@ -1238,9 +1227,9 @@
 <p>After these preparations, installing a package is very
     easy:</p>
 <pre class="screen">
-<code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
+<code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
-<code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
+<code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
 </pre>
 <p>Note that any prerequisite packages needed to run the
     package in question will be installed, too, assuming they are
@@ -1321,20 +1310,31 @@
       </p>
 <pre class="screen">
 # download vulnerabilities file
-0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
+0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
+# audit the installed packages and email results to root
+9 3 * * * /usr/pkg/sbin/pkg_admin auit |mail -s "Installed package audit result" root &gt;/dev/null 2&gt;&amp;1
       </pre>
 <p>
-      will update the vulnerability list every day at 3AM. You may wish to do
-      this more often than once a day.
+      will update the vulnerability list every day at 3AM, followed by an audit
+      at 3:09AM. The result of the audit are then emailed to root.
 
-      In addition, you may wish to run the package audit from the daily
-      security script.  This may be accomplished by adding the following
-      line to <code class="filename">/etc/security.local</code>:
+      On NetBSD this may be accomplished instead by adding the following
+      line to <code class="filename">/etc/daily.conf</code>:
       </p>
 <pre class="screen">
-/usr/sbin/pkg_admin audit
+fetch_pkg_vulnerabilities=YES
       </pre>
 <p>
+      to fetch the vulnerability list from the daily security script. The system
+      is set to audit the packages by default but can be set explicitly, if
+      desired (not required), by adding the follwing line to
+<code class="filename">/etc/security.conf</code>:
+      </p>
+<pre class="screen">
+check_pkg_vulnerabilities=YES
+      </pre>
+<p>
+      see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5+NetBSD-5.0.1+i386";><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> 
and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5+NetBSD-5.0.1+i386";><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for 
more details.
     </p>
 </div>
 <div class="sect2">
@@ -1627,7 +1627,7 @@
            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
 <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
            database about installed packages is stored.  The default is
-           <code class="filename">/var/db/pkg</code>.</p></li>
+           <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
 <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
            If set, override the packages'
            <code class="varname">MASTER_SITES</code> with this value.</p></li>
@@ -1636,10 +1636,8 @@
            if not found locally or in
            <code class="filename">${MASTER_SITES}</code> or
            <code class="filename">${PATCH_SITES}</code> respectively.
-           The defaults are
-           <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
-           and
-           <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
+           The defaults is
+           <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
 <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
            <em class="replaceable"><code>arch</code></em> are replaced with OS
@@ -1798,7 +1796,7 @@
 <li class="listitem"><p><code class="varname">sunpro</code>:
            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
 <li class="listitem"><p><code class="varname">xlc</code>:
-           IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
+           IBM's XL C/C++ compiler suite</p></li>
 </ul></div>
 <p>The default is
          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
@@ -2081,7 +2079,7 @@
 <p>Or any other way that fits (e.g., curl, wget).</p>
 <p>Deploy and configure pbulk tools, e.g.:</p>
 <pre class="screen">
-<code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
+<code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
 </pre>
@@ -8831,7 +8829,7 @@
        and if you still don't have the answer, ask on the
        <code class="literal">pkgsrc-users</code> mailing list.</p>
 <div class="qandaset">
-<a name="idp140723587338736"></a><dl>
+<a name="idp140382928609984"></a><dl>
 <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
        MAKEFLAGS, .MAKEFLAGS and
        MAKE_FLAGS?</a>
@@ -8876,7 +8874,7 @@
 <tbody>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.makeflags"></a><a name="idp140723587339392"></a><p><b>22.1.</b></p>
+<a name="devfaq.makeflags"></a><a name="idp140382928610688"></a><p><b>22.1.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
@@ -8892,7 +8890,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.make"></a><a name="idp140723587343856"></a><p><b>22.2.</b></p>
+<a name="devfaq.make"></a><a name="idp140382928615152"></a><p><b>22.2.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
@@ -8910,7 +8908,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.cc"></a><a name="idp140723587348864"></a><p><b>22.3.</b></p>
+<a name="devfaq.cc"></a><a name="idp140382928620160"></a><p><b>22.3.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
@@ -8928,7 +8926,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.bl3flags"></a><a name="idp140723587353776"></a><p><b>22.4.</b></p>
+<a name="devfaq.bl3flags"></a><a name="idp140382928625024"></a><p><b>22.4.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
        <code class="varname">BUILDLINK_LDFLAGS</code>,
@@ -8941,7 +8939,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.bl3prefix"></a><a name="idp140723587356352"></a><p><b>22.5.</b></p>
+<a name="devfaq.bl3prefix"></a><a name="idp140382928627600"></a><p><b>22.5.</b></p>
 </td>
 <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
@@ -8957,7 +8955,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.master_sites"></a><a name="idp140723587360272"></a><p><b>22.6.</b></p>
+<a name="devfaq.master_sites"></a><a name="idp140382928631440"></a><p><b>22.6.</b></p>
 </td>
 <td align="left" valign="top"><p>What does
        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
@@ -8981,7 +8979,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.mailinglists"></a><a name="idp140723587368016"></a><p><b>22.7.</b></p>
+<a name="devfaq.mailinglists"></a><a name="idp140382928639184"></a><p><b>22.7.</b></p>
 </td>
 <td align="left" valign="top"><p>Which mailing lists are there for package
        developers?</p></td>
@@ -9006,7 +9004,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.documentation"></a><a name="idp140723587372976"></a><p><b>22.8.</b></p>
+<a name="devfaq.documentation"></a><a name="idp140382928644096"></a><p><b>22.8.</b></p>
 </td>



Home | Main Index | Thread Index | Old Index