Adding upstream version 1:2.3.21+dfsg1.upstream/1%2.3.21+dfsg1

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 93 insertions, 0 deletions

diff --git a/doc/man/doveadm-dump.1.in b/doc/man/doveadm-dump.1.in
new file mode 100644
index 0000000..4582b4f
--- /dev/null
+++ b/doc/man/doveadm-dump.1.in
@@ -0,0 +1,93 @@
+.\" Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-DUMP 1 "2014-08-24" "Dovecot v2.3" "Dovecot"
+.SH NAME
+doveadm\-dump \- Dump the content of Dovecot\(aqs binary mailbox index/log
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " dump " [" \-t
+.IR type "] " path
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+Dovecot uses several binary index and log files in order to improve
+performance for accessing mails. For some mailbox formats, such as sdbox
+and mdbox, the index files are part of the format itself.
+For details about index files, see also: http://wiki2.dovecot.org/IndexFiles
+.PP
+.B doveadm dump
+is used to show the contents of those mailbox index/log files, in human
+readable format. This is mainly useful for Dovecot developers when
+debugging some problem.
+.\"------------------------------------------------------------------------
+@INCLUDE:global-options@
+.\" --- command specific options --- "/.
+.PP
+Command specific
+.IR options :
+.TP
+.BI \-t\  type
+the file type of the file to be dumped.
+If the
+.I type
+was omitted,
+.BR doveadm (1)
+tries to detect the type of
+.IR path .
+.I type
+can be:
+.RS
+.TP 12
+.B dbox
+\(rA m.\c
+.I n
+(sdbox or mdbox mailbox file)
+.TP
+.B fts\-expunge\-log
+Dump the list of expunged mails in
+.IR dovecot\-expunges.log .
+Currently used only by fts\-lucene.
+.TP
+.B fts\-lucene
+Dump the list of indexed mails in
+.I lucene\-indexes
+directory
+.TP
+.B imapzlib
+Uncompress an IMAP traffic log, which contains data compressed using the
+IMAP COMPRESSION extension.
+.TP
+.B dcrypt-file
+Dump metadata of a dcrypt encrypted file.
+.TP
+.B dcrypt-key
+Dump metadata of a dcrypt key.
+.TP
+.B index
+\(rA dovecot.index, dovecot.map.index
+.TP
+.B log
+\(rA dovecot.index.log, dovecot.map.index.log
+.TP
+.B mailboxlog
+\(rA dovecot.mailbox.log
+.TP
+.B thread
+\(rA dovecot.index.thread
+.RE
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.TP
+.I path
+The path to the corresponding dbox storage, index or log file.
+If only a directory is specified, doveadm tries to detect the type of files
+under it and dumps them.
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+Look at the contents of a mailbox\(aqs index:
+.PP
+.nf
+.B doveadm dump ~/Maildir/.work/
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1)
\ No newline at end of file