.\" Copyright (c) 2012 Dovecot authors, see the included COPYING file .TH DOVEADM\-MOUNT 1M "2012-02-16" "Dovecot v2.2" "Dovecot" .SH NAME doveadm mount \- Manage the list of mountpoints where mails are stored .\"------------------------------------------------------------------------ .SH SYNOPSIS .nh .na .HP \" ./global-options-short.inc \" ./master-options-short.inc \fBdoveadm mount add\fR [\-D] [\-F\ \fIformatter\fR] [\-v] [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]... [\fIpath\fR [\fIstate\fR]] .HP \" ./global-options-short.inc \" ./master-options-short.inc \fBdoveadm mount list\fR [\-D] [\-F\ \fIformatter\fR] [\-v] [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]... .HP \" ./global-options-short.inc \" ./master-options-short.inc \fBdoveadm mount remove\fR [\-D] [\-F\ \fIformatter\fR] [\-v] [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]... \fIpath\fR .ad .hy .\"------------------------------------------------------------------------ .SH DESCRIPTION The doveadm .B mount commands can be used to manage the list of mountpoints where mails are stored. This is used mainly for better error handling when a mountpoint isn\'t mounted for some reason: .RS 2 .IP * 2 If a mail directory doesn\'t exist, it\'s autocreated. If the user\'s mails aren\'t mounted and filesystem permissions still allow the autocreation, the user will see an empty mailbox and later will have to redownload all mails. If the mountpoint is known to be unmounted, dovecot will simply fail opening any mailboxes. .IP * If dbox alternate storage isn\'t mounted and a mail in it is attempted to be accessed, dovecot normally rebuilds the indexes and notices that all the mails in alt storage are expunged. When the alt storage is mounted back and even if index is again rebuilt, the mails won\'t necessarily become visible anymore for IMAP clients. If the mountpoint is known to be unmounted, dovecot won\'t rebuild indexes and lose the mails. .RE .PP Dovecot automatically adds mountpoints to this list at startup. If you don\'t want some of the mountpoints added, you can add a wildcard ignore for it. .\"------------------------------------------------------------------------ .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'). .\"------------------------------------------------------------------------ .SH OPERANDS .TP .I path The directory name of a mountpoint .TP .I state The state of a mountpoint. Either \fBonline\fR or \fBignore\fR. .\"------------------------------------------------------------------------ .SH SUBCOMMANDS .na .HP \" ./global-options-short.inc \" ./master-options-short.inc \fBmount add\fR [\-D] [\-F\ \fIformatter\fR] [\-v] [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]... [\fIpath\fR [\fIstate\fR]] .ad .RS 3 .P If this command is run without any parameters, doveadm detects all missing mountpoints and adds them (the same way as when dovecot does at startup). When a mountpoint \fIpath\fR is given, it\'s added as a mountpoint. The \fIstate\fR can currently be either \fBonline\fR (default) or \fBignore\fR. The ignore state is mainly useful with path wildcards to add mountpoints that you never want dovecot to automatically add, such as: .B doveadm mount add '/mnt/*' ignore .RE .sp 2 .na .HP \" ./global-options-short.inc \" ./master-options-short.inc \fBmount list\fR [\-D] [\-F\ \fIformatter\fR] [\-v] [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]... .ad .RS 3 .P This command lists the mountpoints known to dovecot and their state. .RE .sp 2 .na .HP \" ./global-options-short.inc \" ./master-options-short.inc \fBmount remove\fR [\-D] [\-F\ \fIformatter\fR] [\-v] [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]... \fIpath\fR .ad .RS 3 .P This command removes the specified \fIpath\fR from the mountpoint list. .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