kea/src/bin/sockcreator/kea-sockcreator.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) 2012-2016 Internet Systems Consortium, Inc. ("ISC")
 -
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->

<refentry>

  <refentryinfo>
    <productname>ISC Kea</productname>
    <date>Oct. 27, 2017</date>
    <edition>1.3.0</edition>
    <author>
      <contrib>The Kea software has been written by a number of
        engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
        Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed,
        Wlodek Wencel and Shawn Routhier.  That list is roughly in the
        chronological order in which the authors made their first
        contribution. For a complete list of authors and
        contributors, see AUTHORS file.</contrib>
      <orgname>Internet Systems Consortium, Inc.</orgname>
    </author>
  </refentryinfo>

  <refmeta>
    <refentrytitle>kea-sockcreator</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>Kea</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>kea-sockcreator</refname>
    <refpurpose>socket creation daemon</refpurpose>
  </refnamediv>

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

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>kea-sockcreator</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      The <command>kea-sockcreator</command> daemon's entire job
      is to create sockets and assign names to them.
    </para>

<!-- TODO: integrate README here -->

    <para>
      The <command>kea-sockcreator</command> daemon will exit
      if there is an unrecoverable error or unknown command.
    </para>

  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citetitle>Kea Guide</citetitle>.
    </para>
<!-- TODO: point to developer docs -->
  </refsect1>

  <refsect1>
    <title>HISTORY</title>
    <para>
      The <command>b10-sockcreator</command> daemon
      was initially designed by Michal Vaner of CZNIC.
    </para>
    <para>
      Kea became a standalone server and the BIND10 framework was
      removed. The socket creator server binary was renamed to
      kea-sockcreator in July 2014.
    </para>
  </refsect1>

</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->