diff options
| author | Bruno Victal <mirai@makinata.eu> | 2023-03-05 00:48:23 +0000 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2023-03-17 23:20:36 +0100 |
| commit | 20aa4c30fbfdb72c25d267fe36299f02e3e202e2 (patch) | |
| tree | 9f853079f86f34ba3830a6a83dbfa2912a8125e3 /doc | |
| parent | 511ae8325db0dfc7803d7b98d7e4d8f76774e8c5 (diff) | |
services: dict: Deprecate 'dicod-service' procedure.
* doc/guix.texi (Miscellaneous Services): Remove 'dicod-service' mention.
* gnu/services/dict.scm (dicod-service): Deprecate procedure.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix.texi | 46 |
1 files changed, 20 insertions, 26 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index edf410d0243..fa9ea5a6ecf 100644 --- a/doc/guix.texi +++ b/doc/guix.texi | |||
| @@ -37850,25 +37850,17 @@ If true, this must be the name of a file to log messages to. | |||
| 37850 | 37850 | ||
| 37851 | @subsubheading Dictionary Service | 37851 | @subsubheading Dictionary Service |
| 37852 | @cindex dictionary | 37852 | @cindex dictionary |
| 37853 | |||
| 37853 | The @code{(gnu services dict)} module provides the following service: | 37854 | The @code{(gnu services dict)} module provides the following service: |
| 37854 | 37855 | ||
| 37855 | @defvar dicod-service-type | 37856 | @defvar dicod-service-type |
| 37856 | This is the type of the service that runs the @command{dicod} daemon, an | 37857 | This is the type of the service that runs the @command{dicod} daemon, an |
| 37857 | implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual}). | 37858 | implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual}). |
| 37858 | @end defvar | ||
| 37859 | |||
| 37860 | @deffn {Scheme Procedure} dicod-service [#:config (dicod-configuration)] | ||
| 37861 | Return a service that runs the @command{dicod} daemon, an implementation | ||
| 37862 | of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual}). | ||
| 37863 | |||
| 37864 | The optional @var{config} argument specifies the configuration for | ||
| 37865 | @command{dicod}, which should be a @code{<dicod-configuration>} object, by | ||
| 37866 | default it serves the GNU Collaborative International Dictionary of English. | ||
| 37867 | 37859 | ||
| 37868 | You can add @command{open localhost} to your @file{~/.dico} file to make | 37860 | You can add @command{open localhost} to your @file{~/.dico} file to make |
| 37869 | @code{localhost} the default server for @command{dico} client | 37861 | @code{localhost} the default server for @command{dico} client |
| 37870 | (@pxref{Initialization File,,, dico, GNU Dico Manual}). | 37862 | (@pxref{Initialization File,,, dico, GNU Dico Manual}). |
| 37871 | @end deffn | 37863 | @end defvar |
| 37872 | 37864 | ||
| 37873 | @deftp {Data Type} dicod-configuration | 37865 | @deftp {Data Type} dicod-configuration |
| 37874 | Data type representing the configuration of dicod. | 37866 | Data type representing the configuration of dicod. |
| @@ -37933,22 +37925,24 @@ A @code{<dicod-database>} object serving the GNU Collaborative International | |||
| 37933 | Dictionary of English using the @code{gcide} package. | 37925 | Dictionary of English using the @code{gcide} package. |
| 37934 | @end defvar | 37926 | @end defvar |
| 37935 | 37927 | ||
| 37936 | The following is an example @code{dicod-service} configuration. | 37928 | The following is an example @code{dicod-service-type} configuration. |
| 37937 | 37929 | ||
| 37938 | @lisp | 37930 | @lisp |
| 37939 | (dicod-service #:config | 37931 | (service dicod-service-type |
| 37940 | (dicod-configuration | 37932 | (dicod-configuration |
| 37941 | (handlers (list (dicod-handler | 37933 | (handlers (list |
| 37942 | (name "wordnet") | 37934 | (dicod-handler |
| 37943 | (module "dictorg") | 37935 | (name "wordnet") |
| 37944 | (options | 37936 | (module "dictorg") |
| 37945 | (list #~(string-append "dbdir=" #$wordnet)))))) | 37937 | (options |
| 37946 | (databases (list (dicod-database | 37938 | (list #~(string-append "dbdir=" #$wordnet)))))) |
| 37947 | (name "wordnet") | 37939 | (databases (list |
| 37948 | (complex? #t) | 37940 | (dicod-database |
| 37949 | (handler "wordnet") | 37941 | (name "wordnet") |
| 37950 | (options '("database=wn"))) | 37942 | (complex? #t) |
| 37951 | %dicod-database:gcide)))) | 37943 | (handler "wordnet") |
| 37944 | (options '("database=wn"))) | ||
| 37945 | %dicod-database:gcide)))) | ||
| 37952 | @end lisp | 37946 | @end lisp |
| 37953 | 37947 | ||
| 37954 | @cindex Docker | 37948 | @cindex Docker |
