Docbook version of manual page added.

This is based on my nroff version but much cleanup and changes.
Most notable I removed some usage that needs to be put in the
other manual pages for the modules.
Also need to re-add some examples here.

I will be adding the examples and more detail to the users guide.

I will later commit the new generated nroff version (which is
already in svn).


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

src/bin/bindctl/bindctl.xml

@@ -0,0 +1,244 @@
+<!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>January 19, 2010</date>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>bindctl</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo>BIND10</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>bindctl</refname>
+    <refpurpose>control and configure BIND 10</refpurpose>
+  </refnamediv>
+
+  <docinfo>
+    <copyright>
+      <year>2010</year>
+      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
+    </copyright>
+  </docinfo>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>bindctl</command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para>
+      The <command>bindctl</command> tool is a user interface to
+      the BIND 10 services.  The program can be used to control
+      the components and configure the BIND 10 options.  The options
+      may be specified
+<!-- TODO: as command-line arguments, or --> via its
+      interactive command interpreter.
+    </para>
+
+    <para>
+      The <command>bindctl</command> prompt shows
+      <quote>&gt; </quote>.
+       The prompt will also display the location if changed.
+       The options are based on the module in use.
+       The usage is:
+       <command>module</command> <command>command</command> <replaceable>param1 = value1 , <replaceable>param2 = value2</replaceable></replaceable>
+     </para>
+
+     <para>
+       <command>bindctl</command>'s
+       interactive interface provides command-line completion and
+       hints.  Press the Tab key to get a hint for the module,
+       command, and/or parameters.
+<!-- TODO: no hints at a blank line though ? -->
+
+      The arrow keys and Emacs-style editing keys may be used to edit
+      and recall previous lines.
+<!-- TODO:  all Emacs-style editing keys? -->
+     </para>
+
+     <para>
+       You can use the <command>help</command>
+       keyword to receive usage assistance for a module or a module's
+       command.
+     </para>
+
+     <para>
+       The <command>quit</command>
+       command is used to exit
+       <command>bindctl</command>
+       (and doesn't stop the BIND 10 services).
+     </para>
+
+     <para>
+       The following module is available by default:
+       <command>config</command> for Configuration commands.
+<!-- TODO: or is config from the cfgmgr module? -->
+       Additional modules may be available, such as
+       <command>Boss</command>, <command>Xfrin</command>, and
+       <command>Auth</command>.
+     </para>
+
+<!--
+.Sh CONFIGURATION COMMANDS
+The following configuration commands are recognized by
+.Nm :
+.Bl -tag -width Ic
+.It Ic add Ar identifier Ar value
+Add a value to a list.
+.\" TODO: explain better
+.\" TODO: define list, map, others ...
+.\" TODO: why the value?
+.It Ic commit
+Commit all local changes.
+.\" TODO: what does this do?
+.It Ic go Ar identifier
+Go to the specified location within the configuration.
+.\" TODO: explain this
+.It Ic help
+Get help for the
+.Em config
+module.
+.It Ic remove Ar identifier Ar value
+Remove a value from a list.
+.\" TODO: why the value?
+.It Ic revert
+Revert all local changes (that have not been committed).
+.\" TODO: what does this do?
+.It Ic set Ar identifier Ar value
+Set a configuration value.
+.\" TODO
+.It Ic show Op Ar identifier.
+.\" TODO
+Show the currently set configuration values.
+If no
+.Ar identifier
+is given, the current location is used (as set by the
+.Ic go
+command).
+If a config option is a list or a map, the value is not
+shown directly, but must be requested separately.
+.\" TODO: example of this list or map
+.It Ic unset Ar identifier
+Remove a configuration value.
+If the option is mandatory, it will reset to the default value.
+.\" TODO: how to know default values before?
+.El
+.\" This manual page only covers builtin commands.
+.\" .Sh PARKINGLOT COMMANDS
+.\" .Bl -tag -width Ic
+.\" .It Ic help
+.\" Get help for the
+.\" .Em ParkingLot
+.\" module.
+.\" .It Ic print_message Ar string
+.\" Print the given message to stdout.
+.\" .El
+.\"
+.\" TODO: Command arguments which have embedded spaces may be quoted with
+.\" quote
+.\" .Sq \&"
+.\" marks.
+.Pp
+.Pp command-line editing?
+.Pp
+.Sh EXAMPLES
+The following are some
+.Nm
+examples:
+.Bl -tag -width abcde
+.It Ic "config help"
+Show the commands for the
+.Em config
+module.
+.It Ic "config go ParkingLot/"
+Go to the
+.Dq ParkingLot/
+configuration location.
+.It Ic "ParkingLot print_message help"
+Show the one-line description and parameter for the
+.Dq print_message
+command available from the external
+.Dq ParkingLot
+module.
+.\" TODO: why the trailing slash?
+-->
+
+  </refsect1>
+
+<!-- TODO: any options? -->
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <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-xfrin</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>msgq</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citetitle>BIND 10 User Guide</citetitle>.
+    </para>
+<!-- TODO: point to developer docs -->
+  </refsect1>
+
+  <refsect1>
+    <title>AUTHORS</title>
+    <para>
+      The <command>bindctl</command>
+      tool and library were initially coded by Zhang Likun of CNNIC
+      for the BIND 10 project.
+      The initial manual page was written by Jeremy C. Reed of ISC.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>HISTORY</title>
+    <para>
+       The initial version (with internal name of
+       <command>BigTool</command>)
+       was started in October 2009.
+    </para>
+  </refsect1>
+
+</refentry><!--
+ - Local variables:
+ - mode: sgml
+ - End:
+-->
+