.\" Copyright (c) 2010-2012 Dovecot authors, see the included COPYING file .TH DOVEADM\-DUMP 1M "2012-02-21" "Dovecot v2.2" "Dovecot" .SH NAME doveadm dump \- Dump the content of dovecot\'s binary mailbox index/log .\"------------------------------------------------------------------------ .SH SYNOPSIS .nh .na .HP \" ./global-options-short.inc \" ./master-options-short.inc \fBdoveadm dump\fR [\-D] [\-F\ \fIformatter\fR] [\-v] [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]... [\-t \fItype\fR] \fIpath\fR .ad .hy .\"------------------------------------------------------------------------ .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. .\"------------------------------------------------------------------------ .SH OPTIONS Common options: \" ./global-options.inc \" vim: ts=4 sw=4 filetype=nroff .TP .B \-D Enables verbosity and debug messages. .TP .BI \-F\ formatter Specifies the \fIformatter\fR for formatting the output. Supported formatters are: .RS .TP 2 .B flow Prints each line with .IB key = value pairs. .TP .B pager Prints each .IB key = value pair on its own line and separates records with form feed character (\fB^L\fR). .TP .B tab Prints a table header followed by tab separated value lines. .TP .B table Prints a table header followed by adjusted value lines. .RE .TP .B \-v Enables verbosity, including progress counter. \" ./master-options.inc \" vim: ts=4 sw=4 filetype=nroff .TP .BI \-c\ file Read configuration from the given \fIfile\fR. By default \fI/etc/dovecot/dovecot.conf\fR will be used. .TP .BI \-i\ instance Get the configuration from the instance with the name \fIinstance\fR. .TP .B \-k Keep environment, i.e. when executing a new process do not explicitly set the environment variables HOME, USER and when reading configurations, don\'t overwrite currently set environment variables with corresponding settings. Usually used internally, only. .TP .B \-L Log directly. .TP .B \-O Don\'t read settings, but use whatever is in the environment. .TP .BI \-o\ setting = value Overrides the \fIsetting\fR from the current configuration with the given \fIvalue\fR (can be specified multiple times). E.g. with \-o dsync_alt_char=c one is able to overwrite the character to use as an replacement for all invalid characters encountered within a mailbox name (per default \'\fB_\fR'). .P Command specific options: .TP .BI \-t\ type the file type of the file to be dumped. If the \fItype\fR was omitted, .BR doveadm (1M) tries to detect the type of \fIpath\fR. \fItype\fR can be: .RS .IP \fBdbox\fR 2 m.\fIn\fR (sdbox or mdbox mailbox file) .IP \fBindex\fR dovecot.index, dovecot.map.index .IP \fBlog\fR dovecot.index.log, dovecot.map.index.log .IP \fBmailboxlog\fR dovecot.mailbox.log .IP \fBthread\fR dovecot.index.thread .RE .\"------------------------------------------------------------------------ .SH OPERANDS .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 EXAMPLES Look at the contents of a mailbox\'s index: .RS 3 .nf .B doveadm dump ~/Maildir/.work/ .fi .RE .\"------------------------------------------------------------------------ .SH SEE ALSO .BR doveadm (1M) .\"------------------------------------------------------------------------ \" ./reporting-bugs.inc .SH REPORTING BUGS Report bugs, including \fBdoveconf \-n\fR output, to the dovecot Mailing List . Information about reporting bugs is available at: http://dovecot.org/bugreport.html