diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/guix.texi | 84 |
1 files changed, 63 insertions, 21 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index a8ae5441d2..aa779e38e2 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -3426,7 +3426,7 @@ Both phases are executed after the @code{install} phase. @end defvr @defvr {Scheme Variable} ocaml-build-system -This variable is exported by @code{(guix build-sytem ocaml)}. It implements +This variable is exported by @code{(guix build-system ocaml)}. It implements a build procedure for @uref{https://ocaml.org, OCaml} packages, which consists of choosing the correct set of commands to run for each package. OCaml packages can expect many different commands to be run. This build system will @@ -9229,7 +9229,7 @@ The Rottlog package to use. The Rottlog configuration file to use (@pxref{Mandatory RC Variables,,, rottlog, GNU Rot[t]log Manual}). -@item @code{periodic-rotations} (default: @code{`(("weekly" %default-rotatations))}) +@item @code{periodic-rotations} (default: @code{`(("weekly" %default-rotations))}) A list of Rottlog period-name/period-config tuples. For example, taking an example from the Rottlog manual (@pxref{Period @@ -11134,7 +11134,7 @@ Network interface on which to listen. @item @code{port} (default: @code{6379}) Port on which to accept connections on, a value of 0 will disable -listining on a TCP socket. +listening on a TCP socket. @item @code{working-directory} (default: @code{"/var/lib/redis"}) Directory in which to store the database and related files. @@ -11367,9 +11367,9 @@ The driver that the passdb should use. Valid values include Defaults to @samp{"pam"}. @end deftypevr -@deftypevr {@code{passdb-configuration} parameter} free-form-args args -A list of key-value args to the passdb driver. -Defaults to @samp{()}. +@deftypevr {@code{passdb-configuration} parameter} space-separated-string-list args +Space separated list of arguments to the passdb driver. +Defaults to @samp{""}. @end deftypevr @end deftypevr @@ -11386,9 +11386,9 @@ The driver that the userdb should use. Valid values include Defaults to @samp{"passwd"}. @end deftypevr -@deftypevr {@code{userdb-configuration} parameter} free-form-args args -A list of key-value args to the userdb driver. -Defaults to @samp{()}. +@deftypevr {@code{userdb-configuration} parameter} space-separated-string-list args +Space separated list of arguments to the userdb driver. +Defaults to @samp{""}. @end deftypevr @deftypevr {@code{userdb-configuration} parameter} free-form-args override-fields @@ -12524,7 +12524,7 @@ as in this example: @end deffn @deftp {Data Type} opensmtpd-configuration -Data type regresenting the configuration of opensmtpd. +Data type representing the configuration of opensmtpd. @table @asis @item @code{package} (default: @var{opensmtpd}) @@ -13478,7 +13478,7 @@ Defaults to @samp{#f}. @end deftypevr @deftypevr {@code{openvpn-server-configuration} parameter} boolean client-to-client? -When true, clients are alowed to talk to each other inside the VPN. +When true, clients are allowed to talk to each other inside the VPN. Defaults to @samp{#f}. @@ -13502,7 +13502,7 @@ Defaults to @samp{100}. @deftypevr {@code{openvpn-server-configuration} parameter} string status The status file. This file shows a small report on current connection. -It is trunkated and rewritten every minute. +It is truncated and rewritten every minute. Defaults to @samp{"/var/run/openvpn/status"}. @@ -14256,7 +14256,7 @@ Defaults to @samp{#t}. @end deftypevr @deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist -Exclude specified PCI(e) devices adresses from Runtime Power Management. +Exclude specified PCI(e) device addresses from Runtime Power Management. Defaults to @samp{disabled}. @@ -14375,33 +14375,75 @@ This is the list of IP addresses and ports and possibly socket file names to listen to (@pxref{Server Settings, @code{listen} directive,, dico, GNU Dico Manual}). +@item @code{handlers} (default: @var{'()}) +List of @code{<dicod-handler>} objects denoting handlers (module instances). + @item @code{databases} (default: @var{(list %dicod-database:gcide)}) List of @code{<dicod-database>} objects denoting dictionaries to be served. @end table @end deftp -@deftp {Data Type} dicod-database -Data type representing a dictionary database. +@deftp {Data Type} dicod-handler +Data type representing a dictionary handler (module instance). @table @asis @item @code{name} -Name of the database, will be used in DICT commands. +Name of the handler (module instance). -@item @code{module} -Name of the dicod module used by this database +@item @code{module} (default: @var{#f}) +Name of the dicod module of the handler (instance). If it is @code{#f}, +the module has the same name as the handler. (@pxref{Modules,,, dico, GNU Dico Manual}). @item @code{options} List of strings or gexps representing the arguments for the module handler +@end table +@end deftp + +@deftp {Data Type} dicod-database +Data type representing a dictionary database. + +@table @asis +@item @code{name} +Name of the database, will be used in DICT commands. + +@item @code{handler} +Name of the dicod handler (module instance) used by this database (@pxref{Handlers,,, dico, GNU Dico Manual}). + +@item @code{complex?} (default: @var{#f}) +Whether the database configuration complex. The complex configuration +will need a corresponding @code{<dicod-handler>} object, otherwise not. + +@item @code{options} +List of strings or gexps representing the arguments for the database +(@pxref{Databases,,, dico, GNU Dico Manual}). @end table @end deftp @defvr {Scheme Variable} %dicod-database:gcide A @code{<dicod-database>} object serving the GNU Collaborative International -Dictonary of English using the @code{gcide} package. +Dictionary of English using the @code{gcide} package. @end defvr +The following is an example @code{dicod-service} configuration. + +@example +(dicod-service #:config + (dicod-configuration + (handlers (list (dicod-handler + (name "wordnet") + (module "dictorg") + (options + (list #~(string-append "dbdir=" #$wordnet)))))) + (databases (list (dicod-database + (name "wordnet") + (complex? #t) + (handler "wordnet") + (options '("database=wn"))) + %dicod-database:gcide)))) +@end example + @subsubsection Version Control The @code{(gnu services version-control)} module provides the following services: @@ -14411,7 +14453,7 @@ The @code{(gnu services version-control)} module provides the following services @deffn {Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)] Return a service that runs @command{git daemon}, a simple TCP server to -expose repositiories over the Git protocol for annoymous access. +expose repositories over the Git protocol for anonymous access. The optional @var{config} argument should be a @code{<git-daemon-configuration>} object, by default it allows read-only @@ -15320,7 +15362,7 @@ which may be insufficient for some operations. The file name of the qcow2 image. @end table -The default @command{run-vm.sh} script that is returned by an invokation of +The default @command{run-vm.sh} script that is returned by an invocation of @command{guix system vm} does not add a @command{-net user} flag by default. To get network access from within the vm add the @code{(dhcp-client-service)} to your system definition and start the VM using |