From: Pascal Volk <user@localhost.localdomain.org>
Date: Wed, 24 Sep 2014 20:01:46 +0000 (+0000)
Subject: man: Added doveadm-fts.1.
X-Git-Tag: 2.2.14.rc1~41
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=269cd8a29aaf64f7a51e22b77b63fee8ca41693c;p=thirdparty%2Fdovecot%2Fcore.git

man: Added doveadm-fts.1.
---

diff --git a/.hgignore b/.hgignore
index f95a1d5325..6342391ef6 100644
--- a/.hgignore
+++ b/.hgignore
@@ -105,5 +105,5 @@ src/plugins/quota/quota-status
 
 syntax: regexp
 src/.*/test-[^\.]*$
-doc/man/doveadm-(acl|altmove|auth|batch|deduplicate|director|dump|exec|expunge|fetch|flags|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|search|user|who)\.1$
+doc/man/doveadm-(acl|altmove|auth|batch|deduplicate|director|dump|exec|expunge|fetch|flags|fts|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|search|user|who)\.1$
 doc/man/(doveadm|doveconf|dovecot-lda|dovecot|dsync)\.1$
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 9722488ff5..a03e91b617 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -25,6 +25,7 @@ nodist_man1_MANS = \
 	doveadm-expunge.1 \
 	doveadm-fetch.1 \
 	doveadm-flags.1 \
+	doveadm-fts.1 \
 	doveadm-import.1 \
 	doveadm-instance.1 \
 	doveadm-index.1 \
@@ -68,6 +69,7 @@ EXTRA_DIST = \
 	doveadm-expunge.1.in \
 	doveadm-fetch.1.in \
 	doveadm-flags.1.in \
+	doveadm-fts.1.in \
 	doveadm-import.1.in \
 	doveadm-instance.1.in \
 	doveadm-index.1.in \
diff --git a/doc/man/doveadm-fts.1.in b/doc/man/doveadm-fts.1.in
new file mode 100644
index 0000000000..593db001d1
--- /dev/null
+++ b/doc/man/doveadm-fts.1.in
@@ -0,0 +1,76 @@
+.\" Copyright (c) 2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-FTS 1 "2014-09-24" "Dovecot v2.2" "Dovecot"
+.SH NAME
+doveadm\-fts \- Manipulate the Full Text Search (FTS) index
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv ]
+.\"	[\fB\-f\fP \fIformatter\fP]
+.BI fts \ command
+.RI [ OPTIONS ]\ [ ARGUMENTS ]
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+The
+doveadm fts
+.I COMMANDS
+can be used to manipulate the Full Text Search (FTS) index.
+.\"------------------------------------------------------------------------
+.\"	@INCLUDE:global-options-formatter@
+@INCLUDE:global-options@
+.\" --- command specific options --- "/.
+.PP
+This command uses by default the output formatter
+.B flow
+(without the
+.IR key =
+prefix).
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+@INCLUDE:option-A@
+.\"-------------------------------------
+@INCLUDE:option-S-socket@
+.\"-------------------------------------
+@INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.TP
+.I namespace
+The name of a namespace, e.g. the name of the shared namespace.
+When no namespace was given, the user\(aqs private namespace will be used.
+.\"------------------------------------------------------------------------
+.SH COMMANDS
+.SS fts optimize
+.B doveadm fts optimize
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.RI [ namespace ]
+.PP
+Optimize the full text search index.
+This is also done automatically by the full text search engines, but this
+enforces it to happen.
+.\"-------------------------------------
+.SS fts rescan
+.B doveadm fts rescan
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.RI [ namespace ]
+.PP
+Scan what mails exist in the full text search index and compare those to
+what actually exist in mailboxes.
+This removes mails from the index that have already been expunged and
+makes sure that the next
+.B doveadm index
+will index all the missing mails (if any).
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR doveadm\-index (1)
+.\"-------------------------------------
+.PP
+Additional resources:
+.IP "Full text search indexing"
+http://wiki2.dovecot.org/Plugins/FTS
\ No newline at end of file
diff --git a/doc/man/doveadm.1.in b/doc/man/doveadm.1.in
index cf56720a9a..eb4689c696 100644
--- a/doc/man/doveadm.1.in
+++ b/doc/man/doveadm.1.in
@@ -142,6 +142,11 @@ Fetch messages matching given search query.
 Add, remove or replace messages\(aq flags.
 .\"-------------------------------------
 .TP
+.B doveadm fts
+.BR doveadm\-fts (1),
+Manipulate the Full Text Search (FTS) index.
+.\"-------------------------------------
+.TP
 .B doveadm force\-resync
 .BR doveadm\-force\-resync (1),
 Repair broken mailboxes, in case Dovecot doesn\(aqt automatically do that.