.\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
.TH DOVEADM\-WHO 1M "2010-07-12" "Dovecot v2.2" "Dovecot"
.SH NAME
doveadm who \- Show who is logged in to the dovecot server
.\"------------------------------------------------------------------------
.SH SYNOPSIS
.nh
.na
.HP
\" ./global-options-short.inc
\" ./master-options-short.inc
\fBdoveadm who\fR [\-D] [\-F\ \fIformatter\fR] [\-v] [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]...  [\-1] [\-a\ \fIsocket\fR] [\fIuser\fR] [\fIaddr\fR]
.ad
.hy
.\"------------------------------------------------------------------------
.SH DESCRIPTION
This command is used to show which users from which hosts are currently
connected to which service.  It uses by default the output
formatter \fBtable\fR.
.\"------------------------------------------------------------------------
.SH OPTIONS
Common options:

\" ./global-options.inc

\" vim: ts=4 sw=4 filetype=nroff
.TP
.B \-D
Enables verbosity and debug messages.

.TP
.BI \-F\  formatter
Specifies the \fIformatter\fR for formatting the output.  Supported formatters
are:
.RS
.TP 2
.B flow
Prints each line with
.IB key = value
pairs.
.TP
.B pager
Prints each
.IB key = value
pair on its own line and separates records with form feed character (\fB^L\fR).
.TP
.B tab
Prints a table header followed by tab separated value lines.
.TP
.B table
Prints a table header followed by adjusted value lines.
.RE

.TP
.B \-v
Enables verbosity, including progress counter.
\" ./master-options.inc

\" vim: ts=4 sw=4 filetype=nroff
.TP
.BI \-c\  file
Read configuration from the given \fIfile\fR.  By default
\fI/etc/dovecot/dovecot.conf\fR will be used.

.TP
.BI \-i\  instance
Get the configuration from the instance with the name \fIinstance\fR.

.TP
.B \-k
Keep environment, i.e. when executing a new process do not explicitly set 
the environment variables HOME, USER and when reading configurations, don\'t
overwrite currently set environment variables with corresponding settings.
Usually used internally, only.

.TP
.B \-L
Log directly.

.TP
.B \-O
Don\'t read settings, but use whatever is in the environment.

.TP
.BI \-o\  setting = value
Overrides the \fIsetting\fR from the current configuration with the given
\fIvalue\fR (can be specified multiple times). E.g. with \-o dsync_alt_char=c
one is able to overwrite the character to use as an replacement for all invalid
characters encountered within a mailbox name (per default \'\fB_\fR').

.P
Command specific options:

.TP
.B \-1
Print one line per user and connection.
Otherwise the connections are grouped by the username.

.TP
.BI \-a\  socket
The alternative socket to use.
The option\'s argument \fIsocket\fR is either an absolute path to a local UNIX
domain socket, or a hostname and port (\fIhostname\fB:\fIport\fR),
in order to connect a remote host via a TCP socket.

By default
.BR doveadm (1M)
will use the socket named \fBanvil\fR located in the currently configured
\fBbase_dir\fR, e.g. \fI/tmp/dovecot/anvil\fR.
.\"------------------------------------------------------------------------
.SH OPERANDS
.TP
.I addr
Reduce/filter the output wrt. the given IP address or a network range in
CIDR notation \fIip\fR[/\fImask\fR] .
.\"-------------------------------------
.TP
.I user
List only users, whose name match \fIuser\fR.  It is also possible to use
\'\fB*\fR\' and \'\fB?\fR\' wildcards.
.\"------------------------------------------------------------------------
.SH EXAMPLES
Show authenticated sessions, filtered by the client\'s IP address:

.RS 3
.nf
.B doveadm who ::1
username                       # proto (pids)        (ips)
jane                           2 imap  (30155 30412) (::1)

.B doveadm who 192.0.2.0/24
username                        # proto (pids)  (ips)
john@example.com                1 imap  (30257) (192.0.2.34)
.fi
.RE

.PP
Show authenticated sessions, filtered by username:

.RS 3
.nf
.B doveadm who pvo
username         # proto (pids)                    (ips)
pvo              1 sieve (30343)                   (fd95:4eed:38ba::25)
pvo              4 imap  (25693 25686 25679 25669) (fd95:4eed:38ba::25)

.B doveadm who ja\e*
username                    # proto (pids)        (ips)
james                       1 imap  (30091)       (127.0.0.1)
jane                        2 imap  (30155 30412) (::1)
.fi
.RE
.\"------------------------------------------------------------------------
.SH SEE ALSO
.BR doveadm (1M),
.BR doveadm\-kick (1M)
.\"------------------------------------------------------------------------
\" ./reporting-bugs.inc

.SH REPORTING BUGS
Report bugs, including \fBdoveconf \-n\fR
output, to the dovecot Mailing List <dovecot@dovecot.org>.
Information about reporting bugs is available at:
http://dovecot.org/bugreport.html