This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

This manual page is associated with Mac OS X Server. It is not available on standard Mac OS X (client) installations.

For more information about the manual page format, see the manual page for manpages(5).

MASTER(8)                                                                                          MASTER(8)



NAME
       master - master Cyrus process

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

DESCRIPTION
       Master is the process that controls all of the Cyrus processes. This process is responsible for  cre-ating creating
       ating  all imapd, pop3d, lmtpd and sieved child processes. This process also initializes the Berkeley
       DB code and performs scheduled cleanup/maintenance.

       If this process dies, then no new sessions will be started.

       It kills itself and all child processes when it receives a SIGTERM.

OPTIONS
       -C alternate imapd.conf
              Specifies an alternate imapd.conf for use by master (note that this will not affect  any  sub-processes subprocesses
              processes  spawned  by master, you should specify those specifically in the respective entries
              in cyrus.conf).

       -M alternate cyrus.conf
              Specifies an alternate cyrus.conf for use by master.

       -l listen queue backlog
              Increase the listen queue backlog. By default, the listen queue is set  to  32.    On  systems
              with  a  high  connection rate, it may be desirable to increase this value. refer to listen(2)
              for details.

       -j janitor full-sweeps per second
              Sets the amount of times per second the janitor should sweep the entire child table.  Leave it
              at  the  default  of 1 unless you have a really high fork rate (and you have not increased the
              child hash table size when you compiled Cyrus from its default of 10000 entries).

       -p pidfile
              Use pidfile as the pidfile.  If not specified, defaults to /var/run/cyrus-master.pid

       -P snmp agentx ping interval
              Sets the amount on time in seconds the subagent will try and reconnect  to  the  master  agent
              (snmpd) if it ever becomes (or starts) disconnected.  Requires net-snmp 5.0 or higher.

       -d     Start in daemon mode (run in background and disconnect from controlling terminal).

       -D     Don't close stdin/stdout/stderr. Primiarly useful for debugging.

       -x snmp agentx socket
              Address the master agent (most likely snmpd) listens on.  Requires net-snmp 5.0 or higher.

CONFIGURATION
       Upon execution, master reads its configuration information out of the cyrus.conf(5) file.

       Master  rereads its configuration file when it receives a hangup signal, SIGHUP.  Services and events
       may be added, deleted or modified when the configuration file is reread.  Any active services removed
       from the configuration file will be allowed to run until completion.

NOTES
       The  environment  variable  CYRUS_VERBOSE can be set to log additional debugging information. Setting
       the value to 1 results in base level logging.  Setting it higher results in more log  messages  being
       generated.

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

SEE ALSO
       cyrus.conf(5), imapd.conf(5), imapd(8), pop3d(8), lmtpd(8), timsieved(8), idled(8)



CMU                                             Project Cyrus                                      MASTER(8)