xlockmore: Replace MESSAGE with INSTALL.pkgsrc

[Michael Baeuerle <micha%NetBSD.org@localhost>]

Module Name:	pkgsrc-wip
Committed By:	Michael Baeuerle <micha%NetBSD.org@localhost>
Pushed By:	micha
Date:		Mon Jan 17 16:59:21 2022 +0100
Changeset:	fbf99018a74169ac1784baff3530de10b5f4e0f6

Modified Files:
	xlockmore/Makefile.common
	xlockmore/PLIST
	xlockmore/TODO
Added Files:
	xlockmore/files/INSTALL.pkgsrc
Removed Files:
	xlockmore/MESSAGE

Log Message:
xlockmore: Replace MESSAGE with INSTALL.pkgsrc

To see a diff of this commit:
https://wip.pkgsrc.org/cgi-bin/gitweb.cgi?p=pkgsrc-wip.git;a=commitdiff;h=fbf99018a74169ac1784baff3530de10b5f4e0f6

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

diffstat:
 xlockmore/MESSAGE              | 18 ------------------
 xlockmore/Makefile.common      | 15 ++++++++++++++-
 xlockmore/PLIST                |  1 +
 xlockmore/TODO                 |  2 +-
 xlockmore/files/INSTALL.pkgsrc | 18 ++++++++++++++++++
 5 files changed, 34 insertions(+), 20 deletions(-)

diffs:
diff --git a/xlockmore/MESSAGE b/xlockmore/MESSAGE
deleted file mode 100644
index 89cffe636b..0000000000
--- a/xlockmore/MESSAGE
+++ /dev/null
@@ -1,18 +0,0 @@
-===========================================================================
-$NetBSD: MESSAGE,v 1.1 2012/03/28 20:21:46 drochner Exp $
-
-If xlockmore is built with the "pam" option:
-In order to make unlocking work, you need to add an
-xlock file to your pam configuration directory (usually
-/etc/pam.d).  You can find a sample file in:
-	${EGDIR}/pam.d/xlock-NetBSD
-On  NetBSD, the "pam_pwauth_suid.so" module can be used to authenticate
-against a shadow password database. Note that use of this module might
-allow programs with your privileges to get a copy of your plaintext
-password as typed in for unlocking. The advantage is that with that
-module, the suid bit of the
-	${PREFIX}/bin/xlock
-executable can be removed.
-Per default, xlockmore is installed setuid root. Since this is a
-relatively complex program, there is the risk of other exploits.
-===========================================================================
diff --git a/xlockmore/Makefile.common b/xlockmore/Makefile.common
index 57645feb2d..df5df46e01 100644
--- a/xlockmore/Makefile.common
+++ b/xlockmore/Makefile.common
@@ -17,7 +17,6 @@ DISTINFO_FILE?=		${.CURDIR}/../../wip/xlockmore/distinfo
 PATCHDIR?=		${.CURDIR}/../../wip/xlockmore/patches
 PLIST_SRC?=		${.CURDIR}/../../wip/xlockmore/PLIST
 FILESDIR?=		${.CURDIR}/../../wip/xlockmore/files
-MESSAGE_SRC?=		${.CURDIR}/../../wip/xlockmore/MESSAGE
 
 .include "../../mk/bsd.prefs.mk"
 
@@ -98,6 +97,7 @@ SPECIAL_PERMS+=	bin/xlock ${REAL_ROOT_USER} shadow 2511
 EGDIR=			${PREFIX}/share/examples/xlock
 MESSAGE_SUBST+=		EGDIR=${EGDIR:Q}
 INSTALLATION_DIRS+=	${EGDIR}/pam.d
+INSTALLATION_DIRS+=	share/doc/xlockmore
 
 # XXX framework bug: while we don't need it, this would kill
 # the inherited full dependency
@@ -130,6 +130,19 @@ SUBST_MESSAGE.mode=	Preparing default mode in xlock/XLock.ad file ...
 SUBST_FILES.mode=	xlock/XLock.ad
 SUBST_SED.mode=		-e 's|^\(XLock.mode:[ 	]*\).*|\1${XLOCK_DEFAULT_MODE}|'
 
+# Configure INSTALL.pkgsrc (formerly displayed as MESSAGE)
+SUBST_CLASSES+=		install
+SUBST_STAGE.install=	post-configure
+SUBST_MESSAGE.install=	Preparing INSTALL.pkgsrc file ...
+SUBST_FILES.install=	${WRKDIR}/INSTALL.pkgsrc
+SUBST_VARS.install=	PREFIX
+SUBST_VARS.install+=	EGDIR
+
+post-patch:
+	${CP} ${FILESDIR}/INSTALL.pkgsrc ${WRKDIR}
+
 post-install:
 	${INSTALL_DATA} ${FILESDIR}/pam-xlock-NetBSD \
 	    ${DESTDIR}${EGDIR}/pam.d/xlock-NetBSD
+	${INSTALL_DATA} ${WRKDIR}/INSTALL.pkgsrc \
+	    ${DESTDIR}${PREFIX}/share/doc/xlockmore/INSTALL.pkgsrc
diff --git a/xlockmore/PLIST b/xlockmore/PLIST
index 513a5822f6..90eb88bd58 100644
--- a/xlockmore/PLIST
+++ b/xlockmore/PLIST
@@ -3,6 +3,7 @@ bin/play.sh
 ${LITE}bin/xglock
 bin/xlock
 man/man1/xlock.1
+share/doc/xlockmore/INSTALL.pkgsrc
 share/examples/xlock/app-defaults/XLock
 share/examples/xlock/pam.d/xlock-NetBSD
 share/xlock/sounds/complete.au
diff --git a/xlockmore/TODO b/xlockmore/TODO
index ad12fa1785..73533c8fc4 100644
--- a/xlockmore/TODO
+++ b/xlockmore/TODO
@@ -3,4 +3,4 @@
 [X] Check paths in "patch-xlock_XLock.ad"
 [X] Use SUBST framework for "Makefile.common"
 [X] Check whether CVE-2006-0061 is fixed
-[ ] Move MESSAGE to ${PREFIX}/share/doc
+[X] Move MESSAGE to ${PREFIX}/share/doc
diff --git a/xlockmore/files/INSTALL.pkgsrc b/xlockmore/files/INSTALL.pkgsrc
new file mode 100644
index 0000000000..8ea2ec6b84
--- /dev/null
+++ b/xlockmore/files/INSTALL.pkgsrc
@@ -0,0 +1,18 @@
+If xlockmore is built with the "pam" option:
+In order to make unlocking work, you need to add an
+xlock file to your pam configuration directory (usually
+/etc/pam.d).  You can find a sample file in:
+
+    @EGDIR@/pam.d/xlock-NetBSD
+
+On  NetBSD, the "pam_pwauth_suid.so" module can be used to authenticate
+against a shadow password database. Note that use of this module might
+allow programs with your privileges to get a copy of your plaintext
+password as typed in for unlocking. The advantage is that with that
+module, the suid bit of the
+
+    @PREFIX@/bin/xlock
+
+executable can be removed.
+Per default, xlockmore is installed setuid root. Since this is a
+relatively complex program, there is the risk of other exploits.