bind-9.11.3/doc/arm

README-SGMLCopyright (C) 2000, 2001, 2004, 2015, 2016  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/.

The BIND v9 ARM master document is now kept in DocBook 5 XML format.

Most of the ARM is in the single file "Bv9ARM-book.xml", with certain
other files included into it:

    - dlz.xml
    - dnssec.xml
    - libdns.xml
    - logging-categories.xml
    - managed-keys.xml
    - notes.xml
    - pkcs11.xml
    - BIND man pages

All of the published ARM formats - HTML, PDF, etc - are generated from
this master source.

The file "notes.xml" contains the release notes for the current release. In
addition to being included in the ARM as an appendix, it is also built into
a stand-alone document: "notes.pdf" and "notes.html".

Building these these files requires DocBook 5 and dblatex. These are
available as packages in many OS distributes; in debian, for example:

    $ sudo apt-get install docbook5-xml docbook-xml docbook-xsl-ns \
                           docbook-utils dblatex

To build all documentation, run "make doc".

When committing changes or submitting patches, it is only necessary to
edit the XML source (i.e., the files with ".docbook" or ".xml" suffixes);
the files in HTML and man page format are built from the XML source by a
cron job.

If you are familiar with SGML or HTML, editing the DocBook XML is quite
straightforward.  You only need to know what the tags are and how to use
them.  You can find a good resource either for this either online or in
printed form:

    DocBook: The Definitive Guide
    By Norman Walsh and Leonard Muellner
    ISBN: 156592-580-7
    1st Edition, October 1999
    Copyright (C) 1999 by O'Reilly & Associates, Inc. All rights reserved.

The book is available online in HTML format:

    http://docbook.org/

After editing documentation, it is useful to check the correctness of the
XML; this can be done using the "xmllint" utility.
Name	Date	Size
..	2018-03-08 02:11:57	13
.gitignore	2015-10-06 06:59:35	47
acl.grammar.xml	2018-01-23 00:47:25	482
Bv9ARM-book.xml	2018-02-07 03:50:00	591.8 KiB
Bv9ARM.ch01.html	2018-03-08 02:11:57	26.1 KiB
Bv9ARM.ch02.html	2018-03-08 02:11:57	7.2 KiB
Bv9ARM.ch03.html	2018-03-08 02:11:57	30.4 KiB
Bv9ARM.ch04.html	2018-03-08 02:11:57	129.6 KiB
Bv9ARM.ch05.html	2018-03-08 02:11:57	6.3 KiB
Bv9ARM.ch06.html	2018-03-08 02:11:57	677.1 KiB
Bv9ARM.ch07.html	2018-03-08 02:11:57	19.6 KiB
Bv9ARM.ch08.html	2018-03-08 02:11:57	6.3 KiB
Bv9ARM.ch09.html	2018-03-08 02:11:57	18 KiB
Bv9ARM.ch10.html	2018-03-08 02:11:57	6.9 KiB
Bv9ARM.ch11.html	2018-03-08 02:11:57	53.2 KiB
Bv9ARM.ch12.html	2018-03-08 02:11:57	20.4 KiB
Bv9ARM.ch13.html	2018-03-08 02:11:57	9.9 KiB
Bv9ARM.conf	2015-10-06 06:59:35	72
Bv9ARM.html	2018-03-08 02:11:57	29.9 KiB
Bv9ARM.pdf	2018-03-08 02:11:57	1.2 MiB
catz.xml	2017-09-22 01:50:32	12.4 KiB
controls.grammar.xml	2018-01-23 00:47:25	1.1 KiB
delegation-only.zoneopt.xml	2018-01-23 00:47:25	507
dlz.xml	2016-12-07 00:50:50	6.1 KiB
dnssec.xml	2017-11-03 00:46:37	12.8 KiB
dyndb.xml	2016-12-07 00:50:50	4 KiB
forward.zoneopt.xml	2018-01-23 00:47:25	920
hint.zoneopt.xml	2018-01-23 00:47:25	693
in-view.zoneopt.xml	2018-01-23 00:47:25	528
isc-logo.eps	2010-04-20 04:30:06	508.1 KiB
isc-logo.pdf	2010-04-20 04:30:06	281.2 KiB
key.grammar.xml	2018-01-23 00:47:25	555
libdns.xml	2017-10-26 01:50:03	17.2 KiB
logging-categories.xml	2017-10-06 04:53:50	10.4 KiB
logging.grammar.xml	2018-01-23 00:47:25	1.2 KiB
Makefile.in	2016-06-27 06:56:38	2 KiB
man.arpaname.html	2018-03-08 02:11:57	3 KiB
man.ddns-confgen.html	2018-03-08 02:11:57	9.5 KiB
man.delv.html	2018-03-08 02:11:57	23.9 KiB
man.dig.html	2018-03-08 02:11:57	40.1 KiB
man.dnssec-checkds.html	2018-03-08 02:11:57	5.4 KiB
man.dnssec-coverage.html	2018-03-08 02:11:57	11.3 KiB
man.dnssec-dsfromkey.html	2018-03-08 02:11:57	9.7 KiB
man.dnssec-importkey.html	2018-03-08 02:11:57	9.6 KiB
man.dnssec-keyfromlabel.html	2018-03-08 02:11:57	19.1 KiB
man.dnssec-keygen.html	2018-03-08 02:11:57	22.3 KiB
man.dnssec-keymgr.html	2018-03-08 02:11:57	15.1 KiB
man.dnssec-revoke.html	2018-03-08 02:11:57	5.6 KiB
man.dnssec-settime.html	2018-03-08 02:11:57	14.6 KiB
man.dnssec-signzone.html	2018-03-08 02:11:57	30.7 KiB
man.dnssec-verify.html	2018-03-08 02:11:57	7.4 KiB
man.dnstap-read.html	2018-03-08 02:11:57	4.4 KiB
man.genrandom.html	2018-03-08 02:11:57	4.1 KiB
man.host.html	2018-03-08 02:11:57	12.7 KiB
man.isc-hmac-fixup.html	2018-03-08 02:11:57	4.6 KiB
man.lwresd.html	2018-03-08 02:11:57	12.4 KiB
man.mdig.html	2018-03-08 02:11:57	23.2 KiB
man.named-checkconf.html	2018-03-08 02:11:57	6.8 KiB
man.named-checkzone.html	2018-03-08 02:11:57	20.2 KiB
man.named-journalprint.html	2018-03-08 02:11:57	4.2 KiB
man.named-nzd2nzf.html	2018-03-08 02:11:57	3.9 KiB
man.named-rrchecker.html	2018-03-08 02:11:57	4.2 KiB
man.named.conf.html	2018-03-08 02:11:57	73.2 KiB
man.named.html	2018-03-08 02:11:57	19.1 KiB
man.nsec3hash.html	2018-03-08 02:11:57	4.2 KiB
man.nslookup.html	2018-03-08 02:11:57	14.5 KiB
man.nsupdate.html	2018-03-08 02:11:57	28.1 KiB
man.pkcs11-destroy.html	2018-03-08 02:11:57	5.6 KiB
man.pkcs11-keygen.html	2018-03-08 02:11:57	7.1 KiB
man.pkcs11-list.html	2018-03-08 02:11:57	5.5 KiB
man.pkcs11-tokens.html	2018-03-08 02:11:57	3.7 KiB
man.rndc-confgen.html	2018-03-08 02:11:57	11.5 KiB
man.rndc.conf.html	2018-03-08 02:11:57	10.2 KiB
man.rndc.html	2018-03-08 02:11:57	39.9 KiB
managed-keys.grammar.xml	2018-01-23 00:47:25	626
managed-keys.xml	2017-11-03 00:46:37	4.6 KiB
master.zoneopt.xml	2018-01-23 00:47:25	5.5 KiB
masters.grammar.xml	2018-01-23 00:47:25	809
notes-wrapper.xml	2016-12-07 00:50:50	550
notes.conf	2015-10-06 06:59:35	75
notes.html	2018-03-08 02:11:57	14.8 KiB
notes.pdf	2018-03-08 02:11:57	63 KiB
notes.xml	2018-02-15 20:16:15	13.3 KiB
noteversion.xml.in	2016-06-27 06:56:38	348
options.grammar.xml	2018-01-23 00:47:25	22.2 KiB
pkcs11.xml	2016-12-07 00:50:50	24.4 KiB
pkgversion.xml.in	2016-06-27 06:56:38	379
README-SGML	2016-06-27 06:56:38	2 KiB
redirect.zoneopt.xml	2018-01-23 00:47:25	1.5 KiB
releaseinfo.xml.in	2016-06-27 06:56:38	342
server.grammar.xml	2018-01-23 00:47:25	2.8 KiB
slave.zoneopt.xml	2018-01-23 00:47:25	6 KiB
static-stub.zoneopt.xml	2018-01-23 00:47:25	1.4 KiB
statistics-channels.grammar.xml	2018-01-23 00:47:25	680
stub.zoneopt.xml	2018-01-23 00:47:25	3 KiB
trusted-keys.grammar.xml	2018-01-23 00:47:25	592