doc: Expound on inputattach service.
authorLudovic Courtès <ludo@gnu.org>
Mon, 18 Mar 2019 09:22:57 +0000 (10:22 +0100)
committerLudovic Courtès <ludo@gnu.org>
Mon, 18 Mar 2019 09:51:06 +0000 (10:51 +0100)
* doc/guix.texi (Miscellaneous Services): Expound documentation of
inputattach service.

doc/guix.texi

index 601afed..63581bb 100644 (file)
@@ -22506,19 +22506,31 @@ resolution when the graphical console window resizes.
 @cindex inputattach
 @subsubheading inputattach Service
 
+@cindex tablet input, for Xorg
+@cindex touchscreen input, for Xorg
+The @uref{https://linuxwacom.github.io/, inputattach} service allows you to
+use input devices such as Wacom tablets, touchscreens, or joysticks with the
+Xorg display server.
+
+@deffn {Scheme Variable} inputattach-service-type
+Type of a service that runs @command{inputattach} on a device and
+dispatches events from it.
+@end deffn
+
 @deftp {Data Type} inputattach-configuration
 @table @asis
-@item @code{device-type} The type of device to connect to.
-@item @code{device} The device file to connect to the device.
-@item @code{log-file} The file to log messages to.
+@item @code{device-type} (default: @code{"wacom"})
+The type of device to connect to.  Run @command{inputattach --help}, from the
+@code{inputattach} package, to see the list of supported device types.
+
+@item @code{device} (default: @code{"/dev/ttyS0"})
+The device file to connect to the device.
+
+@item @code{log-file} (default: @code{#f})
+If true, this must be the name of a file to log messages to.
 @end table
 @end deftp
 
-@deffn {Scheme Procedure} inputattach-service-type
-Return a service that runs inputattach on a device and
-dispatches events from it.
-@end deffn
-
 @subsection Dictionary Services
 @cindex dictionary
 The @code{(gnu services dict)} module provides the following service: