www.LinuxHowtos.org howtos, tips&tricks and tutorials for linux

from small one page howto to huge articles all in one place

Other .linuxhowtos.org sites:gentoo.linuxhowtos.org

Last additions:

using iotop to find disk usage hogs

words:

887

views:

209595

userrating:

May 25th. 2007:

Words

486

Views

258597

why adblockers are bad

Workaround and fixes for the current Core Dump Handling vulnerability affected kernels

words:

161

views:

149892

userrating:

April, 26th. 2006:

Words

Views

107378

New subdomain: toolsntoys.linuxhowtos.org

You are here: manpages

DOVEAD-FTS

Section: Dovecot (1)
Updated: February 2026
Index Return to Main Contents

NAME

dovead-fts- Manipulate the Full Text Search (FTS) index

SYNOPSIS

doveadm [lB]GLOBAL OPTIONS[rB] fts command [lB]OPTIONS[rB] [lB]ARGUMENTS[rB]

DESCRIPTION

The doveadm fts COMMANDS can be used to manipulate the Full Text Search (FTS) index.

GLOBAL OPTIONS

Global doveadm(1) -D

: Enables verbosity and debug messages.

-O

: Do not read any config file, just use defaults. The dovecot_storage_version setting defaults to the latest version, but can be overridden with

-k

: Preserve entire environment for doveadm, not just import_environment setting.

-v

: Enables verbosity, including progress counter.

-i instanc-name

: If using multiple Dovecot instances, choose the config file based on this instance name. See instance_name setting for more information.

-c confi-file

: Read configuration from the given confi-file. By default it first reads config socket, and then falls back to /etc/dovecot/dovecot.conf. You can also point this to config socket of some instance running compatible version.

-o setting=value

: Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.

This command uses by default the output formatter flow (without the key=prefix).

OPTIONS

-A

: If the -A option is present, the command will be performed for all users. Using this option in combination with system users from userdb { driver = passwd } is not recommended, because it contains also users with a lower UID than the one configured with the first_valid_uid setting. When the SQL userdb module is used, make sure that the userdb_sql_iterate_query setting setting matches your database layout. When using the LDAP userdb module, make sure that the userdb_fields setting and userdb_ldap_iterate_fields setting settings match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users.

-F file

: Execute the command for all the users in the file. This is similar to the -A option, but instead of getting the list of users from the userdb, they are read from the given file. The file contains one username per line.

-n-userd-lookup

: Do not perform userdb lookup. Use the USER environment variable to specify the username.

-S socket_path

: The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (hostname:port), in order to connect a remote host via a TCP socket. This allows an administrator to execute doveadm(1) mail commands through the given socket.

-u user/mask

: Run the command only for the given user. It's also possible to use '*' and '?' wildcards (e.g.-u *@example.org).

ARGUMENTS

namespace

: The name of a namespace, e.g. the name of the shared namespace. When no namespace was given, the user's private namespace will be used.

COMMANDS

fts optimize

doveadm [lB]GLOBAL OPTIONS[rB] fts optimize [lB]-u user | -A | -F file | -n-userd-lookup[rB] [lB]-S socket_path[rB] [lB]namespace[rB] Optimize the full text search index. This is also done automatically by the full text search engines, but this enforces it to happen.

fts rescan

doveadm [lB]GLOBAL OPTIONS[rB] fts rescan [lB]-u user | -A | -F file | -n-userd-lookup[rB] [lB]-S socket_path[rB] [lB]namespace[rB] 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 doveadm index will index all the missing mails (if any). Note that currently most FTS drivers do not implement this properly, but instead they delete all the FTS indexes. This may change in the future versions.

fts flatcurve check

doveadm [lB]GLOBAL OPTIONS[rB] fts flatcurve check [lB]-u user | -A | -F file | -n-userd-lookup[rB] [lB]-S socket_path[rB] [lB]mailbox ...[rB] Run a simple check on Dovecot Xapian databases, and attempt to fix basic errors (it is the same checking done by the xapia-check command with the -F comman-line option). mailbox is the list of mailboxes to process. It is possible to use wildcards (* and ?) in this value. For each mailbox that has FTS data, it outputs the following key/value fields: | Key | Value | |- |- | | mailbox | The huma-readable mailbox name. (key is hidden) | | guid | The GUID of the mailbox. | | errors | The number of errors reported by the Xapian library. | | shards | The number of index shards processed. |

fts flatcurve remove

fts flatcurve rotate

fts flatcurve stats

REPORTING BUGS

Report bugs, including doveconf-n output, to the Dovecot Mailing List ladovecot@dovecot.orgra. Information about reporting bugs is available at: https://dovecot.org/bugreport.html