Seth Woolley's Man Viewer

Manual for master - man 8 master

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

MASTER(8)                                                            MASTER(8)



NAME
       master(5,8) - master(5,8) Cyrus process

SYNOPSIS
       master(5,8)  [  -C  alternate  imapd.conf ] [ -M alternate cyrus.conf ] [ -l
       listen(1,2,7) queue(1,3) ] [ -p pidfile ] [ -P snmp agentx ping  interval  ]  [  -j
       janitor period ] [ -d ] [ -D ] [ -x snmp agentx socket(2,7,n) ]

DESCRIPTION
       Master  is  the  process that controls all of the Cyrus processes. This
       process is responsible for creating all imapd(5,8), pop3d(1,8), 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(5,8)  (note  that
              this  will  not  affect any sub-processes spawned by master(5,8), you
              should specify those specifically in(1,8) the respective  entries  in(1,8)
              cyrus.conf).

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

       -l listen(1,2,7) queue(1,3) backlog
              Increase  the listen(1,2,7) queue(1,3) backlog. By default, the listen(1,2,7) queue(1,3)
              is set(7,n,1 builtins) to 32.   On systems with a high connection rate,  it  may
              be  desirable  to  increase  this  value. refer to listen(1,2,7)(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(1,2,n) in(1,8) seconds the subagent will try and
              reconnect to the master(5,8) agent (snmpd) if(3,n)  it  ever  becomes  (or
              starts) disconnected.  Requires net-snmp 5.0 or higher.

       -d     Start in(1,8) daemon mode (run in(1,8) background and disconnect from con-
              trolling terminal).

       -D     Don't close(2,7,n) stdin/stdout/stderr. Primiarly useful for debugging.

       -x snmp agentx socket(2,7,n)
              Address  the  master(5,8)  agent  (most  likely  snmpd)  listens  on.
              Requires net-snmp 5.0 or higher.

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

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

NOTES
       The environment variable CYRUS_VERBOSE can be  set(7,n,1 builtins)  to  log  additional
       debugging  information.  Setting  the  value to 1 results in(1,8) base level
       logging.  Setting it higher results in(1,8) more log messages  being  gener-
       ated.

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

SEE ALSO
       cyrus.conf(5),   imapd.conf(5),   imapd(5,8)(8),  pop3d(1,8)(8),  lmtpd(8),  tim-
       sieved(8), idled(8)



CMU                              Project Cyrus                       MASTER(8)

References for this manual (incoming links)