<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
	       [<!ENTITY mdash "&#8212;">]>
<!--
 - Copyright (C) 2010  Internet Systems Consortium, Inc. ("ISC")
 -
 - Permission to use, copy, modify, and/or distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->

<refentry>

  <refentryinfo>
    <date>March 10, 2010</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>b10-cfgmgr</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND10</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>b10-cfgmgr</refname>
    <refpurpose>Configuration manager</refpurpose>
  </refnamediv>

  <docinfo>
    <copyright>
      <year>2010</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>b10-cfgmgr</command>
      <arg><option>-c<replaceable>config-filename</replaceable></option></arg>
      <arg><option>-p<replaceable>data_path</replaceable></option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      The <command>b10-cfgmgr</command> daemon handles all BIND 10
      system configuration. It provides persistent storage for
      configuration, and notifies running BIND 10 modules of
      configuration changes.
    </para>

    <para>
      The <command>bindctl</command> can be used to talk to this
      configuration manager via a <command>b10-cmdctl</command> connection.
    </para>
     
<!-- TODO: briefly explain why both msqg channel and cmdctl communication -->
    <para>
      This daemon communicates over a <command>b10-msgq</command> C-Channel
      connection.  If this connection is not established,
      <command>b10-cfgmgr</command> will exit.
    </para>
<!-- TODO: will it exit?  -->

    <para>
      The daemon may be cleanly stopped by sending the SIGTERM
      signal to the process.  This shutdown does not notify the
      subscribers.
    </para>

    <para>
      When it exits, it saves its current configuration to
      <filename>/usr/local/var/bind10-devel/b10-config.db</filename>.
<!-- TODO: fix path -->
<!-- TODO: does it periodically save configuration? -->
    </para>

<!-- TODO: add a verbose or quiet switch so it is not so noisy -->
  </refsect1>

  <refsect1>
    <title>ARGUMENTS</title>

    <para>The arguments are as follows:</para>

    <variablelist>
      <varlistentry>
        <term>
          <option>-c</option><replaceable>config-filename</replaceable>,
          <option>--config-filename</option> <replaceable>config-filename</replaceable>
        </term>
        <listitem>
          <para>The configuration database filename to use. Can be either
          absolute or relative to data path.</para>
          <para>Defaults to b10-config.db</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-p</option><replaceable>data-path</replaceable>,
          <option>--data-path</option> <replaceable>data-path</replaceable>
        </term>
        <listitem>
          <para>The path where BIND 10 looks for files. The
          configuration file is looked for here, if it is relative. If it is
          absolute, the path is ignored.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>FILES</title>
<!-- TODO: fix path -->
    <para><filename>/usr/local/var/bind10-devel/b10-config.db</filename>
      &mdash; Configuration storage file.
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>msgq</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>.
    </para>
  </refsect1>

  <refsect1>
    <title>HISTORY</title>
    <para>
      The <command>b10-cfgmgr</command> daemon and configuration
      specification were initially designed by Jelte Jansen of ISC.
      Its development began in October 2009.
    </para>
  </refsect1>
</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->
