[svn] commit: r1469 - in /trunk/doc/userguide: STYLEGUIDE userguide.xml
BIND 10 source code commits
bind10-changes at lists.isc.org
Wed Mar 17 00:01:48 UTC 2010
Author: jreed
Date: Wed Mar 17 00:01:48 2010
New Revision: 1469
Log:
More content and cleanup in user guide.
Typo fix in STYLEGUIDE.
Modified:
trunk/doc/userguide/STYLEGUIDE
trunk/doc/userguide/userguide.xml
Modified: trunk/doc/userguide/STYLEGUIDE
==============================================================================
--- trunk/doc/userguide/STYLEGUIDE (original)
+++ trunk/doc/userguide/STYLEGUIDE Wed Mar 17 00:01:48 2010
@@ -2,6 +2,6 @@
and editing the BIND 10 users guide.
Use alphabetical order for options and configuration syntax
-sorting unless you have a specific reason no too.
+sorting unless you have a specific reason not to.
TODO: list the docbook tags to be used for specific things here
Modified: trunk/doc/userguide/userguide.xml
==============================================================================
--- trunk/doc/userguide/userguide.xml (original)
+++ trunk/doc/userguide/userguide.xml Wed Mar 17 00:01:48 2010
@@ -29,6 +29,9 @@
DNS server. It does provide a EDNS0- and DNSSEC-capable
authoritative DNS server.</para></note>
+ <note><para>This guide covers the experimental prototype version
+ of BIND 10.</para></note>
+
<para>
BIND 10 provides separate executables for different tasks.
The standard components include:
@@ -36,7 +39,7 @@
<itemizedlist>
<listitem>
- <simpara><command>msgq</command> — message bus</simpara>
+ <simpara><command>msgq</command> — message bus daemon</simpara>
</listitem>
<listitem>
<simpara><command>b10-auth</command> — authoritative DNS server</simpara>
@@ -45,13 +48,16 @@
<simpara><command>b10-cfgmgr</command> — configuration manager</simpara>
</listitem>
<listitem>
- <simpara><command>b10-cmdctl</command> <!-- TODO --></simpara>
- </listitem>
-
- <listitem>
- <simpara><command>b10-xfrin</command> <!-- TODO --></simpara>
- </listitem>
-
+ <simpara><command>b10-cmdctl</command> REST-ful communication service</simpara>
+ </listitem>
+
+ <listitem>
+ <simpara><command>b10-xfrin</command> Incoming zone transfer service</simpara>
+ </listitem>
+
+ <listitem>
+ <simpara><command>bind10</command> — master process for BIND 10</simpara>
+ </listitem>
</itemizedlist>
</para>
@@ -63,8 +69,9 @@
<simpara><command>bindctl</command> — interactive administration interface</simpara>
</listitem>
<listitem>
- <simpara><command>bind10</command> — master process for BIND 10</simpara>
- </listitem>
+ <simpara><command>b10-loadzone</command> — tool to load standard master zone files</simpara>
+ </listitem>
+<!-- TODO usermgr -->
</itemizedlist>
</para>
@@ -107,13 +114,82 @@
</chapter>
<chapter id="quickstart">
- <title>Quickstart</title>
- <para>
- This chapter just covers the standard steps for installing
+ <title>Quick start</title>
+ <para>
+ This quickly covers the standard steps for installing
and deploying BIND 10 as an authoritative nameserver using
- its defaults. For full customizations and details, see
- the respective chapters.
- </para>
+ its defaults. For troubleshooting, full customizations and further
+ details, see the respective chapters in the BIND 10 user guide.
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <simpara>Install required dependencies: Python 3.1, SQLite3
+ library, and Boost development headers.</simpara>
+ </listitem>
+
+ <listitem>
+ <simpara>Download the BIND 10 source tarball. <!-- TODO: from -->
+ </simpara>
+ </listitem>
+
+ <listitem>
+ <para>Extract the tar file:
+ <screen>$ <userinput>gzcat bind10-<replaceable>VERSION</replaceable>.tar.gz | tar -xvf -</userinput></screen>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Go into the source and run configure:
+ <screen>$ <userinput>cd bind10-<replaceable>VERSION</replaceable></userinput>
+$ <userinput>./configure</userinput></screen>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Build it:
+ <screen>$ <userinput>make</userinput></screen>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Install it (to default /usr/local):
+ <screen>$ <userinput>make install</userinput></screen>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Start the server:
+ <screen>$ <userinput>/usr/local/sbin/bind10</userinput></screen>
+ </para>
+ </listitem>
+
+ <listitem>
+
+ <note><simpara>The Y1 prototype of the b10-auth server listens on
+ 0.0.0.0 (all interfaces) port 5300. (This is not the standard
+ domain service port.)</simpara></note>
+
+ <para>Test it; for example:
+ <screen>$ <userinput>dig @127.0.0.1 -p 5300 -c CH -t TXT authors.bind</userinput></screen>
+ </para>
+
+ </listitem>
+
+ <listitem>
+ <para>Load desired zone file(s), for example:
+ <screen>$ <userinput>b10-loadzone <replaceable>your.zone.example.org</replaceable></userinput></screen>
+ </para>
+ </listitem>
+
+ <listitem>
+ <simpara>Test the new zone.
+ </simpara>
+ </listitem>
+
+ </itemizedlist>
+
</chapter>
<chapter id="install">
@@ -383,6 +459,8 @@
do config show, and it shows all modules; config show >module> shows all
options for that module
+(12:21:30) jinmei: I'd like to have sample session using a command line www client such as wget
+(12:21:33) jinmei: btw
-->
<para>
@@ -431,3 +509,20 @@
</book>
+<!--
+
+TODO:
+
+Overview
+
+Getting BIND 10 Installed
+ Basics
+ Dependencies
+ Optional
+ Advanced
+
+How Does Everything Work Together?
+
+Need Help?
+
+-->
More information about the bind10-changes
mailing list