man: Added doveadm-proxy.1.

diff --git a/.hgignore b/.hgignore
index 6ba2c8254b252c2705fdc2ae9539c451f4992512..001e6d326fd64b160442e785dff4f797a711fec0 100644 (file)
--- a/.hgignore
+++ b/.hgignore
@@ -105,5 +105,5 @@ src/plugins/quota/quota-status
 
 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 --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 461eed823f771961b5c143a34830719e1684bc52..332ebf2751bdea031313dc6520cfa5031fc84385 100644 (file)
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -39,6 +39,7 @@ nodist_man1_MANS = \
        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 @@ EXTRA_DIST = \
        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 --git a/doc/man/doveadm-proxy.1.in b/doc/man/doveadm-proxy.1.in
new file mode 100644 (file)
index 0000000..585a6b6
--- /dev/null
+++ b/doc/man/doveadm-proxy.1.in
@@ -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.
+.\"------------------------------------------------------------------------
+@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@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@example.net            imap  192.168.0.100   192.168.0.5 143
+.fi
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1)
\ No newline at end of file

diff --git a/doc/man/doveadm.1.in b/doc/man/doveadm.1.in
index 5793a82c1fbf1e3d61bc585bd443573d1b8b65f9..b71a525567572ca286a730c28874e081a99ae018 100644 (file)
--- a/doc/man/doveadm.1.in
+++ b/doc/man/doveadm.1.in
@@ -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 @@ Manage the list of mountpoints where mails are stored.
 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.