dovecot-2.0: man: Added doveadm index.

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.0/rev/822bd4936d46
changeset: 12802:822bd4936d46
user:      Timo Sirainen <tss at iki.fi>
date:      Wed May 11 17:56:25 2011 +0300
description:
man: Added doveadm index.

diffstat:

 .hgignore                  |   2 +-
 doc/man/Makefile.am        |   6 ++++
 doc/man/doveadm-index.1.in |  57 ++++++++++++++++++++++++++++++++++++++++++++++
 doc/man/doveadm.1.in       |   7 ++++-
 4 files changed, 70 insertions(+), 2 deletions(-)

diffs (124 lines):

diff -r a410f68c5fba -r 822bd4936d46 .hgignore
--- a/.hgignore	Wed May 11 17:45:03 2011 +0300
+++ b/.hgignore	Wed May 11 17:56:25 2011 +0300
@@ -94,5 +94,5 @@
 
 syntax: regexp
 src/.*/test-[^\.]*$
-doc/man/doveadm-(altmove|auth|director|dump|expunge|fetch|import|force-resync|help|kick|log|mailbox|penalty|purge|pw|quota|search|user|who)\.1$
+doc/man/doveadm-(altmove|auth|director|dump|expunge|fetch|import|index|force-resync|help|kick|log|mailbox|penalty|purge|pw|quota|search|user|who)\.1$
 doc/man/(doveadm|doveconf|dovecot-lda|dovecot|dsync)\.1$
diff -r a410f68c5fba -r 822bd4936d46 doc/man/Makefile.am
--- a/doc/man/Makefile.am	Wed May 11 17:45:03 2011 +0300
+++ b/doc/man/Makefile.am	Wed May 11 17:56:25 2011 +0300
@@ -18,6 +18,7 @@
 	doveadm-expunge.1 \
 	doveadm-fetch.1 \
 	doveadm-import.1 \
+	doveadm-index.1 \
 	doveadm-force-resync.1 \
 	doveadm-help.1 \
 	doveadm-kick.1 \
@@ -52,6 +53,7 @@
 	doveadm-expunge.1.in \
 	doveadm-fetch.1.in \
 	doveadm-import.1.in \
+	doveadm-index.1.in \
 	doveadm-force-resync.1.in \
 	doveadm-help.1.in \
 	doveadm-kick.1.in \
@@ -105,6 +107,10 @@
 	$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
 		< $(srcdir)/doveadm-import.1.in > doveadm-import.1
 
+doveadm-index.1: $(srcdir)/doveadm-index.1.in $(man_includefiles) Makefile
+	$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
+		< $(srcdir)/doveadm-index.1.in > doveadm-index.1
+
 doveadm-force-resync.1: $(srcdir)/doveadm-force-resync.1.in $(man_includefiles) Makefile
 	$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
 		< $(srcdir)/doveadm-force-resync.1.in > doveadm-force-resync.1
diff -r a410f68c5fba -r 822bd4936d46 doc/man/doveadm-index.1.in
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/doveadm-index.1.in	Wed May 11 17:56:25 2011 +0300
@@ -0,0 +1,57 @@
+.\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-IMPORT 1 "2011-05-11" "Dovecot v2.0" "Dovecot"
+.SH NAME
+doveadm\-index \- Index mailboxes
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " force\-resync " [" \-S
+.IR socket_path "] " mailbox
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] " force\-resync " [" \-S
+.IR socket_path "] "
+.BI \-A \ mailbox
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] " force\-resync " [" \-S
+.IR socket_path "] "
+.BI \-u " user mailbox"
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+Add unindexed messages in a mailbox into index/cache file. If full text
+search is enabled, also add unindexed messages to the fts database.
+.PP
+The caching adds only the fields that were previously added to the
+mailbox\(aqs caching decisions, so it won\(aqt do anything useful for
+mailboxes that user\(aqs client hasn\(aqt accessed yet. You can use
+.B doveadm dump
+command to show a specific mailbox\(aqs current caching decisions.
+.\"------------------------------------------------------------------------
+ at INCLUDE:global-options@
+.\" --- command specific options --- "/.
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+ at INCLUDE:option-A@
+.\"-------------------------------------
+ at INCLUDE:option-S-socket@
+.\"-------------------------------------
+ at INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.TP
+.I mailbox
+The name of the mailbox to index.
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+Index bob\(aqs INBOX:
+.PP
+.nf
+.B doveadm index \-u bob INBOX
+.fi
+.\"------------------------------------------------------------------------
+ at INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1)
\ No newline at end of file
diff -r a410f68c5fba -r 822bd4936d46 doc/man/doveadm.1.in
--- a/doc/man/doveadm.1.in	Wed May 11 17:45:03 2011 +0300
+++ b/doc/man/doveadm.1.in	Wed May 11 17:56:25 2011 +0300
@@ -1,5 +1,5 @@
 .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
-.TH DOVEADM 1 "2010-11-25" "Dovecot v2.0" "Dovecot"
+.TH DOVEADM 1 "2011-05-11" "Dovecot v2.0" "Dovecot"
 .SH NAME
 doveadm \- Dovecot\(aqs administration utility
 .\"------------------------------------------------------------------------
@@ -112,6 +112,11 @@
 Import messages matching given search query.
 .\"-------------------------------------
 .TP
+.B doveadm index
+.BR doveadm\-index (1),
+Index messages in a given mailbox.
+.\"-------------------------------------
+.TP
 .B doveadm mailbox
 .BR doveadm\-mailbox (1),
 Various commands related to handling mailboxes.