Adding upstream version 1:2.3.19.1+dfsg1.upstream/1%2.3.19.1+dfsg1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 80 insertions, 0 deletions

diff --git a/doc/man/doveadm-fts.1.in b/doc/man/doveadm-fts.1.in
new file mode 100644
index 0000000..8e9de7d
--- /dev/null
+++ b/doc/man/doveadm-fts.1.in
@@ -0,0 +1,80 @@
+.\" Copyright (c) 2014-2018 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-FTS 1 "2015-05-09" "Dovecot v2.3" "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-F-file@
+.\"-------------------------------------
+@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\-F\fP \fIfile\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\-F\fP \fIfile\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). Note that currently most FTS
+backends do not implement this properly, but instead they delete all the
+FTS indexes. This may change in the future versions.
+.\"------------------------------------------------------------------------
+@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