aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNikolaus Schulz <microschulz@web.de>2007-10-23 23:11:29 +0000
committerNikolaus Schulz <microschulz@web.de>2007-10-23 23:11:29 +0000
commitf3719df4d257f80d0aaed71da601a89ee8e13b2e (patch)
tree7f86d0d9f572f2a6e0ee6caef4e807c5b941b5eb
parent0e9ae1d91b3f6b117a9d2fffe019ee601717f82c (diff)
downloadarchivemail-f3719df4d257f80d0aaed71da601a89ee8e13b2e.tar.gz
archivemail-f3719df4d257f80d0aaed71da601a89ee8e13b2e.tar.bz2
archivemail-f3719df4d257f80d0aaed71da601a89ee8e13b2e.zip
Updated documentation WRT to the new quoted usernames/passwords in IMAP URLs.
-rw-r--r--archivemail.115
-rw-r--r--archivemail.sgml15
2 files changed, 18 insertions, 12 deletions
diff --git a/archivemail.1 b/archivemail.1
index cb937f5..27b53ce 100644
--- a/archivemail.1
+++ b/archivemail.1
@@ -3,7 +3,7 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "ARCHIVEMAIL" "1" "06 November 2006" "SP" ""
+.TH "ARCHIVEMAIL" "1" "24 October 2007" "SP" ""
.SH NAME
archivemail \- archive and compress your old email
@@ -220,11 +220,14 @@ Display brief summary information about how to run \fBarchivemail\fR\&.
.PP
To archive an \fBIMAP\fR-format mailbox, use the format
\fBimap://username:password@server/mailbox\fR to specify the
-mailbox. You can omit the password from the URL; use the
-\fB--pwfile\fR option to make \fBarchivemail\fR read the
-password from a file, or just enter it upon request. Substitute 'imap\&'
-with 'imaps\&', and \fBarchivemail\fR will establish a secure
-SSL connection.
+mailbox. If your username or password contains the '@' or ':' character,
+you can double-quote it like this:
+\fBimap://"username@bogus.com":"password"@server/mailbox\fR\&. Use a
+backslash to escape double-quotes that are part of a quoted username or password.
+You can omit the password from the URL; use the \fB--pwfile\fR
+option to make \fBarchivemail\fR read the password from a file, or just
+enter it upon request. Substitute 'imap\&' with 'imaps\&', and
+\fBarchivemail\fR will establish a secure SSL connection.
.PP
When reading an \fBmbox\fR-format mailbox, \fBarchivemail\fR will
create a lockfile with the extension \fI\&.lock\fR so that
diff --git a/archivemail.sgml b/archivemail.sgml
index 8b100ee..ff3ecd5 100644
--- a/archivemail.sgml
+++ b/archivemail.sgml
@@ -35,7 +35,7 @@
<RefEntry>
-<DocInfo><Date>2 November 2006</Date></DocInfo>
+<DocInfo><Date>23 October 2007</Date></DocInfo>
<RefMeta>
<RefEntryTitle>archivemail</RefEntryTitle>
@@ -349,11 +349,14 @@ Display brief summary information about how to run <Command/archivemail/.
<Para>
To archive an <application/IMAP/-format mailbox, use the format
<command>imap://username:password@server/mailbox</command> to specify the
-mailbox. You can omit the password from the <acronym/URL/; use the
-<option>--pwfile</option> option to make <command/archivemail/ read the
-password from a file, or just enter it upon request. Substitute '<acronym/imap/'
-with '<acronym/imaps/', and <command/archivemail/ will establish a secure
-<acronym/SSL/ connection.
+mailbox. If your username or password contains the '@' or ':' character,
+you can double-quote it like this:
+<command>imap://"username@bogus.com":"password"@server/mailbox</command>. Use a
+backslash to escape double-quotes that are part of a quoted username or password.
+You can omit the password from the <acronym/URL/; use the <option>--pwfile</option>
+option to make <command/archivemail/ read the password from a file, or just
+enter it upon request. Substitute '<acronym/imap/' with '<acronym/imaps/', and
+<command/archivemail/ will establish a secure <acronym/SSL/ connection.
</Para>
<Para>