[pkgsrc/trunk]: pkgsrc/x11/xscreensaver xscreensaver: adjust some documentation

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/93c951dc2558
branches:  trunk
changeset: 451910:93c951dc2558
user:      gutteridge <gutteridge%pkgsrc.org@localhost>
date:      Mon May 03 23:31:40 2021 +0000

description:
xscreensaver: adjust some documentation

Move the existing MESSAGE content to README.pkgsrc, as much of it
pertains to a non-default option that most users don't need to consider,
and otherwise is not a call to action for a user to do anything. While
here, restructure it a bit.

Also remove the sample NetBSD PAM configration file here, as the
security/pam-pwauth_suid package provides its own (slightly newer)
version of the same, and has its own MESSAGE that references its version
and its distinct installation location (and is a call to action that
users very much need to know about, as otherwise they'll end up with an
X session they can't unlock). There's no point possibly confusing people
with different example files. This addresses PR pkg/50622.

diffstat:

 x11/xscreensaver/MESSAGE                       |  17 -----------------
 x11/xscreensaver/Makefile                      |  12 ++++--------
 x11/xscreensaver/PLIST                         |   4 ++--
 x11/xscreensaver/files/README.pkgsrc           |  15 +++++++++++++++
 x11/xscreensaver/files/pam-xscreensaver-NetBSD |  17 -----------------
 5 files changed, 21 insertions(+), 44 deletions(-)

diffs (109 lines):

diff -r 27d34f3ecc07 -r 93c951dc2558 x11/xscreensaver/MESSAGE
--- a/x11/xscreensaver/MESSAGE  Mon May 03 19:00:52 2021 +0000
+++ /dev/null   Thu Jan 01 00:00:00 1970 +0000
@@ -1,17 +0,0 @@
-===========================================================================
-$NetBSD: MESSAGE,v 1.2 2008/04/08 09:36:23 gson Exp $
-
-If xscreensaver is built with the "pam" option:
-In order to make unlocking work , you need to add an
-xscreensaver file to your pam configuration directory (usually
-/etc/pam.d).  You can find a sample file in:
-       ${EGDIR}/pam.d/xscreensaver-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.
-Alternatively, you might set the
-       ${PREFIX}/bin/xscreensaver
-executable setuid root. Since this is a relatively complex program,
-there is the risk of other exploits.
-===========================================================================
diff -r 27d34f3ecc07 -r 93c951dc2558 x11/xscreensaver/Makefile
--- a/x11/xscreensaver/Makefile Mon May 03 19:00:52 2021 +0000
+++ b/x11/xscreensaver/Makefile Mon May 03 23:31:40 2021 +0000
@@ -1,7 +1,7 @@
-# $NetBSD: Makefile,v 1.128 2021/04/21 11:40:53 adam Exp $
+# $NetBSD: Makefile,v 1.129 2021/05/03 23:31:40 gutteridge Exp $
 
 COMMENT=       Screen saver and locker for the X window system
-PKGREVISION=   1
+PKGREVISION=   2
 
 CONFLICTS+=    xscreensaver-gnome<4.14
 
@@ -13,14 +13,10 @@
 #CONFIGURE_ARGS+=      --with-xml=${BUILDLINK_PREFIX.libxml2}
 CONFIGURE_ARGS+=       --with-configdir=${PREFIX}/libexec/xscreensaver/config
 
-EGDIR=                 ${PREFIX}/share/examples/xscreensaver
-MESSAGE_SUBST+=                EGDIR=${EGDIR:Q}
-
-INSTALLATION_DIRS=     ${EGDIR}/pam.d
+INSTALLATION_DIRS=     share/doc/${PKGBASE}
 
 post-install:
-       ${INSTALL_DATA} ${FILESDIR}/pam-xscreensaver-NetBSD \
-           ${DESTDIR}${EGDIR}/pam.d/xscreensaver-NetBSD
+       ${INSTALL_DATA} ${FILESDIR}/README.pkgsrc ${DESTDIR}${PREFIX}/share/doc/${PKGBASE}
 
 .include "../../graphics/png/buildlink3.mk"
 .include "../../x11/libXScrnSaver/buildlink3.mk"
diff -r 27d34f3ecc07 -r 93c951dc2558 x11/xscreensaver/PLIST
--- a/x11/xscreensaver/PLIST    Mon May 03 19:00:52 2021 +0000
+++ b/x11/xscreensaver/PLIST    Mon May 03 23:31:40 2021 +0000
@@ -1,4 +1,4 @@
-@comment $NetBSD: PLIST,v 1.51 2020/04/05 17:30:36 gutteridge Exp $
+@comment $NetBSD: PLIST,v 1.52 2021/05/03 23:31:40 gutteridge Exp $
 bin/xscreensaver
 bin/xscreensaver-command
 bin/xscreensaver-getimage
@@ -374,7 +374,7 @@
 man/man6/xrayswarm.6
 man/man6/xspirograph.6
 man/man6/zoom.6
-share/examples/xscreensaver/pam.d/xscreensaver-NetBSD
+share/doc/xscreensaver/README.pkgsrc
 share/locale/da/LC_MESSAGES/xscreensaver.mo
 share/locale/de/LC_MESSAGES/xscreensaver.mo
 share/locale/es/LC_MESSAGES/xscreensaver.mo
diff -r 27d34f3ecc07 -r 93c951dc2558 x11/xscreensaver/files/README.pkgsrc
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/x11/xscreensaver/files/README.pkgsrc      Mon May 03 23:31:40 2021 +0000
@@ -0,0 +1,15 @@
+$NetBSD: README.pkgsrc,v 1.1 2021/05/03 23:31:40 gutteridge Exp $
+
+If xscreensaver is built with the non-default "pam" option, on NetBSD, the
+"pam_pwauth_suid.so" module will 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. In order to make unlocking work, you need to add an xscreensaver
+file to your PAM configuration directory (usually /etc/pam.d). On NetBSD,
+you can find a sample pam.d file for xscreensaver in:
+       ${PREFIX}/share/examples/pam-pwauth_suid
+
+By default (if the "pam" option isn't set), pkgsrc will set the
+       ${PREFIX}/bin/xscreensaver
+executable setuid root. Since this is a relatively complex program,
+there is the risk of other exploits.
diff -r 27d34f3ecc07 -r 93c951dc2558 x11/xscreensaver/files/pam-xscreensaver-NetBSD
--- a/x11/xscreensaver/files/pam-xscreensaver-NetBSD    Mon May 03 19:00:52 2021 +0000
+++ /dev/null   Thu Jan 01 00:00:00 1970 +0000
@@ -1,17 +0,0 @@
-# $NetBSD: pam-xscreensaver-NetBSD,v 1.1 2007/01/08 21:45:10 drochner Exp $
-#
-# PAM configuration for the "xscreensaver" service
-#
-
-# auth
-auth           sufficient      pam_pwauth_suid.so
-auth           include         system
-
-# account
-account                include         system
-
-# session
-session                include         system
-
-# password
-password       include         system