Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-quota.1.in @ 22560:9a300e778b20

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
director: When logging "ring SYNC lost", include sync seq number in message This can help with debugging.
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Thu, 14 Sep 2017 17:26:39 +0300
parents 2e2563132d5f
children cb108f786fb4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21390
2e2563132d5f Updated copyright notices to include the year 2017.
Stephan Bosch <stephan.bosch@dovecot.fi>
parents: 19552
diff changeset
1 .\" Copyright (c) 2010-2017 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\-QUOTA 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\-quota \- Initialize/recalculate or show current quota usage
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
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
7 .BR doveadm " [" \-Dv "] [" \-f
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
8 .IR formatter ]
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11798
diff changeset
9 .BR quota " [" \-S
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11798
diff changeset
10 .IR socket_path "] " command
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
11 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
12 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
13 .BR doveadm " [" \-Dv "] [" \-f
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
14 .IR formatter ]
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11798
diff changeset
15 .BR quota " [" \-S
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11798
diff changeset
16 .IR socket_path "]"
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
17 .IB command\ \-A
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
18 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
19 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
20 .BR doveadm " [" \-Dv "] [" \-f
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
21 .IR formatter ]
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11798
diff changeset
22 .BR quota " [" \-S
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11798
diff changeset
23 .IR socket_path "]"
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
24 .IB command\ \-F \ file
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
25 .\"-------------------------------------
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
26 .br
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
27 .BR doveadm " [" \-Dv "] [" \-f
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
28 .IR formatter ]
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
29 .BR quota " [" \-S
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
30 .IR socket_path "]"
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11798
diff changeset
31 .IB command\ \-u \ user
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
32 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
33 .SH DESCRIPTION
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 execute the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
37 .I command
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
38 for the currently logged in user.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
39 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
40 In the second form, the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
41 .I command
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
42 will be performed for all users.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
43 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
44 In the third form, the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
45 .I command
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
46 will be performed for all users listed in the given
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
47 .IR file .
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
48 .PP
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
49 In the fourth form, the
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
50 .I command
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
51 will affect only the matching
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
52 .IR user (s).
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
53 .IP Note:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
54 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
55 .B quota get
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
56 and
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
57 .B quota recalc
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
58 commands are only available when the global
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
59 .I mail_plugins
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
60 setting contains the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
61 .B quota
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
62 plugin.
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:global-options-formatter@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
65 .\" --- command specific options --- "/.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
66 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
67 Command specific
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
68 .IR options :
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
69 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
70 @INCLUDE:option-A@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
71 .\"-------------------------------------
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
72 @INCLUDE:option-F-file@
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
73 .\"-------------------------------------
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11798
diff changeset
74 @INCLUDE:option-S-socket@
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11798
diff changeset
75 .\"-------------------------------------
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
76 @INCLUDE:option-u-user@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
77 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
78 .SH COMMANDS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
79 .SS quota get
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
80 .BR doveadm " [" \-f
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
81 .IR formatter ]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
82 .B quota get
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
83 [\fB\-A\fP|\fB\-u\fP \fIuser\fP|\fB\-F\fP \fIfile\fP]
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
84 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
85 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
86 .B quota get
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
87 command is used to display the current quota usage.
12744
206cc9b37215 man: Storage quota values are reported in kilobytes.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
88 The storage values are reported in kilobytes.
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
89 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
90 This command uses by default the output formatter
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
91 .BR table .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
92 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
93 .SS quota recalc
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
94 .B doveadm quota recalc
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
95 [\fB\-A\fP|\fB\-u\fP \fIuser\fP|\fB\-F\fP \fIfile\fP]
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
96 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
97 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
98 .B quota recalc
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
99 command is used to recalculate the current quota usage.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
100 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
101 .SH FILES
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
102 .TP
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
103 .I @pkgsysconfdir@/dovecot.conf
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
104 Dovecot\(aqs main configuration file, including the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
105 .I dict
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
106 section.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
107 .TP
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
108 .I @pkgsysconfdir@/dovecot\-dict\-sql.conf.ext
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
109 SQL dictionary proxy settings.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
110 .TP
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
111 .I @pkgsysconfdir@/conf.d/10\-mail.conf
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
112 Mailbox locations and namespaces, including global
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
113 .I mail_location
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
114 .TP
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
115 .I @pkgsysconfdir@/conf.d/90\-quota.conf
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
116 Quota configuration.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
117 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
118 .SH EXAMPLE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
119 Get the current quota usage of user jane.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
120 .sp
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
121 .nf
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
122 .B doveadm quota get \-u jane
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
123 Quota name Type Value Limit %
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
124 user STORAGE 90099 102400 87
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
125 user MESSAGE 20548 30000 68
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
126 .fi
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
127 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
128 @INCLUDE:reporting-bugs@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
129 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
130 .SH SEE ALSO
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
131 .BR doveadm (1)