[pkgsrc/trunk]: pkgsrc/doc/guide/files Rewrote the section on manual pages, a...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/3985cf00f354
branches:  trunk
changeset: 516584:3985cf00f354
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sun Jul 23 15:35:08 2006 +0000

description:
Rewrote the section on manual pages, avoiding to say everything twice.

diffstat:

 doc/guide/files/fixes.xml |  33 ++++++++++++++++-----------------
 1 files changed, 16 insertions(+), 17 deletions(-)

diffs (49 lines):

diff -r cb7aa177c8b6 -r 3985cf00f354 doc/guide/files/fixes.xml
--- a/doc/guide/files/fixes.xml Sun Jul 23 15:34:10 2006 +0000
+++ b/doc/guide/files/fixes.xml Sun Jul 23 15:35:08 2006 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: fixes.xml,v 1.63 2006/07/02 10:01:11 rillig Exp $ -->
+<!-- $NetBSD: fixes.xml,v 1.64 2006/07/23 15:35:08 rillig Exp $ -->
 
 <chapter id="fixes"> <?dbhtml filename="fixes.html"?>
   <title>Making your package work</title>
@@ -1260,24 +1260,23 @@
     <sect2 id="manpages">
       <title>Packages installing man pages</title>
 
-      <para>Many packages install manual pages. The man pages
-       are installed under <varname>${PREFIX}/${PKGMANDIR}</varname>
-       which is <filename>/usr/pkg/man</filename> by default.
-       <varname>PKGMANDIR</varname> defaults to <quote>man</quote>.
-       For example, you can set <varname>PKGMANDIR</varname> to
-       <quote>share/man</quote> to have man pages install under
-       <filename>/usr/pkg/share/man/</filename> by default.
-      </para>
+       <para>All packages that install manual pages should install them
+       into the same directory, so that there is one common place to
+       look for them. In pkgsrc, this place is
+       <literal>${PREFIX}/${PKGMANDIR}</literal>, and this expression
+       should be used in packages. The default for
+       <varname>PKGMANDIR</varname> is
+       <quote><filename>man</filename></quote>. Another often-used
+       value is <quote><filename>share/man</filename></quote>.</para>
 
-      <note><para>The support for a custom <varname>PKGMANDIR</varname>
-       is not complete.
-      </para></note>
+       <note><para>The support for a custom
+       <varname>PKGMANDIR</varname> is far from complete.</para></note>
 
-      <para>The <filename>PLIST</filename> files can just
-       use <filename>man/</filename> as the top level directory
-       for the man page file entries
-       and the pkgsrc framework will convert as needed.
-      </para>
+       <para>The <filename>PLIST</filename> files can just use
+       <filename>man/</filename> as the top level directory for the man
+       page file entries, and the pkgsrc framework will convert as
+       needed. In all other places, the correct
+       <varname>PKGMANDIR</varname> must be used.</para>
 
       <para> Packages that are
        configured with <varname>GNU_CONFIGURE</varname> set as