ComputerSurge/bind9
3
0
Fork 0
Code Pull Requests 1 Activity

add support for building sphinx documentation

Browse Source
This commit is contained in:
Evan Hunt
2020-05-13 15:10:20 -07:00
committed by Ondřej Surý
parent 330c9b32ba
commit b580eb2fb3
70 changed files with 1105 additions and 834 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Makefile.in
View File

@@ -15,7 +15,7 @@ srcdir = @srcdir@
VPATH = @srcdir@
top_srcdir = @top_srcdir@
SUBDIRS = arm misc xsl doxygen tex
SUBDIRS = man arm misc doxygen
TARGETS =
@BIND9_MAKE_RULES@

5
doc/arm/.gitignore vendored
View File

@@ -1 +1,6 @@
/_build/
/man/*.1
/man/*.5
/man/*.8
/Bv9ARM.pdf
/notes.pdf

109
doc/arm/Makefile.in
View File

@@ -10,68 +10,79 @@
srcdir = @srcdir@
VPATH = @srcdir@
top_srcdir = @top_srcdir@
abs_srcdir = @abs_srcdir@
builddir = @builddir@
top_builddir = @top_builddir@
@BIND9_MAKE_RULES@
MANOBJS = Bv9ARM.html notes.html
MKDIR_P=@MKDIR_P@
TXTOBJS = notes.txt
BIND9_VERSION=@BIND9_VERSION@
RELEASE_DATE=@RELEASE_DATE@
BIND9_VERSIONSTRING=@BIND9_VERSIONSTRING@
PDFOBJS = Bv9ARM.pdf notes.pdf
# You can set these variables from the command line.
SPHINXBUILD = @SPHINX_BUILD@
SPHINXBUILDDIR = ${builddir}/_build
NOTESXML = notes-download.xml notes-eol.xml notes-intro.xml notes-license.xml \
notes-numbering.xml notes-platforms.xml notes-thankyou.xml \
notes-9.16.0.xml notes-9.16.1.xml notes-9.16.2.xml notes-9.16.3.xml \
notes-9.16.4.xml notes.xml
common_SPHINXOPTS = \
-a \
-v \
-c "${abs_srcdir}"
doc man:: ${MANOBJS} ${TXTOBJS} ${PDFOBJS}
ALLSPHINXOPTS = \
$(common_SPHINXOPTS) \
-D version="${BIND9_VERSION}" \
-D today="${RELEASE_DATE}" \
-D release="${BIND9_VERSIONSTRING}" \
$(SPHINXOPTS) \
${srcdir}
clean::
rm -f Bv9ARM.aux Bv9ARM.brf Bv9ARM.glo Bv9ARM.idx Bv9ARM.toc
rm -f Bv9ARM.log Bv9ARM.out
rm -f notes.aux notes.brf notes.glo notes.idx notes.toc
rm -f notes.log notes.out
man_SPHINXOPTS = \
$(common_SPHINXOPTS) \
-D version="@""BIND9_VERSION""@" \
-D today="@""RELEASE_DATE""@" \
-D release="@""BIND9_VERSIONSTRING""@" \
$(SPHINXOPTS) \
${srcdir}
docclean manclean maintainer-clean:: clean
rm -f *.html ${PDFOBJS}
# Put it first so that "make" without argument just builds manpages
all: man
@:
maintainer-clean distclean::
rm -f releaseinfo.xml
rm -f pkgversion.xml
rm -f noteversion.xml
man:: $(man1_MANS) $(man5_MANS) $(man8_MANS) @PKCS11_MANS@
# use xmllint to process include
notes.html: notes-wrapper.xml ${NOTESXML} releaseinfo.xml pkgversion.xml noteversion.xml
expand notes-wrapper.xml | ${XMLLINT} --xinclude - | \
${XSLTPROC} --stringparam generate.toc "" ../xsl/isc-notes-html.xsl - > notes.html
doc:: @HTMLTARGET@ @PDFTARGET@
notes.pdf: notes-wrapper.xml ${NOTESXML} releaseinfo.xml pkgversion.xml noteversion.xml
${XSLTPROC} ${top_srcdir}/doc/xsl/pre-latex.xsl notes-wrapper.xml | \
${DBLATEX} -c notes.conf -Pdoc.layout="mainmatter" -o notes.pdf -
html dirhtml:
$(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) "$(SPHINXBUILDDIR)"/$@
# Produce notes.txt from notes.html using w3m, with some post-processing:
#
# - remove trailing spaces from every line,
# - remove empty lines from the end of the document,
# - prevent GitLab issue/MR identifiers from being split across two lines.
notes.txt: notes.html
${W3M} -dump -cols 75 -O ascii -T text/html < notes.html | \
sed 's/ *$$//' | \
sed -e :a -e '/^\n*$$/{$$d;N;};/\n$$/ba' | \
sed '/ [!#]$$/{N;s| \([!#]\)\(\n[[:space:]]*\)\([0-9][0-9]*\)|\2\1\3|;};' > notes.txt
pdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) "$(SPHINXBUILDDIR)"/latex
make -C "$(SPHINXBUILDDIR)"/latex
cp "$(SPHINXBUILDDIR)"/latex/Bv9ARM.pdf "${builddir}"
cp "$(SPHINXBUILDDIR)"/latex/notes.pdf "${builddir}"
# use xmllint to process include
Bv9ARM.html: Bv9ARM-book.xml ${NOTESXML} releaseinfo.xml pkgversion.xml noteversion.xml
expand Bv9ARM-book.xml | ${XMLLINT} --xinclude - | \
${XSLTPROC} --stringparam root.filename Bv9ARM \
${top_srcdir}/doc/xsl/isc-docbook-chunk.xsl -
.PHONY: help Makefile doc pdf man
# use xmllint to process include
Bv9ARM-all.html: Bv9ARM-book.xml ${NOTESXML} releaseinfo.xml pkgversion.xml noteversion.xml
expand Bv9ARM-book.xml | ${XMLLINT} --xinclude - |\
${XSLTPROC} -o Bv9ARM-all.html ../xsl/isc-docbook-html.xsl -
installdirs:
$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man1
$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man5
$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8
Bv9ARM.pdf: Bv9ARM-book.xml ${NOTESXML} releaseinfo.xml pkgversion.xml noteversion.xml
expand Bv9ARM-book.xml | \
${XSLTPROC} ${top_srcdir}/doc/xsl/pre-latex.xsl - | \
${DBLATEX} -c Bv9ARM.conf -o Bv9ARM.pdf -
install:: installdirs
for m in $(man1_MANPAGES); do ${INSTALL_DATA} $$m ${DESTDIR}${mandir}/man1/; done
for m in $(man5_MANPAGES); do ${INSTALL_DATA} $$m ${DESTDIR}${mandir}/man5/; done
for m in $(man8_MANPAGES); do ${INSTALL_DATA} $$m ${DESTDIR}${mandir}/man8/; done
for m in @PKCS11_MANS@; do ${INSTALL_DATA} $$m ${DESTDIR}${mandir}/man8/; done
uninstall::
for m in $(man1_MANPAGES); do rm -f ${DESTDIR}${mandir}/man1/$$m; done
for m in $(man5_MANPAGES); do rm -f ${DESTDIR}${mandir}/man5/$$m; done
for m in $(man8_MANPAGES); do rm -f ${DESTDIR}${mandir}/man8/$$m; done
for m in @PKCS11_MANS@; do rm -f ${DESTDIR}${mandir}/man8/$$m; done
clean docclean manclean maintainer-clean::
rm -rf $(SPHINXBUILDDIR)
rm -f notes.pdf Bv9ARM.pdf

24
doc/arm/notes-eol.xml
View File

@@ -1,24 +0,0 @@
<!--
- Copyright (C) Internet Systems Consortium, Inc. ("ISC")
-
- This Source Code Form is subject to the terms of the Mozilla Public
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
- See the COPYRIGHT file distributed with this work for additional
- information regarding copyright ownership.
-->
<section xml:id="end_of_life"><info><title>End of Life</title></info>
<para>
The end of life date for BIND 9.16 has not yet been determined.
At some point in the future BIND 9.16 will be designated as an
Extended Support Version (ESV). Until then, the current ESV is
BIND 9.11, which will be supported until at least December 2021.
</para>
<para>
See
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://kb.isc.org/docs/aa-00896">https://kb.isc.org/docs/aa-00896</link>
for details of ISC's software support policy.
</para>
</section>

22
doc/arm/notes-intro.xml
View File

@@ -1,22 +0,0 @@
<!--
- Copyright (C) Internet Systems Consortium, Inc. ("ISC")
-
- This Source Code Form is subject to the terms of the Mozilla Public
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
- See the COPYRIGHT file distributed with this work for additional
- information regarding copyright ownership.
-->
<section xml:id="relnotes_intro"><info><title>Introduction</title></info>
<para>
BIND 9.16 is a stable branch of BIND.
This document summarizes significant changes since the last
production release on that branch.
</para>
<para>
Please see the file <filename>CHANGES</filename> for a more
detailed list of changes and bug fixes.
</para>
</section>

20
doc/arm/notes-numbering.xml
View File

@@ -1,20 +0,0 @@
<!--
- Copyright (C) Internet Systems Consortium, Inc. ("ISC")
-
- This Source Code Form is subject to the terms of the Mozilla Public
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
- See the COPYRIGHT file distributed with this work for additional
- information regarding copyright ownership.
-->
<section xml:id="relnotes_versions"><info><title>Note on Version Numbering</title></info>
<para>
As of BIND 9.13/9.14, BIND has adopted the "odd-unstable/even-stable"
release numbering convention. BIND 9.16 contains new features added
during the BIND 9.15 development process. Henceforth, the 9.16 branch
will be limited to bug fixes and new feature development will proceed
in the unstable 9.17 branch.
</para>
</section>

247
doc/man/Makefile.in Normal file
View File

@@ -0,0 +1,247 @@
# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# See the COPYRIGHT file distributed with this work for additional
# information regarding copyright ownership.
srcdir = @srcdir@
VPATH = @srcdir@
top_srcdir = @top_srcdir@
abs_srcdir = @abs_srcdir@
builddir = @builddir@
top_builddir = @top_builddir@
@BIND9_MAKE_RULES@
man1_MANS = \
arpaname.1 \
delv.1 \
dig.1 \
dnstap-read.1 \
host.1 \
mdig.1 \
named-rrchecker.1 \
nslookup.1 \
nsupdate.1
man5_MANS = \
named.conf.5 \
rndc.conf.5
man8_MANS = \
ddns-confgen.8 \
dnssec-cds.8 \
dnssec-checkds.8 \
dnssec-coverage.8 \
dnssec-dsfromkey.8 \
dnssec-importkey.8 \
dnssec-keyfromlabel.8 \
dnssec-keygen.8 \
dnssec-keymgr.8 \
dnssec-revoke.8 \
dnssec-settime.8 \
dnssec-signzone.8 \
dnssec-verify.8 \
filter-aaaa.8 \
named-checkconf.8 \
named-checkzone.8 \
named-journalprint.8 \
named-nzd2nzf.8 \
named.8 \
nsec3hash.8 \
rndc-confgen.8 \
rndc.8
MANPAGES_RST = \
arpaname.rst \
ddns-confgen.rst \
delv.rst \
dig.rst \
dnssec-cds.rst \
dnssec-checkds.rst \
dnssec-coverage.rst \
dnssec-dsfromkey.rst \
dnssec-importkey.rst \
dnssec-keyfromlabel.rst \
dnssec-keygen.rst \
dnssec-keymgr.rst \
dnssec-revoke.rst \
dnssec-settime.rst \
dnssec-signzone.rst \
dnssec-verify.rst \
dnstap-read.rst \
filter-aaaa.rst \
host.rst \
mdig.rst \
named-checkconf.rst \
named-checkzone.rst \
named-journalprint.rst \
named-nzd2nzf.rst \
named-rrchecker.rst \
named.conf.rst \
named.rst \
nsec3hash.rst \
nslookup.rst \
nsupdate.rst \
rndc-confgen.rst \
rndc.conf.rst \
rndc.rst \
pkcs11-destroy.rst \
pkcs11-keygen.rst \
pkcs11-list.rst \
pkcs11-tokens.rst
MANPAGES_IN = \
arpaname.1in \
ddns-confgen.8in \
delv.1in \
dig.1in \
dnssec-cds.8in \
dnssec-checkds.8in \
dnssec-coverage.8in \
dnssec-dsfromkey.8in \
dnssec-importkey.8in \
dnssec-keyfromlabel.8in \
dnssec-keygen.8in \
dnssec-keymgr.8in \
dnssec-revoke.8in \
dnssec-settime.8in \
dnssec-signzone.8in \
dnssec-verify.8in \
dnstap-read.1in \
filter-aaaa.8in \
host.1in \
mdig.1in \
named-checkconf.8in \
named-checkzone.8in \
named-journalprint.8in \
named-nzd2nzf.8in \
named-rrchecker.1in \
named.conf.5in \
named.8in \
nsec3hash.8in \
nslookup.1in \
nsupdate.1in \
rndc-confgen.8in \
rndc.conf.5in \
rndc.8in \
pkcs11-destroy.8in \
pkcs11-keygen.8in \
pkcs11-list.8in \
pkcs11-tokens.8in
pkcs11_man8_MANS = \
pkcs11-destroy.8 \
pkcs11-keygen.8 \
pkcs11-list.8 \
pkcs11-tokens.8
BIND9_VERSION=@BIND9_VERSION@
RELEASE_DATE=@RELEASE_DATE@
BIND9_VERSIONSTRING=@BIND9_VERSIONSTRING@
# You can set these variables from the command line.
SPHINXBUILD = @SPHINX_BUILD@
SPHINXBUILDDIR = ${builddir}/_build
common_SPHINXOPTS = \
-a \
-v \
-c "${abs_srcdir}"
ALLSPHINXOPTS = \
$(common_SPHINXOPTS) \
-D version="${BIND9_VERSION}" \
-D today="${RELEASE_DATE}" \
-D release="${BIND9_VERSIONSTRING}" \
$(SPHINXOPTS) \
${srcdir}
man_SPHINXOPTS = \
$(common_SPHINXOPTS) \
-D version="@""BIND9_VERSION""@" \
-D today="@""RELEASE_DATE""@" \
-D release="@""BIND9_VERSIONSTRING""@" \
$(SPHINXOPTS) \
${srcdir}
# Put it first so that "make" without argument just builds manpages
all: man
@:
man:: ootsetup $(man1_MANS) $(man5_MANS) $(man8_MANS) @PKCS11_MANS@
doc:: @HTMLTARGET@ @PDFTARGET@
html dirhtml:
$(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) "$(SPHINXBUILDDIR)"/$@
# copy in out-of-tree files in case sphinx-build isn't available
.NOTPARALLEL:
ootsetup:
for man in $(MANPAGES_IN); do \
[ -e "$$man" ] || cp -f ${srcdir}/"$$man" .; \
done
$(MANPAGES_IN): $(MANPAGES_RST)
$(SPHINXBUILD) -b man $(man_SPHINXOPTS) "$(SPHINXBUILDDIR)"/man
-for man in $(MANPAGES_IN); do \
[ -e "$(SPHINXBUILDDIR)"/man/"$$(basename $$man in)" ] && \
cp -f "$(SPHINXBUILDDIR)"/man/"$$(basename $$man in)" "$$man"; \
done
man_SUBST = sed \
-e 's,[@]BIND9_VERSION[@],$(BIND9_VERSION),' \
-e 's,[@]RELEASE_DATE[@],$(RELEASE_DATE),' \
-e 's,[@]BIND9_VERSION_STRING[@],$(BIND9_VERSION_STRING),' \
-e 's,[@]sysconfdir[@],$(sysconfdir),' \
-e 's,[@]plugindir[@],$(plugindir),'
$(man1_MANS): @MANSRCS@
for m in $(man1_MANS); do \
$(man_SUBST) $${m}in > $$m; \
done
$(man5_MANS): @MANSRCS@
for m in $(man5_MANS); do \
$(man_SUBST) $${m}in > $$m; \
done
$(man8_MANS): @MANSRCS@
for m in $(man8_MANS); do \
$(man_SUBST) $${m}in > $$m; \
done
$(pkcs11_man8_MANS): @MANSRCS@
for m in $(pkcs11_man8_MANS); do \
$(man_SUBST) $${m}in > $$m; \
done
.PHONY: help Makefile doc pdf man
installdirs:
$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man1
$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man5
$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8
install:: installdirs
for m in $(man1_MANS); do ${INSTALL_DATA} $$m ${DESTDIR}${mandir}/man1/; done
for m in $(man5_MANS); do ${INSTALL_DATA} $$m ${DESTDIR}${mandir}/man5/; done
for m in $(man8_MANS); do ${INSTALL_DATA} $$m ${DESTDIR}${mandir}/man8/; done
for m in @PKCS11_MANS@; do ${INSTALL_DATA} $$m ${DESTDIR}${mandir}/man8/; done
uninstall::
for m in $(man1_MANS); do rm -f ${DESTDIR}${mandir}/man1/$$m; done
for m in $(man5_MANS); do rm -f ${DESTDIR}${mandir}/man5/$$m; done
for m in $(man8_MANS); do rm -f ${DESTDIR}${mandir}/man8/$$m; done
for m in @PKCS11_MANS@; do rm -f ${DESTDIR}${mandir}/man8/$$m; done
docclean manclean maintainer-clean::
rm -f $(MANPAGES_IN)
clean::
-rm -rf $(SPHINXBUILDDIR)
-rm -f $(man1_MANS) $(man5_MANS) $(man8_MANS) @PKCS11_MANS@

2
doc/man/arpaname.1in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "ARPANAME" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "ARPANAME" "1" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
arpaname \- translate IP addresses to the corresponding ARPA names
.

3
doc/man/conf.py
View File

@@ -64,10 +64,13 @@ man_pages = [
('delv', 'delv', 'DNS lookup and validation utility', author, 1),
('dig', 'dig', 'DNS lookup utility', author, 1),
('dnssec-cds', 'dnssec-cds', 'change DS records for a child zone based on CDS/CDNSKEY', author, 8),
('dnssec-checkds', 'dnssec-checkds', 'DNSSEC delegation consistency checking tool', author, 8),
('dnssec-coverage', 'dnssec-coverage', 'checks future DNSKEY coverage for a zone', author, 8),
('dnssec-dsfromkey', 'dnssec-dsfromkey', 'DNSSEC DS RR generation tool', author, 8),
('dnssec-importkey', 'dnssec-importkey', 'import DNSKEY records from external systems so they can be managed', author, 8),
('dnssec-keyfromlabel', 'dnssec-keyfromlabel', 'DNSSEC key generation tool', author, 8),
('dnssec-keygen', 'dnssec-keygen', 'DNSSEC key generation tool', author, 8),
('dnssec-keymgr', 'dnssec-keymgr', 'ensure correct DNSKEY coverage based on a defined policy', author, 8),
('dnssec-revoke', 'dnssec-revoke', 'set the REVOKED bit on a DNSSEC key', author, 8),
('dnssec-settime', 'dnssec-settime', 'set the key timing metadata for a DNSSEC key', author, 8),
('dnssec-signzone', 'dnssec-signzone', 'DNSSEC zone signing tool', author, 8),

2
doc/man/ddns-confgen.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DDNS-CONFGEN" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DDNS-CONFGEN" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
ddns-confgen \- ddns key generation tool
.

2
doc/man/delv.1in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DELV" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DELV" "1" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
delv \- DNS lookup and validation utility
.

2
doc/man/dig.1in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DIG" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DIG" "1" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dig \- DNS lookup utility
.

2
doc/man/dnssec-cds.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-CDS" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSSEC-CDS" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-cds \- change DS records for a child zone based on CDS/CDNSKEY
.

96
doc/man/dnssec-checkds.8in Normal file
View File

@@ -0,0 +1,96 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-CHECKDS" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-checkds \- DNSSEC delegation consistency checking tool
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBdnssec\-checkds\fP [\fB\-d\fP\fIdig path\fP] [\fB\-D\fP\fIdsfromkey path\fP]
[\fB\-f\fP\fIfile\fP] [\fB\-l\fP\fIdomain\fP] [\fB\-s\fP\fIfile\fP] {zone}
.SH DESCRIPTION
.sp
\fBdnssec\-checkds\fP verifies the correctness of Delegation Signer (DS)
resource records for keys in a specified zone.
.SH OPTIONS
.sp
\fB\-a\fP \fIalgorithm\fP
.INDENT 0.0
.INDENT 3.5
Specify a digest algorithm to use when converting the zones DNSKEY
records to expected DS records. This option can be repeated, so that
multiple records are checked for each DNSKEY record.
.sp
The \fIalgorithm\fP must be one of SHA\-1, SHA\-256, or SHA\-384. These
values are case insensitive, and the hyphen may be omitted. If no
algorithm is specified, the default is SHA\-256.
.UNINDENT
.UNINDENT
.sp
\fB\-f\fP \fIfile\fP
.INDENT 0.0
.INDENT 3.5
If a \fBfile\fP is specified, then the zone is read from that file to
find the DNSKEY records. If not, then the DNSKEY records for the zone
are looked up in the DNS.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \fIfile\fP
.INDENT 0.0
.INDENT 3.5
Specifies a prepared dsset file, such as would be generated by
\fBdnssec\-signzone\fP, to use as a source for the DS RRset instead of
querying the parent.
.UNINDENT
.UNINDENT
.sp
\fB\-d\fP \fIdig path\fP
.INDENT 0.0
.INDENT 3.5
Specifies a path to a \fBdig\fP binary. Used for testing.
.UNINDENT
.UNINDENT
.sp
\fB\-D\fP \fIdsfromkey path\fP
.INDENT 0.0
.INDENT 3.5
Specifies a path to a \fBdnssec\-dsfromkey\fP binary. Used for testing.
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBdnssec\-dsfromkey\fP(8), \fBdnssec\-keygen\fP(8),
\fBdnssec\-signzone\fP(8),
.SH AUTHOR
Internet Systems Consortium
.SH COPYRIGHT
2020, Internet Systems Consortium
.\" Generated by docutils manpage writer.
.

2
doc/man/dnssec-checkds.rst
View File

@@ -10,4 +10,4 @@
:orphan:
.. include:: ../../bin/python/dnssec-checkds.rst
.. include:: ../../bin/python/dnssec-checkds.rst

192
doc/man/dnssec-coverage.8in Normal file
View File

@@ -0,0 +1,192 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-COVERAGE" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-coverage \- checks future DNSKEY coverage for a zone
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBdnssec\-coverage\fP [\fB\-K\fP\fIdirectory\fP] [\fB\-l\fP\fIlength\fP]
[\fB\-f\fP\fIfile\fP] [\fB\-d\fP\fIDNSKEY TTL\fP] [\fB\-m\fP\fImax TTL\fP]
[\fB\-r\fP\fIinterval\fP] [\fB\-c\fP\fIcompilezone path\fP] [\fB\-k\fP] [\fB\-z\fP]
[zone...]
.SH DESCRIPTION
.sp
\fBdnssec\-coverage\fP verifies that the DNSSEC keys for a given zone or a
set of zones have timing metadata set properly to ensure no future
lapses in DNSSEC coverage.
.sp
If \fBzone\fP is specified, then keys found in the key repository matching
that zone are scanned, and an ordered list is generated of the events
scheduled for that key (i.e., publication, activation, inactivation,
deletion). The list of events is walked in order of occurrence. Warnings
are generated if any event is scheduled which could cause the zone to
enter a state in which validation failures might occur: for example, if
the number of published or active keys for a given algorithm drops to
zero, or if a key is deleted from the zone too soon after a new key is
rolled, and cached data signed by the prior key has not had time to
expire from resolver caches.
.sp
If \fBzone\fP is not specified, then all keys in the key repository will
be scanned, and all zones for which there are keys will be analyzed.
(Note: This method of reporting is only accurate if all the zones that
have keys in a given repository share the same TTL parameters.)
.SH OPTIONS
.sp
\fB\-K\fP \fIdirectory\fP
.INDENT 0.0
.INDENT 3.5
Sets the directory in which keys can be found. Defaults to the
current working directory.
.UNINDENT
.UNINDENT
.sp
\fB\-f\fP \fIfile\fP
.INDENT 0.0
.INDENT 3.5
If a \fBfile\fP is specified, then the zone is read from that file; the
largest TTL and the DNSKEY TTL are determined directly from the zone
data, and the \fB\-m\fP and \fB\-d\fP options do not need to be specified
on the command line.
.UNINDENT
.UNINDENT
.sp
\fB\-l\fP \fIduration\fP
.INDENT 0.0
.INDENT 3.5
The length of time to check for DNSSEC coverage. Key events scheduled
further into the future than \fBduration\fP will be ignored, and
assumed to be correct.
.sp
The value of \fBduration\fP can be set in seconds, or in larger units
of time by adding a suffix: mi for minutes, h for hours, d for days,
w for weeks, mo for months, y for years.
.UNINDENT
.UNINDENT
.sp
\fB\-m\fP \fImaximum TTL\fP
.INDENT 0.0
.INDENT 3.5
Sets the value to be used as the maximum TTL for the zone or zones
being analyzed when determining whether there is a possibility of
validation failure. When a zone\-signing key is deactivated, there
must be enough time for the record in the zone with the longest TTL
to have expired from resolver caches before that key can be purged
from the DNSKEY RRset. If that condition does not apply, a warning
will be generated.
.sp
The length of the TTL can be set in seconds, or in larger units of
time by adding a suffix: mi for minutes, h for hours, d for days, w
for weeks, mo for months, y for years.
.sp
This option is not necessary if the \fB\-f\fP has been used to specify a
zone file. If \fB\-f\fP has been specified, this option may still be
used; it will override the value found in the file.
.sp
If this option is not used and the maximum TTL cannot be retrieved
from a zone file, a warning is generated and a default value of 1
week is used.
.UNINDENT
.UNINDENT
.sp
\fB\-d\fP \fIDNSKEY TTL\fP
.INDENT 0.0
.INDENT 3.5
Sets the value to be used as the DNSKEY TTL for the zone or zones
being analyzed when determining whether there is a possibility of
validation failure. When a key is rolled (that is, replaced with a
new key), there must be enough time for the old DNSKEY RRset to have
expired from resolver caches before the new key is activated and
begins generating signatures. If that condition does not apply, a
warning will be generated.
.sp
The length of the TTL can be set in seconds, or in larger units of
time by adding a suffix: mi for minutes, h for hours, d for days, w
for weeks, mo for months, y for years.
.sp
This option is not necessary if \fB\-f\fP has been used to specify a
zone file from which the TTL of the DNSKEY RRset can be read, or if a
default key TTL was set using ith the \fB\-L\fP to \fBdnssec\-keygen\fP\&. If
either of those is true, this option may still be used; it will
override the values found in the zone file or the key file.
.sp
If this option is not used and the key TTL cannot be retrieved from
the zone file or the key file, then a warning is generated and a
default value of 1 day is used.
.UNINDENT
.UNINDENT
.sp
\fB\-r\fP \fIresign interval\fP
.INDENT 0.0
.INDENT 3.5
Sets the value to be used as the resign interval for the zone or
zones being analyzed when determining whether there is a possibility
of validation failure. This value defaults to 22.5 days, which is
also the default in \fBnamed\fP\&. However, if it has been changed by the
\fBsig\-validity\-interval\fP option in named.conf, then it should also
be changed here.
.sp
The length of the interval can be set in seconds, or in larger units
of time by adding a suffix: mi for minutes, h for hours, d for days,
w for weeks, mo for months, y for years.
.UNINDENT
.UNINDENT
.sp
\fB\-k\fP
.INDENT 0.0
.INDENT 3.5
Only check KSK coverage; ignore ZSK events. Cannot be used with
\fB\-z\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-z\fP
.INDENT 0.0
.INDENT 3.5
Only check ZSK coverage; ignore KSK events. Cannot be used with
\fB\-k\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-c\fP \fIcompilezone path\fP
.INDENT 0.0
.INDENT 3.5
Specifies a path to a \fBnamed\-compilezone\fP binary. Used for testing.
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBdnssec\-checkds\fP(8), \fBdnssec\-dsfromkey\fP(8),
\fBdnssec\-keygen\fP(8), \fBdnssec\-signzone\fP(8)
.SH AUTHOR
Internet Systems Consortium
.SH COPYRIGHT
2020, Internet Systems Consortium
.\" Generated by docutils manpage writer.
.

2
doc/man/dnssec-coverage.rst
View File

@@ -10,4 +10,4 @@
:orphan:
.. include:: ../../bin/python/dnssec-coverage.rst
.. include:: ../../bin/python/dnssec-coverage.rst

2
doc/man/dnssec-dsfromkey.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-DSFROMKEY" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSSEC-DSFROMKEY" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-dsfromkey \- DNSSEC DS RR generation tool
.

4
doc/man/dnssec-importkey.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-IMPORTKEY" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSSEC-IMPORTKEY" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-importkey \- import DNSKEY records from external systems so they can be managed
.
@@ -39,7 +39,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.sp
\fBdnssec\-importkey\fP reads a public DNSKEY record and generates a pair
of .key/.private files. The DNSKEY record may be read from an existing
\&.key file, in which case a corresponding .private file will be
.key file, in which case a corresponding .private file will be
generated, or it may be read from any other file or from the standard
input, in which case both .key and .private files will be generated.
.sp

2
doc/man/dnssec-keyfromlabel.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-KEYFROMLABEL" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSSEC-KEYFROMLABEL" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-keyfromlabel \- DNSSEC key generation tool
.

8
doc/man/dnssec-keygen.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-KEYGEN" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSSEC-KEYGEN" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-keygen \- DNSSEC key generation tool
.
@@ -43,6 +43,12 @@ Key) as defined in \fI\%RFC 2930\fP\&.
The \fBname\fP of the key is specified on the command line. For DNSSEC
keys, this must match the name of the zone for which the key is being
generated.
.sp
The \fBdnssec\-keymgr\fP command acts as a wrapper
around \fBdnssec\-keygen\fP, generating and updating keys
as needed to enforce defined security policies such as key rollover
scheduling. Using \fBdnssec\-keymgr\fP may be preferable
to direct use of \fBdnssec\-keygen\fP\&.
.SH OPTIONS
.INDENT 0.0
.TP

299
doc/man/dnssec-keymgr.8in Normal file
View File

@@ -0,0 +1,299 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-KEYMGR" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-keymgr \- ensure correct DNSKEY coverage based on a defined policy
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
:program:\fBdnssec\-keymgr\fP [\fB\-K\fP\fIdirectory\fP] [\fB\-c\fP\fIfile\fP] [\fB\-f\fP]
[\fB\-k\fP] [\fB\-q\fP] [\fB\-v\fP] [\fB\-z\fP] [\fB\-g\fP\fIpath\fP] [\fB\-s\fP\fIpath\fP]
[zone...]
.SH DESCRIPTION
.sp
\fBdnssec\-keymgr\fP is a high level Python wrapper to facilitate the key
rollover process for zones handled by BIND. It uses the BIND commands
for manipulating DNSSEC key metadata: \fBdnssec\-keygen\fP and
\fBdnssec\-settime\fP\&.
.sp
DNSSEC policy can be read from a configuration file (default
/etc/dnssec\-policy.conf), from which the key parameters, publication and
rollover schedule, and desired coverage duration for any given zone can
be determined. This file may be used to define individual DNSSEC
policies on a per\-zone basis, or to set a "default" policy used for all
zones.
.sp
When \fBdnssec\-keymgr\fP runs, it examines the DNSSEC keys for one or more
zones, comparing their timing metadata against the policies for those
zones. If key settings do not conform to the DNSSEC policy (for example,
because the policy has been changed), they are automatically corrected.
.sp
A zone policy can specify a duration for which we want to ensure the key
correctness (\fBcoverage\fP). It can also specify a rollover period
(\fBroll\-period\fP). If policy indicates that a key should roll over
before the coverage period ends, then a successor key will automatically
be created and added to the end of the key series.
.sp
If zones are specified on the command line, \fBdnssec\-keymgr\fP will
examine only those zones. If a specified zone does not already have keys
in place, then keys will be generated for it according to policy.
.sp
If zones are \fInot\fP specified on the command line, then \fBdnssec\-keymgr\fP
will search the key directory (either the current working directory or
the directory set by the \fB\-K\fP option), and check the keys for all the
zones represented in the directory.
.sp
Key times that are in the past will not be updated unless the \fB\-f\fP is
used (see below). Key inactivation and deletion times that are less than
five minutes in the future will be delayed by five minutes.
.sp
It is expected that this tool will be run automatically and unattended
(for example, by \fBcron\fP).
.SH OPTIONS
.sp
\fB\-c\fP \fIfile\fP
.INDENT 0.0
.INDENT 3.5
If \fB\-c\fP is specified, then the DNSSEC policy is read from \fBfile\fP\&.
(If not specified, then the policy is read from
/etc/dnssec\-policy.conf; if that file doesnt exist, a built\-in global
default policy is used.)
.UNINDENT
.UNINDENT
.sp
\fB\-f\fP
.INDENT 0.0
.INDENT 3.5
Force: allow updating of key events even if they are already in the
past. This is not recommended for use with zones in which keys have
already been published. However, if a set of keys has been generated
all of which have publication and activation dates in the past, but
the keys have not been published in a zone as yet, then this option
can be used to clean them up and turn them into a proper series of
keys with appropriate rollover intervals.
.UNINDENT
.UNINDENT
.sp
\fB\-g\fP \fIkeygen\-path\fP
.INDENT 0.0
.INDENT 3.5
Specifies a path to a \fBdnssec\-keygen\fP binary. Used for testing. See
also the \fB\-s\fP option.
.UNINDENT
.UNINDENT
.sp
\fB\-h\fP
.INDENT 0.0
.INDENT 3.5
Print the \fBdnssec\-keymgr\fP help summary and exit.
.UNINDENT
.UNINDENT
.sp
\fB\-K\fP \fIdirectory\fP
.INDENT 0.0
.INDENT 3.5
Sets the directory in which keys can be found. Defaults to the
current working directory.
.UNINDENT
.UNINDENT
.sp
\fB\-k\fP
.INDENT 0.0
.INDENT 3.5
Only apply policies to KSK keys. See also the \fB\-z\fP option.
.UNINDENT
.UNINDENT
.sp
\fB\-q\fP
.INDENT 0.0
.INDENT 3.5
Quiet: suppress printing of \fBdnssec\-keygen\fP and \fBdnssec\-settime\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-s\fP \fIsettime\-path\fP
.INDENT 0.0
.INDENT 3.5
Specifies a path to a \fBdnssec\-settime\fP binary. Used for testing.
See also the \fB\-g\fP option.
.UNINDENT
.UNINDENT
.sp
\fB\-v\fP
.INDENT 0.0
.INDENT 3.5
Print the \fBdnssec\-keymgr\fP version and exit.
.UNINDENT
.UNINDENT
.sp
\fB\-z\fP
.INDENT 0.0
.INDENT 3.5
Only apply policies to ZSK keys. See also the \fB\-k\fP option.
.UNINDENT
.UNINDENT
.SH POLICY CONFIGURATION
.sp
The dnssec\-policy.conf file can specify three kinds of policies:
.INDENT 0.0
.INDENT 3.5
· \fIPolicy classes\fP (\fBpolicy\fP\fIname\fP\fB{ ... };\fP) can be
inherited by zone policies or other policy classes; these can be used
to create sets of different security profiles. For example, a policy
class \fBnormal\fP might specify 1024\-bit key sizes, but a class
\fBextra\fP might specify 2048 bits instead; \fBextra\fP would be used
for zones that had unusually high security needs.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
· \fIAlgorithm policies:\fP (\fBalgorithm\-policy\fP\fIalgorithm\fP\fB{ ...
};\fP ) override default per\-algorithm settings. For example, by
default, RSASHA256 keys use 2048\-bit key sizes for both KSK and ZSK.
This can be modified using \fBalgorithm\-policy\fP, and the new key
sizes would then be used for any key of type RSASHA256.
.sp
· \fIZone policies:\fP (\fBzone\fP\fIname\fP\fB{ ... };\fP ) set policy for a
single zone by name. A zone policy can inherit a policy class by
including a \fBpolicy\fP option. Zone names beginning with digits
(i.e., 0\-9) must be quoted. If a zone does not have its own policy
then the "default" policy applies.
.UNINDENT
.UNINDENT
.sp
Options that can be specified in policies:
.sp
\fBalgorithm\fP \fIname\fP;
.INDENT 0.0
.INDENT 3.5
The key algorithm. If no policy is defined, the default is RSASHA256.
.UNINDENT
.UNINDENT
.sp
\fBcoverage\fP \fIduration\fP;
.INDENT 0.0
.INDENT 3.5
The length of time to ensure that keys will be correct; no action
will be taken to create new keys to be activated after this time.
This can be represented as a number of seconds, or as a duration
using human\-readable units (examples: "1y" or "6 months"). A default
value for this option can be set in algorithm policies as well as in
policy classes or zone policies. If no policy is configured, the
default is six months.
.UNINDENT
.UNINDENT
.sp
\fBdirectory\fP \fIpath\fP;
.INDENT 0.0
.INDENT 3.5
Specifies the directory in which keys should be stored.
.UNINDENT
.UNINDENT
.sp
\fBkey\-size\fP \fIkeytype\fP \fIsize\fP;
.INDENT 0.0
.INDENT 3.5
Specifies the number of bits to use in creating keys. The keytype is
either "zsk" or "ksk". A default value for this option can be set in
algorithm policies as well as in policy classes or zone policies. If
no policy is configured, the default is 2048 bits for RSA keys.
.UNINDENT
.UNINDENT
.sp
\fBkeyttl\fP \fIduration\fP;
.INDENT 0.0
.INDENT 3.5
The key TTL. If no policy is defined, the default is one hour.
.UNINDENT
.UNINDENT
.sp
\fBpost\-publish\fP \fIkeytype\fP \fIduration\fP;
.INDENT 0.0
.INDENT 3.5
How long after inactivation a key should be deleted from the zone.
Note: If \fBroll\-period\fP is not set, this value is ignored. The
keytype is either "zsk" or "ksk". A default duration for this option
can be set in algorithm policies as well as in policy classes or zone
policies. The default is one month.
.UNINDENT
.UNINDENT
.sp
\fBpre\-publish\fP \fIkeytype\fP \fIduration\fP;
.INDENT 0.0
.INDENT 3.5
How long before activation a key should be published. Note: If
\fBroll\-period\fP is not set, this value is ignored. The keytype is
either "zsk" or "ksk". A default duration for this option can be set
in algorithm policies as well as in policy classes or zone policies.
The default is one month.
.UNINDENT
.UNINDENT
.sp
\fBroll\-period\fP \fIkeytype\fP \fIduration\fP;
.INDENT 0.0
.INDENT 3.5
How frequently keys should be rolled over. The keytype is either
"zsk" or "ksk". A default duration for this option can be set in
algorithm policies as well as in policy classes or zone policies. If
no policy is configured, the default is one year for ZSKs. KSKs do
not roll over by default.
.UNINDENT
.UNINDENT
.sp
\fBstandby\fP \fIkeytype\fP \fInumber\fP;
.INDENT 0.0
.INDENT 3.5
Not yet implemented.
.UNINDENT
.UNINDENT
.SH REMAINING WORK
.INDENT 0.0
.INDENT 3.5
· Enable scheduling of KSK rollovers using the \fB\-P sync\fP and \fB\-D
sync\fP options to \fBdnssec\-keygen\fP and \fBdnssec\-settime\fP\&. Check the
parent zone (as in \fBdnssec\-checkds\fP) to determine when its safe for
the key to roll.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
· Allow configuration of standby keys and use of the REVOKE bit, for
keys that use RFC 5011 semantics.
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBdnssec\-coverage\fP(8), \fBdnssec\-keygen\fP(8),
\fBdnssec\-settime\fP(8), \fBdnssec\-checkds\fP(8)
.SH AUTHOR
Internet Systems Consortium
.SH COPYRIGHT
2020, Internet Systems Consortium
.\" Generated by docutils manpage writer.
.

2
doc/man/dnssec-keymgr.rst
View File

@@ -10,4 +10,4 @@
:orphan:
.. include:: ../../bin/python/dnssec-keymgr.rst
.. include:: ../../bin/python/dnssec-keymgr.rst

2
doc/man/dnssec-revoke.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-REVOKE" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSSEC-REVOKE" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-revoke \- set the REVOKED bit on a DNSSEC key
.

2
doc/man/dnssec-settime.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-SETTIME" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSSEC-SETTIME" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-settime \- set the key timing metadata for a DNSSEC key
.

2
doc/man/dnssec-signzone.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-SIGNZONE" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSSEC-SIGNZONE" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-signzone \- DNSSEC zone signing tool
.

2
doc/man/dnssec-verify.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSSEC-VERIFY" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSSEC-VERIFY" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnssec-verify \- DNSSEC zone verification tool
.

2
doc/man/dnstap-read.1in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "DNSTAP-READ" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "DNSTAP-READ" "1" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
dnstap-read \- print dnstap data in human-readable form
.

2
doc/man/filter-aaaa.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "FILTER-AAAA" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "FILTER-AAAA" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
filter-aaaa \- filter AAAA in DNS responses when A is present
.

2
doc/man/host.1in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "HOST" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "HOST" "1" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
host \- DNS lookup utility
.

2
doc/man/mdig.1in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "MDIG" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "MDIG" "1" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
mdig \- DNS pipelined lookup utility
.

2
doc/man/named-checkconf.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NAMED-CHECKCONF" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NAMED-CHECKCONF" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
named-checkconf \- named configuration file syntax checking tool
.

2
doc/man/named-checkzone.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NAMED-CHECKZONE" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NAMED-CHECKZONE" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
named-checkzone \- zone file validity checking or converting tool
.

2
doc/man/named-journalprint.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NAMED-JOURNALPRINT" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NAMED-JOURNALPRINT" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
named-journalprint \- print zone journal in human-readable form
.

2
doc/man/named-nzd2nzf.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NAMED-NZD2NZF" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NAMED-NZD2NZF" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
named-nzd2nzf \- convert an NZD database to NZF text format
.

2
doc/man/named-rrchecker.1in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NAMED-RRCHECKER" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NAMED-RRCHECKER" "1" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
named-rrchecker \- syntax checker for individual DNS resource records
.

2
doc/man/named.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NAMED" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NAMED" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
named \- Internet domain name server
.

24
doc/man/named.conf.5in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NAMED.CONF" "5" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NAMED.CONF" "5" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
named.conf \- configuration file for **named**
.
@@ -349,7 +349,6 @@ options {
max\-cache\-size ( default | unlimited | sizeval | percentage );
max\-cache\-ttl duration;
max\-clients\-per\-query integer;
max\-ixfr\-ratio ( unlimited | percentage );
max\-journal\-size ( default | unlimited | sizeval );
max\-ncache\-ttl duration;
max\-records integer;
@@ -441,11 +440,10 @@ options {
nsdname\-enable boolean ]; ... } [ add\-soa boolean ] [
break\-dnssec boolean ] [ max\-policy\-ttl duration ] [
min\-update\-interval duration ] [ min\-ns\-dots integer ] [
nsip\-wait\-recurse boolean ] [ nsdname\-wait\-recurse boolean
] [ qname\-wait\-recurse boolean ] [ recursive\-only boolean ]
[ nsip\-enable boolean ] [ nsdname\-enable boolean ] [
dnsrps\-enable boolean ] [ dnsrps\-options { unspecified\-text
} ];
nsip\-wait\-recurse boolean ] [ qname\-wait\-recurse boolean ]
[ recursive\-only boolean ] [ nsip\-enable boolean ] [
nsdname\-enable boolean ] [ dnsrps\-enable boolean ] [
dnsrps\-options { unspecified\-text } ];
root\-delegation\-only [ exclude { string; ... } ];
root\-key\-sentinel boolean;
rrset\-order { [ class string ] [ type string ] [ name
@@ -730,7 +728,6 @@ view string [ class ] {
max\-cache\-size ( default | unlimited | sizeval | percentage );
max\-cache\-ttl duration;
max\-clients\-per\-query integer;
max\-ixfr\-ratio ( unlimited | percentage );
max\-journal\-size ( default | unlimited | sizeval );
max\-ncache\-ttl duration;
max\-records integer;
@@ -813,11 +810,10 @@ view string [ class ] {
nsdname\-enable boolean ]; ... } [ add\-soa boolean ] [
break\-dnssec boolean ] [ max\-policy\-ttl duration ] [
min\-update\-interval duration ] [ min\-ns\-dots integer ] [
nsip\-wait\-recurse boolean ] [ nsdname\-wait\-recurse boolean
] [ qname\-wait\-recurse boolean ] [ recursive\-only boolean ]
[ nsip\-enable boolean ] [ nsdname\-enable boolean ] [
dnsrps\-enable boolean ] [ dnsrps\-options { unspecified\-text
} ];
nsip\-wait\-recurse boolean ] [ qname\-wait\-recurse boolean ]
[ recursive\-only boolean ] [ nsip\-enable boolean ] [
nsdname\-enable boolean ] [ dnsrps\-enable boolean ] [
dnsrps\-options { unspecified\-text } ];
root\-delegation\-only [ exclude { string; ... } ];
root\-key\-sentinel boolean;
rrset\-order { [ class string ] [ type string ] [ name
@@ -939,7 +935,6 @@ view string [ class ] {
masters [ port integer ] [ dscp integer ] { ( masters
| ipv4_address [ port integer ] | ipv6_address [
port integer ] ) [ key string ]; ... };
max\-ixfr\-ratio ( unlimited | percentage );
max\-journal\-size ( default | unlimited | sizeval );
max\-records integer;
max\-refresh\-time integer;
@@ -1046,7 +1041,6 @@ zone string [ class ] {
masters [ port integer ] [ dscp integer ] { ( masters |
ipv4_address [ port integer ] | ipv6_address [ port
integer ] ) [ key string ]; ... };
max\-ixfr\-ratio ( unlimited | percentage );
max\-journal\-size ( default | unlimited | sizeval );
max\-records integer;
max\-refresh\-time integer;

2
doc/man/nsec3hash.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NSEC3HASH" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NSEC3HASH" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
nsec3hash \- generate NSEC3 hash
.

2
doc/man/nslookup.1in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NSLOOKUP" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NSLOOKUP" "1" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
nslookup \- query Internet name servers interactively
.

2
doc/man/nsupdate.1in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "NSUPDATE" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "NSUPDATE" "1" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
nsupdate \- dynamic DNS update utility
.

2
doc/man/pkcs11-destroy.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "PKCS11-DESTROY" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "PKCS11-DESTROY" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
pkcs11-destroy \- destroy PKCS#11 objects
.

2
doc/man/pkcs11-keygen.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "PKCS11-KEYGEN" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "PKCS11-KEYGEN" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
pkcs11-keygen \- generate keys on a PKCS#11 device
.

2
doc/man/pkcs11-list.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "PKCS11-LIST" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "PKCS11-LIST" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
pkcs11-list \- list PKCS#11 objects
.

2
doc/man/pkcs11-tokens.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "PKCS11-TOKENS" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "PKCS11-TOKENS" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
pkcs11-tokens \- list PKCS#11 available tokens
.

2
doc/man/rndc-confgen.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "RNDC-CONFGEN" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "RNDC-CONFGEN" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
rndc-confgen \- rndc key generation tool
.

2
doc/man/rndc.8in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "RNDC" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "RNDC" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
rndc \- name server control utility
.

2
doc/man/rndc.conf.5in
View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "RNDC.CONF" "5" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.TH "RNDC.CONF" "5" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
rndc.conf \- rndc configuration file
.

20
doc/tex/Makefile.in
View File

@@ -1,20 +0,0 @@
# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# See the COPYRIGHT file distributed with this work for additional
# information regarding copyright ownership.
srcdir = @srcdir@
VPATH = @srcdir@
top_srcdir = @top_srcdir@
SUBDIRS =
TARGETS =
@BIND9_MAKE_RULES@
distclean::
rm -f armstyle.sty

21
doc/xsl/Makefile.in
View File

@@ -1,21 +0,0 @@
# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# See the COPYRIGHT file distributed with this work for additional
# information regarding copyright ownership.
srcdir = @srcdir@
VPATH = @srcdir@
top_srcdir = @top_srcdir@
SUBDIRS =
TARGETS =
@BIND9_MAKE_RULES@
distclean::
rm -f isc-docbook-chunk.xsl isc-docbook-html.xsl \
isc-manpage.xsl isc-notes-html.xsl