cyr_info

General cyrus inspection tool

Synopsis

cyr_info [ -C config-file ] [ -M config-file ] [ -n servicename ] command

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.

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 (cyrus.conf format).

-n servicename

Read the configuration as if for the service named name.

Commands

allconf

Print ALL configuration options - including default options

conf

Print only the configuration options which are not the same as default (regardless of whether you have specified them or not)

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 all currently connected processes in the proc directory

Examples

cyr_info proc

List all the proc files and who they’re logged in as.

1763345 imap imap.example.org [10.202.2.80] bettysue user.bettysue
1796653 imap web1.example.org [10.202.2.211] bettysue user.bettysue.Drafts
1796640 imap web2.example.org [10.202.2.212] johnsmith@johnsmith.net johnsmith.net!user.johnsmith
1796663 imap web2.example.org [10.202.2.212] johnsmith@johnsmith.net johnsmith.net!user.johnsmith
cyr_info conf-lint

Lint the configuration for unrecognized settings.

duplicate_mailbox_mode: uniqueid
archivepartition-default: /var/spool/cyrus/spool-archive
rudolf_sync_host: 10.202.79.15
prancer_sync_host: 10.206.51.80
user_folder_limit: 5000

History

This command was introduced in version 3.0.

Files

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