| 1 |
.. cyrusman:: mkimap(8) |
| 2 |
|
| 3 |
.. author: Jeroen van Meeuwen (Kolab Systems) |
| 4 |
.. author: Nic Bernstein (Onlight) |
| 5 |
|
| 6 |
.. _imap-reference-manpages-systemcommands-mkimap: |
| 7 |
|
| 8 |
========== |
| 9 |
**mkimap** |
| 10 |
========== |
| 11 |
|
| 12 |
A (small) Perl script to aid in creating spool and configuration |
| 13 |
directories for Cyrus IMAP installations. |
| 14 |
|
| 15 |
Synopsis |
| 16 |
======== |
| 17 |
|
| 18 |
.. parsed-literal:: |
| 19 |
|
| 20 |
**mkimap** *config-file* |
| 21 |
|
| 22 |
Description |
| 23 |
=========== |
| 24 |
|
| 25 |
The **mkimap** script reads in the configuration file specified on the |
| 26 |
command-line or uses :file:`/etc/imapd.conf` to determine a list of |
| 27 |
directories that Cyrus IMAP would need to operate. |
| 28 |
|
| 29 |
Among these directories are: |
| 30 |
|
| 31 |
* the ``configdirectory`` (from :cyrusman:`imapd.conf(5)`) |
| 32 |
|
| 33 |
* the ``partition-$name`` directories (from :cyrusman:`imapd.conf(5)`) |
| 34 |
|
| 35 |
* the ``meta-partition-$name`` directories (from |
| 36 |
:cyrusman:`imapd.conf(5)`) |
| 37 |
|
| 38 |
.. NOTE:: |
| 39 |
|
| 40 |
This utility needs to be executed as the user ``cyrus`` (or the user |
| 41 |
you run the Cyrus IMAP service as). |
| 42 |
|
| 43 |
Options |
| 44 |
======= |
| 45 |
|
| 46 |
.. program:: mkimap |
| 47 |
|
| 48 |
.. option:: config-file |
| 49 |
|
| 50 |
|cli-dash-c-text| |
| 51 |
|
| 52 |
Examples |
| 53 |
======== |
| 54 |
|
| 55 |
.. parsed-literal:: |
| 56 |
|
| 57 |
**mkimap** */etc/imapd.conf* |
| 58 |
|
| 59 |
.. |
| 60 |
|
| 61 |
Create necessary directories based on settings in |
| 62 |
*/etc/imapd.conf*. |
| 63 |
|
| 64 |
.. only:: html |
| 65 |
|
| 66 |
:: |
| 67 |
|
| 68 |
reading configure file /etc/imapd.conf... |
| 69 |
I will configure directory /var/lib/imap. |
| 70 |
I saw partition /var/spool/cyrus/mail. |
| 71 |
I saw partition /var/spool/cyrus/news. |
| 72 |
done |
| 73 |
configuring /var/lib/imap... |
| 74 |
creating /var/spool/cyrus/mail... |
| 75 |
creating /var/spool/cyrus/news... |
| 76 |
done |
| 77 |
|
| 78 |
See Also |
| 79 |
======== |