| 1 |
.. cyrusman:: master(8) |
| 2 |
|
| 3 |
.. author: Nic Bernstein (Onlight) |
| 4 |
|
| 5 |
.. _imap-reference-manpages-systemcommands-master: |
| 6 |
|
| 7 |
========== |
| 8 |
**master** |
| 9 |
========== |
| 10 |
|
| 11 |
The Cyrus IMAP master process. |
| 12 |
|
| 13 |
Synopsis |
| 14 |
======== |
| 15 |
|
| 16 |
.. parsed-literal:: |
| 17 |
|
| 18 |
**master** [ **-C** *config-file* ] [ **-M** *alternate cyrus.conf* ] |
| 19 |
[ **-l** *listen queue* ] [ **-p** *pidfile* ] [ **-r** *ready_file* ] |
| 20 |
[ **-j** *janitor period* ] [ **-d** | **-D** ] [ **-L** *logfile* ] |
| 21 |
|
| 22 |
Description |
| 23 |
=========== |
| 24 |
|
| 25 |
**master** is the process that controls all of the Cyrus |
| 26 |
processes. This process is responsible for creating all imapd, pop3d, |
| 27 |
lmtpd and timsieved child processes. This process also performs scheduled |
| 28 |
cleanup/maintenance. |
| 29 |
|
| 30 |
If this process dies, then no new sessions will be started. |
| 31 |
|
| 32 |
It kills itself and all child processes when it receives a SIGTERM. |
| 33 |
|
| 34 |
**master** |default-conf-text| |
| 35 |
|
| 36 |
Options |
| 37 |
======= |
| 38 |
|
| 39 |
.. program:: master |
| 40 |
|
| 41 |
.. option:: -C alternate imapd.conf |
| 42 |
|
| 43 |
|cli-dash-c-text| |
| 44 |
|
| 45 |
.. option:: -M alternate cyrus.conf |
| 46 |
|
| 47 |
Specifies an alternate cyrus.conf for use by master. |
| 48 |
|
| 49 |
.. option:: -l listen queue backlog |
| 50 |
|
| 51 |
Increase the listen queue backlog. By default, the listen queue is |
| 52 |
set to 32. On systems with a high connection rate, it may be |
| 53 |
desirable to increase this value. refer to :manpage:`listen(2)` for |
| 54 |
details. |
| 55 |
|
| 56 |
.. option:: -j janitor full-sweeps per second |
| 57 |
|
| 58 |
Sets the number of times per second the janitor should sweep the |
| 59 |
entire child table. Leave it at the default of 1 unless you have a |
| 60 |
really high fork rate (and you have not increased the child hash |
| 61 |
table size when you compiled Cyrus from its default of 10000 |
| 62 |
entries). |
| 63 |
|
| 64 |
.. option:: -p pidfile |
| 65 |
|
| 66 |
Use *pidfile* as the pidfile. If not specified, defaults to |
| 67 |
``master_pid_file`` from :cyrusman:`imapd.conf(5)`, which |
| 68 |
defaults to ``{configdirectory}/master.pid`` |
| 69 |
|
| 70 |
.. option:: -r ready_file |
| 71 |
|
| 72 |
Use *ready_file* as the ready file. If not specified, uses |
| 73 |
``master_ready_file`` from :cyrusman:`imapd.conf(5)`, which |
| 74 |
defaults to ``{configdirectory}/master.ready`` |
| 75 |
|
| 76 |
.. option:: -d |
| 77 |
|
| 78 |
Start in daemon mode (run in background and disconnect from |
| 79 |
controlling terminal). |
| 80 |
|
| 81 |
.. option:: -D |
| 82 |
|
| 83 |
Don't close stdin/stdout/stderr. Primarily useful for debugging. |
| 84 |
Note that **-d** and **-D** cannot be used together; consider using |
| 85 |
**-L** instead. |
| 86 |
|
| 87 |
.. option:: -L logfile |
| 88 |
|
| 89 |
Redirect stdout and stderr to the given *logfile*. |
| 90 |
|
| 91 |
Configuration |
| 92 |
============= |
| 93 |
|
| 94 |
Upon execution, **master** reads its configuration information |
| 95 |
out of the :cyrusman:`cyrus.conf(5)` file, or an alternative if **-M** |
| 96 |
is used. |
| 97 |
|
| 98 |
**master** rereads its configuration file when it receives a |
| 99 |
hangup signal, SIGHUP. Services and events may be added, deleted or |
| 100 |
modified when the configuration file is reread. Any active services |
| 101 |
removed from the configuration file will be allowed to run until |
| 102 |
completion. Services added or modified to listen on a privileged port |
| 103 |
may not be able to bind the port, depending on your system |
| 104 |
configuration. In this case a full restart is needed. |
| 105 |
|
| 106 |
**master** propagates the hangup signal, SIGHUP, to its child |
| 107 |
service processes, so that they stop waiting for incoming connections |
| 108 |
and exit, allowing them to be recycled. This is useful to make |
| 109 |
services take into account a new version of the |
| 110 |
:cyrusman:`imapd.conf(5)` file. Children that are servicing a client |
| 111 |
connection when SIGHUP is received are allowed to run until the client |
| 112 |
logouts before being recycled. It may take a long time until the client |
| 113 |
logouts, so a log message is generated for processes that have not been |
| 114 |
recycled within 30s. |
| 115 |
|
| 116 |
Notes |
| 117 |
===== |
| 118 |
|
| 119 |
The environment variable **CYRUS_VERBOSE** can be set to log additional |
| 120 |
debugging information. Setting the value to 1 results in base level logging. |
| 121 |
Setting it higher results in more log messages being generated. |
| 122 |
|
| 123 |
The :cyrusman:`cyr_info(8)` utility's ``proc`` subcommand can be used to |
| 124 |
list the active processes that **master** is managing. |
| 125 |
|
| 126 |
Files |
| 127 |
===== |
| 128 |
|
| 129 |
/etc/cyrus.conf, |
| 130 |
/etc/imapd.conf, |
| 131 |
/var/run/master.pid |
| 132 |
|
| 133 |
See Also |
| 134 |
======== |
| 135 |
|
| 136 |
:cyrusman:`cyrus.conf(5)`, :cyrusman:`imapd.conf(5)`, :cyrusman:`imapd(8)`, |
| 137 |
:cyrusman:`pop3d(8)`, :cyrusman:`lmtpd(8)`, :cyrusman:`timsieved(8)`, |
| 138 |
:cyrusman:`idled(8)`, :cyrusman:`cyr_info(8)` |