doveadm-mount(1)

1DOVEADM-MOUNT(1)                    Dovecot                   DOVEADM-MOUNT(1)
2
3
4

NAME

6       doveadm-mount - Manage the list of mountpoints where mails are stored
7

SYNOPSIS

9       doveadm [-Dv] [-f formatter] mount command [arguments]
10

DESCRIPTION

12       The  doveadm  mount  commands  can be used to manage the list of mount‐
13       points where mails are stored.  This is used mainly  for  better  error
14       handling when a mountpoint isn't mounted for some reason:
15
16       *   If a mail directory doesn't exist, it's autocreated.  If the user's
17           mails aren't mounted and filesystem  permissions  still  allow  the
18           autocreation,  the  user  will  see an empty mailbox and later will
19           have to redownload all mails.  If the mountpoint  is  known  to  be
20           unmounted, Dovecot will simply fail opening any mailboxes.
21
22       *   If  dbox  alternate  storage  isn't  mounted  and  a  mail in it is
23           attempted to be accessed, Dovecot normally rebuilds the indexes and
24           notices  that  all the mails in alt storage are expunged.  When the
25           alt storage is mounted back and even if index is again rebuilt, the
26           mails  won't  necessarily  become visible anymore for IMAP clients.
27           If the mountpoint is known to be unmounted, Dovecot  won't  rebuild
28           indexes and lose the mails.
29
30       Dovecot automatically adds mountpoints to this list at startup.  If you
31       don't want some of the mountpoints added, you can add a wildcard ignore
32       for it.
33

OPTIONS

35       Global doveadm(1) options:
36
37       -D     Enables verbosity and debug messages.
38
39       -f formatter
40              Specifies  the  formatter  for formatting the output.  Supported
41              formatters are:
42
43              flow   prints each line with key=value pairs.
44
45              pager  prints each key: value pair on its own line and separates
46                     records with form feed character (^L).
47
48              tab    prints  a  table  header  followed by tab separated value
49                     lines.
50
51              table  prints a table header followed by adjusted value lines.
52
53       -o setting=value
54              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
55              cot.conf  and from the userdb with the given value.  In order to
56              override multiple settings, the -o option may be specified  mul‐
57              tiple times.
58
59       -v     Enables verbosity, including progress counter.
60

ARGUMENTS

62       path   The directory name of a mountpoint
63
64       state  The state of a mountpoint.  Either online or ignore.
65

COMMANDS

67   mount add
68       doveadm mount add [path [state]]
69
70       If  this  command  is  run  without any parameters, doveadm detects all
71       missing mountpoints and adds them (the same way as when Dovecot does at
72       startup).
73
74       When a mountpoint path is given, it's added as a mountpoint.  The state
75       can currently be either "online" (default)  or  "ignore".   The  ignore
76       state  is mainly useful with path wildcards to add mountpoints that you
77       never want Dovecot to automatically add, such  as:  doveadm  mount  add
78       '/mnt/*' ignore
79
80   mount list
81       doveadm [-Dv ] [-f formatter] mount list
82
83       This command lists the mountpoints known to Dovecot and their state.
84
85   mount remove
86       doveadm mount remove path
87
88       This command removes the specified path from the mountpoint list.
89

REPORTING BUGS

91       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
92       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
93       at: http://dovecot.org/bugreport.html
94