1CYRUS-MASTER(8) Cyrus IMAP CYRUS-MASTER(8)
2
6 cyrus-master - Cyrus IMAP documentation
7 The Cyrus IMAP cyrus-master process.
9
11 cyrus-master [ -C config-file ] [ -M alternate cyrus.conf ]
12 [ -l listen queue ] [ -p pidfile ] [ -P snmp agentx ping interval ]
13 [ -j janitor period ] [ -d | -D ] [ -L logfile ]
14 [ -x snmp agentx socket ]
15
17 cyrus-master is the process that controls all of the Cyrus processes.
18 This process is responsible for creating all imapd, pop3d, lmtpd and
19 sieved child processes. This process also initializes the Berkeley DB
20 code and performs scheduled cleanup/maintenance.
21 If this process dies, then no new sessions will be started.
23 It kills itself and all child processes when it receives a SIGTERM.
25 cyrus-master reads its configuration options out of the imapd.conf(5)
27 file unless specified otherwise by -C.
28
30 -C alternate imapd.conf
31 Use the specified configuration file config-file rather than the
32 default imapd.conf(5).
33 -M alternate cyrus.conf
35 Specifies an alternate cyrus.conf for use by cyrus-master.
36 -l listen queue backlog
38 Increase the listen queue backlog. By default, the listen queue
39 is set to 32. On systems with a high connection rate, it may
40 be desirable to increase this value. refer to listen(2) for
41 details.
42 -j janitor full-sweeps per second
44 Sets the amount of times per second the janitor should sweep the
45 entire child table. Leave it at the default of 1 unless you
46 have a really high fork rate (and you have not increased the
47 child hash table size when you compiled Cyrus from its default
48 of 10000 entries).
49 -p pidfile
51 Use pidfile as the pidfile. If not specified, defaults to
52 /var/run/cyrus-master.pid
53 -P snmp agentx ping interval
55 Sets the amount on time in seconds the subagent will try and
56 reconnect to the cyrus-master agent (snmpd) if it ever becomes
57 (or starts) disconnected. Requires net-snmp 5.0 or higher.
58 -d Start in daemon mode (run in background and disconnect from con‐
60 trolling terminal).
61 -D Don't close stdin/stdout/stderr. Primarily useful for debugging.
63 Note that -d and -D cannot be used together; consider using -L
64 instead.
65 -L logfile
67 Redirect stdout and stderr to the given logfile.
68 -x snmp agentx socket
70 Address the cyrus-master agent (most likely snmpd) listens on.
71 Requires net-snmp 5.0 or higher.
72
74 Upon execution, cyrus-master reads its configuration information out of
75 the cyrus.conf(5) file, or an alternative if -M is used.
76 cyrus-master rereads its configuration file when it receives a hangup
78 signal, SIGHUP. Services and events may be added, deleted or modified
79 when the configuration file is reread. Any active services removed
80 from the configuration file will be allowed to run until completion.
81 Services added or modified to listen on a privileged port may not be
82 able to bind the port, depending on your system configuration. In this
83 case a full restart is needed.
84 cyrus-master propagates the hangup signal, SIGHUP, to its child service
86 processes, so that they stop waiting for incoming connections and exit,
87 allowing them to be recycled. This is useful to make services take
88 into account a new version of the imapd.conf(5) file. Children that
89 are servicing a client connection when SIGHUP is received are allowed
90 to run until the client logouts before being recycled. It may take a
91 long time until the client logouts, so a log message is generated for
92 processes that have not been recycled within 30s.
93
95 The environment variable CYRUS_VERBOSE can be set to log additional
96 debugging information. Setting the value to 1 results in base level
97 logging. Setting it higher results in more log messages being gener‐
98 ated.
99
101 /etc/cyrus.conf, /etc/imapd.conf, /var/run/cyrus-master.pid
102
104 cyrus.conf(5), imapd.conf(5), imapd(8), pop3d(8), lmtpd(8), tim‐
105 sieved(8), idled(8)
106
108 The Cyrus Team, Nic Bernstein (Onlight)
109
111 1993-2017, The Cyrus Team
1123.0.7 May 18, 2018 CYRUS-MASTER(8)