Mercurial > dovecot > core-2.2

comparison doc/man/doveadm-quota.1.in @ 11644:be2b7d2901a0 HEAD

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: added manual pages
author Pascal Volk <user@localhost.localdomain.org>
date Mon, 28 Jun 2010 13:56:39 +0000
parents
children a2bbd6c3624a
comparison
equal deleted inserted replaced
11643:9be162cc2c52 11644:be2b7d2901a0
1 .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
2 .TH DOVEADM\-QUOTA 1 "2010-06-23" "Dovecot v2.0" "Dovecot"
3 .SH NAME
4 doveadm\-quota \- Initialize/recalculate or show current quota usage
5 .\"------------------------------------------------------------------------
6 .SH SYNOPSIS
7 .BR doveadm " [" \-Dv "] [" \-f
8 .IR formatter ]
9 .B quota
10 .I command
11 .\"-------------------------------------
12 .br
13 .BR doveadm " [" \-Dv "] [" \-f
14 .IR formatter ]
15 .B quota
16 .IB command\ \-A
17 .\"-------------------------------------
18 .br
19 .BR doveadm " [" \-Dv "] [" \-f
20 .IR formatter ]
21 .BI quota\ command\ \-u
22 .I user
23 .\"------------------------------------------------------------------------
24 .SH DESCRIPTION
25 In the first form,
26 .BR doveadm (1)
27 will execute the
28 .I command
29 for the currently logged in user.
30 .PP
31 In the second form, the
32 .I command
33 will be performed for all users.
34 .PP
35 In the third form, the
36 .I command
37 will affect only the matching
38 .IR user (s).
39 .IP Note:
40 The
41 .B quota get
42 and
43 .B quota recalc
44 commands are only available when the global
45 .I mail_plugins
46 setting contains the
47 .B quota
48 plugin.
49 .\"------------------------------------------------------------------------
50 @INCLUDE:global-options-formatter@
51 .\" --- command specific options --- "/.
52 .PP
53 Command specific
54 .IR options :
55 .\"-------------------------------------
56 @INCLUDE:option-A@
57 .\"-------------------------------------
58 @INCLUDE:option-u-user@
59 .\"------------------------------------------------------------------------
60 .SH COMMANDS
61 .SS quota get
62 .BR doveadm " [" \-f
63 .IR formatter ]
64 .B quota get
65 [\fB\-A\fP|\fB\-u\fP \fIuser\fP]
66 .PP
67 The
68 .B quota get
69 command is used to display the current quota usage.
70 .PP
71 This command uses by default the output formatter
72 .BR table .
73 .\"-------------------------------------
74 .SS quota recalc
75 .B doveadm quota recalc
76 [\fB\-A\fP|\fB\-u\fP \fIuser\fP]
77 .PP
78 The
79 .B quota recalc
80 command is used to recalculate the current quota usage.
81 .\"------------------------------------------------------------------------
82 .SH FILES
83 .TP
84 .I @sysconfdir@/dovecot/dovecot.conf
85 Dovecot\(aqs main configuration file, including the
86 .I dict
87 section.
88 .TP
89 .I @sysconfdir@/dovecot/dovecot\-dict\-sql.conf.ext
90 SQL dictionary proxy settings.
91 .TP
92 .I @sysconfdir@/dovecot/conf.d/10\-mail.conf
93 Mailbox locations and namespaces, including global
94 .I mail_location
95 .TP
96 .I @sysconfdir@/dovecot/conf.d/90\-quota.conf
97 Quota configuration.
98 .\"------------------------------------------------------------------------
99 .SH EXAMPLE
100 Get the current quota usage of user jane.
101 .sp
102 .nf
103 .B doveadm quota get \-u jane
104 Quota name Type Value Limit %
105 user STORAGE 90099 102400 87
106 user MESSAGE 20548 30000 68
107 .fi
108 .\"------------------------------------------------------------------------
109 @INCLUDE:reporting-bugs@
110 .\"------------------------------------------------------------------------
111 .SH SEE ALSO
112 .BR doveadm (1)