interimap: accept C-style escape sequences in 'list-mailbox'.

This is useful for defining names containing control characters (incl.
\0 for unspecified hierarchy delimiter).

1 files changed, 11 insertions, 7 deletions

diff --git a/interimap.md b/interimap.md
index 4d85eaf..a230c09 100644
--- a/interimap.md
+++ b/interimap.md
@@ -82,10 +82,10 @@ the *list-mailbox*, *list-select-opts* and *ignore-mailbox* options from
 the [configuration file](#configuration-file) can be used to shrink that
 list and save bandwidth.
 However if some extra argument are provided on the command line,
-`interimap` ignores said options and synchronizes the given
+`interimap` ignores these options and synchronizes the given
 *MAILBOX*es instead.  Note that each *MAILBOX* is taken “as is”; in
 particular, it must be [UTF-7 encoded][RFC 2152], unquoted, and the list
-wildcards ‘\*’ and ‘%’ are not expanded.
+wildcards ‘\*’ and ‘%’ are passed verbatim to the IMAP server.
 
 If the synchronization was interrupted during a previous run while some
 messages were being replicated (but before the `UIDNEXT` or
@@ -219,12 +219,16 @@ Valid options are:
 :   A space separated list of mailbox patterns to use when issuing the
     initial `LIST` command (overridden by the *MAILBOX*es given as
     command-line arguments).
-    Note that each pattern containing special characters such as spaces
-    or brackets (see [RFC 3501] for the exact syntax) must be quoted.
+    Names containing special characters such as spaces or brackets need
+    to be enclosed in double quotes.  Within double quotes C-style
+    backslash escape sequences can be used (‘\\t’ for an horizontal tab,
+    ‘\\n’ for a new line, ‘\\\\’ for a backslash, etc.), as well as
+    hexadecimal escape sequences ‘\\xHH’.
     Furthermore, non-ASCII names must be [UTF-7 encoded][RFC 2152].
-    Two wildcards are available: a ‘\*’ character matches zero or more
-    characters, while a ‘%’ character matches zero or more characters up
-    to the mailbox's hierarchy delimiter.
+    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.
     This option is only available in the default section.
     (The default pattern, `*`, matches all visible mailboxes on the
     server.)