
  Quotient is configured initially using the mktap tool from Twisted. 
Quotient provides three different mktap plugins: quotient, quotient-sip, and
quotient-email.  The parameters to each plugin and examples of usage are
described below.

  mktap quotient
  ==============

  When you run "mktap quotient --help", the following page of usage
information should appear:

Usage:    mktap [options] <command> [command options] quotient [options]
Options:
      --master-store  Act as a master store.
  -w, --webport=      Port to run web server on. [default: 8485]
  -p, --pop3port=     Port to run POP3 server on. [default: 10110]
  -s, --smtpport=     Port to run SMTP server on. [default: 10025]
  -i, --imap4port=    Port to run IMAP server on. [default: 10143]
  -d, --datadir=      Directory name to put database in. [default:
                      QuotientService/db]
  -S, --sipport=      Port to run a SIP registrar service on. [default: 5060]
  -m, --msgcal=       Directory to put original email messages in. [default:
                      QuotientService/mail]
      --dir=          Import a directory full of mail
      --domain=       [default: Domain to run services on.]
  -P, --pop3g=        Grab mail from a POP3 account. user:pass:host:port
      --imap4g=       Grab mail from an IMAP4 account. user:pass:host:port
  -I, --storeID=      The ID to assign to this store.
      --version
      --mbox=
      --help          Display this help and exit.
      --user=


  Several of the flags are simple and relatively self-explanatory:

    --version
    --help         Display information about Twisted and/or Quotient.

    --webport
    --pop3port
    --imap4port
    --smtpport     These parameters allow configuration of the ports various
                   services run on.  By default, high-numbered ports are
                   used so as not to conflict with other system services and
                   so that superuser privileges are not required to run the
                   server.  The defaults are fine when using Quotient in a
                   test environment.  They can also be used to specify other
                   options, such as SSL and interface binding.  See the end of
                   this file for examples.

    --sipport      Port the SIP proxy listens on (default 5060). Unlike the 
                   four above, it only takes a port number as an argument.

    --asteriskport This parameter indicates the port another SIP proxy is 
                   listening on locally that you wish to forward to when 
                   user lookup fails. Divmod uses this to forward call 
                   requests to PSTN numbers through Asterisk.

    --domain       Creates a new domain in this Quotient service.  If it is
                   not specified, it defaults to "localhost".

    --user         Adds a user.  This must be in the format
                   "username:password".

    --imap4g
    --pop3g
    --mbox
    --dir          Add a message source to the most recently specified user. 
                   For --imap4g and --pop3g, this adds a re-occurring task to
                   the user which retrieves messages either from an IMAP4 or
                   a POP3 account.  For --mbox and --dir, it performs a
                   one-time import of messages from either an mbox-formatted
                   mail file or a directory filled with single-message files
                   (a Maildir's new/ or cur/ directory, for example).

    --storeID
    --master-store  Options for configuring a multi-system Quotient setup. 
                    These are not yet fully implemented and should not be
                    specified.

  Examples
  ========

    # A configuration that runs all services on their standard ports and
    # creates a single domain, "foo.bar"
    
    mktap quotient --webport 80 --pop3port 110 --imap4port 143 \
                   --smtpserver 25 --webport ssl:443:privateKey=http.pem \
                   --pop3port ssl:995:privateKey=pop3.pem \
                   --imap4port ssl:993:privateKey=imap4.pem \
                   --sipport 5060 --domain foo.bar


    # A configuration that creates "foo.bar" and adds three users to it.

    mktap quotient --domain foo.bar --user jimbob:tirkis --user kenshi:uraiaSm \
                   --user nigel:bAzop3r


    # A configuration that adds a single user to the "localhost" domain and
    # loads messages from his mail spool.

    mktap quotient --user someguy:drowssap --mbox /var/spool/mail/someguy
