man: Added doveadm-deduplicate.1 and doveadm-flags.1.

diff --git a/.hgignore b/.hgignore
index 22167512fbae050ce8cff5ce0d2118428fbbb8f0..c5bb3ffd95b26edbf37b4ad496fdd560514ce2a3 100644 (file)
--- a/.hgignore
+++ b/.hgignore
@@ -105,5 +105,5 @@ src/plugins/quota/quota-status
 
 syntax: regexp
 src/.*/test-[^\.]*$
-doc/man/doveadm-(altmove|auth|director|dump|expunge|fetch|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|search|user|who)\.1$
+doc/man/doveadm-(altmove|auth|deduplicate|director|dump|expunge|fetch|flags|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|search|user|who)\.1$
 doc/man/(doveadm|doveconf|dovecot-lda|dovecot|dsync)\.1$

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index c18e6c36bde6b16b662a298375ccad9f2e823ad8..b4ca9e969a56b1205469ed419551da96513fdef6 100644 (file)
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -15,10 +15,12 @@ nodist_man1_MANS = \
        doveadm.1 \
        doveadm-altmove.1 \
        doveadm-auth.1 \
+       doveadm-deduplicate.1 \
        doveadm-director.1 \
        doveadm-dump.1 \
        doveadm-expunge.1 \
        doveadm-fetch.1 \
+       doveadm-flags.1 \
        doveadm-import.1 \
        doveadm-instance.1 \
        doveadm-index.1 \
@@ -53,10 +55,12 @@ EXTRA_DIST = \
        doveadm.1.in \
        doveadm-altmove.1.in \
        doveadm-auth.1.in \
+       doveadm-deduplicate.1.in \
        doveadm-director.1.in \
        doveadm-dump.1.in \
        doveadm-expunge.1.in \
        doveadm-fetch.1.in \
+       doveadm-flags.1.in
        doveadm-import.1.in \
        doveadm-instance.1.in \
        doveadm-index.1.in \

diff --git a/doc/man/doveadm-deduplicate.1.in b/doc/man/doveadm-deduplicate.1.in
new file mode 100644 (file)
index 0000000..9a2115f
--- /dev/null
+++ b/doc/man/doveadm-deduplicate.1.in
@@ -0,0 +1,87 @@
+.\" Copyright (c) 2013 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-DEDUPLICATE 1 "2013-08-02" "Dovecot v2.2" "Dovecot"
+.SH NAME
+doveadm\-deduplicate \- expunge duplicate messages
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " deduplicate " [" \-u
+.IR user |\c
+.BR \-A "] [" \-S
+.IR socket_path "] ["\c
+.BR \-m ]
+.I search_query
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+This command is used to expunge duplicated messages in mailboxes.
+.B doveadm deduplicate
+is mainly useful to revert some (more or less) accidental duplication of
+messages, e.g. after
+.BR "doveadm copy" " or " "doveadm import" .
+.BR doveadm (1)
+will delete the newest duplicated messages from the mailbox and keep the
+oldest.
+.br
+Deduplication across multiple mailboxes is not supported.
+.\"------------------------------------------------------------------------
+@INCLUDE:global-options@
+.\"-------------------------------------
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+@INCLUDE:option-A@
+.\"-------------------------------------
+@INCLUDE:option-S-socket@
+.\"-------------------------------------
+.TP
+.B \-m
+if the
+.B \-m
+option is given,
+.BR doveadm (1)
+will deduplicate by Message\-Id header.
+By default deduplication will be done by message GUIDs.
+.\"-------------------------------------
+@INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.TP
+.I search_query
+expunge duplicates found from messages matching the given search query.
+Typically a search query like \(aq\c
+.BI "mailbox  " mailbox_name " OR  mailbox " other_box\c
+\(aq will be sufficient.
+See
+.BR doveadm\-search\-query (7)
+for details.
+
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+This example shows how to list and expunge duplicate messages from a
+mailbox.
+.sp
+.nf
+.B doveadm \-f table fetch \-u jane \(aqguid uid\(aq mailbox a_Box | sort
+guid                             uid
+8aad0f0a30169f4bea620000ca356bad 18751
+8aad0f0a30169f4bea620000ca356bad 18756
+923e301ab9219b4b4f440000ca356bad 18748
+923e301ab9219b4b4f440000ca356bad 18753
+\&...
+.B doveadm deduplicate \-u jane mailbox a_Box
+.B doveadm \-f table fetch \-u jane \(aqguid uid\(aq mailbox a_Box | sort
+guid                             uid
+8aad0f0a30169f4bea620000ca356bad 18751
+923e301ab9219b4b4f440000ca356bad 18748
+a7999e1530739c4bd26d0000ca356bad 18749
+\&...
+.fi
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR doveadm\-copy (1),
+.BR doveadm\-fetch (1),
+.BR doveadm\-import (1),
+.BR doveadm\-search\-query (7)
\ No newline at end of file

diff --git a/doc/man/doveadm-flags.1.in b/doc/man/doveadm-flags.1.in
new file mode 100644 (file)
index 0000000..80a075d
--- /dev/null
+++ b/doc/man/doveadm-flags.1.in
@@ -0,0 +1,103 @@
+.\" Copyright (c) 2013 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-FLAGS 1 "2013-08-02" "Dovecot v2.2" "Dovecot"
+.SH NAME
+doveadm\-flags \- add, remove or replace messages\(aq flags
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " flags " [" \-S
+.IR socket_path "] " "command flags search_query"
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] " flags " [" \-S
+.IR socket_path "] " "command flags search_query"
+.B \-A
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] " flags " [" \-S
+.IR socket_path "] " "command flags search_query"
+.BI "\-u " user
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+This command is used to manipulate flags of messages.
+.\"------------------------------------------------------------------------
+@INCLUDE:global-options@
+.\"-------------------------------------
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+@INCLUDE:option-A@
+.\"-------------------------------------
+@INCLUDE:option-S-socket@
+.\"-------------------------------------
+@INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.TP
+.I flags
+Message flags as described in RFC 3501, section 2.3.2 (Flags Message
+Attribute):
+.BR \(rsAnswered ", " \(rsDeleted ", " \(rsDraft ", " \(rsFlagged ", "
+.BR \(rsRecent " and " \(rsSeen .
+And the IMAP keywords
+.BR \(DoForwarded ", " \(DoMDNSent ", " \(DoSubmitPending " and "
+.B \(DoSubmitted
+or user\-defined keywords, e.g. Junk, \(DoNonSpam or \(DoLabel1.
+.br
+One or multiple flags and/or keywords can be specified.
+.\"-------------------------------------
+.TP
+.I search_query
+Manipulate the flags of messages matching the given search query.
+See
+.BR doveadm\-search\-query (7)
+for details.
+.\"------------------------------------------------------------------------
+.SH COMMANDS
+.SS flags add
+.BR "doveadm flags add" " [" \-u
+.IR user |\c
+.BR \-A "] [" \-S
+.IR socket_path "] " "flags search_query"
+.PP
+This command is used to extend the current set of flags with the given
+.IR flags .
+.\"-------------------------------------
+.SS flags remove
+.BR "doveadm flags remove" " [" \-u
+.IR user |\c
+.BR \-A "] [" \-S
+.IR socket_path "] " "flags search_query"
+.PP
+In order to remove the given
+.I flags
+from the current set of flags, use this command.
+.\"-------------------------------------
+.SS flags replace
+.BR "doveadm flags replace" " [" \-u
+.IR user |\c
+.BR \-A "] [" \-S
+.IR socket_path "] " "flags search_query"
+.PP
+This command is used to replace ALL current flags with the given
+.IR flags .
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+List and manipulate the message flags of the message with uid 81563
+.sp
+.nf
+.B doveadm fetch \-u bob \(aquid flags\(aq mailbox dovecot uid 81563
+uid: 81563
+flags: \(rsAnswered \(rsSeen NonJunk
+
+.B doveadm flags \-u bob remove NonJunk mailbox dovecot uid 81563
+.B doveadm flags \-u bob add \(aq\(rsFlagged \(DoForwarded\(aq \
+mailbox dovecot uid 81563
+.fi
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR doveadm\-fetch (1),
+.BR doveadm\-search\-query (7)
\ No newline at end of file

diff --git a/doc/man/doveadm.1.in b/doc/man/doveadm.1.in
index 960666870b90b2583e70d79f2d1d66ec48021281..10608a4166752443ea51eea063fdac920f226b8b 100644 (file)
--- a/doc/man/doveadm.1.in
+++ b/doc/man/doveadm.1.in
@@ -1,5 +1,5 @@
-.\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
-.TH DOVEADM 1 "2011-05-11" "Dovecot v2.2" "Dovecot"
+.\" Copyright (c) 2010-2013 Dovecot authors, see the included COPYING file
+.TH DOVEADM 1 "2013-08-02" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm \- Dovecot\(aqs administration utility
 .\"------------------------------------------------------------------------
@@ -97,6 +97,11 @@ Perform a user lookup in Dovecot\(aqs userdbs
 Move matching mails to the alternative storage.
 .\"-------------------------------------
 .TP
+.B doveadm deduplicate
+.BR doveadm\-deduplicate (1),
+Expunge duplicate messages.
+.\"-------------------------------------
+.TP
 .B doveadm dump
 .BR doveadm\-dump (1),
 Dump the content of Dovecot\(aqs binary mailbox index/log.
@@ -112,6 +117,11 @@ Expunge messages matching given search query.
 Fetch messages matching given search query.
 .\"-------------------------------------
 .TP
+.B doveadm flags
+.BR doveadm\-flags (1),
+Add, remove or replace messages\(aq flags.
+.\"-------------------------------------
+.TP
 .B doveadm force\-resync
 .BR doveadm\-force\-resync (1),
 Repair broken mailboxes, in case Dovecot doesn\(aqt automatically do that.