aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGuilhem Moulin <guilhem@fripost.org>2020-12-11 21:24:32 +0100
committerGuilhem Moulin <guilhem@fripost.org>2020-12-12 11:15:36 +0100
commitea120902dfe146cd7f04a289da9fa05a9e06e44c (patch)
treee9efe02f2d545a5882a5291f07b4851cf7cd9120 /doc
parent765a8c2f7cac073b3b70277160639f8df3acb8ef (diff)
typofix, spelling
Diffstat (limited to 'doc')
-rw-r--r--doc/getting-started.md2
-rw-r--r--doc/interimap.1.md17
-rw-r--r--doc/pullimap.1.md23
3 files changed, 22 insertions, 20 deletions
diff --git a/doc/getting-started.md b/doc/getting-started.md
index 83d3ba9..74fc8da 100644
--- a/doc/getting-started.md
+++ b/doc/getting-started.md
@@ -20,7 +20,7 @@ format][mbox]). Local mail clients usually access it directly. They
also often maintain their own cache in order to speed up message header
listing and searches.
-While most bidirectional synchronisation software (such as [OfflineIMAP])
+While most bidirectional synchronization software (such as [OfflineIMAP])
are able to handle a mail storage in Maildir format, *InterIMAP is
not*. Instead, InterIMAP needs an [IMAP4rev1] server on *both* peers
to synchronize. This may sound like a severe limitation at first, but by
diff --git a/doc/interimap.1.md b/doc/interimap.1.md
index 9b14a49..2310cb3 100644
--- a/doc/interimap.1.md
+++ b/doc/interimap.1.md
@@ -249,7 +249,7 @@ Valid options are:
Two wildcards are available, and passed verbatim to the IMAP server:
a ‘\*’ character matches zero or more characters, while a ‘%’
character matches zero or more characters up to the hierarchy
- delimiter. Hardcoding the hierarchy delimiter in this setting is
+ delimiter. Hard-coding the hierarchy delimiter in this setting is
not advised because the server might silently change it at some
point. A null character should be used instead. For instance, if
*list-mailbox* is set `"foo\x00bar"` then, assuming the hierarchy
@@ -309,7 +309,7 @@ Valid options are:
`type=imap` and `type=imaps` are respectively used for IMAP and IMAP
over SSL/TLS connections over an INET socket.
`type=tunnel` causes `interimap` to create an unnamed pair of
- connected sockets for interprocess communication with a *command*
+ connected sockets for inter-process communication with a *command*
instead of opening a network socket.
Note that specifying `type=tunnel` in the `[remote]` section makes
the default *database* to be `localhost.db`.
@@ -383,13 +383,14 @@ Valid options are:
*SSL_protocols*
-: A space-separated list of SSL protocols to explicitly enable or
- disable (if prefixed with an exclamation mark `!`. Known protocols
- are `SSLv2`, `SSLv3`, `TLSv1`, `TLSv1.1`, `TLSv1.2`, and `TLSv1.3`.
+: Space-separated list of SSL/TLS protocol versions to explicitly
+ enable (or disable if prefixed with an exclamation mark `!`). Known
+ protocols are `SSLv2`, `SSLv3`, `TLSv1`, `TLSv1.1`, `TLSv1.2`, and
+ `TLSv1.3`.
Enabling a protocol is a short-hand for disabling all other
protocols.
- *Deprecacted*: Use *SSL_protocol_min* and/or *SSL_protocol_max*
+ *DEPRECATED*: Use *SSL_protocol_min* and/or *SSL_protocol_max*
instead.
*SSL_protocol_min*, *SSL_protocol_max*
@@ -398,7 +399,7 @@ Valid options are:
connection. Accepted values are `SSLv3`, `TLSv1`, `TLSv1.1`,
`TLSv1.2`, and `TLSv1.3`.
-*SSL_cipher_list*
+*SSL_cipherlist*
: The cipher list to send to the server. Although the server
determines which cipher suite is used, it should take the first
@@ -428,7 +429,7 @@ Valid options are:
*SSL_verify*
-: Whether to 1/ verify the server certificate chain, and 2/ match its
+: Whether to 1/ verify the server certificate chain; and 2/ match its
Subject Alternative Name (SAN) or Subject CommonName (CN) against
the value of the *host* option.
(Default: `YES`.)
diff --git a/doc/pullimap.1.md b/doc/pullimap.1.md
index 028cbaa..cf6ec52 100644
--- a/doc/pullimap.1.md
+++ b/doc/pullimap.1.md
@@ -106,14 +106,14 @@ Valid options are:
*deliver-ehlo*
-: Hostname to use in `EHLO` or `LHLO` commands.
+: Name to use in `EHLO` or `LHLO` commands.
(Default: `localhost.localdomain`.)
*deliver-rcpt*
: Message recipient. Note that the local part needs to quoted if it
contains special characters; see [RFC 5321] for details.
- (Default: the username associated with the effective uid of the
+ (Default: the username associated with the effective user ID of the
`pullimap` process.)
*purge-after*
@@ -123,7 +123,7 @@ Valid options are:
`SEARCH` criterion ignoring time and timezone.)
If *purge-after* is set to `0` then messages are deleted immediately
after delivery. Otherwise `pullimap` issues an IMAP `SEARCH` (or
- extended `SEARCH` on servers advertizing the [`ESEARCH`][RFC 4731]
+ extended `SEARCH` on servers advertising the [`ESEARCH`][RFC 4731]
capability) command to list old messages; if `--idle` is set then
the `SEARCH` command is issued again every 12 hours.
@@ -133,7 +133,7 @@ Valid options are:
`type=imap` and `type=imaps` are respectively used for IMAP and IMAP
over SSL/TLS connections over an INET socket.
`type=tunnel` causes `pullimap` to create an unnamed pair of
- connected sockets for interprocess communication with a *command*
+ connected sockets for inter-process communication with a *command*
instead of opening a network socket.
(Default: `imaps`.)
@@ -202,13 +202,14 @@ Valid options are:
*SSL_protocols*
-: A space-separated list of SSL protocols to explicitly enable or
- disable (if prefixed with an exclamation mark `!`. Known protocols
- are `SSLv2`, `SSLv3`, `TLSv1`, `TLSv1.1`, `TLSv1.2`, and `TLSv1.3`.
+: Space-separated list of SSL/TLS protocol versions to explicitly
+ enable (or disable if prefixed with an exclamation mark `!`). Known
+ protocols are `SSLv2`, `SSLv3`, `TLSv1`, `TLSv1.1`, `TLSv1.2`, and
+ `TLSv1.3`.
Enabling a protocol is a short-hand for disabling all other
protocols.
- *Deprecacted*: Use *SSL_protocol_min* and/or *SSL_protocol_max*
+ *DEPRECATED*: Use *SSL_protocol_min* and/or *SSL_protocol_max*
instead.
*SSL_protocol_min*, *SSL_protocol_max*
@@ -217,7 +218,7 @@ Valid options are:
connection. Accepted values are `SSLv3`, `TLSv1`, `TLSv1.1`,
`TLSv1.2`, and `TLSv1.3`.
-*SSL_cipher_list*
+*SSL_cipherlist*
: The cipher list to send to the server. Although the server
determines which cipher suite is used, it should take the first
@@ -247,7 +248,7 @@ Valid options are:
*SSL_verify*
-: Whether to 1/ verify the server certificate chain, and 2/ match its
+: Whether to 1/ verify the server certificate chain; and 2/ match its
Subject Alternative Name (SAN) or Subject CommonName (CN) against
the value of the *host* option.
(Default: `YES`.)
@@ -330,7 +331,7 @@ In more details, `pullimap` works as follows:
to terminate it gracefully.
3. Issue a `UID STORE` command to mark all retrieved messages (and
- stalled UIDs found in the *statefile* after the eigth byte) as
+ stalled UIDs found in the *statefile* after the eighth byte) as
`\Seen`.
4. Update the *statefile* with the new UIDNEXT value (bytes 5-8).