dovecot-2.2: man: doveadm-index.1: Added description for options...

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/151a2cfe3d34
changeset: 17019:151a2cfe3d34
user:      Pascal Volk <user at localhost.localdomain.org>
date:      Sat Nov 23 19:35:09 2013 +0000
description:
man: doveadm-index.1: Added description for options -n and -q.

diffstat:

 doc/man/doveadm-index.1.in |  46 +++++++++++++++++++++++++++++++++++++++++-----
 1 files changed, 41 insertions(+), 5 deletions(-)

diffs (80 lines):

diff -r 14be468c8963 -r 151a2cfe3d34 doc/man/doveadm-index.1.in
--- a/doc/man/doveadm-index.1.in	Sat Nov 23 21:18:30 2013 +0200
+++ b/doc/man/doveadm-index.1.in	Sat Nov 23 19:35:09 2013 +0000
@@ -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 @@
 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 @@
 .\"-------------------------------------
 @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@