summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBruno Victal <mirai@makinata.eu>2023-03-06 17:26:44 +0000
committerLudovic Courtès <ludo@gnu.org>2023-03-10 14:49:58 +0100
commit5627c73a9e410c7e28d67df517bd275d8c5f5d8d (patch)
treeabde077521c315d9f952ba71eef5e34d63991d9e /doc
parent1a6f230dd3228ada28ae54166debecd634998663 (diff)
services: xorg: Deprecate 'screen-locker-service' procedure.
* doc/guix.texi (X Window): Replace 'screen-locker-service' with 'screen-locker-service-type'. Document <screen-locker-configuration>. * gnu/services/desktop.scm (desktop-services-for-system): Use screen-locker-service-type. * gnu/services/xorg.scm: Export accessors for <screen-locker-configuration>. (<screen-locker>): Rename to ... (<screen-locker-configuration>): ... this. (<screen-locker-configuration>)[empty?]: Rename to ... (<screen-locker-configuration>)[allow-empty-password?]: ... this. (screen-locker-pam-services): Update record name. (screen-locker-setuid-programs): Update accessor name. (screen-locker-service): Deprecate procedure. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi32
1 files changed, 26 insertions, 6 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index b098e45a50..ce65a3bf99 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -22212,18 +22212,38 @@ Usually the X server is started by a login manager.
@end deffn
-@deffn {Scheme Procedure} screen-locker-service @var{package} [@var{program}]
-Add @var{package}, a package for a screen locker or screen saver whose
-command is @var{program}, to the set of setuid programs and add a PAM entry
-for it. For example:
+@defvar screen-locker-service-type
+Type for a service that adds a package for a screen locker or screen
+saver to the set of setuid programs and add a PAM entry for it. The
+value for this service is a @code{<screen-locker-configuration>} object.
+
+For example, to make XlockMore usable:
@lisp
-(screen-locker-service xlockmore "xlock")
+(service screen-locker-service-type
+ (screen-locker-configuration
+ "xlock" (file-append xlockmore "/bin/xlock") #f))
@end lisp
makes the good ol' XlockMore usable.
-@end deffn
+@end defvar
+@deftp {Data Type} screen-locker-configuration
+Data type representing the configuration of
+@code{screen-locker-service-type}.
+
+@table @asis
+@item @code{name} (type: string)
+Name of the screen locker.
+
+@item @code{program} (type: gexp)
+Path to the executable for the screen locker as a G-Expression.
+
+@item @code{allow-empty-password?} (type: boolean)
+Whether to allow empty passwords.
+
+@end table
+@end deftp
@node Printing Services
@subsection Printing Services