Documented the new option --debug-imap in the manpage.

This commit is contained in:
Nikolaus Schulz 2008-03-15 19:35:22 +00:00
parent c0f0ad33d7
commit 9ac3a68228
2 changed files with 24 additions and 2 deletions

View File

@ -3,7 +3,7 @@
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches, .\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>. .\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "ARCHIVEMAIL" "1" "13 November 2007" "SP" "" .TH "ARCHIVEMAIL" "1" "15 March 2008" "SP" ""
.SH NAME .SH NAME
archivemail \- archive and compress your old email archivemail \- archive and compress your old email
@ -229,6 +229,14 @@ mailbox.
\fB -v, --verbose\fR \fB -v, --verbose\fR
Reports lots of extra debugging information about what is going on. Reports lots of extra debugging information about what is going on.
.TP .TP
\fB --debug-imap=\fINUM\fB\fR
Set IMAP debugging level. This makes \fBarchivemail\fR dump its
conversation with the IMAP server and some internal IMAP
processing to stdout\&. Higher values for \fINUM\fR give more
elaborate output. Set \fINUM\fR to 4 to see all exchanged
IMAP commands. (Actually, \fINUM\fR is just passed
literally to imaplib.Debug\&.)
.TP
\fB -q, --quiet\fR \fB -q, --quiet\fR
Turns on quiet mode. Do not print any statistics about how many messages were Turns on quiet mode. Do not print any statistics about how many messages were
archived. This should be used if you are running \fBarchivemail\fR from archived. This should be used if you are running \fBarchivemail\fR from

View File

@ -35,7 +35,7 @@
<RefEntry> <RefEntry>
<DocInfo><Date>13 November 2007</Date></DocInfo> <DocInfo><Date>15 March 2008</Date></DocInfo>
<RefMeta> <RefMeta>
<RefEntryTitle>archivemail</RefEntryTitle> <RefEntryTitle>archivemail</RefEntryTitle>
@ -346,6 +346,20 @@ Reports lots of extra debugging information about what is going on.
</Para></ListItem> </Para></ListItem>
</VarListEntry> </VarListEntry>
<VarListEntry>
<Term>
<Option>--debug-imap=<Replaceable/NUM/</Option>
</Term>
<ListItem><Para>
Set <acronym/IMAP/ debugging level. This makes <Command/archivemail/ dump its
conversation with the <acronym/IMAP/ server and some internal <acronym/IMAP/
processing to <Literal/stdout/. Higher values for <Replaceable/NUM/ give more
elaborate output. Set <Replaceable/NUM/ to 4 to see all exchanged
<acronym/IMAP/ commands. (Actually, <Replaceable/NUM/ is just passed
literally to <Literal/imaplib.Debug/.)
</Para></ListItem>
</VarListEntry>
<VarListEntry> <VarListEntry>
<Term> <Term>
<Option>-q, --quiet</Option> <Option>-q, --quiet</Option>