pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc/guide/files Moved all the pkgsrc documentation fro...
details: https://anonhg.NetBSD.org/pkgsrc/rev/f35be7f6c2fb
branches: trunk
changeset: 516853:f35be7f6c2fb
user: rillig <rillig%pkgsrc.org@localhost>
date: Sat Jul 29 15:57:04 2006 +0000
description:
Moved all the pkgsrc documentation from outside the pkgsrc guide to
here. There's still much to do to avoid repetition and such, but
the first steps are done.
diffstat:
doc/guide/files/configuring.xml | 25 +++-
doc/guide/files/introduction.xml | 165 ++++++++++++++++++++--------
doc/guide/files/platforms.xml | 228 +++++++++++++++++++++++++++++++++++---
doc/guide/files/using.xml | 148 ++++++++++++++++++++++--
4 files changed, 478 insertions(+), 88 deletions(-)
diffs (truncated from 690 to 300 lines):
diff -r 91a70cf7046e -r f35be7f6c2fb doc/guide/files/configuring.xml
--- a/doc/guide/files/configuring.xml Sat Jul 29 14:47:16 2006 +0000
+++ b/doc/guide/files/configuring.xml Sat Jul 29 15:57:04 2006 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: configuring.xml,v 1.16 2006/07/27 06:40:05 rillig Exp $ -->
+<!-- $NetBSD: configuring.xml,v 1.17 2006/07/29 15:57:04 rillig Exp $ -->
<chapter id="configuring">
<title>Configuring pkgsrc</title>
@@ -7,8 +7,12 @@
<title>General configuration</title>
<para>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 <filename>/etc/mk.conf</filename>.
+ pkgsrc packages. The preferred method of setting these variables is
+ by setting them in <filename>/etc/mk.conf</filename>. A complete
+ list of the variables that can be configured by the user is
+ available in <filename>mk/defaults/mk.conf</filename>, together with
+ some comments that describe the variable's intent.</para>
+
<itemizedlist>
<listitem><para><varname>LOCALBASE</varname>: Where
packages will be installed. The default is
@@ -46,8 +50,13 @@
<listitem><para><varname>BINPKG_SITES</varname>:
List of sites carrying binary pkgs.</para>
</listitem>
+ <listitem><para><varname>ACCEPTABLE_LICENSES</varname>:
+ List of acceptable licenses. Whenever you try to build a package
+ whose license is not in this list, you will get an error message
+ that includes instructions on how to change this variable.</para>
+ </listitem>
</itemizedlist>
- </para>
+
</sect1>
<sect1 id="variables-affecting-build">
@@ -86,6 +95,14 @@
<filename>/dev/null</filename> to avoid picking up
settings used by builds in <filename>/usr/src</filename>.</para>
</listitem>
+ <listitem><para><varname>DEPENDS_TARGET</varname>:
+ By default, dependencies are only installed, and no binary
+
+ package is created for them. You can set this variable to
+ <literal>package</literal> to automatically create binary
+ packages after installing dependencies.</para>
+ </listitem>
+
<!-- DISTDIR -->
<!-- FAILOVER_FETCH -->
</itemizedlist>
diff -r 91a70cf7046e -r f35be7f6c2fb doc/guide/files/introduction.xml
--- a/doc/guide/files/introduction.xml Sat Jul 29 14:47:16 2006 +0000
+++ b/doc/guide/files/introduction.xml Sat Jul 29 15:57:04 2006 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: introduction.xml,v 1.15 2006/07/29 14:14:19 rillig Exp $ -->
+<!-- $NetBSD: introduction.xml,v 1.16 2006/07/29 15:57:04 rillig Exp $ -->
<chapter id="introduction">
<title>What is pkgsrc?</title>
@@ -45,55 +45,126 @@
such as pthreads and X11, and extended features such as IPv6 support on
a range of platforms.</para>
+<sect2 id="why-pkgsrc">
+<title>Why pkgsrc?</title>
+
+<para>
+pkgsrc provides the following key features:
+</para>
+
+<itemizedlist>
+<listitem><para>Easy building of software from source as well as the creation
+ and installation of binary packages. The source and latest
+ patches are retrieved from a master or mirror download site, checksum
+ verified, then built on your system. Support for binary-only
+ distributions is available for both native platforms and NetBSD
+ emulated platforms.</para></listitem>
+<listitem><para>All packages are installed in a consistent directory tree,
+ including binaries, libraries, man pages and other
+ documentation.</para></listitem>
+<listitem><para>Package dependencies, including when performing package updates,
+ are handled automatically. The configuration files of various
+ packages are handled automatically during updates, so local changes
+ are preserved.</para></listitem>
+<listitem><para>Like NetBSD, pkgsrc is designed with portability in mind and
+ consists of highly portable code. This allows the greatest speed of
+ development when porting to new a platform. This portability also
+ ensures that pkgsrc is <emphasis>consistent across all
+ platforms</emphasis>.</para></listitem>
+<listitem><para>The installation prefix, acceptable software licenses,
+ international encryption requirements and build-time options for a
+ large number of packages are all set in a simple, central
+ configuration file.</para></listitem>
+<listitem><para>The entire source (not including the distribution files) is
+ freely available under a BSD license, so you may extend and adapt
+ pkgsrc to your needs. Support for local packages and patches is
+ available right out of the box, so you can configure it specifically
+ for your environment.</para></listitem>
+</itemizedlist>
+</sect2>
+
+<sect2 id="intro.platforms">
+<title>Supported platforms</title>
+
+<para>pkgsrc consists of both a source distribution and a binary
+distribution for these operating systems. After retrieving the required
+source or binaries, you can be up and running with pkgsrc in just
+minutes!</para>
+
<para>pkgsrc was derived from FreeBSD's ports system, and
initially developed for NetBSD only. Since then, pkgsrc has
grown a lot, and now supports the following platforms:</para>
- <itemizedlist>
- <listitem>
- <para><ulink url="http://developer.apple.com/darwin/";>Darwin</ulink>
- (<ulink url="http://www.apple.com/macosx/";>Mac OS X</ulink>)</para>
- </listitem>
-
- <listitem>
- <para><ulink url="http://www.DragonFlyBSD.org/";>DragonFly BSD</ulink></para>
- </listitem>
-
- <listitem>
- <para><ulink url="http://www.FreeBSD.org/";>FreeBSD</ulink></para>
- </listitem>
-
- <listitem>
- <para>Microsoft Windows, via <ulink url="http://www.microsoft.com/windows/sfu/";>Interix</ulink></para>
- </listitem>
-
- <listitem>
- <para><ulink url="http://www.sgi.com/software/irix6.5/";>IRIX</ulink></para>
- </listitem>
+<table id="supported-platforms">
+ <title>Platforms supported by pkgsrc</title>
+ <tgroup cols = "2">
+ <thead>
+ <row>
+ <entry>Platform</entry>
+ <entry>Date Support Added</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><ulink url="http://www.NetBSD.org/";>NetBSD</ulink></entry>
+ <entry align="center">Aug 1997</entry>
+ </row>
+ <row>
+ <entry><ulink url="http://wwws.sun.com/software/solaris/";>Solaris</ulink></entry>
+ <entry align="center">Mar 1999</entry>
+ </row>
+ <row>
+ <entry><ulink url="http://www.kernel.org/";>Linux</ulink></entry>
+ <entry align="center">Jun 1999</entry>
+ </row>
+ <row>
+ <entry>
+ <ulink url="http://developer.apple.com/darwin/";>Darwin</ulink>
+ (<ulink url="http://developer.apple.com/macosx/";>Mac OS X</ulink>)
+ </entry>
+ <entry align="center">Oct 2001</entry>
+ </row>
+ <row>
+ <entry><ulink url="http://www.freebsd.org/";>FreeBSD</ulink></entry>
+ <entry align="center">Nov 2002</entry>
+ </row>
+ <row>
+ <entry><ulink url="http://www.openbsd.org/";>OpenBSD</ulink></entry>
+ <entry align="center">Nov 2002</entry>
+ </row>
+ <row>
+ <entry><ulink url="http://www.sgi.com/software/irix/";>IRIX</ulink></entry>
+ <entry align="center">Dec 2002</entry>
+ </row>
+ <row>
+ <entry>BSD/OS</entry>
+ <entry align="center">Dec 2003</entry>
+ </row>
+ <row>
+ <entry><ulink url="http://www-1.ibm.com/servers/aix/";>AIX</ulink></entry>
+ <entry align="center">Dec 2003</entry>
+ </row>
+ <row>
+ <entry>
+ <ulink url="http://www.microsoft.com/windows/sfu/";>Interix</ulink>
+ (Microsoft Windows Services for Unix)
+ </entry>
+ <entry align="center">Mar 2004</entry>
+ </row>
+ <row>
+ <entry><ulink url="http://www.dragonflybsd.org/";>DragonFlyBSD</ulink></entry>
+ <entry align="center">Oct 2004</entry>
+ </row>
+ <row>
+ <entry><ulink url="http://www.tru64.org/";>OSF/1</ulink></entry>
+ <entry align="center">Nov 2004</entry>
+ </row>
+ </tbody>
+ </tgroup>
+</table>
+</sect2>
- <listitem>
- <para><ulink url="http://www.linux.org/";>Linux</ulink></para>
- </listitem>
-
- <listitem>
- <para><ulink url="http://www.NetBSD.org/";>NetBSD</ulink> (of
- course)</para>
- </listitem>
-
- <listitem>
- <para><ulink url="http://h30097.www3.hp.com/";>Tru64</ulink>
- (Digital UNIX, OSF1)</para>
- </listitem>
-
- <listitem>
- <para><ulink url="http://www.openbsd.org/";>OpenBSD</ulink></para>
- </listitem>
-
- <listitem>
- <para><ulink url="http://www.sun.com/solaris/";>Solaris</ulink></para>
- </listitem>
- </itemizedlist>
- </sect1>
+</sect1>
<sect1 id="overview">
<title>Overview</title>
@@ -223,8 +294,8 @@
</sect2>
- <sect2 id="term.people">
- <title>People involved in pkgsrc</title>
+ <sect2 id="term.roles">
+ <title>Roles involved in pkgsrc</title>
<variablelist>
diff -r 91a70cf7046e -r f35be7f6c2fb doc/guide/files/platforms.xml
--- a/doc/guide/files/platforms.xml Sat Jul 29 14:47:16 2006 +0000
+++ b/doc/guide/files/platforms.xml Sat Jul 29 15:57:04 2006 +0000
@@ -1,31 +1,217 @@
-<!-- $NetBSD: platforms.xml,v 1.31 2006/06/23 05:00:55 rillig Exp $ -->
+<!-- $NetBSD: platforms.xml,v 1.32 2006/07/29 15:57:04 rillig Exp $ -->
<chapter id="platforms">
<title>Using pkgsrc on systems other than &os;</title>
+<sect1 id="binarydist">
+<title>Binary distribution</title>
+<para>
+We provide a bootstrap kit in both source and binary form for other
+platforms than &os;, consisting of the pkg administration tools and other
+tools required to use pkgsrc and build packages.
+</para>
+
+<note><para>
+Older binary snapshots are available in the
+<ulink url="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/";>bootstrap-pkgsrc/archive</ulink>
+directory on ftp.NetBSD.org.</para>
+</note>
+
+<table id="binary-kits">
+ <title>Binary kits and available packages</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Platform</entry>
+ <entry>Latest snapshot</entry>
+ <entry>Binary kit</entry>
+ <entry>Binary packages</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry role="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</entry>
+ <entry role="date">20021209</entry>
+ <entry role="kit-url"><ulink url="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-5.5-powerpc-20021209.tar.gz";>binary kit</ulink></entry>
+ <entry role="binary-pkgs-url"></entry>
+ </row>
+ <row>
+ <entry role="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</entry>
+ <entry role="date">20030623</entry>
+ <entry role="kit-url"><ulink url="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-6.6-powerpc-20030623.tar.gz";>binary kit</ulink></entry>
+ <entry role="binary-pkgs-url"></entry>
+ </row>
+ <row>
+ <entry role="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</entry>
+ <entry role="date">20041219</entry>
+ <entry role="kit-url"><ulink url="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.6.0-powerpc-20041219.tar.gz";>binary kit</ulink></entry>
+ <entry role="binary-pkgs-url"><ulink url="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/";>binary packages</ulink></entry>
+ </row>
+ <row>
Home |
Main Index |
Thread Index |
Old Index