| 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 |
|
| 12 |
General cyrus inspection tool |
| 13 |
|
| 14 |
Synopsis |
| 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 |
|
| 25 |
Description |
| 26 |
=========== |
| 27 |
|
| 28 |
**cyr_info** is a tool for getting information from Cyrus. The intent |
| 29 |
is to extend this tool with useful commands to make managing and |
| 30 |
configuring 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 the configuration options which have been set to a value |
| 39 |
other than their default, and their value. |
| 40 |
|
| 41 |
With **-s version**, configuration options whose behaviour has |
| 42 |
changed since *version* will be highlighted. |
| 43 |
|
| 44 |
.. option:: conf-all |
| 45 |
|
| 46 |
Print ALL configuration options and their configured values (including |
| 47 |
those using their default value). This command shows which options |
| 48 |
will be in effect at runtime. |
| 49 |
|
| 50 |
With **-s version**, configuration options which have been added or |
| 51 |
whose behaviour has changed since *version* will be highlighted. |
| 52 |
|
| 53 |
.. option:: conf-default |
| 54 |
|
| 55 |
Print the default values for all available configuration options. |
| 56 |
|
| 57 |
With **-s version**, configuration options which have been added or |
| 58 |
whose behaviour has changed since *version* will be highlighted. |
| 59 |
|
| 60 |
.. option:: conf-lint |
| 61 |
|
| 62 |
Print only configuration options which are NOT recognised. This |
| 63 |
command should not print anything. It uses cyrus.conf to find |
| 64 |
the names of configured services to avoid displaying any known |
| 65 |
configuration options for the named service. |
| 66 |
|
| 67 |
.. option:: proc |
| 68 |
|
| 69 |
Print active processes that :cyrusman:`master(8)` is managing. |
| 70 |
|
| 71 |
Options |
| 72 |
======= |
| 73 |
|
| 74 |
.. program:: cyr_info |
| 75 |
|
| 76 |
.. option:: -C config-file |
| 77 |
|
| 78 |
|cli-dash-c-text| |
| 79 |
|
| 80 |
.. option:: -M config-file |
| 81 |
|
| 82 |
Read service specifications from *config-file* (cyrus.conf format). |
| 83 |
|
| 84 |
.. option:: -n name, --service=name |
| 85 |
|
| 86 |
Read the configuration as if for the service named *name*. |
| 87 |
|
| 88 |
.. option:: -s version, --since=version |
| 89 |
|
| 90 |
Highlight configuration options that have been added or whose behaviour |
| 91 |
has been modified since *version*. Use this option after a server upgrade, |
| 92 |
specifying your previous version, to find which options you need to review |
| 93 |
and maybe change before starting up the upgraded server. |
| 94 |
|
| 95 |
For use with the **conf**, **conf-all**, and **conf-default** sub-commands. |
| 96 |
|
| 97 |
Examples |
| 98 |
======== |
| 99 |
|
| 100 |
.. parsed-literal:: |
| 101 |
|
| 102 |
**cyr_info** *proc* |
| 103 |
|
| 104 |
.. |
| 105 |
|
| 106 |
List the active processes that master is managing |
| 107 |
|
| 108 |
.. only:: html |
| 109 |
|
| 110 |
:: |
| 111 |
|
| 112 |
1763345 imap imap.example.org [10.202.2.80] bettysue user.bettysue |
| 113 |
1796653 imap web1.example.org [10.202.2.211] bettysue user.bettysue.Drafts |
| 114 |
1796640 imap web2.example.org [10.202.2.212] [email protected] johnsmith.net!user.johnsmith |
| 115 |
1796663 imap web2.example.org [10.202.2.212] [email protected] johnsmith.net!user.johnsmith |
| 116 |
|
| 117 |
.. parsed-literal:: |
| 118 |
|
| 119 |
**cyr_info** *conf-lint* |
| 120 |
|
| 121 |
.. |
| 122 |
|
| 123 |
Lint the configuration for unrecognized settings. |
| 124 |
|
| 125 |
.. only:: html |
| 126 |
|
| 127 |
:: |
| 128 |
|
| 129 |
duplicate_mailbox_mode: uniqueid |
| 130 |
archivepartition-default: /var/spool/cyrus/spool-archive |
| 131 |
rudolf_sync_host: 10.202.79.15 |
| 132 |
prancer_sync_host: 10.206.51.80 |
| 133 |
user_folder_limit: 5000 |
| 134 |
|
| 135 |
History |
| 136 |
======= |
| 137 |
|
| 138 |
|v3-new-command| |
| 139 |
|
| 140 |
Files |
| 141 |
===== |
| 142 |
|
| 143 |
/etc/imapd.conf, |
| 144 |
/etc/cyrus.conf |
| 145 |
|
| 146 |
See Also |
| 147 |
======== |
| 148 |
:cyrusman:`imapd.conf(5)`, :cyrusman:`cyrus.conf(5)`, :cyrusman:`master(8)` |