Mercurial > dovecot > core-2.2
changeset 13553:af13ef62d083
man: Added doveadm move.
author | Pascal Volk <user@localhost.localdomain.org> |
---|---|
date | Sun, 25 Sep 2011 22:32:04 +0000 |
parents | 67a545272b3f |
children | 743ebecc1224 |
files | .hgignore doc/man/Makefile.am doc/man/doveadm-move.1.in doc/man/doveadm.1.in |
diffstat | 4 files changed, 100 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/.hgignore Fri Sep 23 16:07:29 2011 +0300 +++ b/.hgignore Sun Sep 25 22:32:04 2011 +0000 @@ -99,5 +99,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$
--- a/doc/man/Makefile.am Fri Sep 23 16:07:29 2011 +0300 +++ 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
--- /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). +.\"------------------------------------------------------------------------ +@INCLUDE:global-options@ +.\" --- command specific options --- "/. +.PP +Command specific +.IR options : +.\"------------------------------------- +@INCLUDE:option-A@ +.\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- +@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 +.\"------------------------------------------------------------------------ +@INCLUDE:reporting-bugs@ +.\"------------------------------------------------------------------------ +.SH SEE ALSO +.BR doveadm (1), +.BR doveadm\-search\-query (7) \ No newline at end of file
--- a/doc/man/doveadm.1.in Fri Sep 23 16:07:29 2011 +0300 +++ 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.