summaryrefslogtreecommitdiff
path: root/mk/help
diff options
context:
space:
mode:
authorrillig <rillig>2006-10-25 08:39:29 +0000
committerrillig <rillig>2006-10-25 08:39:29 +0000
commit09ed4d27dff63577f0246e8df7a590e2ea41f2ee (patch)
treed06caed5091e9517bd847ae2a0caa0603c9324c3 /mk/help
parent401deba6fbc6367ed4215a04ae9141bcadc767d9 (diff)
downloadpkgsrc-09ed4d27dff63577f0246e8df7a590e2ea41f2ee.tar.gz
The file directories.mk provides a short help on some directories that
are important to pkgsrc.
Diffstat (limited to 'mk/help')
-rw-r--r--mk/help/directories.mk41
1 files changed, 41 insertions, 0 deletions
diff --git a/mk/help/directories.mk b/mk/help/directories.mk
new file mode 100644
index 00000000000..2e009084a9b
--- /dev/null
+++ b/mk/help/directories.mk
@@ -0,0 +1,41 @@
+# $NetBSD: directories.mk,v 1.1 2006/10/25 08:39:29 rillig Exp $
+#
+# This file contains some short documentation on the directories that
+# are used within pkgsrc.
+
+# PREFIX
+# This is the directory where the package should install its
+# files. In special situations, this variable may be set to a
+# subdirectory of LOCALBASE, but this is usually not needed.
+#
+
+# LOCALBASE
+# This is the directory where all packages are usually installed.
+# It is set by the user, and packages must not modify it.
+#
+
+# PKG_SYSCONFBASE
+# PKG_SYSCONFDIR.*
+# These variables may be set in mk.conf to control where the
+# configuration files are put.
+#
+# See also: guide:faq.html#faq.conf
+#
+
+# PKG_SYSCONFVAR
+# This variable can be set by packages to select the variable
+# which can then be overridden in mk.conf to change the directory
+# where the configuration files go.
+#
+# Default value: ${PKGBASE}
+#
+
+# PKG_SYSCONFDIR
+# This is the directory where the current package should install
+# its configuration files. It may be changed by the package to
+# point to a subdirectory of PKG_SYSCONFBASE.
+#
+
+# TODO:PKG_SYSCONFDEPOTBASE
+# TODO:PKG_SYSCONFBASEDIR
+#