summaryrefslogtreecommitdiffstats
path: root/driver/xscreensaver-systemd.man
diff options
context:
space:
mode:
Diffstat (limited to 'driver/xscreensaver-systemd.man')
-rw-r--r--driver/xscreensaver-systemd.man80
1 files changed, 49 insertions, 31 deletions
diff --git a/driver/xscreensaver-systemd.man b/driver/xscreensaver-systemd.man
index 082cac7..beb23e7 100644
--- a/driver/xscreensaver-systemd.man
+++ b/driver/xscreensaver-systemd.man
@@ -1,49 +1,67 @@
-.TH XScreenSaver 1 "4-Jun-2019 (5.43)" "X Version 11"
+.TH XScreenSaver 1 "6-Jan-2021 (6.00)" "X Version 11"
.SH NAME
-xscreensaver-systemd - lock the screen when the machine suspends.
+xscreensaver-systemd - lock the screen upon suspend, and inhibit
+screen-blanking during video playback.
.SH SYNOPSIS
-.B xscreensaver-systemd
+.B xscreensaver-systemd [-verbose]
.SH DESCRIPTION
-The \fIxscreensaver\-systemd\fP program is a helper program to
-integrate xscreensaver with
-.BR systemd (1).
-When run from \fI~/.xsession\fP or equivalent, this will:
-.TP 3
-\fB1:
-Lock the screen before the system goes to sleep
-(using \fIxscreensaver-command -suspend\fP).
-.TP 3
-\fB2:
-Ensure the XScreenSaver password dialog is shown after the system
-is resumed (using \fIxscreensaver-command -deactivate\fP).
+The \fIxscreensaver\-systemd\fP program is a helper program launched by
+.BR xscreensaver (1)
+for
+.BR systemd (1)
+or
+.BR elogind (8)
+integration. It does two things:
+.TP 2
+\fB*
+When the system is about to go to sleep (e.g., the laptop lid has just been
+closed) it locks the screen just \fIbefore\fP the system sleeps, by running
+\fIxscreensaver-command -suspend\fP. When the system wakes up again, it
+runs \fIxscreensaver-command -deactivate\fP to make the unlock dialog appear
+immediately. It does this through the
+.BR org.freedesktop.login1 (5)
+D-Bus interface.
+.TP 2
+\fB*
+When another process on the system asks for the screen saver to be
+inhibited (e.g. because a video is playing) this program periodically runs
+\fIxscreensaver-command -deactivate\fP to keep the display un-blanked.
+It does this until the other program asks for it to stop, or exits.
+It does this through the
+.BR org.freedesktop.ScreenSaver (5)
+D-Bus interface.
.RS 0
-
-This is implemented using inhibitor locks;
-.BR sd-bus (3)
-is used for DBUS communication.
.SH BUGS
-Uses libsystemd.
+Only one program at a time can register with
+.BR systemd (1)
+for screen-saver-related events, so if another screen saver is running as a
+part of the desktop environment, \fIxscreensaver-systemd\fP will be unable to
+launch. Likely adversaries include
+.BR ksmserver (1)
+and
+.BR gsd\-screensaver\-proxy (1).
.SH SEE ALSO
.BR X (1),
.BR xscreensaver (1),
-.BR xscreensaver\-demo (1),
+.BR xscreensaver\-settings (1),
.BR xscreensaver\-command (1),
.BR systemd (1),
-.BR sd-bus (3)
+.BR sd-bus (3),
+.BR elogind (8)
.SH COPYRIGHT
-Copyright \(co 2019 by Martin Lucina.
+Copyright \(co 2019-2021 by Martin Lucina and Jamie Zawinski.
Permission to use, copy, modify, and/or distribute this software
for any purpose with or without fee is hereby granted, provided
that the above copyright notice and this permission notice appear
in all copies.
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
-WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
-CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
-OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
-NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
-CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+The software is provided "as is" and the author disclaims all
+warranties with regard to this software including all implied
+warranties of merchantability and fitness. in no event shall the
+author be liable for any special, direct, indirect, or
+consequential damages or any damages whatsoever resulting from loss
+of use, data or profits, whether in an action of contract,
+negligence or other tortious action, arising out of or in
+connection with the use or performance of this software.
.SH AUTHOR
Martin Lucina <martin@lucina.net>, 4-Jun-2019