1.. cyrusman:: cyr_info(8)
2
3.. author: Nic Bernstein (Onlight)
4.. author: Jeroen van Meeuwen (Kolab Systems)
5
6.. _imap-reference-manpages-systemcommands-cyr_info:
7
8==============
9**cyr_info**
10==============
11
12General cyrus inspection tool
13
14Synopsis
15========
16
17.. parsed-literal::
18
19    **cyr_info** [OPTIONS] conf
20    **cyr_info** [OPTIONS] conf-default
21    **cyr_info** [OPTIONS] conf-all
22    **cyr_info** [OPTIONS] conf-lint
23    **cyr_info** [OPTIONS] proc
24
25Description
26===========
27
28**cyr_info** is a tool for getting information from Cyrus.  The intent
29is to extend this tool with useful commands to make managing and
30configuring Cyrus easier.
31
32**cyr_info** |default-conf-text|
33
34**cyr_info** provides the following sub-commands:
35
36.. option:: conf
37
38    Print only the configuration options which are not the same as
39    default (regardless of whether you have specified them or not).
40
41.. option:: conf-default
42
43    Print all default configuration options, ignoring those set locally.
44
45.. option:: conf-all
46
47    Print ALL configuration options - including default options.  This
48    command shows which options will be in effect at runtime.
49
50.. option:: conf-lint
51
52    Print only configuration options which are NOT recognised.  This
53    command should not print anything.  It uses cyrus.conf to find
54    the names of configured services to avoid displaying any known
55    configuration options for the named service.
56
57.. option:: proc
58
59    Print all currently connected processes in the proc directory
60
61Options
62=======
63
64.. program:: cyr_info
65
66.. option:: -C config-file
67
68    |cli-dash-c-text|
69
70.. option:: -M config-file
71
72    Read service specifications from *config-file* (cyrus.conf format).
73
74.. option:: -n servicename
75
76    Read the configuration as if for the service named *name*.
77
78Examples
79========
80
81.. parsed-literal::
82
83    **cyr_info** *proc*
84
85..
86
87        List all the proc files and who they're logged in as.
88
89.. only:: html
90
91    ::
92
93        1763345 imap imap.example.org [10.202.2.80] bettysue user.bettysue
94        1796653 imap web1.example.org [10.202.2.211] bettysue user.bettysue.Drafts
95        1796640 imap web2.example.org [10.202.2.212] johnsmith@johnsmith.net johnsmith.net!user.johnsmith
96        1796663 imap web2.example.org [10.202.2.212] johnsmith@johnsmith.net johnsmith.net!user.johnsmith
97
98.. parsed-literal::
99
100    **cyr_info** *conf-lint*
101
102..
103
104        Lint the configuration for unrecognized settings.
105
106.. only:: html
107
108    ::
109
110        duplicate_mailbox_mode: uniqueid
111        archivepartition-default: /var/spool/cyrus/spool-archive
112        rudolf_sync_host: 10.202.79.15
113        prancer_sync_host: 10.206.51.80
114        user_folder_limit: 5000
115
116History
117=======
118
119|v3-new-command|
120
121Files
122=====
123
124/etc/imapd.conf,
125/etc/cyrus.conf
126
127See Also
128========
129:cyrusman:`imapd.conf(5)`, :cyrusman:`cyrus.conf(5)`
130