Browse Source

Update some docs to have correct bind10-devel path.
TODO: use a stylesheet ENTITY to define these.
Regen few manual pages to roff format.


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

Jeremy C. Reed 15 years ago
parent
commit
d7802279b9

+ 13 - 14
doc/guide/bind10-guide.xml

@@ -556,10 +556,9 @@ var/
             </listitem>
             <listitem>
             <simpara>
-              <filename>etc/bind10/</filename> &mdash;
+              <filename>etc/bind10-devel/</filename> &mdash;
               configuration files.
             </simpara>
-      <!-- TODO: create the etc/bind10/ directory? -->
             </listitem>
             <listitem>
               <simpara>
@@ -569,7 +568,7 @@ var/
             </listitem>
             <listitem>
               <simpara>
-                <filename>libexec/bind10/</filename> &mdash;
+                <filename>libexec/bind10-devel/</filename> &mdash;
                 executables that a user wouldn't normally run directly and
                 are not run independently.
                 These are the BIND 10 modules which are daemons started by
@@ -584,7 +583,7 @@ var/
             </listitem>
             <listitem>
               <simpara>
-                <filename>share/bind10/</filename> &mdash;
+                <filename>share/bind10-devel/</filename> &mdash;
                 configuration specifications.
               </simpara>
             </listitem>
@@ -596,7 +595,7 @@ var/
             </listitem>
             <listitem>
               <simpara>
-                <filename>var/bind10/</filename> &mdash;
+                <filename>var/bind10-devel/</filename> &mdash;
                 data source and configuration databases.
               </simpara>
             </listitem>
@@ -751,7 +750,7 @@ config changes are actually commands to cfgmgr
 <!-- TODO: what about command line switch to change this? -->
       <para>
         The stored configuration file is at
-        <filename>/usr/local/var/bind10/b10-config.db</filename>.
+        <filename>/usr/local/var/bind10-devel/b10-config.db</filename>.
         (The full path is what was defined at build configure time for
         <option>--localstatedir</option>.
         The default is <filename>/usr/local/var/</filename>.)
@@ -844,13 +843,13 @@ but you might wanna check with likun
     <para>The HTTPS server requires a private key,
       such as a RSA PRIVATE KEY.
       The default location is at
-      <filename>/usr/local/etc/bind10/cmdctl-keyfile.pem</filename>.
+      <filename>/usr/local/etc/bind10-devel/cmdctl-keyfile.pem</filename>.
       (A sample key is at
-      <filename>/usr/local/share/bind10/cmdctl-keyfile.pem</filename>.)
+      <filename>/usr/local/share/bind10-devel/cmdctl-keyfile.pem</filename>.)
       It also uses a certificate located at
-      <filename>/usr/local/etc/bind10/cmdctl-certfile.pem</filename>.
+      <filename>/usr/local/etc/bind10-devel/cmdctl-certfile.pem</filename>.
       (A sample certificate is at
-      <filename>/usr/local/share/bind10/cmdctl-certfile.pem</filename>.)
+      <filename>/usr/local/share/bind10-devel/cmdctl-certfile.pem</filename>.)
       This may be a self-signed certificate or purchased from a
       certification authority.
     </para>
@@ -886,11 +885,11 @@ but that is a single file, maybethis should go back to that format?
     <para>
       The <command>b10-cmdctl</command> daemon also requires
       the user account file located at
-      <filename>/usr/local/etc/bind10/cmdctl-accounts.csv</filename>.
+      <filename>/usr/local/etc/bind10-devel/cmdctl-accounts.csv</filename>.
       This comma-delimited file lists the accounts with a user name,
       hashed password, and salt.
       (A sample file is at
-      <filename>/usr/local/share/bind10/cmdctl-accounts.csv</filename>.
+      <filename>/usr/local/share/bind10-devel/cmdctl-accounts.csv</filename>.
       It contains the user named <quote>root</quote> with the password
       <quote>bind10</quote>.)
     </para>
@@ -1059,7 +1058,7 @@ This may be a temporary setting until then.
 
       <para>
         By default, the SQLite3 backend uses the data file located at
-        <filename>/usr/local/var/bind10/zone.sqlite3</filename>.
+        <filename>/usr/local/var/bind10-devel/zone.sqlite3</filename>.
         (The full path is what was defined at build configure time for
         <option>--localstatedir</option>.
         The default is <filename>/usr/local/var/</filename>.)
@@ -1122,7 +1121,7 @@ This may be a temporary setting until then.
       <para>
         In the Y1 prototype release, only the SQLite3 back end is used.
         By default, it stores the zone data in
-        <filename>/usr/local/var/bind10/zone.sqlite3</filename>
+        <filename>/usr/local/var/bind10-devel/zone.sqlite3</filename>
         unless the <option>-d</option> switch is used to set the
         database filename.
         Multiple zones are stored in a single SQLite3 zone database.

+ 3 - 2
src/bin/cfgmgr/b10-cfgmgr.8

@@ -40,13 +40,14 @@ will exit\&.
 .PP
 The daemon may be cleanly stopped by sending the SIGTERM signal to the process\&. This shutdown does not notify the subscribers\&.
 .PP
-When it exits, it saves its current configuration to /var/bind10/b10\-config\&.db
+When it exits, it saves its current configuration to
+/usr/local/var/bind10\-devel/b10\-config\&.db\&.
 
 .PP
 The daemon has no command line options\&. It ignores any arguments\&.
 .SH "FILES"
 .PP
-/var/bind10/b10\-config\&.db
+/usr/local/var/bind10\-devel/b10\-config\&.db
 \(em Configuration storage file\&.
 .SH "SEE ALSO"
 .PP

+ 2 - 2
src/bin/cfgmgr/b10-cfgmgr.xml

@@ -83,7 +83,7 @@
 
     <para>
       When it exits, it saves its current configuration to
-      /var/bind10/b10-config.db
+      <filename>/usr/local/var/bind10-devel/b10-config.db</filename>.
 <!-- TODO: fix path -->
 <!-- TODO: does it periodically save configuration? -->
     </para>
@@ -115,7 +115,7 @@
   <refsect1>
     <title>FILES</title>
 <!-- TODO: fix path -->
-    <para><filename>/var/bind10/b10-config.db</filename>
+    <para><filename>/usr/local/var/bind10-devel/b10-config.db</filename>
       &mdash; Configuration storage file.
     </para>
   </refsect1>

+ 3 - 3
src/bin/cmdctl/b10-cmdctl.8

@@ -72,13 +72,13 @@ Display the version number and exit\&.
 .RE
 .SH "FILES"
 .PP
-/usr/local/etc/bind10/cmdctl\-accounts\&.csv
+/usr/local/etc/bind10\-devel/cmdctl\-accounts\&.csv
 \(em account database containing the name, hashed password, and the salt\&.
 .PP
-/usr/local/etc/bind10/cmdctl\-keyfile\&.pem
+/usr/local/etc/bind10\-devel/cmdctl\-keyfile\&.pem
 \(em contains the Private key\&.
 .PP
-/usr/local/etc/bind10/cmdctl\-certfile\&.pem
+/usr/local/etc/bind10\-devel/cmdctl\-certfile\&.pem
 \(em contains the Certificate\&.
 .SH "SEE ALSO"
 .PP

+ 3 - 3
src/bin/cmdctl/b10-cmdctl.xml

@@ -144,17 +144,17 @@
 <!-- TODO: permissions -->
 <!-- TODO: what about multiple accounts? -->
 <!-- TODO: shouldn't the password file name say cmdctl in it? -->
-    <para><filename>/usr/local/etc/bind10/cmdctl-accounts.csv</filename>
+    <para><filename>/usr/local/etc/bind10-devel/cmdctl-accounts.csv</filename>
       &mdash; account database containing the name, hashed password,
       and the salt.
     </para>
 <!-- TODO: replace /usr/local -->
 <!-- TODO: permissions -->
 <!-- TODO: shouldn't have both in same file, will be configurable -->
-    <para><filename>/usr/local/etc/bind10/cmdctl-keyfile.pem</filename>
+    <para><filename>/usr/local/etc/bind10-devel/cmdctl-keyfile.pem</filename>
       &mdash; contains the Private key.
     </para>
-    <para><filename>/usr/local/etc/bind10/cmdctl-certfile.pem</filename>
+    <para><filename>/usr/local/etc/bind10-devel/cmdctl-certfile.pem</filename>
       &mdash; contains the Certificate.
     </para>
   </refsect1>

+ 1 - 1
src/bin/loadzone/b10-loadzone.8

@@ -55,7 +55,7 @@ When re\-loading an existing zone, the prior version is completely removed\&. Wh
 \-d \fIdatabase\fR
 .RS 4
 Defines the filename for the database\&. The default is
-/usr/local/var/bind10/zone\&.sqlite3\&.
+/usr/local/var/bind10\-devel/zone\&.sqlite3\&.
 .RE
 .PP
 \-o \fIorigin\fR

+ 1 - 1
src/bin/loadzone/b10-loadzone.xml

@@ -95,7 +95,7 @@
         <listitem><para>
           Defines the filename for the database.
 	  The default is
-	  <filename>/usr/local/var/bind10/zone.sqlite3</filename>.
+	  <filename>/usr/local/var/bind10-devel/zone.sqlite3</filename>.
 <!-- TODO: fix filename -->
         </para></listitem>
       </varlistentry>