Updated documentation WRT to the new quoted usernames/passwords in IMAP URLs.

This commit is contained in:
Nikolaus Schulz 2007-10-23 23:11:29 +00:00
parent 0e9ae1d91b
commit f3719df4d2
2 changed files with 18 additions and 12 deletions

View File

@ -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

View File

@ -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>