This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 2 and 3
Revision 2 as of 2014-10-26 05:30:33
Size: 4772
Editor: PageImporter
Comment:
Revision 3 as of 2015-05-10 05:30:31
Size: 5168
Editor: PageImporter
Comment:
Deletions are marked like this. Additions are marked like this.
Line 39: Line 39:
<dt><b>-F&nbsp;</b><i>file</i></dt>
<dd>Execute the <i>command</i> for all the users in the <i>file</i>. This is similar to the
<b>-A</b> option, but instead of getting the list of users from the userdb, they are read from the
given <i>file</i>. The <i>file</i> contains one username per line.</dd>
Line 49: Line 53:
When neither the <b>-A</b> option nor <b>-u&nbsp;</b><i>user</i> was specified, the <i>command</i>
will be executed with the environment of the currently logged in user.</dd>
When neither the <b>-A</b> option, nor the <b>-F&nbsp;</b><i>file</i> option, nor the
<b>-u&nbsp;</b><i>user</i> was specified, the <i>command</i> will be executed with the environment
of the currently logged in user.</dd>
Line 61: Line 66:
<p><b>doveadm fts optimize</b> [<b>-u</b> <i>user</i>|<b>-A</b>] [<b>-S</b> <i>socket_path</i>]
[<i>namespace</i>]</p>
<p><b>doveadm fts optimize</b> [<b>-u</b> <i>user</i>|<b>-A</b>|<b>-F</b> <i>file</i>] [<b>-S</b>
<i>socket_path</i>] [<i>namespace</i>]</p>
Line 66: Line 71:
<p><b>doveadm fts rescan</b> [<b>-u</b> <i>user</i>|<b>-A</b>] [<b>-S</b> <i>socket_path</i>]
[<i>namespace</i>]</p>
<p><b>doveadm fts rescan</b> [<b>-u</b> <i>user</i>|<b>-A</b>|<b>-F</b> <i>file</i>] [<b>-S</b>
<i>socket_path</i>] [<i>namespace</i>]</p>

Doveadm-Fts

Name

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

Synopsis

doveadm [-Dv] fts command [OPTIONS] [ARGUMENTS]

Description

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

Options

Global doveadm(1) options:

-D
Enables verbosity and debug messages.
-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.
-v
Enables verbosity, including progress counter.

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

Command specific 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 iterate_query setting in /etc/dovecot/dovecot-sql.conf.ext matches your database layout. When using the LDAP userdb module, make sure that the iterate_attrs and iterate_filter settings in /etc/dovecot/dovecot-ldap.conf.ext 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.
-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).
When neither the -A option, nor the -F file option, nor the -u user was specified, the command will be executed with the environment of the currently logged in user.

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 fts optimize [-u user|-A|-F file] [-S socket_path] [namespace]

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 fts rescan [-u user|-A|-F file] [-S socket_path] [namespace]

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).

See Also

doveadm(1), doveadm-index(1)

Additional resources:

Full text search indexing
http://wiki2.dovecot.org/Plugins/FTS


CategoryMan

None: Tools/Doveadm/FTS (last edited 2020-02-09 03:30:01 by PageImporter)