From: Pascal Volk <user@localhost.localdomain.org>
Date: Sat, 23 Nov 2013 19:35:09 +0000 (+0000)
Subject: man: doveadm-index.1: Added description for options -n and -q.
X-Git-Tag: 2.2.9~12
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ac3614a25b9569131ddb8ee9884c6fb4d100a21d;p=thirdparty%2Fdovecot%2Fcore.git

man: doveadm-index.1: Added description for options -n and -q.
---

diff --git a/doc/man/doveadm-index.1.in b/doc/man/doveadm-index.1.in
index 14ddb95002..ecd9b8328e 100644
--- a/doc/man/doveadm-index.1.in
+++ b/doc/man/doveadm-index.1.in
@@ -1,21 +1,27 @@
-.\" Copyright (c) 2010-2011 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-INDEX 1 "2011-05-11" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2010-2013 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-INDEX 1 "2013-11-23" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm\-index \- Index mailboxes
 .\"------------------------------------------------------------------------
 .SH SYNOPSIS
 .BR doveadm " [" \-Dv "] " index " [" \-S
-.IR socket_path "] " mailbox
+.IR socket_path ]
+.RB [ \-q "] [" \-n
+.IR max_recent "] " mailbox
 .\"-------------------------------------
 .br
 .BR doveadm " [" \-Dv "] " index " [" \-S
 .IR socket_path "] "
-.BI \-A \ mailbox
+.B \-A
+.RB [ \-q "] [" \-n
+.IR max_recent "] " mailbox
 .\"-------------------------------------
 .br
 .BR doveadm " [" \-Dv "] " index " [" \-S
 .IR socket_path "] "
-.BI \-u " user mailbox"
+.BI \-u \ user
+.RB [ \-q "] [" \-n
+.IR max_recent "] " mailbox
 .\"------------------------------------------------------------------------
 .SH DESCRIPTION
 Add unindexed messages in a mailbox into index/cache file. If full text
@@ -26,6 +32,17 @@ mailbox\(aqs caching decisions, so it won\(aqt do anything useful for
 mailboxes that user\(aqs client hasn\(aqt accessed yet. You can use
 .B doveadm dump
 command to show a specific mailbox\(aqs current caching decisions.
+.PP
+Messages can also be added automatically to full text search index using:
+.sp
+.nf
+plugin {
+  ...
+  fts_autoindex = yes
+}
+.fi
+in
+.IR @pkgsysconfdir@/conf.d/90\-plugin.conf .
 .\"------------------------------------------------------------------------
 @INCLUDE:global-options@
 .\" --- command specific options --- "/.
@@ -35,6 +52,25 @@ Command specific
 .\"-------------------------------------
 @INCLUDE:option-A@
 .\"-------------------------------------
+.TP
+.BI \-n \ max_recent
+An integer value, which specifies the maximum number of \(rsRecent
+messages in mailboxes.
+If the mailbox contains more than
+.I max_recent
+messages with \(rsRecent flag set, the mailbox will not be indexed.
+This may be useful to avoid unnecessary indexing for large mailboxes that
+are never opened.
+.\"-------------------------------------
+.TP
+.B \-q
+Queues the indexing to be run by indexer process.
+Without \-q the indexing is done directly by the
+.BR doveadm (1)
+process.
+Some backends like fts\-lucene can\(aqt handle multiple processes updating
+the indexes simultaneously, so \-q should usually be used on production.
+.\"-------------------------------------
 @INCLUDE:option-S-socket@
 .\"-------------------------------------
 @INCLUDE:option-u-user@