Mercurial > dovecot > core-2.2

comparison doc/man/doveadm-who.1.in @ 11644:be2b7d2901a0 HEAD

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: added manual pages
author Pascal Volk <user@localhost.localdomain.org>
date Mon, 28 Jun 2010 13:56:39 +0000
parents
children e546af72d6bb
comparison
equal deleted inserted replaced
11643:9be162cc2c52 11644:be2b7d2901a0
1 .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
2 .TH DOVEADM\-WHO 1 "2010-06-23" "Dovecot v2.0" "Dovecot"
3 .SH NAME
4 doveadm\-who \- Show who is logged in to the Dovecot server
5 .\"------------------------------------------------------------------------
6 .SH SYNOPSIS
7 .BR doveadm " [" \-Dv "] [" \-f
8 .IR formatter ]
9 .BR who\ [ \-1 ]
10 [\fB\-a\fP \fIanvil_socket_path\fP]
11 .RI [ user ]
12 [\fIip\fP[\fB/\fP\fImask\fP]]
13 .\"------------------------------------------------------------------------
14 .SH DESCRIPTION
15 The
16 .B who
17 command is used to show which users from which hosts are currently
18 connected to which service.
19 .\"------------------------------------------------------------------------
20 @INCLUDE:global-options-formatter@
21 .\" --- command specific options --- "/.
22 .PP
23 This command uses by default the output formatter
24 .BR table .
25 .PP
26 Command specific
27 .IR options :
28 .\"-------------------------------------
29 .TP
30 .B \-1
31 Print one line per user and connection.
32 Otherwise the connections are grouped by the username.
33 .\"-------------------------------------
34 .TP
35 .BI \-a\ anvil_socket_path
36 This option is used to specify an absolute path to an alternative UNIX
37 domain socket.
38 .sp
39 By default
40 .BR doveadm (1)
41 will use the socket
42 .IR @rundir@/anvil .
43 The socket may be located in another directory, when the default
44 .I base_dir
45 setting was overridden in
46 .IR @sysconfdir@/dovecot/dovecot.conf .
47 .\"------------------------------------------------------------------------
48 .SH ARGUMENTS
49 .TP
50 \fIip\fP[\fB/\fP\fImask\fP]
51 Specify an
52 .I ip
53 address or network range, in CIDR notation, to reduce the result to
54 matching connections.
55 .\"-------------------------------------
56 .TP
57 .I user
58 List only users, whose name match
59 .IR user .
60 It\(aqs also possible to use wildcards in the
61 .I user
62 name.
63 .\"------------------------------------------------------------------------
64 .SH EXAMPLE
65 Show authenticated sessions, filtered by the client\(aqs IP address.
66 .sp
67 .nf
68 .B doveadm who ::1
69 username # proto (pids) (ips)
70 jane 2 imap (30155 30412) (::1)
71 .B doveadm who 192.0.2.0/24
72 username # proto (pids) (ips)
73 john@example.com 1 imap (30257) (192.0.2.34)
74 .fi
75 .PP
76 Show authenticated sessions, filtered by username.
77 .sp
78 .nf
79 .B doveadm who pvo
80 username # proto (pids) (ips)
81 pvo 1 sieve (30343) (fd95:4eed:38ba::25)
82 pvo 4 imap (25693 25686 25679 25669) (fd95:4eed:38ba::25)
83 .B doveadm who ja*
84 username # proto (pids) (ips)
85 james 1 imap (30091) (127.0.0.1)
86 jane 2 imap (30155 30412) (::1)
87 .fi
88 .\"------------------------------------------------------------------------
89 @INCLUDE:reporting-bugs@
90 .\"------------------------------------------------------------------------
91 .SH SEE ALSO
92 .BR doveadm (1),
93 .BR doveadm\-kick (1)