Browse Source

Add a TODO file for loading zones.
Add a manual page for b10-loadzone. (Actually in xml docbook format.
Later need to add make targets for this and add the nroff man result.)


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

Jeremy C. Reed 15 years ago
parent
commit
08379e2d25
2 changed files with 153 additions and 0 deletions
  1. 134 0
      src/bin/loadzone/b10-loadzone.xml
  2. 19 0
      src/lib/python/isc/auth/TODO

+ 134 - 0
src/bin/loadzone/b10-loadzone.xml

@@ -0,0 +1,134 @@
+<!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 8, 2010</date>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>b10-loadzone</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo>BIND10</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>b10-loadzone</refname>
+    <refpurpose>Load DNS Zone File</refpurpose>
+  </refnamediv>
+
+  <docinfo>
+    <copyright>
+      <year>2010</year>
+      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
+    </copyright>
+  </docinfo>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>b10-loadzone</command>
+      <arg><option>-d <replaceable class="parameter">database</replaceable></option></arg>
+      <arg><option>-o <replaceable class="parameter">origin</replaceable></option></arg>
+      <arg chose="req">filename</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para>The <command>b10-loadzone</command> utility
+      loads a RFC 1035 style DNS master zone file and stores it
+      in a BIND 10 ready data source format.
+      Master files are text files that contain DNS Resource Records
+      in text form.
+    </para>
+    <note><simpara>Currently only the SQLITE3 data source is supported.
+    </simpara></note>
+
+    <para>
+    Some control entries (aka directives) are supported.
+    $ORIGIN is followed by a domain name and is used to define the
+    relative domain name.
+    $INCLUDE is followed by a filename to load.
+<!-- TODO: and optionally a
+    domain name used to set the relative domain name origin. -->
+    The previous origin is restored after the file is included.
+<!-- the current domain name is also restored -->
+    $TTL is followed by a time-to-live value which is used
+    by following records that don't have their TTL set.
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>ARGUMENTS</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>-d <replaceable class="parameter">database</replaceable> </term>
+<listitem><para>
+  Defines the filename for the database.
+          The default is <filename>/tmp/zone.sqlite3</filename>.
+<!-- TODO: fix filename -->
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>-o <replaceable class="parameter">origin</replaceable></term>
+        <listitem><para>
+          Defines the default origin for the zone file records.
+        </para></listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>FILES</title>
+    <para><filename></filename>
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>AUTHORS</title>
+    <para>
+      The <command>b10-loadzone</command> tool was initial written
+      by Evan Hunt of ISC.
+    </para>
+  </refsect1>
+</refentry><!--
+ - Local variables:
+ - mode: sgml
+ - End:
+-->

+ 19 - 0
src/lib/python/isc/auth/TODO

@@ -0,0 +1,19 @@
+Support optional origin in $INCLUDE:
+$INCLUDE filename origin
+
+Support optional comment in $INCLUDE:
+$INCLUDE filename origin comment
+
+Support optional comment in $TTL (RFC 2308):
+$TTL number comment
+
+If ttl is not set on the record line but $TTL is set at top,
+it is not loaded. But running master.py manually does show the
+TTL to be same as the $TTL. When including the ttl on every line,
+it is loaded and can be served.
+
+Open questions to document in manual page:
+
+What happens in the database? replaces existing? What if a.foo
+existed but new zone file didn't have a.foo, would previous a.foo
+in database be removed?