summaryrefslogtreecommitdiff
path: root/mk/help
diff options
context:
space:
mode:
authorrillig <rillig>2007-09-29 13:49:21 +0000
committerrillig <rillig>2007-09-29 13:49:21 +0000
commitaa8fd93d1462867976005eb97e59da385beb73a5 (patch)
tree93f9547a673203ddf2da1b5da10f3cd435922c51 /mk/help
parent03fc251340890ec8f95ca9335985eba6cf256e3f (diff)
downloadpkgsrc-aa8fd93d1462867976005eb97e59da385beb73a5.tar.gz
Added documentation about manpage handling in pkgsrc. This still needs
much work.
Diffstat (limited to 'mk/help')
-rw-r--r--mk/help/man.help36
1 files changed, 36 insertions, 0 deletions
diff --git a/mk/help/man.help b/mk/help/man.help
new file mode 100644
index 00000000000..664b06d3332
--- /dev/null
+++ b/mk/help/man.help
@@ -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
+#