[pkgsrc/trunk]: pkgsrc/mk/help Added documentation about manpage handling in ...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/a2b971f2890a
branches:  trunk
changeset: 533774:a2b971f2890a
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sat Sep 29 13:49:21 2007 +0000

description:
Added documentation about manpage handling in pkgsrc. This still needs
much work.

diffstat:

 mk/help/man.help |  36 ++++++++++++++++++++++++++++++++++++
 1 files changed, 36 insertions(+), 0 deletions(-)

diffs (40 lines):

diff -r fafbf00ca5ed -r a2b971f2890a mk/help/man.help
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/mk/help/man.help  Sat Sep 29 13:49:21 2007 +0000
@@ -0,0 +1,36 @@
+# $NetBSD: man.help,v 1.1 2007/09/29 13:49:21 rillig Exp $
+#
+# The installation of manual pages (manpages) can be handled very flexibly
+# with pkgsrc, and is therefore quite complex.
+#
+# XXX: Why do we need this complexity?
+#
+# TODO:        Document all the pkgsrc magic that concerns manpages.
+#
+# TODO:        Change pkgsrc so that this documentation is correct.
+#
+# TODO:        How should manpages be specified in the PLIST?
+#
+# TODO:        What happens if a package installs more or fewer than the requested
+#      manpages?
+#
+# User-settable variables:
+#
+# PKGMANDIR
+#      (See mk/defaults/mk.conf)
+#
+# MANINSTALL
+#      A list of installation types for manpages. Can contain one or more
+#      of the following:
+#
+#      * catinstall: Preformatted manpages are installed in
+#        ${PREFIX}/${PKGMANDIR}/cat*.
+#
+#      * maninstall: Unformatted manpages are installed in
+#        ${PREFIX}/${PKGMANDIR}/man*.
+#
+#      If this list is empty, no manpages are installed at all.
+#
+# See also:
+#      IMAKE_MANINSTALL
+#