Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-purge.1.in @ 23017:c1d36f2575c7 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
lib-imap: Fix "Don't accept strings with NULs" cherry-pick
author Timo Sirainen <timo.sirainen@open-xchange.com>
date Thu, 29 Aug 2019 09:55:25 +0300
parents cb108f786fb4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22713
cb108f786fb4 Updated copyright notices to include the year 2018.
Stephan Bosch <stephan.bosch@dovecot.fi>
parents: 21390
diff changeset
1 .\" Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
2 .TH DOVEADM\-PURGE 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
3 .SH NAME
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
4 doveadm\-purge \- Remove messages with refcount=0 from mdbox files
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
5 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
6 .SH SYNOPSIS
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
7 .BR doveadm " [" \-Dv "] " purge " [" \-S
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
8 .IR socket_path "] "
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
9 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
10 .br
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
11 .BR doveadm " [" \-Dv "] " purge " [" \-S
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
12 .IR socket_path ]
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
13 .B \-A
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
14 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
15 .br
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
16 .BR doveadm " [" \-Dv "] " purge " [" \-S
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
17 .IR socket_path ]
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
18 .BI \-F\ file
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
19 .\"-------------------------------------
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
20 .br
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
21 .BR doveadm " [" \-Dv "] " purge " [" \-S
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
22 .IR socket_path "] "
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
23 .BI \-u \ user
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
24 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
25 .SH DESCRIPTION
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
26 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
27 .B doveadm purge
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
28 command is used to remove all messages with refcount=0 from a user\(aqs
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
29 mail storage.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
30 The refcount of a message is decreased to 0 when the user (or some
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
31 administration utility) has expunged all instances of a message from all
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
32 mailboxes.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
33 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
34 In the first form,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
35 .BR doveadm (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
36 will perform the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
37 .B purge
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
38 action for the currently logged in user.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
39 .PP
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
40 In the second form, the command will be executed for all users.
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
41 .PP
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
42 In the third form, the command will be executed for all users listed in
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
43 the given
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
44 .IR file .
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
45 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
46 In the last form, only messages of the given
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
47 .IR user (s)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
48 will be purged.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
49 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
50 @INCLUDE:global-options@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
51 .\" --- command specific options --- "/.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
52 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
53 Command specific
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
54 .IR options :
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
55 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
56 @INCLUDE:option-A@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
57 .\"-------------------------------------
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
58 @INCLUDE:option-F-file@
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
59 .\"-------------------------------------
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
60 @INCLUDE:option-S-socket@
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
61 .\"-------------------------------------
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
62 @INCLUDE:option-u-user@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
63 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
64 @INCLUDE:reporting-bugs@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
65 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
66 .SH SEE ALSO
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
67 .BR doveadm (1),
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
68 .BR doveadm\-expunge (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
69 .PP
11691
245cd41837ff man pages: Use wiki2.dovecot.org links until wiki2 becomes the default.
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
70 See http://wiki2.dovecot.org/MailboxFormat/dbox#Multi\-dbox for some
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11691
diff changeset
71 details.