git: 095885577167 - main - sysutils/seatd: document common usage

[Jan Beich]

The branch main has been updated by jbeich:

URL: https://cgit.FreeBSD.org/ports/commit/?id=0958855771675c0baba0262b7e5d4266dc9fe2df

commit 0958855771675c0baba0262b7e5d4266dc9fe2df
Author:     Jan Beich <jbeich at FreeBSD.org>
AuthorDate: 2021-09-24 15:04:54 +0000
Commit:     Jan Beich <jbeich at FreeBSD.org>
CommitDate: 2021-09-24 17:22:01 +0000

    sysutils/seatd: document common usage
    
    In wlroots affects WLR_BACKENDS=drm,libinput (default on console).
    Weston also supports libseat but hasn't been tested.
    
    PR:             258664
    Submitted by:   Evgeniy Khramtsov <evgeniy at khramtsov.org> (based on)
---
 sysutils/seatd/Makefile             |  3 +++
 sysutils/seatd/files/pkg-message.in | 47 +++++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)

diff --git a/sysutils/seatd/Makefile b/sysutils/seatd/Makefile
index d80ab69175d6..1f934cd06c37 100644
--- a/sysutils/seatd/Makefile
+++ b/sysutils/seatd/Makefile
@@ -1,5 +1,6 @@
 PORTNAME=	seatd
 DISTVERSION=	0.6.2
+PORTREVISION=	1
 CATEGORIES=	sysutils
 MASTER_SITES=	https://git.sr.ht/~kennylevinsen/${PORTNAME}/archive/${DISTVERSIONFULL}${EXTRACT_SUFX}?dummy=/
 
@@ -12,6 +13,7 @@ LICENSE_FILE=	${WRKSRC}/LICENSE
 USES=		compiler:c11 meson pkgconfig
 USE_LDCONFIG=	yes
 USE_RC_SUBR=	${PORTNAME}
+SUB_FILES=	pkg-message
 PLIST_FILES=	bin/${PORTNAME} \
 		"@(,video,4750) bin/${PORTNAME}-launch" \
 		include/libseat.h \
@@ -21,6 +23,7 @@ PLIST_FILES=	bin/${PORTNAME} \
 
 OPTIONS_DEFINE=	BASU MANPAGES
 OPTIONS_DEFAULT=BASU MANPAGES
+OPTIONS_SUB=	yes
 
 # https://lists.sr.ht/~kennylevinsen/seatd-devel/%3CQHZRRQ.73ZI29COPK131%40unrelenting.technology%3E
 BASU_DESC=		ConsoleKit2 support via basu (experimental)
diff --git a/sysutils/seatd/files/pkg-message.in b/sysutils/seatd/files/pkg-message.in
new file mode 100644
index 000000000000..ce9f84223c62
--- /dev/null
+++ b/sysutils/seatd/files/pkg-message.in
@@ -0,0 +1,47 @@
+[
+{ type: install
+  message: <<EOM
+libseat is used to get DRM master and input devices for non-root users.
+On Wayland this is only necessary when starting a compositor under KMS
+console (e.g., /dev/ttyv0 backed by /dev/dri/card0). Nested sessions like
+"Wayland on X11" or "Wayland on Wayland" don't need extra configuration.
+
+By default libseat tries to find the first working backend. To override
+set LIBSEAT_BACKEND via environ(7). Available backends and try order:
+
+* "seatd" - seatd-launch(1) or seatd rc.d(8) service
+%%BASU%%* "consolekit2" - ck-launch-session(1) or pam_ck_connector(8)
+
+"seatd" backend requires membership in "video" group to be allowed to
+use setuid bit in seatd-launch(1) or connect to seatd(1) socket.
+
+  # pw groupmod video -m <user>
+  $ exit # log out to refresh group permissions
+
+For example, to start a wlroots-based compositor replace "sway" with
+your compositor (e.g., "hikari", "wayfire", "labwc", "river") then run
+
+  $ seatd-launch sway
+
+Alternatively, configure and run seatd(1) as system service
+
+  # sysrc seatd_enable=YES
+  # service seatd start
+  $ sway
+
+%%BASU%%To use ConsoleKit2 run
+%%BASU%%
+%%BASU%%  # pkg install consolekit2 basu
+%%BASU%%  # sysrc -x seatd_enable
+%%BASU%%  # service seatd stop
+%%BASU%%  # sysrc dbus_enable=YES
+%%BASU%%  # service dbus start
+%%BASU%%  $ ck-launch-session sway
+%%BASU%%
+%%BASU%%where "ck-launch-session" can be dropped after
+%%BASU%%
+%%BASU%%  # echo "session optional pam_ck_connector.so" >>/etc/pam.d/system
+%%BASU%%  $ exit # log out to re-trigger PAM
+EOM
+}
+]