summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2006-07-29 14:14:23 +0000
committerrillig <rillig@pkgsrc.org>2006-07-29 14:14:23 +0000
commit7e1b7fd9a3252a1e717b50670c006e068a6bd4bc (patch)
treeaa8d40ec8172be7f3ca255713c7d17a42d5f2910 /doc
parent162239966ab1399ccaa527f12e76eaf8cd700917 (diff)
downloadpkgsrc-7e1b7fd9a3252a1e717b50670c006e068a6bd4bc.tar.gz
Integrated the useful information from the NetBSD guide, chap-pack.xml,
where the pkgsrc guide did not mention things before. Discarded the rest.
Diffstat (limited to 'doc')
-rw-r--r--doc/guide/files/getting.xml11
-rw-r--r--doc/guide/files/submit.xml6
-rw-r--r--doc/guide/files/using.xml60
3 files changed, 65 insertions, 12 deletions
diff --git a/doc/guide/files/getting.xml b/doc/guide/files/getting.xml
index 887745e2f59..4b739518476 100644
--- a/doc/guide/files/getting.xml
+++ b/doc/guide/files/getting.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: getting.xml,v 1.11 2006/05/31 11:44:07 rillig Exp $ -->
+<!-- $NetBSD: getting.xml,v 1.12 2006/07/29 14:14:23 rillig Exp $ -->
<chapter id="getting">
<title>Where to get pkgsrc and how to keep it up-to-date</title>
@@ -121,7 +121,14 @@
When removing the old files, any changes that you have done to
the pkgsrc files will be lost after updating. Therefore updating
via CVS is strongly recommended.</para></warning>
-
+
+ <para>Note that by default the distfiles and the binary packages
+ are saved in the pkgsrc tree, so don't forget to rescue them
+ before updating. You can also configure pkgsrc to use other than
+ the default directories by setting the
+ <varname>DISTDIR</varname> and <varname>PACKAGES</varname>
+ variables. See <xref linkend="configuring"/> for the details.</para>
+
<para>To update pkgsrc from a tar file, download the tar file as
explained above. Then, make sure that you have not made any
changes to the files in the pkgsrc directory. Remove the pkgsrc
diff --git a/doc/guide/files/submit.xml b/doc/guide/files/submit.xml
index 68b825a156b..1fc57a7ba02 100644
--- a/doc/guide/files/submit.xml
+++ b/doc/guide/files/submit.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: submit.xml,v 1.11 2006/05/19 21:08:42 rillig Exp $ -->
+<!-- $NetBSD: submit.xml,v 1.12 2006/07/29 14:14:23 rillig Exp $ -->
<chapter id="submit"> <?dbhtml filename="submit.html"?>
<title>Submitting and Committing</title>
@@ -15,13 +15,14 @@
see <xref linkend="bulk-upload"/>.</para>
</sect1>
+
<sect1 id="submitting-your-package">
<title>Submitting source packages (for non-NetBSD-developers)</title>
<para>First, check that your package is complete, compiles and
runs well; see <xref linkend="debug"/> and the rest of this
document. Next, generate an uuencoded gzipped &man.tar.1;
- archive, preferably with all files in a single directory.
+ archive that contains all files that make up the package.
Finally, <command>send-pr</command> with category
<quote>pkg</quote>, a synopsis which includes the package name
and version number, a short description of your package
@@ -38,6 +39,7 @@
for details.</para>
</sect1>
+
<sect1 id="general-notes-for-changes">
<title>General notes when adding, updating, or removing packages</title>
diff --git a/doc/guide/files/using.xml b/doc/guide/files/using.xml
index c7ae22f5427..87707b65421 100644
--- a/doc/guide/files/using.xml
+++ b/doc/guide/files/using.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: using.xml,v 1.20 2006/07/23 15:34:10 rillig Exp $ -->
+<!-- $NetBSD: using.xml,v 1.21 2006/07/29 14:14:23 rillig Exp $ -->
<chapter id="using"> <?dbhtml filename="using.html"?>
<title>Using pkgsrc</title>
@@ -30,7 +30,7 @@
</tgroup>
</informaltable>
- <para>These prebuilt package tools use
+ <para>These pre-built package tools use
<filename>/usr/pkg</filename> for the base directory, and
<filename>/var/db/pkg</filename> for the database of installed
packages. If you cannot use these directories for whatever
@@ -85,7 +85,7 @@
automatically by giving <command>pkg_add</command> an FTP URL:
</para>
- <screen><prompt>#</prompt> <userinput>pkg_add ftp://ftp.NetBSD.org/pub/NetBSD/packages/&lt;OSVERSION&gt;/&lt;ARCH&gt;/All/package.tgz</userinput></screen>
+ <screen><prompt>#</prompt> <userinput>pkg_add ftp://ftp.NetBSD.org/pub/NetBSD/packages/&lt;OSVERSION&gt;/&lt;ARCH&gt;/All/package</userinput></screen>
<para>Note that any prerequisite packages needed to run the
package in question will be installed, too, assuming they are
@@ -116,6 +116,49 @@
installed program. </para>
</sect2>
+<sect2 id="using.pkg_delete">
+<title>Deinstalling packages</title>
+
+ <para>To deinstall a package, it does not matter whether it was
+ installed from source code or from a binary package. The
+ <command>pkg_delete</command> command does not know it anyway.
+ To delete a package, you can just run <command>pkg_delete
+ <replaceable>package-name</replaceable></command>. The package
+ name can be given with or without version number. Wildcards can
+ also be used to deinstall a set of packages, for example
+ <literal>*emacs*</literal>. Be sure to include them in quotes,
+ so that the shell does not expand them before
+ <literal>pkg_delete</literal> sees them.</para>
+
+ <para>The <option>-r</option> option is very powerful: it
+ removes all the packages that require the package in question
+ and then removes the package itself. For example:
+
+<screen>
+ &rprompt; <userinput>pkg_delete -r jpeg</userinput>
+</screen>
+
+ will remove jpeg and all the packages that used it; this allows
+ upgrading the jpeg package.</para>
+
+</sect2>
+
+<sect2 id="using.pkg_info">
+<title>Getting information about installed packages</title>
+
+ <para>The <command>pkg_info</command> shows information about
+ installed packages or binary package files.</para>
+
+</sect2>
+
+<sect2 id="using.pkg_admin">
+<title>Other administrative functions</title>
+
+ <para>The <command>pkg_admin</command> executes various
+ administrative functions on the package system.</para>
+
+</sect2>
+
<sect2 id="a-word-of-warning">
<title>A word of warning</title>
@@ -145,11 +188,12 @@
<sect2 id="requirements">
<title>Requirements</title>
- <para> To build packages from source on a NetBSD system the
- <quote>comp</quote> and the <quote>text</quote> distribution
- sets must be installed. If you want to build X11-related
- packages the <quote>xbase</quote> and <quote>xcomp</quote>
- distribution sets are required, too.</para>
+ <para>To build packages from source, you need a working C
+ compiler. On NetBSD, you need to install the
+ <quote>comp</quote> and the <quote>text</quote> distribution
+ sets. If you want to build X11-related packages, the
+ <quote>xbase</quote> and <quote>xcomp</quote> distribution
+ sets are required, too.</para>
<!-- FIXME: what about installing x11/XFree86-*? -->
</sect2>