Scroll to navigation

DOVEADM-HELP(1) Dovecot DOVEADM-HELP(1)

NAME

doveadm-help - Show information about doveadm commands

SYNOPSIS

doveadm [GLOBAL OPTIONS] help [command]

DESCRIPTION

With no command argument given, doveadm help will print:

  • the synopsis for the most of the doveadm(1) commands,
  • groups of commands, e.g. log or mailbox.

When the name of a command (or a group) was given, it will show the man page for that command.

GLOBAL OPTIONS

Global doveadm(1)

-D

Enables verbosity and debug messages.

-O

Do not read any config file, just use defaults. The dovecot_storage_version setting defaults to the latest version, but can be overridden with

-k

Preserve entire environment for doveadm, not just import_environment setting.

-v

Enables verbosity, including progress counter.

-i instance-name

If using multiple Dovecot instances, choose the config file based on this instance name.

See instance_name setting for more information.

-c config-file

Read configuration from the given config-file. By default it first reads config socket, and then falls back to /etc/dovecot/dovecot.conf. You can also point this to config socket of some instance running compatible version.

-o setting=value

Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.

REPORTING BUGS

Report bugs, including doveconf -n output, to the Dovecot Mailing List ⟨dovecot@dovecot.org⟩. Information about reporting bugs is available at: https://dovecot.org/bugreport.html

SEE ALSO

doveadm(1)

January 2025 2bfb822