summaryrefslogtreecommitdiffstats
path: root/doc/man/doveadm-purge.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/doveadm-purge.1.in')
-rw-r--r--doc/man/doveadm-purge.1.in71
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/man/doveadm-purge.1.in b/doc/man/doveadm-purge.1.in
new file mode 100644
index 0000000..2049cd7
--- /dev/null
+++ b/doc/man/doveadm-purge.1.in
@@ -0,0 +1,71 @@
+.\" Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-PURGE 1 "2015-05-09" "Dovecot v2.3" "Dovecot"
+.SH NAME
+doveadm\-purge \- Remove messages with refcount=0 from mdbox files
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " purge " [" \-S
+.IR socket_path "] "
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] " purge " [" \-S
+.IR socket_path ]
+.B \-A
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] " purge " [" \-S
+.IR socket_path ]
+.BI \-F\ file
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] " purge " [" \-S
+.IR socket_path "] "
+.BI \-u \ user
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+The
+.B doveadm purge
+command is used to remove all messages with refcount=0 from a user\(aqs
+mail storage.
+The refcount of a message is decreased to 0 when the user (or some
+administration utility) has expunged all instances of a message from all
+mailboxes.
+.PP
+In the first form,
+.BR doveadm (1)
+will perform the
+.B purge
+action for the currently logged in user.
+.PP
+In the second form, the command will be executed for all users.
+.PP
+In the third form, the command will be executed for all users listed in
+the given
+.IR file .
+.PP
+In the last form, only messages of the given
+.IR user (s)
+will be purged.
+.\"------------------------------------------------------------------------
+@INCLUDE:global-options@
+.\" --- command specific options --- "/.
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+@INCLUDE:option-A@
+.\"-------------------------------------
+@INCLUDE:option-F-file@
+.\"-------------------------------------
+@INCLUDE:option-S-socket@
+.\"-------------------------------------
+@INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR doveadm\-expunge (1)
+.PP
+See http://wiki2.dovecot.org/MailboxFormat/dbox#Multi\-dbox for some
+details. \ No newline at end of file