cyrus-master(8)

1CYRUS-MASTER(8)             System Manager's Manual            CYRUS-MASTER(8)
2
3
4

NAME

6       cyrus-master - cyrus-master Cyrus process
7

SYNOPSIS

9       cyrus-master  [ -C alternate imapd.conf ] [ -M alternate cyrus.conf ] [
10       -l listen queue ] [ -p pidfile ] [ -P snmp agentx ping interval ] [  -j
11       janitor period ] [ -d ] [ -D ] [ -x snmp agentx socket ]
12

DESCRIPTION

14       Cyrus-master  is  the process that controls all of the Cyrus processes.
15       This process is responsible for creating all imapd,  pop3d,  lmtpd  and
16       sieved  child  processes. This process also initializes the Berkeley DB
17       code and performs scheduled cleanup/maintenance.
18
19       If this process dies, then no new sessions will be started.
20
21       It kills itself and all child processes when it receives a SIGTERM.
22

OPTIONS

24       -C alternate imapd.conf
25              Specifies an alternate imapd.conf for use by cyrus-master  (note
26              that  this  will  not affect any sub-processes spawned by cyrus-
27              master, you should specify those specifically in the  respective
28              entries in cyrus.conf).
29
30       -M alternate cyrus.conf
31              Specifies an alternate cyrus.conf for use by cyrus-master.
32
33       -l listen queue backlog
34              Increase  the listen queue backlog. By default, the listen queue
35              is set to 32.   On systems with a high connection rate,  it  may
36              be  desirable  to  increase  this  value. refer to listen(2) for
37              details.
38
39       -j janitor full-sweeps per second
40              Sets the amount of times per second the janitor should sweep the
41              entire  child  table.   Leave  it at the default of 1 unless you
42              have a really high fork rate (and you  have  not  increased  the
43              child  hash  table size when you compiled Cyrus from its default
44              of 10000 entries).
45
46       -p pidfile
47              Use pidfile as the  pidfile.   If  not  specified,  defaults  to
48              /var/run/cyrus-cyrus-master.pid
49
50       -P snmp agentx ping interval
51              Sets  the  amount  on  time in seconds the subagent will try and
52              reconnect to the cyrus-master agent (snmpd) if it  ever  becomes
53              (or starts) disconnected.  Requires net-snmp 5.0 or higher.
54
55       -d     Start in daemon mode (run in background and disconnect from con‐
56              trolling terminal).
57
58       -D     Don't close stdin/stdout/stderr. Primiarly useful for debugging.
59
60       -x snmp agentx socket
61              Address the cyrus-master agent (most likely snmpd)  listens  on.
62              Requires net-snmp 5.0 or higher.
63

CONFIGURATION

65       Upon execution, cyrus-master reads its configuration information out of
66       the cyrus.conf(5) file.
67
68       Cyrus-master rereads its configuration file when it receives  a  hangup
69       signal,  SIGHUP.  Services and events may be added, deleted or modified
70       when the configuration file is reread.   Any  active  services  removed
71       from the configuration file will be allowed to run until completion.
72

NOTES

74       The  environment  variable  CYRUS_VERBOSE  can be set to log additional
75       debugging information. Setting the value to 1  results  in  base  level
76       logging.   Setting  it higher results in more log messages being gener‐
77       ated.
78

FILES

80       /etc/cyrus.conf, /etc/imapd.conf, /var/run/cyrus-cyrus-master.pid
81