README-SGML revision ffb47c916a32684adbd031c0bacdd0d11ff33e3a
247N/ACopyright (C) 2004, 2015 Internet Systems Consortium, Inc. ("ISC")
247N/ACopyright (C) 2000, 2001 Internet Software Consortium.
247N/ASee COPYRIGHT in the source root or http://isc.org/copyright.html for terms.
247N/A
247N/AThe BIND v9 ARM master document is now kept in DocBook 5 XML format.
247N/A
247N/AMost of the ARM is in the single file "Bv9ARM-book.xml", with certain
247N/Aother files included into it:
247N/A
247N/A - dlz.xml
247N/A - dnssec.xml
247N/A - libdns.xml
247N/A - logging-categories.xml
247N/A - managed-keys.xml
247N/A - notes.xml
247N/A - pkcs11.xml
247N/A - BIND man pages
247N/A
247N/AAll of the published ARM formats - HTML, PDF, etc - are generated from
247N/Athis master source.
247N/A
714N/AThe file "notes.xml" contains the release notes for the current release. In
247N/Aaddition to being included in the ARM as an appendix, it is also built into
247N/Aa stand-alone document: "notes.pdf" and "notes.html".
247N/A
247N/ABuilding these these files requires DocBook 5 and dblatex. These are
247N/Aavailable as packages in many OS distributes; in debian, for example:
1247N/A
247N/A $ sudo apt-get install docbook5-xml docbook-xml docbook-xsl-ns \
247N/A docbook-utils dblatex
844N/A
1247N/ATo build all documentation, run "make doc".
1247N/A
247N/AWhen committing changes or submitting patches, it is only necessary to
247N/Aedit the XML source (i.e., the files with ".docbook" or ".xml" suffixes);
247N/Athe files in HTML and man page format are built from the XML source by a
247N/Acron job.
247N/A
247N/AIf you are familiar with SGML or HTML, editing the DocBook XML is quite
714N/Astraightforward. You only need to know what the tags are and how to use
714N/Athem. You can find a good resource either for this either online or in
714N/Aprinted form:
714N/A
714N/A DocBook: The Definitive Guide
714N/A By Norman Walsh and Leonard Muellner
714N/A ISBN: 156592-580-7
714N/A 1st Edition, October 1999
714N/A Copyright (C) 1999 by O'Reilly & Associates, Inc. All rights reserved.
714N/A
714N/AThe book is available online in HTML format:
714N/A
714N/A http://docbook.org/
714N/A
714N/AAfter editing documentation, it is useful to check the correctness of the
714N/AXML; this can be done using the "xmllint" utility.
714N/A