changeset 22934:7a52d7471f90

man: Document doveadm mailbox cache commands
author Aki Tuomi <aki.tuomi@dovecot.fi>
date Wed, 25 Apr 2018 10:56:04 +0300
parents d086a11030b7
children dc05b2f6a4dd
files doc/man/doveadm-mailbox.1.in
diffstat 1 files changed, 50 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/man/doveadm-mailbox.1.in	Fri Apr 13 13:28:47 2018 +0300
+++ b/doc/man/doveadm-mailbox.1.in	Wed Apr 25 10:56:04 2018 +0300
@@ -284,6 +284,55 @@
 Usually this is only ever to be used during migration, or restoring mailbox after disaster.
 Settings these values is highly discouraged, and is not supported for all mail backends.
 .\"------------------------------------------------------------------------
+.SS mailbox cache decision
+.B doveadm mailbox cache decision
+[\fB\-A\fP|\fB\-u\fP \fIuser\fP|\fB\-F\fP \fIfile\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+[\fB\--all\fP]
+[\fB\--fields\fP \fIlist of fields\fP]
+[\fB\--last-used\fP \fIunix timestamp\fP]
+[\fB\--decision\fP \fIno|temp|yes\fP]
+.IR mailbox\ ...
+.PP
+This command is used to list or change caching decisions for field(s) in mailbox(es).
+You can list decisions by leaving out decision and last-used parameters.
+.PP
+.\"-------------------------------------
+.TP
+.B \--all
+List or change all fields.
+.\"-------------------------------------
+.TP
+.B \--fields
+List or change these comma/space separated fields.
+.\"-------------------------------------
+.TP
+.B \--decision
+Set field caching decision. Yes means it's always cached.
+Temp means it's provisionally cached.
+No means the field is not cached.
+.\"-------------------------------------
+.TP
+.B \--last-used
+Set field's last used timestamp.
+.\"-------------------------------------
+.RE
+.PP
+NOTE. This command cannot be used to add new fields to cache! \
+You need to first add them to configuration. \
+Setting caching to no will not immediately drop field from cache, \
+it will stop adding the field to cache.
+.\"------------------------------------------------------------------------
+.SS mailbox cache remove
+.B doveadm mailbox cache remove
+[\fB\-A\fP|\fB\-u\fP \fIuser\fP|\fB\-F\fP \fIfile\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.IR search query
+.PP
+Remove any matching mail(s) from cache.
+.PP
+WARNING! This command can erase ALL cached data, causing system slowness.
+.\"------------------------------------------------------------------------
 .SH EXAMPLE
 List subscribed mailboxes, beginning with \(aqdovecot\(aq, of user bob.
 .sp
@@ -328,4 +377,5 @@
 .\"------------------------------------------------------------------------
 .SH SEE ALSO
 .BR doveadm (1)
+.BR doveadm-search-query (5)
 .BR doveadm-mailbox-cryptokey(1)