From: Pieter Lexis <pieter.lexis@powerdns.com>
Date: Fri, 29 Apr 2016 14:32:05 +0000 (+0200)
Subject: Add calidns manpage and add to pdns-tools
X-Git-Tag: rec-4.0.0-alpha3~19^2~23
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1e0d75dee2685020d87f7f8060dc7a52fa60c88d;p=thirdparty%2Fpdns.git

Add calidns manpage and add to pdns-tools
---

diff --git a/build-scripts/build-auth-rpm b/build-scripts/build-auth-rpm
index a1212a457f..d15af6a563 100755
--- a/build-scripts/build-auth-rpm
+++ b/build-scripts/build-auth-rpm
@@ -246,6 +246,7 @@ fi
 %{_bindir}/nsec3dig
 %{_bindir}/saxfr
 %{_bindir}/sdig
+%{_mandir}/man1/calidns.1.gz
 %{_mandir}/man1/dnsbulktest.1.gz
 %{_mandir}/man1/dnsgram.1.gz
 %{_mandir}/man1/dnsreplay.1.gz
@@ -518,6 +519,7 @@ exit 0
 %{_bindir}/nsec3dig
 %{_bindir}/saxfr
 %{_bindir}/sdig
+%{_mandir}/man1/calidns.1.gz
 %{_mandir}/man1/dnsbulktest.1.gz
 %{_mandir}/man1/dnsgram.1.gz
 %{_mandir}/man1/dnsreplay.1.gz
@@ -773,6 +775,7 @@ exit 0
 %{_bindir}/nsec3dig
 %{_bindir}/saxfr
 %{_bindir}/sdig
+%{_mandir}/man1/calidns.1.gz
 %{_mandir}/man1/dnsbulktest.1.gz
 %{_mandir}/man1/dnsgram.1.gz
 %{_mandir}/man1/dnsreplay.1.gz
diff --git a/build-scripts/debian-authoritative/pdns-tools.install b/build-scripts/debian-authoritative/pdns-tools.install
index c6d8196191..046caf0c4f 100644
--- a/build-scripts/debian-authoritative/pdns-tools.install
+++ b/build-scripts/debian-authoritative/pdns-tools.install
@@ -1,3 +1,4 @@
+usr/bin/calidns
 usr/bin/dnsbulktest
 usr/bin/dnsgram
 usr/bin/dnsreplay
diff --git a/build-scripts/debian-authoritative/pdns-tools.manpages b/build-scripts/debian-authoritative/pdns-tools.manpages
index bb90d803ba..b3e8663a4f 100644
--- a/build-scripts/debian-authoritative/pdns-tools.manpages
+++ b/build-scripts/debian-authoritative/pdns-tools.manpages
@@ -1,3 +1,4 @@
+debian/tmp/usr/share/man/man1/calidns.1
 debian/tmp/usr/share/man/man1/dnsbulktest.1
 debian/tmp/usr/share/man/man1/dnsgram.1
 debian/tmp/usr/share/man/man1/dnsreplay.1
diff --git a/docs/Makefile.am b/docs/Makefile.am
index a20c6a1716..4a6eb6bbe5 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -5,7 +5,8 @@ MANPAGES_TARGET_AUTH = pdns_server.1 \
 	zone2ldap.1 \
 	zone2sql.1
 
-MANPAGES_TARGET_TOOLS = dnsbulktest.1 \
+MANPAGES_TARGET_TOOLS = calidns.1 \
+	dnsbulktest.1 \
 	dnsgram.1 \
 	dnsreplay.1 \
 	dnsscan.1 \
diff --git a/docs/manpages/calidns.1.md b/docs/manpages/calidns.1.md
new file mode 100644
index 0000000000..ee434e42b0
--- /dev/null
+++ b/docs/manpages/calidns.1.md
@@ -0,0 +1,31 @@
+% CALIDNS(1)
+% PowerDNS.com BV
+% April 2016
+
+# NAME
+**calidns** - A DNS recursor testing tool
+
+# SYNOPSIS
+**calidns** *QUERY_FILE* *DESTINATION* *INITIAL_QPS* *HITRATE*
+
+# DESCRIPTION
+**calidns** reads queries from *QUERY_FILE* and sends them as a recursive query to
+*DESTINATION* (an IPv4 or IPv6 address, optionally with a port number), starting
+at INITIAL_QPS queries per second and aims to have a cache hitrate of *HITRATE*
+percent.
+
+It will then try to determine the maximum amount of queries per second the recursor
+can handle with the aforementioned *HITRATE*.
+
+# QUERY_FILE format
+The format of the *QUERY_FILE* is very simple, it should contain "QNAME<space>QTYPE"
+tuples, one per line. For example:
+
+powerdns.com A
+powerdns.com AAAA
+google.com A
+
+This is similar to Alexa top 1 million list.
+
+# OPTIONS
+None
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 5aacda9c76..7e2f5ee749 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -89,6 +89,7 @@ pages:
     - Documentation details: appendix/documentation.md
     - Compiling PowerDNS: appendix/compiling-powerdns.md
     - DNS Analysis Tools: tools/analysis.md
+    - 'Manpage: calidns.1': manpages/calidns.1.md
     - 'Manpage: dnsbulktest.1': manpages/dnsbulktest.1.md
     - 'Manpage: dnsgram.1': manpages/dnsgram.1.md
     - 'Manpage: dnsreplay.1': manpages/dnsreplay.1.md