dovecot-2.2: man: Added doveadm-proxy.1.

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/71b010a63bae
changeset: 17911:71b010a63bae
user:      Pascal Volk <user at localhost.localdomain.org>
date:      Tue Oct 07 22:24:21 2014 +0000
description:
man: Added doveadm-proxy.1.

diffstat:

 .hgignore                  |   2 +-
 doc/man/Makefile.am        |   2 +
 doc/man/doveadm-proxy.1.in |  86 ++++++++++++++++++++++++++++++++++++++++++++++
 doc/man/doveadm.1.in       |   7 +++-
 4 files changed, 95 insertions(+), 2 deletions(-)

diffs (142 lines):

diff -r 96f79038038f -r 71b010a63bae .hgignore
--- a/.hgignore	Tue Oct 07 21:35:44 2014 +0300
+++ b/.hgignore	Tue Oct 07 22:24:21 2014 +0000
@@ -105,5 +105,5 @@
 
 syntax: regexp
 src/.*/test-[^\.]*$
-doc/man/doveadm-(acl|altmove|auth|batch|deduplicate|director|dump|exec|expunge|fetch|flags|fts|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|replicator|search|sync|user|who)\.1$
+doc/man/doveadm-(acl|altmove|auth|batch|deduplicate|director|dump|exec|expunge|fetch|flags|fts|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|proxy|purge|pw|quota|replicator|search|sync|user|who)\.1$
 doc/man/(doveadm|doveconf|dovecot-lda|dovecot)\.1$
diff -r 96f79038038f -r 71b010a63bae doc/man/Makefile.am
--- a/doc/man/Makefile.am	Tue Oct 07 21:35:44 2014 +0300
+++ b/doc/man/Makefile.am	Tue Oct 07 22:24:21 2014 +0000
@@ -39,6 +39,7 @@
 	doveadm-mount.1 \
 	doveadm-move.1 \
 	doveadm-penalty.1 \
+	doveadm-proxy.1 \
 	doveadm-purge.1 \
 	doveadm-pw.1 \
 	doveadm-quota.1 \
@@ -84,6 +85,7 @@
 	doveadm-mount.1.in \
 	doveadm-move.1.in \
 	doveadm-penalty.1.in \
+	doveadm-proxy.1.in \
 	doveadm-purge.1.in \
 	doveadm-pw.1.in \
 	doveadm-quota.1.in \
diff -r 96f79038038f -r 71b010a63bae doc/man/doveadm-proxy.1.in
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/doveadm-proxy.1.in	Tue Oct 07 22:24:21 2014 +0000
@@ -0,0 +1,86 @@
+.\" Copyright (c) 2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-PROXY 1 "2014-10-07" "Dovecot v2.2" "Dovecot"
+.SH NAME
+doveadm\-proxy \- Handle Dovecot proxy connections
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv ]
+[\fB\-f\fP \fIformatter\fP]
+.BI proxy \ command
+.RI [ OPTIONS ]\ [ ARGUMENTS ]
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+The
+.B doveadm proxy
+.I commands
+are used to list or kick active Dovecot proxy connections.
+.\"------------------------------------------------------------------------
+ at INCLUDE:global-options-formatter@
+.\" --- command specific options --- "/.
+.PP
+This command uses by default the
+.B table
+output formatter.
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+.TP
+.BI \-a \ ipc_socket_path
+This option is used to specify an alternative socket.
+The option\(aqs argument is either an absolute path to a local UNIX domain
+socket, or a hostname and port
+.RI ( hostname : port ),
+in order to connect a remote host via a TCP socket.
+.sp
+By default
+.BR doveadm (1)
+will use the socket
+.IR @rundir@/ipc .
+The socket may be located in another directory, when the default
+.I base_dir
+setting was overridden in
+.IR @pkgsysconfdir@/dovecot.conf .
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.TP
+.I user
+Is a
+.IR user \(aqs
+login name.
+Depending on the configuration, a login name may be for example
+.BR jane " or " john at example.com .
+It\(aqs also possible to use
+.RB \(dq * \(dq
+and
+.RB \(dq ? \(dq
+wildcards (e.g. *@example.org).
+.\"------------------------------------------------------------------------
+.SH COMMANDS
+.SS proxy kick
+.B doveadm proxy kick
+[\fB\-a\fP \fIipc_socket_path\fP]
+.I user
+.PP
+Kick all the connections being proxied for the given
+.IR user .
+.\"-------------------------------------
+.SS proxy list
+.B doveadm proxy list
+[\fB\-a\fP \fIipc_socket_path\fP]
+.PP
+List all the users currently being proxied.
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+List all currently active proxy connections:
+.PP
+.nf
+.B doveadm proxy list
+username                    proto src ip          dest ip     port
+jane at example.net            imap  192.168.0.100   192.168.0.5 143
+.fi
+.\"------------------------------------------------------------------------
+ at INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1)
\ No newline at end of file
diff -r 96f79038038f -r 71b010a63bae doc/man/doveadm.1.in
--- a/doc/man/doveadm.1.in	Tue Oct 07 21:35:44 2014 +0300
+++ b/doc/man/doveadm.1.in	Tue Oct 07 22:24:21 2014 +0000
@@ -1,5 +1,5 @@
 .\" Copyright (c) 2010-2014 Dovecot authors, see the included COPYING file
-.TH DOVEADM 1 "2014-09-24" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM 1 "2014-10-07" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm \- Dovecot\(aqs administration utility
 .\"------------------------------------------------------------------------
@@ -74,6 +74,11 @@
 Show current penalties.
 .\"-------------------------------------
 .TP
+.B doveadm proxy
+.BR doveadm\-proxy (1),
+Handle Dovecot proxy connections.
+.\"-------------------------------------
+.TP
 .B doveadm who
 .BR doveadm\-who (1);
 Show who is logged in to the Dovecot server.