dovecot-2.0: man: Added doveadm move.

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.0/rev/c194c76b98ff
changeset: 12938:c194c76b98ff
user:      Pascal Volk <user at localhost.localdomain.org>
date:      Sun Sep 25 22:32:04 2011 +0000
description:
man: Added doveadm move.

diffstat:

 .hgignore                 |   2 +-
 doc/man/Makefile.am       |   6 +++
 doc/man/doveadm-move.1.in |  88 +++++++++++++++++++++++++++++++++++++++++++++++
 doc/man/doveadm.1.in      |   5 ++
 4 files changed, 100 insertions(+), 1 deletions(-)

diffs (148 lines):

diff -r 447d20eae931 -r c194c76b98ff .hgignore
--- a/.hgignore	Sun Sep 25 19:52:43 2011 +0000
+++ b/.hgignore	Sun Sep 25 22:32:04 2011 +0000
@@ -95,5 +95,5 @@
 
 syntax: regexp
 src/.*/test-[^\.]*$
-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-(altmove|auth|director|dump|expunge|fetch|import|index|force-resync|help|kick|log|mailbox|move|penalty|purge|pw|quota|search|user|who)\.1$
 doc/man/(doveadm|doveconf|dovecot-lda|dovecot|dsync)\.1$
diff -r 447d20eae931 -r c194c76b98ff doc/man/Makefile.am
--- a/doc/man/Makefile.am	Sun Sep 25 19:52:43 2011 +0000
+++ b/doc/man/Makefile.am	Sun Sep 25 22:32:04 2011 +0000
@@ -24,6 +24,7 @@
 	doveadm-kick.1 \
 	doveadm-log.1 \
 	doveadm-mailbox.1 \
+	doveadm-move.1 \
 	doveadm-penalty.1 \
 	doveadm-purge.1 \
 	doveadm-pw.1 \
@@ -59,6 +60,7 @@
 	doveadm-kick.1.in \
 	doveadm-log.1.in \
 	doveadm-mailbox.1.in \
+	doveadm-move.1.in \
 	doveadm-penalty.1.in \
 	doveadm-purge.1.in \
 	doveadm-pw.1.in \
@@ -131,6 +133,10 @@
 	$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
 		< $(srcdir)/doveadm-mailbox.1.in > doveadm-mailbox.1
 
+doveadm-move.1: $(srcdir)/doveadm-move.1.in $(man_includefiles) Makefile
+	$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
+		< $(srcdir)/doveadm-move.1.in > doveadm-move.1
+
 doveadm-penalty.1: $(srcdir)/doveadm-penalty.1.in $(man_includefiles) Makefile
 	$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
 		< $(srcdir)/doveadm-penalty.1.in > doveadm-penalty.1
diff -r 447d20eae931 -r c194c76b98ff doc/man/doveadm-move.1.in
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/doveadm-move.1.in	Sun Sep 25 22:32:04 2011 +0000
@@ -0,0 +1,88 @@
+.\" Copyright (c) 2011 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-MOVE 1 "2011-09-25" "Dovecot v2.0" "Dovecot"
+.SH NAME
+doveadm\-move \- Move messages matching the given search query into another
+mailbox
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " move " [" \-S
+.IR socket_path "] " "destination search_query"
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " move " [" \-S
+.IR socket_path "] "
+.BI \-A " destination search_query"
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " move " [" \-S
+.IR socket_path "] "
+.BI \-u " user destination search_query"
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+.B doveadm move
+can be used for moving mails between mailboxes for one or more users.
+The
+.I search_query
+is used to restrict which messages are moved into the
+.I destination
+mailbox.
+.PP
+In the first form,
+.BR doveadm (1)
+will executed the
+.B move
+action with the environment of the logged in system user.
+.PP
+In the second form,
+.BR doveadm (1)
+will iterate over all users, found in the configured
+.IR user_db (s),
+and move each user\(aqs messages, matching the given
+.IR search_query ,
+into the user\(aqs
+.IR destination " mailbox."
+.PP
+In the third form, matching mails will be moved only for given
+.IR user (s).
+.\"------------------------------------------------------------------------
+ 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 destination
+The name of the destination mailbox, into which the mails should be moved.
+The
+.I destination
+mailbox must exist, otherwise this command will fail.
+.\"-------------------------------------
+.TP
+.I search_query
+Move messages matching the given search query.
+See
+.BR doveadm\-search\-query (7)
+for details.
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+Move jane\(aqs messages \- received in September 2011 \- from her INBOX
+into her archive.
+.PP
+.nf
+.B doveadm move \-u jane Archive/2011/09 mailbox INBOX BEFORE \(rs
+.B 2011-10-01 SINCE 01-Sep-2011
+.fi
+.\"------------------------------------------------------------------------
+ at INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR doveadm\-search\-query (7)
\ No newline at end of file
diff -r 447d20eae931 -r c194c76b98ff doc/man/doveadm.1.in
--- a/doc/man/doveadm.1.in	Sun Sep 25 19:52:43 2011 +0000
+++ b/doc/man/doveadm.1.in	Sun Sep 25 22:32:04 2011 +0000
@@ -122,6 +122,11 @@
 Various commands related to handling mailboxes.
 .\"-------------------------------------
 .TP
+.B doveadm move
+.BR doveadm\-move (1)
+Move messages matching the given search query into another mailbox.
+.\"-------------------------------------
+.TP
 .B doveadm purge
 .BR doveadm\-purge (1)
 Remove messages with refcount=0 from mdbox files.