aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristopher Baines <mail@cbaines.net>2020-01-20 19:02:32 +0000
committerChristopher Baines <mail@cbaines.net>2020-01-20 19:09:00 +0000
commit2e1a31487122aa841d513c212f65d47294a927a6 (patch)
tree5e38bb57bde424698e3f3b6af6ecbfe51e2db988
parent147a7f1fd2c33058600eda17153911cd36cc9c3f (diff)
downloadpatches-2e1a31487122aa841d513c212f65d47294a927a6.tar
patches-2e1a31487122aa841d513c212f65d47294a927a6.tar.gz
services: getmail: Fix some configuration documentation strings.
* gnu/services/getmail.scm (getmail-retriever-configuration): Specify proper documentation strings for some of the fields. * doc/guix.texi (Mail Services): Update the documentation accordingly.
-rw-r--r--doc/guix.texi14
-rw-r--r--gnu/services/getmail.scm14
2 files changed, 14 insertions, 14 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index dea4584286..25dc8b9124 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -17715,21 +17715,21 @@ Defaults to @samp{"SimpleIMAPSSLRetriever"}.
@end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string server
-Space separated list of arguments to the userdb driver.
+Username to login to the mail server with.
Defaults to @samp{unset}.
@end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string username
-Space separated list of arguments to the userdb driver.
+Username to login to the mail server with.
Defaults to @samp{unset}.
@end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} non-negative-integer port
-Space separated list of arguments to the userdb driver.
+Port number to connect to.
Defaults to @samp{#f}.
@@ -17750,28 +17750,28 @@ Defaults to @samp{()}.
@end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string keyfile
-PEM-formatted key file to use for the TLS negotiation
+PEM-formatted key file to use for the TLS negotiation.
Defaults to @samp{""}.
@end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string certfile
-PEM-formatted certificate file to use for the TLS negotiation
+PEM-formatted certificate file to use for the TLS negotiation.
Defaults to @samp{""}.
@end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} string ca-certs
-CA certificates to use
+CA certificates to use.
Defaults to @samp{""}.
@end deftypevr
@deftypevr {@code{getmail-retriever-configuration} parameter} parameter-alist extra-parameters
-Extra retriever parameters
+Extra retriever parameters.
Defaults to @samp{()}.
diff --git a/gnu/services/getmail.scm b/gnu/services/getmail.scm
index 218e018b05..93e0ab1add 100644
--- a/gnu/services/getmail.scm
+++ b/gnu/services/getmail.scm
@@ -112,13 +112,13 @@
@samp{passwd} and @samp{static}.")
(server
(string 'unset)
- "Space separated list of arguments to the userdb driver.")
+ "Name or IP adddress of the server to retrieve mail from.")
(username
(string 'unset)
- "Space separated list of arguments to the userdb driver.")
+ "Username to login to the mail server with.")
(port
(non-negative-integer #f)
- "Space separated list of arguments to the userdb driver.")
+ "Port number to connect to.")
(password
(string "")
"Override fields from passwd.")
@@ -127,16 +127,16 @@
"Override fields from passwd.")
(keyfile
(string "")
- "PEM-formatted key file to use for the TLS negotiation")
+ "PEM-formatted key file to use for the TLS negotiation.")
(certfile
(string "")
- "PEM-formatted certificate file to use for the TLS negotiation")
+ "PEM-formatted certificate file to use for the TLS negotiation.")
(ca-certs
(string "")
- "CA certificates to use")
+ "CA certificates to use.")
(extra-parameters
(parameter-alist '())
- "Extra retriever parameters"))
+ "Extra retriever parameters."))
(define (serialize-getmail-destination-configuration field-name val)
(serialize-configuration val getmail-destination-configuration-fields))