cyrus-master(8)

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

NAME

8       cyrus-master - cyrus-master Cyrus process
9

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

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

CONFIGURATION

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

NOTES

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

FILES

82       /etc/cyrus.conf, /etc/imapd.conf, /var/run/cyrus-master.pid
83