From: Aki Tuomi <aki.tuomi@dovecot.net>
Date: Tue, 12 Jan 2016 07:47:43 +0000 (+0200)
Subject: doveadm-stats: Add documentation about stats subcommand
X-Git-Tag: 2.2.22.rc1~343
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=102af99302e83d0590a57194f2b10d8b82ce8247;p=thirdparty%2Fdovecot%2Fcore.git

doveadm-stats: Add documentation about stats subcommand
---

diff --git a/.gitignore b/.gitignore
index bf16175564..920d982301 100644
--- a/.gitignore
+++ b/.gitignore
@@ -69,6 +69,7 @@ doc/man/doveadm-purge.1
 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
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index ab8da5f275..3bfaea3d23 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -45,6 +45,7 @@ nodist_man1_MANS = \
 	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 @@ EXTRA_DIST = \
 	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 \
diff --git a/doc/man/doveadm-stats.1.in b/doc/man/doveadm-stats.1.in
new file mode 100644
index 0000000000..8db083433d
--- /dev/null
+++ b/doc/man/doveadm-stats.1.in
@@ -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)
diff --git a/doc/man/doveadm.1.in b/doc/man/doveadm.1.in
index 7b023731de..09bdcfea11 100644
--- a/doc/man/doveadm.1.in
+++ b/doc/man/doveadm.1.in
@@ -197,6 +197,11 @@ Initialize/recalculate or show current quota usage.
 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.