From d06f9e4adb713c261e857c574f5b4a0f8dbfb66a Mon Sep 17 00:00:00 2001 From: Pieter Lexis Date: Fri, 19 Jan 2018 16:20:42 +0100 Subject: [PATCH] ixfrdist: add manpage --- docs/Makefile.am | 1 + docs/conf.py | 1 + docs/manpages/ixfrdist.1.rst | 39 ++++++++++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+) create mode 100644 docs/manpages/ixfrdist.1.rst diff --git a/docs/Makefile.am b/docs/Makefile.am index e5435432f..1ec5d8766 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -15,6 +15,7 @@ MANPAGES_TARGET_TOOLS = calidns.1 \ dnsscope.1 \ dnswasher.1 \ dumresp.1 \ + ixfrdist.1 \ ixplore.1 \ nproxy.1 \ nsec3dig.1 \ diff --git a/docs/conf.py b/docs/conf.py index 6ee0e1f2a..899d8e186 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -177,6 +177,7 @@ descriptions = { 'dnstcpbench': 'tool to perform TCP benchmarking of nameservers', 'dnswasher': 'A PowerDNS nameserver debugging tool', 'dumresp': 'A dumb DNS responder', + 'ixfrdist': 'An IXFR/AXFR-only server that re-distributes zones', 'ixplore': 'A tool that provides insights into IXFRs', 'nsec3dig': 'Show and validate NSEC3 proofs', 'pdns_control': 'Control the PowerDNS nameserver', diff --git a/docs/manpages/ixfrdist.1.rst b/docs/manpages/ixfrdist.1.rst new file mode 100644 index 000000000..5539950f4 --- /dev/null +++ b/docs/manpages/ixfrdist.1.rst @@ -0,0 +1,39 @@ +ixfrdist +======== + +Synopsis +-------- + +:program:`ixfrdist` [*OPTION*]... *DOMAIN* [*DOMAIN*]... + +Description +----------- + +:program:`ixfrdist` transfers zones from an authoritative server and re-serves these zones over AXFR and IXFR. +It checks the SOA serial for all *DOMAIN*\ s from the server set with **--server-address** and downloads new versions to **--work-dir**. +This working directory has the following structure: ``work-dir/ZONE/SERIAL``, e.g. ``work-dir/rpz.example./2018011902``. + +When a SOA query comes in on the address(es) set with **--listen-address**, :program:`ixfrdist` responds with the latest SOA for the zone it has. +This query can be followed up with an IXFR or AXFR query, which will then be served. +Should an IXFR be served, :program:`ixfrdist` will condense the diff into the IXFR. + +Options +------- + +--help Show all supported options +--verbose Log INFO messages +--debug Log INFO and DEBUG messages +--version Display the version of ixfrdist +--listen-address
Listen on *ADDRESS* for incoming queries. + *ADDRESS* may contain a port number, when unset 53 is assumed. + This option can be given multiple times. + When not set, 127.0.0.1:53 is assumed. +--server-address
IP address and port of the upstream server. + 127.0.0.1:5300 by default. +--work-dir Path to a directory where the AXFR data are saved. + By default, this is the current working directory. + +See also +-------- + +ixplore(1), pdns_server(1) -- 2.40.0