Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-auth.1.in @ 22664:fea53c2725c0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
director: Fix director_max_parallel_moves/kicks type Should be uint, not time.
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Thu, 09 Nov 2017 12:24:16 +0200
parents 2e2563132d5f
children cb108f786fb4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21390
2e2563132d5f Updated copyright notices to include the year 2017.
Stephan Bosch <stephan.bosch@dovecot.fi>
parents: 19552
diff changeset
1 .\" Copyright (c) 2010-2017 Dovecot authors, see the included COPYING file
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 17784
diff changeset
2 .TH DOVEADM\-AUTH 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
3 .SH NAME
17784
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
4 doveadm\-auth \- Flush/lookup/test authentication data
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
5 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
6 .SH SYNOPSIS
17784
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
7 .BR doveadm " [" \-Dv ]
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
8 [\fB\-f\fP \fIformatter\fP]
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
9 .BI auth \ command
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
10 .RI [ OPTIONS ]\ [ ARGUMENTS ]
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
11 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
12 .SH DESCRIPTION
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
13 The
17784
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
14 .B doveadm \ auth
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
15 .I COMMANDS
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
16 can be used to perform various authentication related actions.
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
17 .\"------------------------------------------------------------------------
17784
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
18 @INCLUDE:global-options-formatter@
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
19 .\" --- command specific options --- "/.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
20 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
21 Command specific
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
22 .IR options :
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
23 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
24 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
25 .BI \-x\ auth_info
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
26 .I auth_info
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
27 specifies additional conditions for the
17784
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
28 .BR "auth lookup" " and " "auth test"
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
29 commands.
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
30 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
31 .I auth_info
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
32 option string has to be given as
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
33 .IB name = value
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
34 pair.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
35 For multiple conditions the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
36 .B \-x
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
37 option could be supplied multiple times.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
38 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
39 Possible names for the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
40 .I auth_info
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
41 are:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
42 .RS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
43 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
44 .B service
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
45 The service for which the authentication lookup should be tested.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
46 The value may be the name of a service, commonly used with Dovecot.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
47 For example:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
48 .BR imap ,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
49 .BR pop3\ or
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
50 .BR smtp .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
51 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
52 .B lip
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
53 The local IP address (server) for the test.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
54 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
55 .B rip
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
56 The remote IP address (client) for the test.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
57 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
58 .B lport
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
59 The local port, e.g. 143
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
60 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
61 .B rport
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
62 The remote port, e.g. 24567
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
63 .RE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
64 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
65 .SH ARGUMENTS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
66 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
67 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
68 .I user
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
69 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
70 .IR user \(aqs
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
71 login name.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
72 Depending on the configuration, the login name may be for example
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
73 .BR jane " or " john@example.com .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
74 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
75 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
76 .I password
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
77 Optionally the user\(aqs password.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
78 .BR doveadm (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
79 will prompt for the password, if none was given.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
80 .\"------------------------------------------------------------------------
17784
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
81 .SH COMMANDS
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
82 .SS auth cache flush
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
83 .B doveadm auth cache flush
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
84 .RB [ \-a
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
85 .IR master_socket_path ]
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
86 .RI [ user " ...]"
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
87 .PP
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
88 Flush the authentication cache.
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
89 By default the cache is flushed for all the users (which can also be done
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
90 by sending SIGHUP to the auth process).
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
91 You can also flush the cache for one or more users by providing their
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
92 usernames.
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
93 .PP
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
94 .TP
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
95 .BI \-a \ master_socket_path
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
96 This option is used to specify an absolute path to an alternative UNIX
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
97 domain socket.
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
98 .sp
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
99 By default
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
100 .BR doveadm (1)
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
101 will use the socket
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
102 .IR @rundir@/auth\-master .
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
103 The socket may be located in another directory, when the default
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
104 .I base_dir
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
105 setting was overridden in
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
106 .IR @pkgsysconfdir@/dovecot.conf .
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
107 .\"-------------------------------------
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
108 .SS auth lookup
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
109 .B doveadm auth lookup
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
110 .RB [ \-a
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
111 .IR userdb_socket_path ]
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
112 .RB [ \-x
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
113 .IR auth_info ]
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
114 .RB [ \-f
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
115 .IR field ] \ user \ [...]
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
116 .PP
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
117 Similar to
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
118 .BR doveadm\-user (1)
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
119 command, except it performs a
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
120 .I passdb
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
121 lookup (without authentication) instead of a
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
122 .I userdb
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
123 lookup.
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
124 .PP
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
125 .TP
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
126 .BI \-a \ userdb_socket_path
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
127 This option is used to specify an absolute path to an alternative UNIX
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
128 domain socket.
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
129 .sp
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
130 By default
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
131 .BR doveadm (1)
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
132 will use the socket
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
133 .IR @rundir@/auth\-userdb .
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
134 The socket may be located in another directory, when the default
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
135 .I base_dir
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
136 setting was overridden in
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
137 .IR @pkgsysconfdir@/dovecot.conf .
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
138 .\"-----------------
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
139 .TP
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
140 .BI \-f \ field
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
141 When this option and the name of a userdb field is given,
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
142 .BR doveadm (1)
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
143 will show only the value of the specified field.
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
144 .\"-------------------------------------
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
145 .SS auth test
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
146 .B doveadm auth test
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
147 .RB [ \-a
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
148 .IR auth_socket_path ]
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
149 .RB [ \-x
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
150 .IR auth_info ]
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
151 .IR user \ [ password ]
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
152 .PP
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
153 Test authentication for the given user.
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
154 .\"-------------------------------------
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
155 .TP
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
156 .BI \-a\ auth_socket_path
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
157 This option is used to specify an absolute path to an alternative UNIX
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
158 domain socket.
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
159 .sp
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
160 By default
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
161 .BR doveadm (1)
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
162 will use the socket
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
163 .IR @rundir@/auth\-client .
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
164 The socket may be located in another directory, when the default
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
165 .I base_dir
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
166 setting was overridden in
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
167 .IR @pkgsysconfdir@/dovecot.conf .
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
168
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
169 .\"------------------------------------------------------------------------
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
170 .SH EXAMPLE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
171 This example demonstrates an imap authentication test for user john,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
172 assuming the user is connected from the host with the IP address
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
173 192.0.2.143.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
174 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
175 .nf
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 17784
diff changeset
176 .ft B
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 17784
diff changeset
177 doveadm auth test \-x service=imap \-x rip=192.0.2.143 john
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 17784
diff changeset
178 .ft P
17784
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
179 Password:
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
180 passdb: john auth succeeded
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
181 extra fields:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
182 user=john
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
183 .fi
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
184 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
185 @INCLUDE:reporting-bugs@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
186 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
187 .SH SEE ALSO
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
188 .BR doveadm (1),
17784
03653943b6ad man: doveadm-auth man page updated
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
189 .BR doveadm\-user (1),
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
190 .BR doveconf (1)