pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc regenerated.
details: https://anonhg.NetBSD.org/pkgsrc/rev/87ef63330029
branches: trunk
changeset: 518812:87ef63330029
user: rillig <rillig%pkgsrc.org@localhost>
date: Mon Sep 18 22:34:58 2006 +0000
description:
regenerated.
diffstat:
doc/pkgsrc.html | 309 +++++++++++++++++++++++++++++++------------------------
doc/pkgsrc.txt | 208 ++++++++++++++++++++++---------------
2 files changed, 297 insertions(+), 220 deletions(-)
diffs (truncated from 1127 to 300 lines):
diff -r a6a412cc6a56 -r 87ef63330029 doc/pkgsrc.html
--- a/doc/pkgsrc.html Mon Sep 18 22:27:54 2006 +0000
+++ b/doc/pkgsrc.html Mon Sep 18 22:34:58 2006 +0000
@@ -5,7 +5,11 @@
<title>The pkgsrc guide</title>
<link rel="stylesheet" href="/NetBSD.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
-<meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers
installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
+<meta name="description" content="pkgsrc is a centralized package management system for
+ Unix-like operating systems. This guide provides information for
+ users and developers of pkgsrc. It covers installation of binary
+ and source packages, creation of binary and source packages and
+ a high-level overview about the infrastructure.">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
<div class="titlepage">
@@ -107,7 +111,6 @@
<dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
<dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
<dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
-<dt><span class="sect2"><a href="#selecting-the-compiler">4.2.4. Selecting the compiler</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
@@ -116,8 +119,9 @@
<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>
-<dt><span class="sect2"><a href="#conf.ldflags">5.3.2. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
+<dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
+<dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
+<dt><span class="sect2"><a href="#conf.ldflags">5.3.3. 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>
@@ -160,7 +164,8 @@
<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="#too-much-time">7.18. I have a little time to kill. What shall I do?</a></span></dt>
+<dt><span class="sect1"><a href="#faq.rcs-conflicts">7.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
+<dt><span class="sect1"><a href="#too-much-time">7.19. 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>
@@ -544,7 +549,7 @@
grown a lot, and now supports the following platforms:</p>
<div class="table">
<a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
-<div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
+<table summary="Platforms supported by pkgsrc" border="1">
<colgroup>
<col>
<col>
@@ -609,9 +614,8 @@
<td align="center">Nov 2004</td>
</tr>
</tbody>
-</table></div>
-</div>
-<br class="table-break">
+</table>
+</div>
</div>
</div>
<div class="sect1" lang="en">
@@ -772,7 +776,6 @@
<dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
<dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
<dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
-<dt><span class="sect2"><a href="#selecting-the-compiler">4.2.4. Selecting the compiler</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
@@ -781,8 +784,9 @@
<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>
-<dt><span class="sect2"><a href="#conf.ldflags">5.3.2. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
+<dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
+<dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
+<dt><span class="sect2"><a href="#conf.ldflags">5.3.3. 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>
@@ -825,7 +829,8 @@
<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="#too-much-time">7.18. I have a little time to kill. What shall I do?</a></span></dt>
+<dt><span class="sect1"><a href="#faq.rcs-conflicts">7.18. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
+<dt><span class="sect1"><a href="#too-much-time">7.19. I have a little time to kill. What shall I do?</a></span></dt>
</dl></dd>
</dl>
</div>
@@ -1034,7 +1039,7 @@
</div>
<div class="table">
<a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
-<div class="table-contents"><table summary="Binary kits and available packages" border="1">
+<table summary="Binary kits and available packages" border="1">
<colgroup>
<col>
<col>
@@ -1205,9 +1210,9 @@
<td class="binary-pkgs-url"> </td>
</tr>
</tbody>
-</table></div>
-</div>
-<br class="table-break"><p>
+</table>
+</div>
+<p>
Simply download the binary kit for your platform, and extract it into
<code class="filename">/</code> e.g.
</p>
@@ -1261,21 +1266,21 @@
<a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
<p>Darwin 5.x and up are supported. There are two methods of using
pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
- image</a>, or a <a href="#platform.osx-ufs" title="3.3.1.2. Using a UFS partition">UFS
+ image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
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>
-<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
+<p>If you already have a UFS or HFSX partition, or have a spare partition
+ that you can format as UFS or HFSX, 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
- requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ file system as found in Darwin 7.0 and newer.</p>
+ requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
</div>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
@@ -1287,28 +1292,28 @@
<code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-<p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid. It will also mount the filesystem asynchronous, which is somewhat dangerous
according to the mount(8) man page.</p>
-</div>
-<p>Allow suid and synchronous writes:</p>
-<pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid,sync /Volumes/NetBSD</code></strong></pre>
+<p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid. In the case of UFS, it will also mount the filesystem asynchronous, which is
somewhat dangerous according to the mount(8) man page. In the case of HFSX, it will disable journalling.</p>
+</div>
+<p>Allow suid:</p>
+<pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
</div>
<div class="sect3" lang="en">
<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>
+<a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX 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
+ or HFSX 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
+ and formatted the target partition as UFS or HFSX, it should automatically
mount on <code class="filename">/Volumes/<volume name></code> when the
- machine boots. If you are (re)formatting a partition as UFS, you need
+ machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
to ensure that the partition map correctly reflects
- “<span class="quote">Apple_UFS</span>” and not “<span class="quote">Apple_HFS</span>”.</p>
+ “<span class="quote">Apple_UFS</span>” or “<span class="quote">Apple_HFSX</span>” and not “<span class="quote">Apple_HFS</span>”.</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
@@ -1317,8 +1322,8 @@
<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
+ to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
+ installer which will reboot your machine. The new UFS or HFSX 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>
@@ -1807,7 +1812,6 @@
<dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
<dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
<dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
-<dt><span class="sect2"><a href="#selecting-the-compiler">4.2.4. Selecting the compiler</a></span></dt>
</dl></dd>
</dl>
</div>
@@ -2240,47 +2244,6 @@
<span class="emphasis"><em>not</em></span> install any if you use a non-standard
<code class="varname">LOCALBASE</code>.</p>
</div>
-<div class="sect2" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="selecting-the-compiler"></a>4.2.4. Selecting the compiler</h3></div></div></div>
-<p>By default, pkgsrc will use GCC to build packages. This may be
- overridden by setting the following variables in /etc/mk.conf:</p>
-<div class="variablelist"><dl>
-<dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
-<dd>
-<p>This is a list of values specifying the chain of
- compilers to invoke when building packages. Valid values
- are:</p>
-<div class="itemizedlist"><ul type="disc">
-<li><p><code class="varname">distcc</code>:
- distributed C/C++ (chainable)</p></li>
-<li><p><code class="varname">ccache</code>:
- compiler cache (chainable)</p></li>
-<li><p><code class="varname">gcc</code>:
- GNU C/C++ Compiler</p></li>
-<li><p><code class="varname">mipspro</code>:
- Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
-<li><p><code class="varname">mipspro</code>:
- Silicon Graphics, Inc. MIPSpro (o32)</p></li>
-<li><p><code class="varname">sunpro</code>:
- Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
-</ul></div>
-<p>The default is
- “<span class="quote"><code class="varname">gcc</code></span>”. You can use
- <code class="varname">ccache</code> and/or
- <code class="varname">distcc</code> with an appropriate
- <code class="varname">PKGSRC_COMPILER</code> setting,
- e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
- variable should always be
- terminated with a value for a real compiler.</p>
-</dd>
-<dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
-<dd><p>This specifies the minimum version of GCC to use
- when building packages. If the system GCC doesn't
- satisfy this requirement, then pkgsrc will build and
- install one of the GCC packages to use instead.</p></dd>
-</dl></div>
-</div>
</div>
</div>
<div class="chapter" lang="en">
@@ -2293,22 +2256,39 @@
<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>
-<dt><span class="sect2"><a href="#conf.ldflags">5.3.2. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
+<dt><span class="sect2"><a href="#selecting-the-compiler">5.3.1. Selecting the compiler</a></span></dt>
+<dt><span class="sect2"><a href="#conf.cflags">5.3.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
+<dt><span class="sect2"><a href="#conf.ldflags">5.3.3. 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>
</div>
+<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
+<code class="filename">/etc/</code>. In all other cases the default location is
+<code class="literal">${PREFIX}/etc/</code>, depending on where you told the
+bootstrap program to install the binary packages.</p>
+<p>During the bootstrap, an example configuration file is created. To
+use that, you have to create the directory
+<code class="filename">${PREFIX}/etc</code> and copy the example file
+there.</p>
+<p>The format of the configuration file is that of the usual
+BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
+is done by setting variables in this file. Note that you can define all
+kinds of variables, and no special error checking (for example for
+spelling mistakes) takes place, so you have to try it out to see if it
+works.</p>
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
<p>In this section, you can find some variables that apply to all
- pkgsrc packages. The preferred method of setting these variables is
- by setting them in <code class="filename">/etc/mk.conf</code>. A complete
- list of the variables that can be configured by the user is
- available in <code class="filename">mk/defaults/mk.conf</code>, together with
- some comments that describe the variable's intent.</p>
+ pkgsrc packages. A complete list of the variables that can be
+ configured by the user is available in
+ <code class="filename">mk/defaults/mk.conf</code>, together with some
+ comments that describe each variable's intent.</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="varname">LOCALBASE</code>: Where
packages will be installed. The default is
@@ -2363,7 +2343,7 @@
can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
is local to every architecture. (It should be noted that
Home |
Main Index |
Thread Index |
Old Index