2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-02 15:05:16 +00:00

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
This commit is contained in:
Jeremy C. Reed
2010-03-19 12:44:07 +00:00
parent 23d5e5e2dc
commit d7802279b9
7 changed files with 26 additions and 26 deletions

View File

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

View File

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

View File

@@ -83,7 +83,7 @@
<para> <para>
When it exits, it saves its current configuration to 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: fix path -->
<!-- TODO: does it periodically save configuration? --> <!-- TODO: does it periodically save configuration? -->
</para> </para>
@@ -115,7 +115,7 @@
<refsect1> <refsect1>
<title>FILES</title> <title>FILES</title>
<!-- TODO: fix path --> <!-- 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. &mdash; Configuration storage file.
</para> </para>
</refsect1> </refsect1>

View File

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

View File

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

View File

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

View File

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