summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBruno Victal <mirai@makinata.eu>2023-02-25 18:58:10 +0000
committerLudovic Courtès <ludo@gnu.org>2023-03-03 17:55:34 +0100
commite24555234a2914ccd2f6291f9ca95f60f137d74f (patch)
tree43885716b1d29bbce6c95d1265713642ef6a5099 /doc
parenteddd9b1240897caabf64c90549ffa940eef45ce7 (diff)
services: lirc: Deprecate 'lirc-service' procedure.
* doc/guix.texi (Miscellaneous Services): Replace 'lirc-service' with 'lirc-service-type'. Document <lirc-configuration>. * gnu/services/lirc.scm (<lirc-configuration>): Set default values based on the arguments from the now deprecated 'lirc-service' procedure. (lirc-service-type): Set default value. (lirc-service): Deprecate procedure. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi40
1 files changed, 27 insertions, 13 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 937b85e16ce..54b75dd1f8e 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -37726,24 +37726,38 @@ under @file{pcsc/drivers} in the store directory of the package.
37726@end table 37726@end table
37727@end deftp 37727@end deftp
37728 37728
37729@cindex lirc 37729@cindex LIRC
37730@subsubheading Lirc Service 37730@subsubheading LIRC Service
37731 37731
37732The @code{(gnu services lirc)} module provides the following service. 37732The @code{(gnu services lirc)} module provides the following service.
37733 37733
37734@deffn {Scheme Procedure} lirc-service [#:lirc lirc] @ 37734@defvar lirc-service-type
37735 [#:device #f] [#:driver #f] [#:config-file #f] @ 37735Type for a service that runs @url{http://www.lirc.org, LIRC}, a daemon
37736 [#:extra-options '()] 37736that decodes infrared signals from remote controls.
37737Return a service that runs @url{http://www.lirc.org,LIRC}, a daemon that
37738decodes infrared signals from remote controls.
37739 37737
37740Optionally, @var{device}, @var{driver} and @var{config-file} 37738The value for this service is a @code{<lirc-configuration>} object.
37741(configuration file name) may be specified. See @command{lircd} manual 37739@end defvar
37742for details.
37743 37740
37744Finally, @var{extra-options} is a list of additional command-line options 37741@deftp {Data Type} lirc-configuration
37745passed to @command{lircd}. 37742Data type representing the configuration of @command{lircd}.
37746@end deffn 37743
37744@table @asis
37745@item @code{lirc} (default: @code{lirc}) (type: file-like)
37746Package object for @command{lirc}.
37747
37748@item @code{device} (default: @code{#f}) (type: string)
37749@itemx @code{driver} (default: @code{#f}) (type: string)
37750@itemx @code{config-file} (default: @code{#f}) (type: string-or-file-like)
37751TODO. See @command{lircd} manual for details.
37752
37753@item @code{extra-options} (default: @code{'()}) (type: list-of-string)
37754Additional command-line options to pass to @command{lircd}.
37755
37756@end table
37757@end deftp
37758
37759@c TODO: Document <lirc-configuration>, preferably by refactoring this to use
37760@c define-configuration and generating documentation from it.
37747 37761
37748@cindex spice 37762@cindex spice
37749@subsubheading Spice Service 37763@subsubheading Spice Service