<?xml version="1.0" standalone='no'?>
<!DOCTYPE manpage SYSTEM "/usr/share/xmltoman/xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="/usr/share/xmltoman/xmltoman.xsl" ?>

<!-- OpenVAS
 $Id$
 Description: openvasmd manpage

 Authors:
 Matthew Mundell <matthew.mundell@greenbone.net>

 Copyright:
 Copyright (C) 2009 Greenbone Networks GmbH

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
-->

<manpage name="openvasmd" section="8" desc="Manager daemon of the Open Vulnerability Assessment System (OpenVAS)">

  <synopsis>
    <cmd>openvasmd OPTIONS</cmd>
  </synopsis>

  <description>
    <p>
      OpenVAS Scanner, openvassd(8), acts as a service and offers a
      communication protocol for its clients called OTP. The core
      task of the OpenVAS Scanner is the actual scan process.
    </p>

    <p>
      The OpenVAS Manager is a OTP client and adds various management
      functionalities to handle and organise scan results.
      Thus OpenVAS Manager acts as a layer between the
      OpenVAS Scanner and its own clients (for example omp(8),
      gsad(8) or gsd(8)) which connect via the OMP protocol
      to the OpenVAS Manager.
    </p>

    <p>
      A related service is OpenVAS Administrator, openvasad(8) which
      among other tasks also manages user accounts for OpenVAS.
    </p>
  </description>

  <options>
    <option>
      <p><opt>-a, --listen=<arg>ADDRESS</arg></opt></p>
      <optdesc><p>Listen on ADDRESS.</p></optdesc>
    </option>

    <option>
      <p><opt>--create-user=<arg>USERNAME</arg></opt></p>
      <optdesc><p>Create admin user USERNAME and exit.</p></optdesc>
    </option>

    <option>
      <p><opt>--role=<arg>ROLE</arg></opt></p>
      <optdesc><p>Role for --create-user option.</p></optdesc>
    </option>

    <option>
      <p><opt>--delete-user=<arg>USERNAME</arg></opt></p>
      <optdesc><p>Delete user USERNAME and exit.</p></optdesc>
    </option>

    <option>
      <p><opt>--get-users</opt></p>
      <optdesc><p>List users and exit.</p></optdesc>
    </option>

    <option>
      <p><opt>--create-scanner=<arg>NAME</arg></opt></p>
      <optdesc><p>Create scanner NAME and exit.</p></optdesc>
    </option>

    <option>
      <p><opt>--scanner-host=<arg>HOST</arg></opt></p>
      <optdesc>
        <p>Scanner host for --create-scanner, --rebuild and --update. Default is 127.0.0.1.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--scanner-port=<arg>PORT</arg></opt></p>
      <optdesc>
        <p>Scanner port for --create-scanner, --rebuild and --update. Default is 9391.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--scanner-type=<arg>TYPE</arg></opt></p>
      <optdesc><p>Type for --create-scanner option.
                  Could be "OpenVAS Scanner" or "OSP Ovaldi".</p></optdesc>
    </option>

    <option>
      <p><opt>--scanner-ca-pub=<arg>CAPUB</arg></opt></p>
      <optdesc><p>Scanner CA public key path for --create-scanner.</p></optdesc>
    </option>

    <option>
      <p><opt>--scanner-key-pub=<arg>KEYPUB</arg></opt></p>
      <optdesc><p>Scanner public key path for --create-scanner.</p></optdesc>
    </option>

    <option>
      <p><opt>--scanner-key-priv=<arg>KEYPRIV</arg></opt></p>
      <optdesc><p>Scanner private key path for --create-scanner.</p></optdesc>
    </option>

    <option>
      <p><opt>--delete-scanner=<arg>UUID</arg></opt></p>
      <optdesc><p>Delete scanner with UUID and exit.</p></optdesc>
    </option>

    <option>
      <p><opt>--get-scanners</opt></p>
      <optdesc><p>List scanners and exit.</p></optdesc>
    </option>

    <option>
      <p><opt>--gnutls-priorities=<arg>PRIORITY</arg></opt></p>
      <optdesc><p>Set the GnuTLS priority string to PRIORITY.</p></optdesc>
    </option>

    <option>
      <p><opt>--dh-params=<arg>FILE</arg></opt></p>
      <optdesc><p>Path to file containing Diffie-Hellman parameters which
                  are needed for DHE-RSA. This file could be generated using
                  openssl or certtool.</p></optdesc>
    </option>

    <option>
      <p><opt>--max-email-attachment-size=<arg>SIZE</arg></opt></p>
      <optdesc>
        <p>
          Maximum number of bytes permitted in alert email attachments.
        </p>
        <p>
          0 to use the default, negative to allow any size.
        </p>
      </optdesc>
    </option>

    <option>
      <p><opt>--max-email-include-size=<arg>SIZE</arg></opt></p>
      <optdesc>
        <p>
          Maximum number of bytes permitted in reports inlined in alert email
          attachments.
        </p>
        <p>
          0 to use the default, negative to allow any size.
        </p>
      </optdesc>
    </option>

    <option>
      <p><opt>--max-ips-per-target=<arg>SIZE</arg></opt></p>
      <optdesc>
        <p>
          Maximum number of IPs per target.
        </p>
      </optdesc>
    </option>

    <option>
      <p><opt>-u, --update</opt></p>
      <optdesc>
        <p>Updates the database with information from a running
           scanner (openvassd) and exits.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-p, --port=<arg>NUMBER</arg></opt></p>
      <optdesc>
        <p>Listen on port number <arg>NUMBER</arg>.</p>
      </optdesc>
    </option>

        <option>
      <p><opt>--rebuild</opt></p>
      <optdesc>
        <p>Rebuild the database with information from a running
           scanner (openvassd) and exits.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--version</opt></p>
      <optdesc><p>Print version.</p></optdesc>
    </option>

    <option>
      <p><opt>-v, --verbose</opt></p>
      <optdesc><p>Print progress messages.</p></optdesc>
    </option>

    <option>
      <p><opt>-?, --help</opt></p>
      <optdesc><p>Show help.</p></optdesc>
    </option>
  </options>

  <section name="SIGNALS">
    <p>SIGHUP causes openvasmd to rebuild the database with information from
       the Scanner (openvassd).</p>
  </section>

  <section name="EXAMPLES">
    <p>openvasmd --port 1241</p>
    <p>Serve OMP clients on port 1241 and connect to a OTP server on 7772.</p>
  </section>

  <section name="SEE ALSO">
    <p>
      <manref name="openvassd" section="8"/>,
      <manref name="openvasad" section="8"/>,
      <manref name="gsad" section="8"/>,
      <manref name="omp" section="8"/>,
      <manref name="gsd" section="8"/>
    </p>
  </section>

  <section name="MORE INFORMATION ABOUT THE OpenVAS PROJECT">
    <p>
      The canonical places where you will find more information
      about the OpenVAS project are:

      <url href="http://www.openvas.org/"/>
        (Official site)

      <url href="http://wald.intevation.org/projects/openvas/"/>
        (Development Platform)
    </p>
  </section>

  <section name="COPYRIGHT">
    <p>
      The OpenVAS Manager is released under the GNU GPL, version 2,
      or, at your option, any later version.
    </p>
  </section>

</manpage>
