From: Pieter Lexis <pieter.lexis@powerdns.com>
Date: Mon, 26 Oct 2015 19:23:37 +0000 (+0100)
Subject: ixplore: add manpage and package it in pdns-tools
X-Git-Tag: dnsdist-1.0.0-alpha1~230^2~32^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=803902a7d2ccb22cd122de2048619ea6178456ca;p=pdns

ixplore: add manpage and package it in pdns-tools
---

diff --git a/build-scripts/build-auth-rpm b/build-scripts/build-auth-rpm
index 93b74fd2a..fb79abb7b 100755
--- a/build-scripts/build-auth-rpm
+++ b/build-scripts/build-auth-rpm
@@ -228,6 +228,7 @@ fi
 %{_bindir}/dnstcpbench
 %{_bindir}/dnswasher
 %{_bindir}/dumresp
+%{_bindir}/ixplore
 %{_bindir}/notify
 %{_bindir}/nproxy
 %{_bindir}/nsec3dig
@@ -240,6 +241,7 @@ fi
 %{_mandir}/man1/dnsscope.1.gz
 %{_mandir}/man1/dnstcpbench.1.gz
 %{_mandir}/man1/dnswasher.1.gz
+%{_mandir}/man1/ixplore.1.gz
 %{_mandir}/man1/nsec3dig.1.gz
 %{_mandir}/man1/saxfr.1.gz
 %{_mandir}/man1/sdig.1.gz
@@ -490,6 +492,7 @@ exit 0
 %{_bindir}/dnstcpbench
 %{_bindir}/dnswasher
 %{_bindir}/dumresp
+%{_bindir}/ixplore
 %{_bindir}/notify
 %{_bindir}/nproxy
 %{_bindir}/nsec3dig
@@ -502,6 +505,7 @@ exit 0
 %{_mandir}/man1/dnsscope.1.gz
 %{_mandir}/man1/dnstcpbench.1.gz
 %{_mandir}/man1/dnswasher.1.gz
+%{_mandir}/man1/ixplore.1.gz
 %{_mandir}/man1/nsec3dig.1.gz
 %{_mandir}/man1/saxfr.1.gz
 %{_mandir}/man1/sdig.1.gz
diff --git a/build-scripts/debian-authoritative-semistatic/rules b/build-scripts/debian-authoritative-semistatic/rules
index d2da226f5..a33b813e0 100755
--- a/build-scripts/debian-authoritative-semistatic/rules
+++ b/build-scripts/debian-authoritative-semistatic/rules
@@ -85,7 +85,7 @@ binary-main-prepare:
 
 	#FIXME: shell loops hide errors
 	for prog in dnsbulktest dnsgram dnsreplay dnsscan dnsscope dnstcpbench dnswasher \
-		notify nproxy nsec3dig saxfr sdig ; do \
+		ixplore notify nproxy nsec3dig saxfr sdig ; do \
 		mv "$(tmpdir)"/usr/bin/$$prog "$(tools_tmpdir)"/usr/bin ; \
 		[ -e "$(tmpdir)"/usr/share/man/man8/"$$prog".8 ] && \
 			mv "$(tmpdir)"/usr/share/man/man8/"$$prog".8 "$(tools_tmpdir)"/usr/share/man/man8/ ; \
diff --git a/build-scripts/debian-authoritative/pdns-tools.install b/build-scripts/debian-authoritative/pdns-tools.install
index 5fe1e9994..2e69c1536 100644
--- a/build-scripts/debian-authoritative/pdns-tools.install
+++ b/build-scripts/debian-authoritative/pdns-tools.install
@@ -5,6 +5,7 @@ usr/bin/dnsscan
 usr/bin/dnsscope
 usr/bin/dnstcpbench
 usr/bin/dnswasher
+usr/bin/ixplore
 usr/bin/nsec3dig
 usr/bin/saxfr
 usr/bin/sdig
diff --git a/build-scripts/debian-authoritative/pdns-tools.manpages b/build-scripts/debian-authoritative/pdns-tools.manpages
index 1be4dc2a3..bb90d803b 100644
--- a/build-scripts/debian-authoritative/pdns-tools.manpages
+++ b/build-scripts/debian-authoritative/pdns-tools.manpages
@@ -5,5 +5,6 @@ debian/tmp/usr/share/man/man1/dnsscan.1
 debian/tmp/usr/share/man/man1/dnsscope.1
 debian/tmp/usr/share/man/man1/dnstcpbench.1
 debian/tmp/usr/share/man/man1/dnswasher.1
+debian/tmp/usr/share/man/man1/ixplore.1
 debian/tmp/usr/share/man/man1/nsec3dig.1
 debian/tmp/usr/share/man/man1/saxfr.1
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 95337cc01..4cef06922 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -11,6 +11,7 @@ MANPAGES_TARGET_TOOLS = dnsbulktest.1 \
 	dnsscope.1 \
 	dnstcpbench.1 \
 	dnswasher.1 \
+	ixplore.1 \
 	nsec3dig.1 \
 	saxfr.1 \
 	sdig.1
diff --git a/docs/manpages/ixplore.1.md b/docs/manpages/ixplore.1.md
new file mode 100644
index 000000000..da9b2c617
--- /dev/null
+++ b/docs/manpages/ixplore.1.md
@@ -0,0 +1,53 @@
+% IXPLORE(1)
+% Pieter Lexis (pieter.lexis@powerdns.com)
+% October 2015
+
+# NAME
+**ixplore** - A tool that provides insights into IXFRs
+
+# SYNOPSIS
+**ixplore** *COMMAND* *COMMAND_OPT*...
+
+**ixplore** diff *ZONE* *BEFORE* *AFTER*
+
+**ixplore** track *IP ADDRESS* *PORT* *ZONE* *DIRECTORY*
+
+# DESCRIPTION
+**ixplore** is a tool to work with IXFR (incremental zonetransfers)  in two modes
+(specified by *COMMAND*): diff or track.
+
+In the 'diff' mode, it will show a diff(1)-like output between *BEFORE* and *AFTER*.
+
+In the 'track' mode, **ixplore** consumes IXFRs from *IP ADDRESS* and writes the
+resulting zonefiles out to *DIRECTORY*/*ZONE*-serial. If no initial zonefiles
+exist, an initial AXFR will be done first. **ixplore** will then check the SOA
+serial on *IP ADDRESS* for *ZONE* every SOA Refresh seconds and perform an IXFR
+if the serial has increased.
+
+# OPTIONS
+## diff-mode
+ZONE
+:    The name of the zone the IXFRs are consumed from.
+
+BEFORE
+:    Path to the 'before' zonefile.
+
+AFYER
+:    Path to the 'after' zonefile.
+
+
+## track-mode
+IP ADDRESS
+:    The IP address to consume IXFRs from.
+
+PORT
+:    The port to use on *IP ADDRESS*.
+
+ZONE
+:    Name of the zone to track changes of.
+
+DIRECTORY
+:    Directory where the zonefiles will be stored.
+
+# SEE ALSO
+diff(1)