CYR_INFO(8)

πŸ’– CYR_INFO(8) πŸ’–

okay bestie, gather round, because this is cyr_info from Cyrus IMAP β€” your general-purpose "let me peek inside Cyrus" inspection tool, and honestly? she's giving main character energy. πŸ”βœ¨


🌸 NAME 🌸

cyr_info β€” Cyrus IMAP documentation

General cyrus inspection tool. no cap, that's literally the whole job. πŸ’…


✨ 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 πŸ¦‹

cyr_info is the tool for getting information out of Cyrus. The vibe is: we're gonna keep adding useful commands to her so that managing and configuring Cyrus gets easier and easier. The intent is literally to extend this tool with useful commands. iykyk. 🫢

She reads her configuration options out of the imapd.conf(5) file, unless you tell her otherwise with -C. rude to assume, but okay.

So. Here are the sub-commands she ships with, and bestie, they're iconic:

  • conf β€” Prints the configuration options that have been set to a value other than their default, plus their value.

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 just chilling on their default value). This command shows which options will actually be in effect at runtime. fr fr, this is the real tea.

With -s version, configuration options which 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 which have been added or whose behaviour has changed since version get highlighted. 🌈

  • conf-lint β€” Prints only configuration options which are NOT recognised. This command should not print anything. (Not one single line. Silence = slay.) It uses cyrus.conf to find the names of the configured services, so it can avoid displaying any known configuration options for the named service. 🧚
  • proc β€” Prints the active processes that master(8) is managing. πŸ‘‘

πŸ’… OPTIONS πŸ’…

  • -C config-file β€” Use the specified configuration file config-file rather than the default imapd.conf(5).
  • -M config-file β€” Read service specifications from config-file (in cyrus.conf format).
  • -n name, --service=name β€” Read the configuration as if it were for the service named name.
  • -s version, --since=version β€” Highlight the 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 out 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.


πŸŽ€ EXAMPLES πŸŽ€

cyr_info proc

List the active processes that master is managing. go off, queen. πŸ‘‘

cyr_info conf-lint

Lint the configuration for unrecognized settings. (And if it prints nothing? congrats, that's the point. πŸ’–)


πŸ“œ HISTORY πŸ“œ

This command was introduced in version 3.0. a legend from day one, honestly.


πŸ“ 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)


1993–2026, The Cyrus Team


and that's the whole page, bestie!! go forth and inspect your Cyrus with confidence πŸ¦‹βœ¨

mwah πŸ’‹ β€” this was cyr_info(8) from Cyrus IMAP, version 3.12.4, dated Sep 09, 2026. catch you in the next manpage, ily 🫢

πŸ“¦ where this page comes from