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 ]
13           [ -j janitor period ] [ -d | -D ] [ -L logfile ]
14

DESCRIPTION

16       master  is  the  process that controls all of the Cyrus processes. This
17       process is responsible for creating all imapd, pop3d,  lmtpd  and  tim‐
18       sieved   child   processes.   This   process  also  performs  scheduled
19       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
25       master reads its configuration options out of  the  imapd.conf(5)  file
26       unless specified otherwise by -C.
27

OPTIONS

29       -C alternate imapd.conf
30              Use the specified configuration file config-file rather than the
31              default imapd.conf(5).
32
33       -M alternate cyrus.conf
34              Specifies an alternate cyrus.conf for use by master.
35
36       -l listen queue backlog
37              Increase the listen queue backlog. By default, the listen  queue
38              is  set  to 32.   On systems with a high connection rate, it may
39              be desirable to increase this value. refer to listen(2) for  de‐
40              tails.
41
42       -j janitor full-sweeps per second
43              Sets the number of times per second the janitor should sweep the
44              entire child table.  Leave it at the default  of  1  unless  you
45              have  a  really  high  fork rate (and you have not increased the
46              child hash table size when you compiled Cyrus from  its  default
47              of 10000 entries).
48
49       -p pidfile
50              Use  pidfile  as  the  pidfile.   If  not specified, defaults to
51              /var/run/master.pid
52
53       -d     Start in daemon mode (run in background and disconnect from con‐
54              trolling terminal).
55
56       -D     Don’t close stdin/stdout/stderr. Primarily useful for debugging.
57              Note that -d and -D cannot be used together; consider  using  -L
58              instead.
59
60       -L logfile
61              Redirect stdout and stderr to the given logfile.
62

CONFIGURATION

64       Upon  execution,  master reads its configuration information out of the
65       cyrus.conf(5) file, or an alternative if -M is used.
66
67       master rereads its configuration file when it receives a hangup signal,
68       SIGHUP.  Services and events may be added, deleted or modified when the
69       configuration file is reread.  Any active  services  removed  from  the
70       configuration  file  will be allowed to run until completion.  Services
71       added or modified to listen on a privileged port may  not  be  able  to
72       bind  the port, depending on your system configuration.  In this case a
73       full restart is needed.
74
75       master propagates the hangup signal, SIGHUP, to its child service  pro‐
76       cesses,  so  that  they stop waiting for incoming connections and exit,
77       allowing them to be recycled.  This is useful  to  make  services  take
78       into  account  a  new version of the imapd.conf(5) file.  Children that
79       are servicing a client connection when SIGHUP is received  are  allowed
80       to  run  until  the client logouts before being recycled. It may take a
81       long time until the client logouts, so a log message is  generated  for
82       processes that have not been recycled within 30s.
83

NOTES

85       The environment variable CYRUS_VERBOSE can be set to log additional de‐
86       bugging information. Setting the value to 1 results in base level  log‐
87       ging.  Setting it higher results in more log messages being generated.
88

FILES

90       /etc/cyrus.conf, /etc/imapd.conf, /var/run/master.pid
91

SEE ALSO

93       cyrus.conf(5),   imapd.conf(5),   imapd(8),  pop3d(8),  lmtpd(8),  tim‐
94       sieved(8), idled(8)
95

AUTHOR

97       The Cyrus Team, Nic Bernstein (Onlight)
98
100       1993–2022, The Cyrus Team
101
102
103
104
1053.6.0                          December 12, 2022                     MASTER(8)
Impressum