cyr_info - Cyrus IMAP documentation
Contents
Copyright
1993–2025, The Cyrus Team
3.10.2 Jun 27, 2025 CYR_INFO(8)
Description
cyr_info is a tool for getting information from Cyrus. The intent is to extend this tool with useful
commands to make managing and configuring Cyrus easier.
cyr_info reads its configuration options out of the imapd.conf(5) file unless specified otherwise by -C.
cyr_info provides the following sub-commands:
conf Print the configuration options which have been set to a value other than their default, and their
value.
With -sversion, configuration options whose behaviour has changed since version will be
highlighted.
conf-all
Print ALL configuration options and their configured values (including those using their default
value). This command shows which options will be in effect at runtime.
With -sversion, configuration options which have been added or whose behaviour has changed since
version will be highlighted.
conf-default
Print the default values for all available configuration options.
With -sversion, configuration options which have been added or whose behaviour has changed since
version will be highlighted.
conf-lint
Print only configuration options which are NOT recognised. This command should not print
anything. It uses cyrus.conf to find the names of configured services to avoid displaying any
known configuration options for the named service.
proc Print active processes that master(8) is managing.
Examples
cyr_infoprocListtheactiveprocessesthatmasterismanagingcyr_infoconf-lintLinttheconfigurationforunrecognizedsettings.
Files
/etc/imapd.conf, /etc/cyrus.conf
History
This command was introduced in version 3.0.
Name
cyr_info - Cyrus IMAP documentation
General cyrus inspection tool
Options
-Cconfig-file
Use the specified configuration file config-file rather than the default imapd.conf(5).
-Mconfig-file
Read service specifications from config-file (cyrus.conf format).
-nname,--service=name
Read the configuration as if for the service named name.
-sversion,--since=version
Highlight configuration options that have been added or whose behaviour has been modified since
version. Use this option after a server upgrade, specifying your previous version, to find which
options you need to review and maybe change before starting up the upgraded server.
For use with the conf, conf-all, and conf-default sub-commands.
See Also
imapd.conf(5), cyrus.conf(5), master(8)
Synopsis
cyr_info [OPTIONS] conf
cyr_info [OPTIONS] conf-default
cyr_info [OPTIONS] conf-all
cyr_info [OPTIONS] conf-lint
cyr_info [OPTIONS] proc
