diff options
author | conses <contact@conses.eu> | 2023-03-14 13:36:36 +0100 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2023-03-16 12:37:03 +0100 |
commit | 837e179e009cd55acc03193e5600fb0a8eb60e6b (patch) | |
tree | 0f04fe0dbde0cd87176f57ba9c5f61132135c4ac /doc/guix.texi | |
parent | 797461e16c0053db499285cbbcb66d7a4024dd42 (diff) | |
download | guix-837e179e009cd55acc03193e5600fb0a8eb60e6b.tar.gz |
home: services: Add home-unclutter-service-type.
* gnu/home/services/desktop.scm (home-unclutter-configuration) (home-unclutter-service-type): New variables; (home-unclutter-shepherd-service): New procedure; * doc/guix.texi (Desktop Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Diffstat (limited to 'doc/guix.texi')
-rw-r--r-- | doc/guix.texi | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 39932d5aad..56a24a1011 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -42541,6 +42541,36 @@ The package providing the @code{/bin/dbus-daemon} command. @end table @end deftp +@defvar home-unclutter-service-type +This is the service type for Unclutter, a program that runs on the +background of an X11 session and detects when the X pointer hasn't moved +for a specified idle timeout, after which it hides the cursor so that +you can focus on the text underneath. Its associated value must be a +@code{home-unclutter-configuration} record, as shown below. + +A typical configuration, where we manually specify the idle timeout (in +seconds), might look like this: + +@lisp +(service home-unclutter-service-type + (home-unclutter-configuration + (idle-timeout 2))) +@end lisp +@end defvar + +@deftp {Data Type} home-unclutter-configuration +The configuration record for @code{home-unclutter-service-type}. + +@table @asis +@item @code{unclutter} (default: @code{unclutter}) (type: file-like) +Unclutter package to use. + +@item @code{idle-timeout} (default: @code{5}) (type: integer) +A timeout in seconds after which to hide cursor. +@end table + +@end deftp + @node Guix Home Services @subsection Guix Home Services |