Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions data/doveadm.js
Original file line number Diff line number Diff line change
Expand Up @@ -3014,10 +3014,11 @@ This command cannot be used safely via API by untrusted users.`
type: doveadm_arg_types.STRING,
text: `Only show value of this field.`,
},
// TODO: Needs documentation in man file
'expand-field': {
cli: 'e',
type: doveadm_arg_types.STRING
example: 'userdb_field',
type: doveadm_arg_types.STRING,
text: `Expand all %variables in this template string.`,
},
'userdb-only': {
cli: 'u',
Expand Down
10 changes: 9 additions & 1 deletion docs/core/man/doveadm-user.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ dovecotComponent: core

**doveadm** [*GLOBAL OPTIONS*] **user**
[**-a** *userdb_socket_path*]
[**-e** *template*]
[**-f** *field*]
[**-u**]
[**-x** *auth_info*]
Expand Down Expand Up @@ -44,15 +45,22 @@ userdb passwd-file {
The socket may be located in another directory, when the default
*base_dir* setting was overridden in */etc/dovecot/dovecot.conf*.

**-e** *template*
: When this option and a string with %variables is given,
[[man,doveadm]] will show the expanded string for the user.
This option can't be used together with the `-f` or `-u` options.

**-f** *field*
: When this option and the name of a userdb field is given,
[[man,doveadm]] will show only the value of the specified field.
This option can't be used together with the `-e` or `-u` options.

**-u**
: When this option is given, [[man,doveadm]] will only show values
from the *userdb*. Without -u parameter if any of the *uid*, *gid*,
from the *userdb*. Without `-u` parameter if any of the *uid*, *gid*,
*home* or *mail_path* fields are missing, their defaults are taken from
configuration file.
This option can't be used together with the `-e` or `-f` options.

<!-- @include: include/option-x.inc -->

Expand Down
Loading