1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
|
.TH "DOVEADM-WHO" "1" "March 2025" "78ffb79" "Dovecot"
.SH "NAME"
\fBdoveadm-who\fR - Show who is logged into the Dovecot server
.SH "SYNOPSIS"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBwho\fR \[lB]\fB-1\fR\[rB] \[lB]\fB-f\fR \fIpassdb_field\fR\[rB] \[lB]\fB-a\fR \fIanvil_socket_path\fR\[rB] \[lB]\fIuser_mask\fR\[rB] \[lB]\fIip\fR \[lB]\fB/\fR \fIbits\fR\[rB]\[rB]
.SH "DESCRIPTION"
.P
The \fBwho\fR command is used to show which users from which hosts are currently connected to which service.
.SH "GLOBAL OPTIONS"
.P
Global doveadm(1)
.P
\fB-D\fR
.RS 0
.RS 4
.P
Enables \fIverbosity\fR and debug messages.
.RE 0
.RE 0
.P
\fB-O\fR
.RS 0
.RS 4
.P
Do not read any config file, just use defaults. The \fBdovecot_storage_version\fR setting defaults to the latest version, but can be overridden with
.RE 0
.RE 0
.P
\fB-k\fR
.RS 0
.RS 4
.P
Preserve entire environment for doveadm, not just \fBimport_environment\fR setting.
.RE 0
.RE 0
.P
\fB-v\fR
.RS 0
.RS 4
.P
Enables verbosity, including progress counter.
.RE 0
.RE 0
.P
\fB-i\fR \fIinstance-name\fR
.RS 0
.RS 4
.P
If using multiple Dovecot instances, choose the config file based on this instance name.
.P
See \fBinstance_name\fR setting for more information.
.RE 0
.RE 0
.P
\fB-c\fR \fIconfig-file\fR
.RS 0
.RS 4
.P
Read configuration from the given \fIconfig-file\fR. By default it first reads config socket, and then falls back to \fI/etc/dovecot/dovecot.conf\fR. You can also point this to config socket of some instance running compatible version.
.RE 0
.RE 0
.P
\fB-o\fR \fIsetting\fR\fB=\fR\fIvalue\fR
.RS 0
.RS 4
.P
Overrides the configuration \fIsetting\fR from \fI/etc/dovecot/dovecot.conf\fR and from the userdb with the given \fIvalue\fR. In order to override multiple settings, the \fB-o\fR option may be specified multiple times.
.RE 0
.RE 0
.P
\fB-f\fR \fIformatter\fR
.RS 0
.RS 4
.P
Specifies the \fIformatter\fR for formatting the output. Supported formatters are:
.P
\fBflow\fR
.RS 4
.P
prints each line with \fIkey\fR\fB=\fR\fIvalue\fR pairs.
.RE 0
.P
\fBpager\fR
.RS 4
.P
prints each \fIkey\fR: \fIvalue\fR pair on its own line and separates records with form feed character (\fB^L\fR).
.RE 0
.P
\fBtab\fR
.RS 4
.P
prints a table header followed by tab separated value lines.
.RE 0
.P
\fBtable\fR
.RS 4
.P
prints a table header followed by adjusted value lines.
.RE 0
.RE 0
.RE 0
.P
This command uses by default the output formatter \fBtable\fR.
.SH "OPTIONS"
.P
\fB-1\fR
.RS 0
.RS 4
.P
Print one line per user and connection. Otherwise the connections are grouped by the username.
.RE 0
.RE 0
.P
\fB-a\fR \fIanvil_socket_path\fR
.RS 0
.RS 4
.P
This option is used to specify an alternative socket. The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (\fIhostname\fR:\fIport\fR), in order to connect a remote host via a TCP socket.
.P
By default doveadm(1) will use the socket
.RE 0
.RE 0
.P
\fB-f\fR \fIpassdb_field\fR
.RS 0
.RS 4
.P
Alternative username field to use for querying, as returned by passdb. Only the passdb fields beginning with the \fIuser_\fR prefix are tracked.
.RE 0
.RE 0
.SH "ARGUMENTS"
.P
\fIip\fR \[lB]\fB/\fR \fIbits\fR\[rB]
.RS 0
.RS 4
.P
Specify an \fIip\fR address or network range, in CIDR notation, to reduce the result to matching connections.
.RE 0
.RE 0
.P
\fIuser_mask\fR
.RS 0
.RS 4
.P
List only users whose login name matches the \fIuser_mask\fR, or the alternative username (user_* field) if the \fB-f\fR parameter is used. It's also possible to use wildcards in the \fIuser\fR name.
.RE 0
.RE 0
.SH "EXAMPLE"
.P
Show authenticated sessions, filtered by the client's IP address:
.P
.RS 2
.nf
doveadm who ::1
.fi
.RE
.P
.RS 2
.nf
username # proto (pids) (ips)
jane 2 imap (30155 30412) (::1)
$ doveadm who 192.0.2.0/24
username # proto (pids) (ips)
john@example.com 1 imap (30257) (192.0.2.34)
.fi
.RE
.P
Show authenticated sessions, filtered by username:
.P
.RS 2
.nf
doveadm who pvo
.fi
.RE
.P
.RS 2
.nf
username # proto (pids) (ips)
pvo 1 sieve (30343) (fd95:4eed:38ba::25)
pvo 4 imap (25693 25686 25679 25669) (fd95:4eed:38ba::25)
$ doveadm who ja\[rs]*
username # proto (pids) (ips)
james 1 imap (30091) (127.0.0.1)
jane 2 imap (30155 30412) (::1)
.fi
.RE
.SH "REPORTING BUGS"
.P
Report bugs, including \fIdoveconf -n\fR output, to the Dovecot Mailing List \fI\(ladovecot@dovecot.org\(ra\fR. Information about reporting bugs is available at: https://dovecot.org/bugreport.html
.SH "SEE ALSO"
.P
doveadm(1)
|