Start of manual page about b10-cfgmgr.

git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@1300 e5f2f494-b856-4b98-b285-d166d9295462

src/bin/cfgmgr/b10-cfgmgr.xml

@@ -0,0 +1,147 @@
+<!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.
+-->
+
+<!-- $Id$ -->
+<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></command>
+      <arg><option></option></arg>
+      <arg choice="opt"></arg>
+      <arg choice="opt"></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>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
+      /var/bind10/b10-config.db
+<!-- TODO: fix path -->
+<!-- TODO: does it periodically save configuration? -->
+    </para>
+
+    <para>
+      The daemon has no command line options.  It ignores any arguments.
+<!-- TODO: add a verbose or quiet switch so it is not so noisy -->
+    </para>
+  </refsect1>
+
+<!--
+  <refsect1>
+    <title>ARGUMENTS</title>
+    <para>
+      <orderedlist numeration="loweralpha">
+        <listitem>
+          <para>
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+          </para>
+        </listitem>
+      </orderedlist>
+    </para>
+
+  </refsect1>
+-->
+  <refsect1>
+    <title>FILES</title>
+<!-- TODO: fix path -->
+    <para><filename>/var/bind10/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:
+-->