~ubuntu-branches/ubuntu/trusty/dovecot/trusty-updates

« back to all changes in this revision

Viewing changes to doc/man/doveadm-index.1.in

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2014-01-08 09:35:49 UTC
  • mfrom: (1.15.3) (96.1.1 trusty-proposed)
  • Revision ID: package-import@ubuntu.com-20140108093549-814nkqdcxfbvgktg
Tags: 1:2.2.9-1ubuntu1
* Merge from Debian unstable, remaining changes:
  + Add mail-stack-delivery package:
    - Update d/rules
    - d/control: convert existing dovecot-postfix package to a dummy
      package and add new mail-stack-delivery package.
    - Update maintainer scripts.
    - Rename d/dovecot-postfix.* to debian/mail-stack-delivery.*
    - d/mail-stack-delivery.preinst: Move previously installed backups and
      config files to a new package namespace.
    - d/mail-stack-delivery.prerm: Added to handle downgrades.
  + Use Snakeoil SSL certificates by default:
    - d/control: Depend on ssl-cert.
    - d/dovecot-core.postinst: Relax grep for SSL_* a bit.
  + Add autopkgtest to debian/tests/*.
  + Add ufw integration:
    - d/dovecot-core.ufw.profile: new ufw profile.
    - d/rules: install profile in dovecot-core.
    - d/control: dovecot-core - suggest ufw.
  + d/dovecot-core.dirs: Added usr/share/doc/dovecot-core
  + Add apport hook:
    - d/rules, d/source_dovecot.py
  + Add upstart job:
    - d/rules, d/dovecot-core.dovecot.upstart, d/control,
      d/dovecot-core.dirs, dovecot-imapd.{postrm, postinst, prerm},
      d/dovecot-pop3d.{postinst, postrm, prerm}.
      d/mail-stack-deliver.postinst: Convert init script to upstart.
  + Use the autotools-dev dh addon to update config.guess/config.sub for
    arm64.
* Dropped changes, included in Debian:
  - Update Dovecot name to reflect distribution in login greeting.
  - Update Drac plugin for >= 2.0.0 support.
* d/control: Drop dovecot-postfix package as its no longer required.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" Copyright (c) 2010-2011 Dovecot authors, see the included COPYING file
2
 
.TH DOVEADM\-INDEX 1 "2011-05-11" "Dovecot v2.1" "Dovecot"
 
1
.\" Copyright (c) 2010-2013 Dovecot authors, see the included COPYING file
 
2
.TH DOVEADM\-INDEX 1 "2013-11-23" "Dovecot v2.2" "Dovecot"
3
3
.SH NAME
4
4
doveadm\-index \- Index mailboxes
5
5
.\"------------------------------------------------------------------------
6
6
.SH SYNOPSIS
7
7
.BR doveadm " [" \-Dv "] " index " [" \-S
8
 
.IR socket_path "] " mailbox
9
 
.\"-------------------------------------
10
 
.br
11
 
.BR doveadm " [" \-Dv "] " index " [" \-S
12
 
.IR socket_path "] "
13
 
.BI \-A \ mailbox
14
 
.\"-------------------------------------
15
 
.br
16
 
.BR doveadm " [" \-Dv "] " index " [" \-S
17
 
.IR socket_path "] "
18
 
.BI \-u " user mailbox"
 
8
.IR socket_path ]
 
9
.RB [ \-q "] [" \-n
 
10
.IR max_recent "] " mailbox
 
11
.\"-------------------------------------
 
12
.br
 
13
.BR doveadm " [" \-Dv "] " index " [" \-S
 
14
.IR socket_path "] "
 
15
.B \-A
 
16
.RB [ \-q "] [" \-n
 
17
.IR max_recent "] " mailbox
 
18
.\"-------------------------------------
 
19
.br
 
20
.BR doveadm " [" \-Dv "] " index " [" \-S
 
21
.IR socket_path "] "
 
22
.BI \-u \ user
 
23
.RB [ \-q "] [" \-n
 
24
.IR max_recent "] " mailbox
19
25
.\"------------------------------------------------------------------------
20
26
.SH DESCRIPTION
21
27
Add unindexed messages in a mailbox into index/cache file. If full text
26
32
mailboxes that user\(aqs client hasn\(aqt accessed yet. You can use
27
33
.B doveadm dump
28
34
command to show a specific mailbox\(aqs current caching decisions.
 
35
.PP
 
36
Messages can also be added automatically to full text search index using:
 
37
.sp
 
38
.nf
 
39
plugin {
 
40
  ...
 
41
  fts_autoindex = yes
 
42
}
 
43
.fi
 
44
in
 
45
.IR @pkgsysconfdir@/conf.d/90\-plugin.conf .
29
46
.\"------------------------------------------------------------------------
30
47
@INCLUDE:global-options@
31
48
.\" --- command specific options --- "/.
35
52
.\"-------------------------------------
36
53
@INCLUDE:option-A@
37
54
.\"-------------------------------------
 
55
.TP
 
56
.BI \-n \ max_recent
 
57
An integer value, which specifies the maximum number of \(rsRecent
 
58
messages in mailboxes.
 
59
If the mailbox contains more than
 
60
.I max_recent
 
61
messages with \(rsRecent flag set, the mailbox will not be indexed.
 
62
This may be useful to avoid unnecessary indexing for large mailboxes that
 
63
are never opened.
 
64
.\"-------------------------------------
 
65
.TP
 
66
.B \-q
 
67
Queues the indexing to be run by indexer process.
 
68
Without \-q the indexing is done directly by the
 
69
.BR doveadm (1)
 
70
process.
 
71
Some backends like fts\-lucene can\(aqt handle multiple processes updating
 
72
the indexes simultaneously, so \-q should usually be used on production.
 
73
.\"-------------------------------------
38
74
@INCLUDE:option-S-socket@
39
75
.\"-------------------------------------
40
76
@INCLUDE:option-u-user@