Browse Source

reorder some more; move supported os and requirements into the intro section, not the installation section.

git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@1529 e5f2f494-b856-4b98-b285-d166d9295462
Michael Graff 15 years ago
parent
commit
b57191fa2d
2 changed files with 85 additions and 85 deletions
  1. 0 4
      doc/userguide/userguide.css
  2. 85 81
      doc/userguide/userguide.xml

+ 0 - 4
doc/userguide/userguide.css

@@ -28,7 +28,3 @@ body {
   -moz-border-radius: 10px;
   -webkit-border-radius: 10px;
 }
-
-.section {
-	padding-left: 1em;
-}

+ 85 - 81
doc/userguide/userguide.xml

@@ -41,24 +41,94 @@
         authoritative DNS server.
       </para>
     </note>
-    
-    <para>
-      BIND 10 is modular.  Part of this modularity is
-      accomplished using multiple cooperating processes which, together,
-      provide DNS functionality.  This is a change from the previous generation
-      of BIND software, which used a single process.
-    </para>
-    
-    <para>
-      At first, running many different processes may seem confusing.  However,
-      these processes are started, stopped, and maintained by a single command,
-      <command>bind10</command>.  Additionally, most processes started by
-      the <command>bind10</command> command have names starting with "b10-",
-      with one exception, <command>msgq</command>.
-    </para>
+
+  	<section>
+      <title>Supported Platforms</title>
+      <para>
+	BIND 10 builds have been tested on Debian GNU/Linux 5,
+	Ubuntu 9.10, NetBSD 5, Solaris 10, FreeBSD 7, and CentOS
+	Linux 5.3.
+
+	It has been tested on Sparc, i386, and amd64 hardware
+	platforms.
+
+        It is planned for BIND 10 to build, install and run on
+        Windows and standard Unix-type platforms.
+      </para>
+    </section>
+
+    <section>
+      <title>Required Software</title>
+      <para>
+        BIND 10 requires Python 3.1.  Later versions may work, but Python
+				3.1 is the minimum version which will work.
+      </para>
+
+      <para>
+        Building from source code requires the Boost
+        build-time headers. At least Boost version 1.34 is required.
+<!-- TODO: we don't check for this version -->
+<!-- NOTE: jreed has tested with 1.34, 1.38, and 1.41. -->
+      </para>
+
+      <para>
+	If the Boost System Library is detected at configure time,
+	BIND 10 will be built using an alternative method for
+	networking I/O using Boost ASIO support.  This provides
+	asynchrony support; with ASIO the Authoritative DNS server
+	can handle other queries while the processing of a TCP
+	transaction stalls.
+        This dependency is not required unless you need
+        <!-- TODO: want --> this feature as TCP transport support is
+        provided using alternative code.
+      </para>
+
+      <note><para>
+        For the Y1 prototype release, the only supported data source
+        backend is SQLite3. The authoritative server requires
+        SQLite 3.3.9 or newer,
+        and the <command>b10-xfrin</command> module requires the
+				Python _sqlite3.so module.
+      </para></note>
+<!-- TODO: this will change ... -->
+
+<!-- TODO: list where to get these from -->
+
+      <note>
+				<para>
+  	      Some operating systems do not provide these dependencies
+					in their default installation nor standard packages
+					collections.
+	        You may need to install them separately.
+      	</para>
+			</note>
+
+      <para>
+        Building BIND 10 also requires a C++ compiler and
+        standard development headers.
+        BIND 10 builds have been tested with GCC g++ 3.4.3, 4.1.2,
+        4.2.1, 4.3.2, and 4.4.1.
+      </para>
+
+    </section>
 
     <section id="starting_stopping">
       <title>Starting and Stopping the Server</title>
+
+	    <para>
+	      BIND 10 is modular.  Part of this modularity is
+	      accomplished using multiple cooperating processes which, together,
+	      provide DNS functionality.  This is a change from the previous generation
+	      of BIND software, which used a single process.
+	    </para>
+
+	    <para>
+	      At first, running many different processes may seem confusing.  However,
+	      these processes are started, stopped, and maintained by a single command,
+	      <command>bind10</command>.  Additionally, most processes started by
+	      the <command>bind10</command> command have names starting with "b10-",
+	      with one exception, <command>msgq</command>.
+	    </para>
       
       <para>
         Starting and stopping the server is performed by a single command,
@@ -172,72 +242,6 @@ var/
   <chapter id="installation">
     <title>Installation</title>
 
-    <section>
-      <title>Required Software</title>
-      <para>
-        BIND 10 requires Python 3.1.
-      </para>
-
-      <para>
-        Building from source code requires the Boost
-        build-time headers. At least Boost version 1.34 is required.
-<!-- TODO: we don't check for this version -->
-<!-- NOTE: jreed has tested with 1.34, 1.38, and 1.41. -->
-      </para>
-
-      <para>
-	If the Boost System Library is detected at configure time,
-	BIND 10 will be built using an alternative method for
-	networking I/O using Boost ASIO support.  This provides
-	asynchrony support; with ASIO the Authoritative DNS server
-	can handle other queries while the processing of a TCP
-	transaction stalls.
-        This dependency is not required unless you need
-        <!-- TODO: want --> this feature as TCP transport support is
-        provided using alternative code.
-      </para>
-
-      <note><para>
-        For the Y1 prototype release, the only supported data source
-        backend is SQLite3. The authoritative server requires
-        SQLite 3.3.9 or newer,
-        and the XFRin module requires the Python _sqlite3.so module.
-      </para></note>
-<!-- TODO: this will change ... -->
-
-<!-- TODO: list where to get these from -->
-
-      <note><para>
-        Some operating systems do not provide these dependencies
-	in their default installation nor standard packages
-	collections.
-        You may need to install them separately.
-      </para></note>
-
-      <para>
-        Building BIND 10 also requires a C++ compiler and
-        standard development headers.
-        BIND 10 builds have been tested with GCC g++ 3.4.3, 4.1.2,
-        4.2.1, 4.3.2, and 4.4.1.
-      </para>
-
-    </section>
-
-    <section>
-      <title>Supported Platforms</title>
-      <para>
-	BIND 10 builds have been tested on Debian GNU/Linux 5,
-	Ubuntu 9.10, NetBSD 5, Solaris 10, FreeBSD 7, and CentOS
-	Linux 5.3.
-
-	It has been tested on Sparc, i386, and amd64 hardware
-	platforms.
-
-        It is planned for BIND 10 to build, install and run on
-        Windows and standard Unix-type platforms.
-      </para>
-    </section>
-    
     <section id="quickstart">
       <title>Quick start</title>
       <para>