summaryrefslogtreecommitdiffstats
path: root/doc/man/doveadm-quota.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/doveadm-quota.1.in')
-rw-r--r--doc/man/doveadm-quota.1.in131
1 files changed, 131 insertions, 0 deletions
diff --git a/doc/man/doveadm-quota.1.in b/doc/man/doveadm-quota.1.in
new file mode 100644
index 0000000..98f7072
--- /dev/null
+++ b/doc/man/doveadm-quota.1.in
@@ -0,0 +1,131 @@
+.\" Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-QUOTA 1 "2015-05-09" "Dovecot v2.3" "Dovecot"
+.SH NAME
+doveadm\-quota \- Initialize/recalculate or show current quota usage
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] [" \-f
+.IR formatter ]
+.BR quota " [" \-S
+.IR socket_path "] " command
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] [" \-f
+.IR formatter ]
+.BR quota " [" \-S
+.IR socket_path "]"
+.IB command\ \-A
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] [" \-f
+.IR formatter ]
+.BR quota " [" \-S
+.IR socket_path "]"
+.IB command\ \-F \ file
+.\"-------------------------------------
+.br
+.BR doveadm " [" \-Dv "] [" \-f
+.IR formatter ]
+.BR quota " [" \-S
+.IR socket_path "]"
+.IB command\ \-u \ user
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+In the first form,
+.BR doveadm (1)
+will execute the
+.I command
+for the currently logged in user.
+.PP
+In the second form, the
+.I command
+will be performed for all users.
+.PP
+In the third form, the
+.I command
+will be performed for all users listed in the given
+.IR file .
+.PP
+In the fourth form, the
+.I command
+will affect only the matching
+.IR user (s).
+.IP Note:
+The
+.B quota get
+and
+.B quota recalc
+commands are only available when the global
+.I mail_plugins
+setting contains the
+.B quota
+plugin.
+.\"------------------------------------------------------------------------
+@INCLUDE:global-options-formatter@
+.\" --- command specific options --- "/.
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+@INCLUDE:option-A@
+.\"-------------------------------------
+@INCLUDE:option-F-file@
+.\"-------------------------------------
+@INCLUDE:option-S-socket@
+.\"-------------------------------------
+@INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+.SH COMMANDS
+.SS quota get
+.BR doveadm " [" \-f
+.IR formatter ]
+.B quota get
+[\fB\-A\fP|\fB\-u\fP \fIuser\fP|\fB\-F\fP \fIfile\fP]
+.PP
+The
+.B quota get
+command is used to display the current quota usage.
+The storage values are reported in kilobytes.
+.PP
+This command uses by default the output formatter
+.BR table .
+.\"-------------------------------------
+.SS quota recalc
+.B doveadm quota recalc
+[\fB\-A\fP|\fB\-u\fP \fIuser\fP|\fB\-F\fP \fIfile\fP]
+.PP
+The
+.B quota recalc
+command is used to recalculate the current quota usage.
+.\"------------------------------------------------------------------------
+.SH FILES
+.TP
+.I @pkgsysconfdir@/dovecot.conf
+Dovecot\(aqs main configuration file, including the
+.I dict
+section.
+.TP
+.I @pkgsysconfdir@/dovecot\-dict\-sql.conf.ext
+SQL dictionary proxy settings.
+.TP
+.I @pkgsysconfdir@/conf.d/10\-mail.conf
+Mailbox locations and namespaces, including global
+.I mail_location
+.TP
+.I @pkgsysconfdir@/conf.d/90\-quota.conf
+Quota configuration.
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+Get the current quota usage of user jane.
+.sp
+.nf
+.B doveadm quota get \-u jane
+Quota name Type Value Limit %
+user STORAGE 90099 102400 87
+user MESSAGE 20548 30000 68
+.fi
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1) \ No newline at end of file