kea/src/bin/bind10/bind10.xml

<!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>July 29, 2010</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>bind10</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND10</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>bind10</refname>
    <refpurpose>BIND 10 boss process</refpurpose>
  </refnamediv>

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

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>bind10</command>    
      <arg><option>-a <replaceable>address</replaceable></option></arg>
      <arg><option>-m <replaceable>file</replaceable></option></arg>
      <arg><option>-n</option></arg>
      <arg><option>-p <replaceable>number</replaceable></option></arg>
      <arg><option>-u <replaceable>user</replaceable></option></arg>
      <arg><option>-v</option></arg>
      <arg><option>--address <replaceable>address</replaceable></option></arg>
      <arg><option>--msgq-socket-file <replaceable>file</replaceable></option></arg>
      <arg><option>--no-cache</option></arg>
      <arg><option>--port <replaceable>number</replaceable></option></arg>
      <arg><option>--user <replaceable>user</replaceable></option></arg>
      <arg><option>--pretty-name <replaceable>name</replaceable></option></arg>
      <arg><option>--verbose</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para>The <command>bind10</command> daemon starts up other
    BIND 10 required daemons.  It handles restarting of exiting
    programs and also the shutdown of all managed daemons.</para>

<!-- TODO: list what it starts here? -->

<!-- TODO
    <para>The configuration of the <command>bind10</command> daemon
    is defined in the TODO configuration file, as described in the
    <citerefentry><refentrytitle>TODO</refentrytitle><manvolnum>5</manvolnum></citerefentry>
    manual page.</para>
-->

  </refsect1>

  <refsect1>
    <title>ARGUMENTS</title>

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

    <variablelist>

      <varlistentry>
        <term><option>-a</option> <replaceable>address</replaceable>, <option>--address</option> <replaceable>address</replaceable></term>

        <listitem>
	  <para>The IPv4 or IPv6 address for the
	    <citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
            daemon to listen on.
            The default is to listen on all addresses. 
            (This is a short term workaround. This argument may change.)
          </para>
         </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-m</option> <replaceable>file</replaceable>,
           <option>--msgq-socket-file</option> <replaceable>file</replaceable></term>

        <listitem>
          <para>The UNIX domain socket file for the
	    <citerefentry><refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum></citerefentry>
            daemon to use.
            The default is
            <filename>/usr/local/var/bind10-devel/msg_socket</filename>.
<!-- @localstatedir@/@PACKAGE_NAME@/msg_socket -->
           </para>
         </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-n</option>, <option>--no-cache</option></term>
        <listitem>
	  <para>Disables the hot-spot caching used by the
	    <citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	  daemon.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-p</option> <replaceable>number</replaceable>, <option>--port</option> <replaceable>number</replaceable></term>

        <listitem>
          <para>The port number for the
	    <citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
            daemon to listen on.
            The default is 5300.</para>
<!-- TODO: -->
	    <note><simpara>The Y1 prototype release uses a non-default
	    port for domain service.</simpara></note>
         </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-u</option> <replaceable>user</replaceable>, <option>--user</option> <replaceable>name</replaceable></term>

        <listitem>
          <para>The username for <command>bind10</command> to run as.
<!-- TODO: example more detail. -->
            <command>bind10</command> must be initially ran as the
            root user to use this option.
            The default is to run as the current user.</para>
         </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--pretty-name <replaceable>name</replaceable></option></term>

        <listitem>
          <para>The name this process should have in tools like
          <command>ps</command> or <command>top</command>. This
          is handy if you have multiple versions/installations
          of <command>bind10</command>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-v</option>, <option>--verbose</option></term>
        <listitem>
	  <para>Display more about what is going on for
	  <command>bind10</command> and its child processes.</para>
<!-- TODO: not true about all children yet -->
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

<!--
  <refsect1>
    <title>FILES</title>
    <para><filename></filename>
    </para>
  </refsect1>
-->

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>bindctl</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-xfrin</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-xfrout</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citetitle>BIND 10 Guide</citetitle>.
    </para>
  </refsect1>

  <refsect1 id='history'><title>HISTORY</title>
    <para>The development of <command>bind10</command>
    was started in October 2009.</para>
  </refsect1>

  <refsect1>
    <title>AUTHORS</title>
    <para>
      The <command>bind10</command>
      daemon was initially designed by Shane Kerr of ISC.
    </para>
  </refsect1>
</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->