doveadm-user(1)

1DOVEADM-USER(1)                     Dovecot                    DOVEADM-USER(1)
2
3
4

NAME

6       doveadm-user - Perform a user lookup in Dovecot's userdbs
7

SYNOPSIS

9       doveadm   [-Dv]  user  [-a  userdb_socket_path]  [-f  field]  [-u]  [-x
10       auth_info] user ...
11

DESCRIPTION

13       The user command is used to perform a user lookup - to show what infor‐
14       mation  Dovecot  sees  about the user(s), or if it exists at all in the
15       configured userdb(s).
16
17       The auth_info may be useful when the userdb is for example a SQL  data‐
18       base  and  you  are  using %variables, like %s or %l, in the user_query
19       setting.  Or when you have configured the userdb in a way like this:
20
21       userdb {
22         driver = passwd-file
23         args = /etc/%s.passwd
24       }
25

OPTIONS

27       Global doveadm(1) options:
28
29       -D     Enables verbosity and debug messages.
30
31       -o setting=value
32              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
33              cot.conf  and from the userdb with the given value.  In order to
34              override multiple settings, the -o option may be specified  mul‐
35              tiple times.
36
37       -v     Enables verbosity, including progress counter.
38
39       Command specific options:
40
41       -a userdb_socket_path
42              This  option  is used to specify an absolute path to an alterna‐
43              tive UNIX domain socket.
44
45              By  default  doveadm(1)  will  use  the  socket   /var/run/dove‐
46              cot/auth-userdb.   The  socket  may be located in another direc‐
47              tory, when  the  default  base_dir  setting  was  overridden  in
48              /etc/dovecot/dovecot.conf.
49
50       -f field
51              When  this  option  and  the  name  of  a userdb field is given,
52              doveadm(1) will show only the value of the specified field.
53
54       -u     When this option is given, doveadm(1) will only show values from
55              the  userdb.   Without -u parameter if any of the uid, gid, home
56              or mail fields are missing, their defaults are taken  from  con‐
57              figuration file.
58
59       -x auth_info
60              auth_info  specifies additional conditions for the user command.
61              The auth_info option string has to be given as name=value  pair.
62              For multiple conditions the -x option could be supplied multiple
63              times.
64              Possible names for the auth_info are:
65
66              service
67                     The service for which the userdb lookup should be tested.
68                     The  value  may  be  the name of a service, commonly used
69                     with Dovecot.  For example: imap, pop3 or smtp.
70
71              lip    The local IP address (server) for the test.
72
73              rip    The remote IP address (client) for the test.
74
75              lport  The local port, e.g. 143
76
77              rport  The remote port, e.g. 24567
78

ARGUMENTS

80       user   Is a user's login name.  Depending on the configuration, a login
81              name  may  be  for  example jane or john@example.com.  It's also
82              possible to use '*' and '?' wildcards (e.g. -u *@example.org).
83

EXAMPLE

85       Perform a user lookup for the users jane and john@example.com.
86
87       doveadm user jane john@example.com
88       userdb: jane
89         uid       : 8001
90         gid       : 8001
91         home      : /home/jane
92         mail      : sdbox:~/sdbox
93         plugins   : sieve
94         quota_rule: *:storage=150M
95
96       userdb: john@example.com
97         home      : /srv/mail/8/70312/79832
98         uid       : 79832
99         gid       : 70312
100         mail      : mdbox:~/mdbox
101
102       The next example shows a user lookup, using wildcards.
103
104       doveadm user *.?oe@example.net
105       jane.doe@example.net
106       judy.roe@example.net
107       john.doe@example.net
108

REPORTING BUGS

110       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
111       <dovecot@dovecot.org>.   Information  about reporting bugs is available
112       at: http://dovecot.org/bugreport.html
113