From: Pascal Volk Date: Sat, 16 Nov 2013 14:06:32 +0000 (+0000) Subject: man: Added description for command `doveadm copy`. X-Git-Tag: 2.2.8~34 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=bc5edefef5f01a24657e56e1c881b40ba0c38565;p=thirdparty%2Fdovecot%2Fcore.git man: Added description for command `doveadm copy`. --- diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 83614da490..b0f9068811 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -5,6 +5,7 @@ SUFFIXES = .1.in .1 dist_man1_MANS = \ deliver.1 \ doveadm-config.1 \ + doveadm-copy.1 \ doveadm-reload.1 \ doveadm-stop.1 diff --git a/doc/man/doveadm-copy.1 b/doc/man/doveadm-copy.1 new file mode 100644 index 0000000000..288040675f --- /dev/null +++ b/doc/man/doveadm-copy.1 @@ -0,0 +1 @@ +.so man1/doveadm-move.1 diff --git a/doc/man/doveadm-move.1.in b/doc/man/doveadm-move.1.in index 8e316f808d..55da8efea8 100644 --- a/doc/man/doveadm-move.1.in +++ b/doc/man/doveadm-move.1.in @@ -1,8 +1,11 @@ .\" Copyright (c) 2011 Dovecot authors, see the included COPYING file -.TH DOVEADM\-MOVE 1 "2011-09-25" "Dovecot v2.2" "Dovecot" +.TH DOVEADM\-MOVE 1 "2013-11-16" "Dovecot v2.2" "Dovecot" .SH NAME doveadm\-move \- Move messages matching the given search query into another mailbox +.br +doveadm\-copy \- Copy messages matching the given search query into another +mailbox .\"------------------------------------------------------------------------ .SH SYNOPSIS .BR doveadm " [" \-Dv "] " move " [" \-S @@ -17,6 +20,20 @@ mailbox .BR doveadm " [" \-Dv "] " move " [" \-S .IR socket_path "] " .BI \-u " user destination search_query" +.\"------------------------------------- +.PP +.BR doveadm " [" \-Dv "] " copy " [" \-S +.IR socket_path "] " "destination search_query" +.br +.\"------------------------------------- +.BR doveadm " [" \-Dv "] " copy " [" \-S +.IR socket_path "] " +.BI \-A " destination search_query" +.br +.\"------------------------------------- +.BR doveadm " [" \-Dv "] " copy " [" \-S +.IR socket_path "] " +.BI \-u " user destination search_query" .\"------------------------------------------------------------------------ .SH DESCRIPTION .B doveadm move @@ -26,23 +43,28 @@ The is used to restrict which messages are moved into the .I destination mailbox. +.br +.B doveadm copy +behaves the same as +.BR "doveadm move" , +except that copied messages will not be expunged after copying. .PP In the first form, .BR doveadm (1) -will executed the -.B move +will execute the +.BR move / copy 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 +and move or copy 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 +In the third form, matching mails will be moved or copied only for given .IR user (s). .\"------------------------------------------------------------------------ @INCLUDE:global-options@ @@ -60,14 +82,15 @@ Command specific .SH ARGUMENTS .TP .I destination -The name of the destination mailbox, into which the mails should be moved. +The name of the destination mailbox, into which the mails should be moved +or copied. The .I destination mailbox must exist, otherwise this command will fail. .\"------------------------------------- .TP .I search_query -Move messages matching the given search query. +Move/copy messages matching the given search query. See .BR doveadm\-search\-query (7) for details. diff --git a/doc/man/doveadm.1.in b/doc/man/doveadm.1.in index f1b23cc05b..7d2fc82f90 100644 --- a/doc/man/doveadm.1.in +++ b/doc/man/doveadm.1.in @@ -1,5 +1,5 @@ .\" Copyright (c) 2010-2013 Dovecot authors, see the included COPYING file -.TH DOVEADM 1 "2013-08-05" "Dovecot v2.2" "Dovecot" +.TH DOVEADM 1 "2013-11-16" "Dovecot v2.2" "Dovecot" .SH NAME doveadm \- Dovecot\(aqs administration utility .\"------------------------------------------------------------------------ @@ -102,6 +102,11 @@ Perform a user lookup in Dovecot\(aqs userdbs Move matching mails to the alternative storage. .\"------------------------------------- .TP +.B doveadm copy +.BR doveadm\-copy (1), +Copy messages matching the given search query into another mailbox. +.\"------------------------------------- +.TP .B doveadm deduplicate .BR doveadm\-deduplicate (1), Expunge duplicate messages.