1CYR_INFO(8)                       Cyrus IMAP                       CYR_INFO(8)
2
3
4

NAME

6       cyr_info - Cyrus IMAP documentation
7
8       General cyrus inspection tool
9

SYNOPSIS

11          cyr_info [OPTIONS] conf
12          cyr_info [OPTIONS] conf-default
13          cyr_info [OPTIONS] conf-all
14          cyr_info [OPTIONS] conf-lint
15          cyr_info [OPTIONS] proc
16

DESCRIPTION

18       cyr_info  is  a tool for getting information from Cyrus.  The intent is
19       to extend this tool with useful commands to make managing and configur‐
20       ing Cyrus easier.
21
22       cyr_info  reads its configuration options out of the imapd.conf(5) file
23       unless specified otherwise by -C.
24
25       cyr_info provides the following sub-commands:
26
27       conf   Print the configuration options which have been set to  a  value
28              other than their default, and their value.
29
30              With  -s  version,  configuration  options  whose  behaviour has
31              changed since version will be highlighted.
32
33       conf-all
34              Print ALL configuration options and their configured values (in‐
35              cluding  those  using  their default value).  This command shows
36              which options will be in effect at runtime.
37
38              With -s version, configuration options which have been added  or
39              whose behaviour has changed since version will be highlighted.
40
41       conf-default
42              Print  the  default  values  for all available configuration op‐
43              tions.
44
45              With -s version, configuration options which have been added  or
46              whose behaviour has changed since version will be highlighted.
47
48       conf-lint
49              Print only configuration options which are NOT recognised.  This
50              command should not print anything.  It uses cyrus.conf  to  find
51              the  names  of configured services to avoid displaying any known
52              configuration options for the named service.
53
54       proc   Print all currently connected processes in the proc directory
55

OPTIONS

57       -C config-file
58              Use the specified configuration file config-file rather than the
59              default imapd.conf(5).
60
61       -M config-file
62              Read  service  specifications  from config-file (cyrus.conf for‐
63              mat).
64
65       -n name, --service=name
66              Read the configuration as if for the service named name.
67
68       -s version, --since=version
69              Highlight configuration options that have been  added  or  whose
70              behaviour  has been modified since version.  Use this option af‐
71              ter a server upgrade, specifying your previous version, to  find
72              which  options you need to review and maybe change before start‐
73              ing up the upgraded server.
74
75              For use with the conf, conf-all, and conf-default sub-commands.
76

EXAMPLES

78          cyr_info proc
79          List all the proc files and who they're logged in as.
80
81          cyr_info conf-lint
82          Lint the configuration for unrecognized settings.
83

HISTORY

85       This command was introduced in version 3.0.
86

FILES

88       /etc/imapd.conf, /etc/cyrus.conf
89

SEE ALSO

91       imapd.conf(5), cyrus.conf(5)
92

AUTHOR

94       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
95       tems)
96

98       1993–2023, The Cyrus Team
99
100
101
102
1033.8.1                            Sep 11, 2023                      CYR_INFO(8)
Impressum