From 06563b95754156d8803d7dae47d1737985886a55 Mon Sep 17 00:00:00 2001
From: dakkar <dakkar@thenautilus.net>
Date: Sat, 1 May 2021 10:48:04 +0100
Subject: pod

---
 scripts/xscreensaver-dbus | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

(limited to 'scripts')

diff --git a/scripts/xscreensaver-dbus b/scripts/xscreensaver-dbus
index 5e188f2..98e61c9 100755
--- a/scripts/xscreensaver-dbus
+++ b/scripts/xscreensaver-dbus
@@ -3,6 +3,51 @@ use strict;
 use warnings;
 use Log::Any::Adapter Stdout => ( log_level => 'debug' );
 use App::XScreenSaver::DBus;
+# VERSION
+# PODNAME: xscreensaver-dbus
+# ABSTRACT: tie xscreensaver into dbus
 
 $|++;
 App::XScreenSaver::DBus->new->run;
+
+=head1 SYNOPSIS
+
+    xscreensaver &
+    xscreensaver-dbus > ~/xscreensaver-dbus.log &
+
+=head1 DESCRIPTION
+
+This program will ensure that xscreensaver locks the screen before
+your laptop goes to sleep, and will prevent the screen saver from
+running while video is playing.
+
+It does so by implementing L<the "idle inhibition" DBus
+service|https://people.freedesktop.org/~hadess/idle-inhibition-spec/index.html>
+and using L<the "inhibitor locks" feature of
+logind|https://www.freedesktop.org/wiki/Software/systemd/inhibit/>.
+
+=head1 WHY?
+
+If you use xscreensaver, you may have noticed that it doesn't
+integrate very well with all the new & fancy desktop features.
+
+jwz has resisted adding this kind of integration to the base program,
+saying (sensibly) that they would bloat the code and introduce
+potential security holes.
+
+From version 5.43, xscreensaver includes F<xscreensaver-systemd>, a
+stripped-down version of L<a program initially developed by Martin
+Lucina|https://github.com/mato/xscreensaver-systemd>, which handles
+the logind interaction. Both of those versions link to F<libsystemd>,
+which you may not have if you use elogind instead of the full systemd.
+
+So I wrote this.
+
+=head1 REFERENCES
+
+=for :list
+* Martin Lucina F<xscreensaver-systemd> https://github.com/mato/xscreensaver-systemd
+* the Debian bug where the above program is first mentioned https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=781961
+* "Is there a decent way to inhibit screensavers in linux?" on StackOverflow https://stackoverflow.com/questions/460140/is-there-a-decent-way-to-inhibit-screensavers-in-linux
+* the systemd "Inhibitor Locks" documentation https://www.freedesktop.org/wiki/Software/systemd/inhibit/
+* the "idle inhibition" spec https://people.freedesktop.org/~hadess/idle-inhibition-spec/index.html
-- 
cgit v1.2.3