Mercurial > dovecot > core-2.2
changeset 19577:d9d60683732f
doveadm-stats: Add documentation about stats subcommand
| author | Aki Tuomi <aki.tuomi@dovecot.net> |
|---|---|
| date | Tue, 12 Jan 2016 09:47:43 +0200 |
| parents | d9189bd01219 |
| children | 516ebaf73c74 |
| files | .gitignore doc/man/Makefile.am doc/man/doveadm-stats.1.in doc/man/doveadm.1.in |
| diffstat | 4 files changed, 71 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/.gitignore Mon Jan 11 15:46:35 2016 +0200 +++ b/.gitignore Tue Jan 12 09:47:43 2016 +0200 @@ -69,6 +69,7 @@ doc/man/doveadm-pw.1 doc/man/doveadm-quota.1 doc/man/doveadm-replicator.1 +doc/man/doveadm-stats.1 doc/man/doveadm-search.1 doc/man/doveadm-sync.1 doc/man/doveadm-user.1
--- a/doc/man/Makefile.am Mon Jan 11 15:46:35 2016 +0200 +++ b/doc/man/Makefile.am Tue Jan 12 09:47:43 2016 +0200 @@ -45,6 +45,7 @@ doveadm-quota.1 \ doveadm-replicator.1 \ doveadm-search.1 \ + doveadm-stats.1 \ doveadm-sync.1 \ doveadm-user.1 \ doveadm-who.1 \ @@ -92,6 +93,7 @@ doveadm-quota.1.in \ doveadm-replicator.1.in \ doveadm-search.1.in \ + doveadm-stats.1.in \ doveadm-sync.1.in \ doveadm-user.1.in \ doveadm-who.1.in \
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/man/doveadm-stats.1.in Tue Jan 12 09:47:43 2016 +0200 @@ -0,0 +1,63 @@ +.\" Copyright (c) 2010-2016 Dovecot authors, see the included COPYING file +.TH DOVEADM\-DUMP 1 "2016-01-12" "Dovecot v2.2" "Dovecot" +.SH NAME +doveadm\-stats \- Inspect or reset stats +.\"------------------------------------------------------------------------ +.SH SYNOPSIS +.BR doveadm\ stats\ dump " [ " \-s\ <stats\ socket\ path> " ] " <type> " [ " <filter> " ]" +.PP +.BR doveadm\ stats\ top " [ " \-s\ <stats\ socket\ path> " ] " "[ " -b " ]" " [ " sort field> " ]" +.PP +.BR doveadm\ stats\ reset " [ " \-s\ <stats\ socket\ path> " ] " +.\"------------------------------------------------------------------------ +.SH DESCRIPTION +.B doveadm stats dump +is used to output statistics +.PP +.B doveadm stats top +is used to monitor statistics +.PP +.B doveadm stats reset +is used to reset statistics +.\"------------------------------------------------------------------------ +.SH OPTIONS +Command specific +.IR options : +.TP +.BI \-s socketpath +Sets stats socket path +.TP +.B \-b +Show disk input/output bytes +.\"------------------------------------------------------------------------ +.SH ARGUMENTS +.BR dump +accepts following types: command, session, user, domain, ip and global. +.PP +Filter can be +.TP +.B user=<wildcard> +Match given user. +.TP +.B domain=<wildcard> +Match given DNS domain name +.TP +.B session=<str> +Match session identifier +.TP +.B ip=<ip>"["/<mask>"]" +Match local or remote IP +.TP +.B since=<timestamp> +Match session start time +.TP +.B connected +Show only connected sessions +.PP +.BR top +accepts any valid field name to sort along with. +.\"------------------------------------------------------------------------ +@INCLUDE:reporting-bugs@ +.\"------------------------------------------------------------------------ +.SH SEE ALSO +.BR doveadm (1)
--- a/doc/man/doveadm.1.in Mon Jan 11 15:46:35 2016 +0200 +++ b/doc/man/doveadm.1.in Tue Jan 12 09:47:43 2016 +0200 @@ -197,6 +197,11 @@ Manage users\(aq mail replicaton. .\"------------------------------------- .TP +.B doveadm stats +.BR doveadm\-stats (1), +Inspect or reset stats. +.\"------------------------------------- +.TP .B doveadm sync .BR doveadm\-sync (1), Dovecot\(aqs two\-way mailbox synchronization utility.