CYR_INFO(8)

✨ NAME ✨

okay bestie, welcome to cyr_info β€” the Cyrus IMAP documentation girlie πŸ’– she's your general cyrus inspection tool, and honestly? iconic.


πŸ’… SYNOPSIS πŸ’…

cyr_info [OPTIONS] conf
cyr_info [OPTIONS] conf-default
cyr_info [OPTIONS] conf-all
cyr_info [OPTIONS] conf-lint
cyr_info [OPTIONS] proc

🌸 DESCRIPTION 🌸

so cyr_info is literally the tool you use to get information out of Cyrus, bestie. the intent (the vision, the vibe) is to keep extending this tool with useful commands so that managing and configuring Cyrus gets easier. main character energy for a config inspector, no cap.

she reads her configuration options out of imapd.conf(5) unless you tell her otherwise with -C. πŸŽ€

and she provides the following sub-commands:

  • conf β€” prints the configuration options that have been set to a value other than their default, plus what that value is. slay. with -s version, configuration options whose behaviour has changed since version get highlighted. πŸ‘‘
  • conf-all β€” prints ALL the configuration options and their configured values (yes, even the ones chillin' at their default value). this is the "what will actually be in effect at runtime" command. 🫢 with -s version, configuration options that have been added or whose behaviour has changed since version get highlighted.
  • conf-default β€” prints the default values for all available configuration options. πŸ¦‹ with -s version, configuration options that have been added or whose behaviour has changed since version get highlighted.
  • conf-lint β€” prints only the configuration options that are NOT recognised. and like… this command should not print anything. if it prints something, that's the tea. 🍡 it uses cyrus.conf to find the names of configured services so it can avoid displaying any known configuration options for the named service.
  • proc β€” prints active processes that master(8) is managing. πŸ’œ

⭐ OPTIONS ⭐

  • -C config-file β€” use the specified configuration file config-file instead of the default imapd.conf(5).
  • -M config-file β€” read service specifications from config-file (that's cyrus.conf format, iykyk).
  • -n name, --service=name β€” read the configuration as if for the service named name.
  • -s version, --since=version β€” highlight configuration options that have been added or whose behaviour has been modified since version. bestie, use this one after a server upgrade, specifying your previous version, so you can find which options you need to review and maybe change before starting up the upgraded server. πŸ™ˆ

only for use with the conf, conf-all, and conf-default sub-commands, okay?


🌈 EXAMPLES 🌈

cyr_info proc
List the active processes that master is managing
cyr_info conf-lint
Lint the configuration for unrecognized settings.

πŸ’€ HISTORY πŸ’€

this command was introduced in version 3.0. so she's a legacy icon fr fr.


πŸ“ FILES πŸ“

/etc/imapd.conf, /etc/cyrus.conf


🧚 SEE ALSO 🧚

imapd.conf(5), cyrus.conf(5), master(8)


πŸ‘‘ AUTHOR πŸ‘‘

the Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Systems) β€” we stan. πŸ’…


1993–2026, The Cyrus Team


and that's the whole page bestie, thanks for reading my little manual rant πŸ₯Ή this was Cyrus IMAP version 3.12.3, dated Jul 15, 2026, and yes she really is that girl. periodt. πŸ’…βœ¨

πŸ“¦ where this page comes from