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/f96d2de18ac4
branches: trunk
changeset: 532302:f96d2de18ac4
user: rillig <rillig%pkgsrc.org@localhost>
date: Wed Aug 15 20:54:20 2007 +0000
description:
regen
diffstat:
doc/pkgsrc.html | 153 ++++++++++++++++++++++++++-----------------------------
doc/pkgsrc.txt | 132 +++++++++++++++++++++++------------------------
2 files changed, 137 insertions(+), 148 deletions(-)
diffs (truncated from 972 to 300 lines):
diff -r 9ab0cce9af6d -r f96d2de18ac4 doc/pkgsrc.html
--- a/doc/pkgsrc.html Wed Aug 15 20:52:02 2007 +0000
+++ b/doc/pkgsrc.html Wed Aug 15 20:54:20 2007 +0000
@@ -30,8 +30,8 @@
The pkgsrc Developers
</h3>
</div></div>
-<div><p class="copyright">Copyright © 1994-2006 The NetBSD Foundation, Inc</p></div>
-<div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.24 2006/11/11 05:39:09 rillig Exp $</p></div>
+<div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
+<div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.25 2007/08/15 06:32:38 rillig Exp $</p></div>
<div><div class="abstract">
<p class="title"><b>Abstract</b></p>
<p>pkgsrc is a centralized package management system for
@@ -554,14 +554,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>
@@ -1421,7 +1421,7 @@
<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
+<li><p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
<code class="filename">/etc/mk.conf.example</code> file
when you use the bootstrap script.</p></li>
</ol></div>
@@ -1619,7 +1619,7 @@
with.</p>
<p>Therefore, please make sure that you have no conflicting
<code class="varname">CFLAGS</code> in your environment or the
- <code class="filename">/etc/mk.conf</code>. Particularly, make sure that you do not
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
try to link n32 object files with lib64 or vice versa. Check your
<code class="filename">/etc/compiler.defaults</code>!</p>
<p>If you have the actual pkgsrc tree mounted via NFS from a different host,
@@ -1638,7 +1638,7 @@
</pre>
<p>
- in <code class="filename">/etc/mk.conf</code>. Otherwise, pkgsrc will assume you
+ in <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
are using gcc and may end up passing invalid flags to the compiler. Note that
bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
default.</p>
@@ -1675,7 +1675,7 @@
overridden so that __attribute__ is assumed supported by the
compiler.</p>
<p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
- in <code class="filename">/etc/mk.conf</code>:</p>
+ in <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
<pre class="programlisting">
PKGSRC_COMPILER= icc
</pre>
@@ -1683,7 +1683,7 @@
<code class="filename">/opt/intel_cc_80</code>, which
is also the pkgsrc default. If you have installed it into a different
directory, set <code class="varname">ICCBASE</code> in
- <code class="filename">/etc/mk.conf</code>:</p>
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
<pre class="programlisting">
ICCBASE= /opt/icc
</pre>
@@ -1722,10 +1722,10 @@
</pre>
</li>
<li>
-<p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
+<p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
<code class="filename">/etc/mk.conf.example</code> file
when you use the bootstrap script. OpenBSD's make program uses
- <code class="filename">/etc/mk.conf</code>
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a>
as well. You can work around this by enclosing all the pkgsrc-specific parts
of the file with:</p>
<pre class="programlisting">
@@ -1786,7 +1786,7 @@
- Sun WorkShop Compilers common components</p></li>
</ul></div>
<p>You should set the following variables in your
- <code class="filename">mk.conf</code> file:</p>
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
<pre class="programlisting">
CC= cc
CXX= CC
@@ -1804,8 +1804,7 @@
<div class="titlepage"><div><div><h4 class="title">
<a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
<p>To build 64-bit packages, you just need to have the
- following lines in your <code class="filename">mk.conf</code>
- file:</p>
+ following lines in your <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
<pre class="programlisting">
PKGSRC_COMPILER= sunpro
ABI= 64
@@ -1824,7 +1823,7 @@
<code class="filename">/bin/ksh</code> crashes with a segmentation fault.
The workaround is to use another shell for the configure
scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html"; target="_top"><code class="filename">shells/bash</code></a> and adding the
following lines
- to your <code class="filename">mk.conf</code>:</p>
+ to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
<pre class="programlisting">
CONFIG_SHELL= ${LOCALBASE}/bin/bash
WRAPPER_SHELL= ${LOCALBASE}/bin/bash
@@ -2100,7 +2099,7 @@
<p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
is <code class="filename">/usr/pkg</code>. If you wish to change this, you
should do so by setting <code class="varname">LOCALBASE</code> in
- <code class="filename">mk.conf</code>. You should not try to use multiple
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
different <code class="varname">LOCALBASE</code> definitions on the same
system (inside a chroot is an exception). </p>
<p>The rest of this chapter assumes that the package is already
@@ -2129,7 +2128,7 @@
</p>
<pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
<p>
- to your <code class="filename">mk.conf</code>.</p>
+ to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
<p>By default a list of distribution sites will be randomly
intermixed to prevent huge load on servers which holding popular
packages (for example, SourceForge.net mirrors). Thus, every
@@ -2150,7 +2149,7 @@
time.</p>
<p>You can change these settings either in your shell's environment, or,
if you want to keep the settings, by editing the
- <code class="filename">/etc/mk.conf</code> file,
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a> file,
and adding the definitions there.</p>
<p>
If a package depends on many other packages (such as
@@ -2238,12 +2237,12 @@
conflicts between programs and other files installed by the
package system and whatever else may have been installed
there.</p>
-<p>Some packages look in <code class="filename">/etc/mk.conf</code> to
+<p>Some packages look in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
alter some configuration options at build time. Have a look at
<code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
of what will be set there by default. Environment variables such
as <code class="varname">LOCALBASE</code> can be set in
- <code class="filename">/etc/mk.conf</code> to save having to remember to
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
set them each time you want to use pkgsrc.</p>
<p>Occasionally, people want to “<span class="quote">look under the
covers</span>” to see what is going on when a package is building
@@ -2316,7 +2315,7 @@
<dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
</dl>
</div>
-<p>The whole pkgsrc system is configured in a single file, usually
+<a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
that file depends on the installation. On NetBSD, when you use
<a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current";><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
@@ -2401,7 +2400,7 @@
can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
is local to every architecture. (It should be noted that
<code class="varname">PKGSRCDIR</code> should not be set by the user
- — it is an internal definition which refers to the
+ — it is an internal definition which refers to the
root of the pkgsrc tree. It is possible to have many
pkgsrc tree instances.)</p></li>
<li><p><code class="varname">LOCALPATCHES</code>:
@@ -2409,7 +2408,7 @@
See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more
information.</p></li>
<li><p><code class="varname">PKGMAKECONF</code>: Location of
- the <code class="filename">mk.conf</code> file used by a package's
+ the <a href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
BSD-style Makefile. If this is not set,
<code class="varname">MAKECONF</code> is set to
<code class="filename">/dev/null</code> to avoid picking up
@@ -2587,7 +2586,7 @@
These options are currently enabled: mozilla ssl
</pre>
<p>The following variables can be defined in
- <code class="filename">/etc/mk.conf</code> to select which options to
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
which can be used to select or disable options for all packages
that support them, and
@@ -2597,7 +2596,7 @@
these variables are selected, options preceded by “<span class="quote">-</span>”
are disabled. A few examples:</p>
<pre class="screen">
-<code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
+<code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" <a href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
PKG_OPTIONS.kdebase= debug -sasl
PKG_OPTIONS.apache= suexec </pre>
@@ -2621,12 +2620,12 @@
<p>Before the options framework was introduced, build options
were selected by setting a variable (often named
<code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
- <code class="filename">/etc/mk.conf</code> for each option. To ease
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
transition to the options framework for the user, these legacy
variables are converted to the appropriate options setting
(<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
automatically. A warning is issued to prompt the user to update
- <code class="filename">/etc/mk.conf</code> to use the options framework
+ <a href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
directly. Support for the legacy variables will be removed
eventually.</p>
</div>
@@ -2718,14 +2717,14 @@
</div>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
-<p>You may want to set variables in
- <code class="filename">/etc/mk.conf</code>.
+<a name="binary.mk.conf"></a>6.3.1.2. <a href="#mk.conf"><code class="filename">mk.conf</code></a>
+</h4></div></div></div>
+<p>You may want to set variables in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
details of the default settings. You will want to ensure that
<code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
- accepts <span class="emphasis"><em>all</em></span> licenses.</p>
+ completely bypasses the license check.</p>
<pre class="programlisting">
PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
@@ -2952,7 +2951,7 @@
</li>
<li>
<p><code class="filename">/usr/src</code> (system sources,
- e. g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html"; target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
+ e. g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html"; target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
<pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
<code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
</li>
@@ -2978,7 +2977,7 @@
<code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
<code class="filename">.../distfiles</code> point somewhere
appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
-<li><p>Edit <code class="filename">/etc/mk.conf</code>, see <a href="#binary.mk.conf" title="6.3.1.2. /etc/mk.conf">Section 6.3.1.2, “/etc/mk.conf”</a>.</p></li>
+<li><p>Edit <a href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a href="#binary.mk.conf" title="6.3.1.2. mk.conf">Section 6.3.1.2, “<code
class="filename">mk.conf</code>”</a>.</p></li>
<li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
</ol></div>
<p>When the chroot sandbox is set up, you can start
@@ -3000,7 +2999,7 @@
pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
may be used to build a subset of the packages contained in
pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
- in <code class="filename">/etc/mk.conf</code>, the variables</p>
+ in <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
<div class="itemizedlist"><ul type="disc">
<li><p>SITE_SPECIFIC_PKGS</p></li>
<li><p>HOST_SPECIFIC_PKGS</p></li>
@@ -3189,7 +3188,7 @@
operation.</p></li>
<li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
<code class="filename">/etc</code> in the base system. It contains configuration
-files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
+files of the packages, as well as pkgsrc's <a href="#mk.conf"><code class="filename">mk.conf</code></a>
itself.</p></li>
</ul></div>
<div class="sect1" lang="en">
@@ -3450,7 +3449,7 @@
<p>By default, resuming transfers in pkgsrc is disabled, but you can
enable this feature by adding the option
<code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
-<code class="filename">/etc/mk.conf</code>. If, during a fetch step, an incomplete
+<a href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
distfile is found, pkgsrc will try to resume it.</p>
<p>You can also
use a different program than the default <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current";><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by
changing the
@@ -3474,7 +3473,7 @@
<p>If you want to use modular X.org from pkgsrc instead of your system's own X11
(<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
you will have to add the following line into
-<code class="filename">/etc/mk.conf</code>:</p>
+<a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
<pre class="programlisting">
X11_TYPE=modular
</pre>
@@ -3513,7 +3512,7 @@
<code class="filename">/usr/bin/ftp</code>, which automatically tries passive
connections first, and falls back to active connections if the server
refuses to do passive. For the other tools, add the following to your
-<code class="filename">/etc/mk.conf</code> file:
+<a href="#mk.conf"><code class="filename">mk.conf</code></a> file:
<code class="varname">PASSIVE_FETCH=1</code>.</p>
<p>Having that option present will prevent
Home |
Main Index |
Thread Index |
Old Index