2019-03-31 12:49:47 +02:00
|
|
|
############################################################################
|
|
|
|
# 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
|
2020-09-14 16:20:40 -07:00
|
|
|
# file, you can obtain one at https://mozilla.org/MPL/2.0/.
|
2019-03-31 12:49:47 +02:00
|
|
|
#
|
|
|
|
# See the COPYRIGHT file distributed with this work for additional
|
|
|
|
# information regarding copyright ownership.
|
|
|
|
############################################################################
|
|
|
|
|
|
|
|
# flake8: noqa: E501
|
|
|
|
|
|
|
|
#
|
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
|
|
#
|
|
|
|
# This file only contains a selection of the most common options. For a full
|
|
|
|
# list see the documentation:
|
|
|
|
# http://www.sphinx-doc.org/en/master/config
|
|
|
|
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
|
|
#
|
|
|
|
# import os
|
|
|
|
# import sys
|
|
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
|
|
project = u'BIND 9'
|
2021-04-07 16:42:28 +02:00
|
|
|
# pylint: disable=wrong-import-position
|
|
|
|
import datetime
|
|
|
|
year = datetime.datetime.now().year
|
2019-03-31 12:49:47 +02:00
|
|
|
# pylint: disable=redefined-builtin
|
2021-04-07 16:42:28 +02:00
|
|
|
copyright = u"%d, Internet Systems Consortium" % year
|
2019-03-31 12:49:47 +02:00
|
|
|
author = u'Internet Systems Consortium'
|
|
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
|
|
# ones.
|
|
|
|
extensions = []
|
|
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
|
|
templates_path = ['../arm/_templates']
|
|
|
|
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
|
|
# directories to ignore when looking for source files.
|
|
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
|
|
exclude_patterns = [
|
|
|
|
'_build',
|
|
|
|
'Thumbs.db',
|
|
|
|
'.DS_Store',
|
|
|
|
]
|
|
|
|
|
|
|
|
# The master toctree document.
|
|
|
|
master_doc = 'index'
|
|
|
|
|
|
|
|
# pylint: disable=line-too-long
|
|
|
|
man_pages = [
|
|
|
|
('arpaname', 'arpaname', 'translate IP addresses to the corresponding ARPA names', author, 1),
|
2021-01-11 12:27:17 +01:00
|
|
|
('ddns-confgen', 'ddns-confgen', 'ddns key generation tool', author, 8),
|
2019-03-31 12:49:47 +02:00
|
|
|
('delv', 'delv', 'DNS lookup and validation utility', author, 1),
|
|
|
|
('dig', 'dig', 'DNS lookup utility', author, 1),
|
2020-05-22 15:44:27 +02:00
|
|
|
('dnssec-cds', 'dnssec-cds', 'change DS records for a child zone based on CDS/CDNSKEY', author, 1),
|
|
|
|
('dnssec-dsfromkey', 'dnssec-dsfromkey', 'DNSSEC DS RR generation tool', author, 1),
|
|
|
|
('dnssec-importkey', 'dnssec-importkey', 'import DNSKEY records from external systems so they can be managed', author, 1),
|
|
|
|
('dnssec-keyfromlabel', 'dnssec-keyfromlabel', 'DNSSEC key generation tool', author, 1),
|
|
|
|
('dnssec-keygen', 'dnssec-keygen', 'DNSSEC key generation tool', author, 1),
|
|
|
|
('dnssec-revoke', 'dnssec-revoke', 'set the REVOKED bit on a DNSSEC key', author, 1),
|
|
|
|
('dnssec-settime', 'dnssec-settime', 'set the key timing metadata for a DNSSEC key', author, 1),
|
|
|
|
('dnssec-signzone', 'dnssec-signzone', 'DNSSEC zone signing tool', author, 1),
|
|
|
|
('dnssec-verify', 'dnssec-verify', 'DNSSEC zone verification tool', author, 1),
|
2019-03-31 12:49:47 +02:00
|
|
|
('dnstap-read', 'dnstap-read', 'print dnstap data in human-readable form', author, 1),
|
|
|
|
('filter-aaaa', 'filter-aaaa', 'filter AAAA in DNS responses when A is present', author, 8),
|
2021-03-03 11:33:55 +01:00
|
|
|
('filter-a', 'filter-a', 'filter A in DNS responses when AAAA is present', author, 8),
|
2019-03-31 12:49:47 +02:00
|
|
|
('host', 'host', 'DNS lookup utility', author, 1),
|
|
|
|
('mdig', 'mdig', 'DNS pipelined lookup utility', author, 1),
|
2020-05-22 15:44:27 +02:00
|
|
|
('named-checkconf', 'named-checkconf', 'named configuration file syntax checking tool', author, 1),
|
|
|
|
('named-checkzone', 'named-checkzone', 'zone file validity checking or converting tool', author, 1),
|
2021-03-22 09:36:48 +01:00
|
|
|
('named-compilezone', 'named-compilezone', 'zone file validity checking or converting tool', author, 1),
|
2020-05-22 15:44:27 +02:00
|
|
|
('named-journalprint', 'named-journalprint', 'print zone journal in human-readable form', author, 1),
|
|
|
|
('named-nzd2nzf', 'named-nzd2nzf', 'convert an NZD database to NZF text format', author, 1),
|
2019-03-31 12:49:47 +02:00
|
|
|
('named-rrchecker', 'named-rrchecker', 'syntax checker for individual DNS resource records', author, 1),
|
|
|
|
('named.conf', 'named.conf', 'configuration file for **named**', author, 5),
|
|
|
|
('named', 'named', 'Internet domain name server', author, 8),
|
2020-05-22 15:44:27 +02:00
|
|
|
('nsec3hash', 'nsec3hash', 'generate NSEC3 hash', author, 1),
|
2019-03-31 12:49:47 +02:00
|
|
|
('nslookup', 'nslookup', 'query Internet name servers interactively', author, 1),
|
|
|
|
('nsupdate', 'nsupdate', 'dynamic DNS update utility', author, 1),
|
2020-05-22 15:44:27 +02:00
|
|
|
('pkcs11-destroy', 'pkcs11-destroy', 'destroy PKCS#11 objects', author, 1),
|
|
|
|
('pkcs11-keygen', 'pkcs11-keygen', 'generate keys on a PKCS#11 device', author, 1),
|
|
|
|
('pkcs11-list', 'pkcs11-list', 'list PKCS#11 objects', author, 1),
|
|
|
|
('pkcs11-tokens', 'pkcs11-tokens', 'list PKCS#11 available tokens', author, 1),
|
2019-03-31 12:49:47 +02:00
|
|
|
('rndc-confgen', 'rndc-confgen', 'rndc key generation tool', author, 8),
|
|
|
|
('rndc.conf', 'rndc.conf', 'rndc configuration file', author, 5),
|
|
|
|
('rndc', 'rndc', 'name server control utility', author, 8),
|
2020-07-02 15:27:54 -07:00
|
|
|
('tsig-keygen', 'tsig-keygen', 'TSIG key generation tool', author, 8),
|
2019-03-31 12:49:47 +02:00
|
|
|
]
|