diff options
author | Bruno Victal <mirai@makinata.eu> | 2023-02-25 18:58:10 +0000 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2023-03-03 17:55:34 +0100 |
commit | e24555234a2914ccd2f6291f9ca95f60f137d74f (patch) | |
tree | 43885716b1d29bbce6c95d1265713642ef6a5099 /doc | |
parent | eddd9b1240897caabf64c90549ffa940eef45ce7 (diff) | |
download | guix-e24555234a2914ccd2f6291f9ca95f60f137d74f.tar.gz |
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.texi | 40 |
1 files changed, 27 insertions, 13 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 937b85e16c..54b75dd1f8 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -37726,24 +37726,38 @@ under @file{pcsc/drivers} in the store directory of the package. @end table @end deftp -@cindex lirc -@subsubheading Lirc Service +@cindex LIRC +@subsubheading LIRC Service The @code{(gnu services lirc)} module provides the following service. -@deffn {Scheme Procedure} lirc-service [#:lirc lirc] @ - [#:device #f] [#:driver #f] [#:config-file #f] @ - [#:extra-options '()] -Return a service that runs @url{http://www.lirc.org,LIRC}, a daemon that -decodes infrared signals from remote controls. +@defvar lirc-service-type +Type for a service that runs @url{http://www.lirc.org, LIRC}, a daemon +that decodes infrared signals from remote controls. -Optionally, @var{device}, @var{driver} and @var{config-file} -(configuration file name) may be specified. See @command{lircd} manual -for details. +The value for this service is a @code{<lirc-configuration>} object. +@end defvar -Finally, @var{extra-options} is a list of additional command-line options -passed to @command{lircd}. -@end deffn +@deftp {Data Type} lirc-configuration +Data type representing the configuration of @command{lircd}. + +@table @asis +@item @code{lirc} (default: @code{lirc}) (type: file-like) +Package object for @command{lirc}. + +@item @code{device} (default: @code{#f}) (type: string) +@itemx @code{driver} (default: @code{#f}) (type: string) +@itemx @code{config-file} (default: @code{#f}) (type: string-or-file-like) +TODO. See @command{lircd} manual for details. + +@item @code{extra-options} (default: @code{'()}) (type: list-of-string) +Additional command-line options to pass to @command{lircd}. + +@end table +@end deftp + +@c TODO: Document <lirc-configuration>, preferably by refactoring this to use +@c define-configuration and generating documentation from it. @cindex spice @subsubheading Spice Service |