1MASTER(8)                         Cyrus IMAP                         MASTER(8)
2
3
4

NAME

6       master - Cyrus IMAP documentation
7
8       The Cyrus IMAP master process.
9

SYNOPSIS

11       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

DESCRIPTION

17       master  is  the  process that controls all of the Cyrus processes. This
18       process is responsible for creating all imapd, pop3d,  lmtpd  and  tim‐
19       sieved  child  processes. This process also initializes the Berkeley DB
20       code and performs scheduled cleanup/maintenance.
21
22       If this process dies, then no new sessions will be started.
23
24       It kills itself and all child processes when it receives a SIGTERM.
25
26       master reads its configuration options out of  the  imapd.conf(5)  file
27       unless specified otherwise by -C.
28

OPTIONS

30       -C alternate imapd.conf
31              Use the specified configuration file config-file rather than the
32              default imapd.conf(5).
33
34       -M alternate cyrus.conf
35              Specifies an alternate cyrus.conf for use by master.
36
37       -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
43       -j janitor full-sweeps per second
44              Sets the number 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
50       -p pidfile
51              Use  pidfile  as  the  pidfile.   If  not specified, defaults to
52              /var/run/master.pid
53
54       -P snmp agentx ping interval
55              Sets the amount on time in seconds the  subagent  will  try  and
56              reconnect  to  the  master  agent (snmpd) if it ever becomes (or
57              starts) disconnected.  Requires net-snmp 5.0 or higher.
58
59       -d     Start in daemon mode (run in background and disconnect from con‐
60              trolling terminal).
61
62       -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
66       -L logfile
67              Redirect stdout and stderr to the given logfile.
68
69       -x snmp agentx socket
70              Address  the  master  agent  (most  likely  snmpd)  listens  on.
71              Requires net-snmp 5.0 or higher.
72

CONFIGURATION

74       Upon execution, master reads its configuration information out  of  the
75       cyrus.conf(5) file, or an alternative if -M is used.
76
77       master rereads its configuration file when it receives a hangup signal,
78       SIGHUP.  Services and events may be added, deleted or modified when the
79       configuration  file  is  reread.   Any active services removed from the
80       configuration file will be allowed to run until  completion.   Services
81       added  or  modified  to  listen on a privileged port may not be able to
82       bind the port, depending on your system configuration.  In this case  a
83       full restart is needed.
84
85       master  propagates the hangup signal, SIGHUP, to its child service pro‐
86       cesses, 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

NOTES

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

FILES

101       /etc/cyrus.conf, /etc/imapd.conf, /var/run/master.pid
102

SEE ALSO

104       cyrus.conf(5),   imapd.conf(5),   imapd(8),  pop3d(8),  lmtpd(8),  tim‐
105       sieved(8), idled(8)
106

AUTHOR

108       The Cyrus Team, Nic Bernstein (Onlight)
109
111       1993-2017, The Cyrus Team
112
113
114
115
1163.0.13                         December 16, 2019                     MASTER(8)
Impressum