Merge branch 'master' into debian

1 files changed, 49 insertions, 5 deletions

diff --git a/interimap.1 b/interimap.1
index 44235fc..988fa16 100644
--- a/interimap.1
+++ b/interimap.1
@@ -15,10 +15,7 @@ servers.
 Such synchronization is made possible by the QRESYNC extension from
 [RFC7162]; for convenience reasons servers must also support
 LIST\-EXTENDED [RFC5258], LIST\-STATUS [RFC5819] and UIDPLUS [RFC4315].
-Furthermore, while \fBInterIMAP\fR can work with servers lacking support
-for LITERAL+ [RFC2088] and MULTIAPPEND [RFC3502], these extensions
-greatly improve performance by reducing the number of required round
-trips hence are recommended.
+See also the \fBSUPPORTED EXTENSIONS\fR section.
 
 .PP
 Stateful synchronization is only possible for mailboxes supporting
@@ -311,6 +308,49 @@ rely on Certificate Authorities.
 Directory containing the certificate(s) of the trusted Certificate
 Authorities, used for server certificate verification.
 
+.TP
+.I compress
+Whether to use the IMAP COMPRESS extension [RFC4978] for servers
+advertizing it.
+(Default: \(lqNO\(rq for the \(lq[local]\(rq section, \(lqYES\(rq for
+the \(lq[remote]\(rq section.)
+
+.TP
+.I null-stderr
+Whether to redirect \fIcommand\fR's standard error to \(lq/dev/null\(rq
+for type \fItype\fR=tunnel.
+(Default: \(lqNO\(rq.)
+
+.TP
+.I use-binary
+Whether to use the Binary Content extension [RFC3516] in FETCH and
+APPEND commands.
+This is useful for binary attachments for instance, as it avoids the
+overhead caused by base64 encodings.  Moreover if the IMAP COMPRESS
+extension is enabled, full flush points are placed around large non-text
+literals to empty the compression dictionary.
+This option is only available in the default section, and is ignored if
+either server does not advertize \(lqBINARY\(rq in its capability list.
+(Default: \(lqYES\(rq.)
+
+.SH SUPPORTED EXTENSIONS
+
+Performance is better for servers supporting the following extensions to
+the IMAP4rev1 [RFC3501] protocol:
+
+.IP \[bu]
+LITERAL+ [RFC2088] non-synchronizing literals (recommended),
+.IP \[bu]
+MULTIAPPEND [RFC3502] (recommended),
+.IP \[bu]
+COMPRESS=DEFLATE [RFC4978] (recommended),
+.IP \[bu]
+SASL-IR [RFC4959] SASL Initial Client Response,
+.IP \[bu]
+UNSELECT [RFC3691], and
+.IP \[bu]
+BINARY [RFC3516].
+
 .SH KNOWN BUGS AND LIMITATIONS
 
 .IP \[bu]
@@ -329,10 +369,14 @@ a message is moved to another mailbox (using the MOVE command from
 [RFC6851] or COPY + STORE + EXPUNGE), moving a messages causes
 \fBInterIMAP\fR to believe that it was deleted while another one (which
 is replicated again) was added to the other mailbox in the meantime.
-
 .IP \[bu]
 \(lqPLAIN\(rq and \(lqLOGIN\(rq are the only authentication mechanisms
 currently supported.
+.IP \[bu]
+\fBInterIMAP\fR will probably not work with non RFC-compliant servers.
+In particular, no work-around are currently implemented beside the
+tunable in the configuration file.  Morever, few IMAP servers have been
+tested so far.
 
 .SH AUTHOR
 Written by Guilhem Moulin