Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-auth.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 a2bbd6c3624a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
1 .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
2 .TH DOVEADM\-AUTH 1 "2010-06-09" "Dovecot v2.0" "Dovecot"
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
3 .SH NAME
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
4 doveadm\-auth \- Test authentication for a user
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
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
7 .BR doveadm " [" \-Dv "] " auth
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
8 [\fB\-a\fP \fIauth_socket_path\fP]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
9 [\fB\-x\fP \fIauth_info\fP]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
10 .I user
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
11 [\fIpassword\fP]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
12 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
13 .SH DESCRIPTION
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
14 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
15 .B auth
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
16 command can be used to test the authentication for the given
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
17 .IR user .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
18 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
19 @INCLUDE:global-options@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
20 .\" --- command specific options --- "/.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
21 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
22 Command specific
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
23 .IR options :
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
24 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
25 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
26 .BI \-a\ auth_socket_path
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
27 This option is used to specify an absolute path to an alternative UNIX
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
28 domain socket.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
29 .sp
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
30 By default
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
31 .BR doveadm (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
32 will use the socket
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
33 .IR @rundir@/auth\-client .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
34 The socket may be located in another directory, when the default
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
35 .I base_dir
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
36 setting was overridden in
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
37 .IR @sysconfdir@/dovecot/dovecot.conf .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
38 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
39 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
40 .BI \-x\ auth_info
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
41 .I auth_info
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
42 specifies additional conditions for the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
43 .B auth
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
44 command.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
45 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
46 .I auth_info
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
47 option string has to be given as
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
48 .IB name = value
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
49 pair.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
50 For multiple conditions the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
51 .B \-x
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
52 option could be supplied multiple times.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
53 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
54 Possible names for the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
55 .I auth_info
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
56 are:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
57 .RS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
58 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
59 .B service
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
60 The service for which the authentication lookup should be tested.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
61 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
62 For example:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
63 .BR imap ,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
64 .BR pop3\ or
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
65 .BR smtp .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
66 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
67 .B lip
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
68 The local IP address (server) for the test.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
69 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
70 .B rip
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
71 The remote IP address (client) for the test.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
72 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
73 .B lport
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
74 The local port, e.g. 143
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 .B rport
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
77 The remote port, e.g. 24567
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
78 .RE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
79 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
80 .SH ARGUMENTS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
81 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
82 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
83 .I user
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
84 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
85 .IR user \(aqs
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
86 login name.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
87 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
88 .BR jane " or " john@example.com .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
89 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
90 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
91 .I password
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
92 Optionally the user\(aqs password.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
93 .BR doveadm (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
94 will prompt for the password, if none was given.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
95 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
96 .SH EXAMPLE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
97 This example demonstrates an imap authentication test for user john,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
98 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
99 192.0.2.143.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
100 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
101 .nf
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
102 .B doveadm auth \-x service=imap \-x rip=192.0.2.143 john johns_password
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
103 passdb: john auth succeeded
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
104 extra fields:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
105 user=john
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
106 .fi
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
107 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
108 @INCLUDE:reporting-bugs@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
109 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
110 .SH SEE ALSO
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
111 .BR doveadm (1),
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
112 .BR doveconf (1)