From e9046dbc6fd888fa706316797a4efcf2cc46216d Mon Sep 17 00:00:00 2001 From: Pieter Lexis Date: Tue, 2 Dec 2014 08:45:53 +0100 Subject: [PATCH] Port manpages to MarkDown and use autotools Shout out to @rubenk for helping with autotools. * Add disable-dnssec to pdnssec docs (closes #641) * Make manpages consistent with eachother * Expanded missing options * Removed old manpages * Added --with-docs and --with-manpages configure switches * Build manpages and docs in travis. * Add both the built docs/manpages and sources to dist tarball * Build docs to pdsn/docs/html (instead of html-new) * Remove all references to asciidoc * Distribute both the source files and built docs + manpages in the tarball created with `make dist` * Move all manpages to section 1 (closes #1753) --- .travis.yml | 3 +- Makefile.am | 28 +-- configure.ac | 6 +- debian/control | 2 +- m4/pdns_check_mkdocs.m4 | 10 + m4/pdns_check_pandoc.m4 | 10 + pdns/Makefile.am | 10 - pdns/docs/.gitignore | 9 +- pdns/docs/Makefile | 29 --- pdns/docs/Makefile.am | 41 ++++ pdns/docs/dnsreplay.8 | 47 ----- pdns/docs/dnsscope.8 | 14 -- pdns/docs/dnstcpbench.1.txt | 87 -------- pdns/docs/dnswasher.8 | 17 -- .../{dnsdist.1.txt => manpages/dnsdist.1.md} | 68 +++--- pdns/docs/manpages/dnsreplay.1.md | 59 ++++++ pdns/docs/manpages/dnsscope.1.md | 45 ++++ pdns/docs/manpages/dnstcpbench.1.md | 68 ++++++ pdns/docs/manpages/dnswasher.1.md | 21 ++ pdns/docs/manpages/pdns_control.1.md | 92 ++++++++ pdns/docs/manpages/pdns_recursor.1.md | 173 ++++++++++++++++ pdns/docs/manpages/pdns_server.1.md | 40 ++++ pdns/docs/manpages/pdnssec.1.md | 196 ++++++++++++++++++ pdns/docs/manpages/rec_control.1.md | 129 ++++++++++++ pdns/docs/manpages/zone2ldap.1.md | 45 ++++ pdns/docs/manpages/zone2sql.1.md | 68 ++++++ pdns/docs/markdown/authoritative/dnssec.md | 3 +- pdns/docs/mkdocs.yml | 2 +- pdns/docs/pdns_control.8 | 116 ----------- pdns/docs/pdns_recursor.1.txt | 188 ----------------- pdns/docs/pdns_server.8 | 33 --- pdns/docs/pdnssec.8 | 97 --------- pdns/docs/process-md.sh | 2 +- pdns/docs/rec_control.1.txt | 150 -------------- pdns/docs/zone2ldap.8 | 76 ------- pdns/docs/zone2sql.8 | 64 ------ 36 files changed, 1039 insertions(+), 1009 deletions(-) create mode 100644 m4/pdns_check_mkdocs.m4 create mode 100644 m4/pdns_check_pandoc.m4 delete mode 100644 pdns/docs/Makefile create mode 100644 pdns/docs/Makefile.am delete mode 100644 pdns/docs/dnsreplay.8 delete mode 100644 pdns/docs/dnsscope.8 delete mode 100644 pdns/docs/dnstcpbench.1.txt delete mode 100644 pdns/docs/dnswasher.8 rename pdns/docs/{dnsdist.1.txt => manpages/dnsdist.1.md} (56%) create mode 100644 pdns/docs/manpages/dnsreplay.1.md create mode 100644 pdns/docs/manpages/dnsscope.1.md create mode 100644 pdns/docs/manpages/dnstcpbench.1.md create mode 100644 pdns/docs/manpages/dnswasher.1.md create mode 100644 pdns/docs/manpages/pdns_control.1.md create mode 100644 pdns/docs/manpages/pdns_recursor.1.md create mode 100644 pdns/docs/manpages/pdns_server.1.md create mode 100644 pdns/docs/manpages/pdnssec.1.md create mode 100644 pdns/docs/manpages/rec_control.1.md create mode 100644 pdns/docs/manpages/zone2ldap.1.md create mode 100644 pdns/docs/manpages/zone2sql.1.md delete mode 100644 pdns/docs/pdns_control.8 delete mode 100644 pdns/docs/pdns_recursor.1.txt delete mode 100644 pdns/docs/pdns_server.8 delete mode 100644 pdns/docs/pdnssec.8 delete mode 100644 pdns/docs/rec_control.1.txt delete mode 100644 pdns/docs/zone2ldap.8 delete mode 100644 pdns/docs/zone2sql.8 diff --git a/.travis.yml b/.travis.yml index 6d39ba7b8..b030071d6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,7 +8,7 @@ before_script: - sudo /sbin/ip addr add 1.2.3.4/32 dev lo - sudo rm -f /etc/apt/sources.list.d/travis_ci_zeromq3-source.list - sudo apt-get update --quiet --quiet - - sudo apt-get install --quiet --quiet --no-install-recommends libboost-all-dev libtolua-dev bc libcdb-dev libnet-dns-perl unbound-host ldnsutils dnsutils bind9utils libtool libcdb-dev xmlto links asciidoc ruby-json ruby-sqlite3 rubygems libcurl4-openssl-dev ruby1.9.1 socat time pkg-config daemontools authbind liblua5.1-posix1 libopendbx1-dev libopendbx1-sqlite3 python-virtualenv libldap2-dev softhsm libp11-kit-dev p11-kit moreutils libgeoip-dev geoip-database faketime + - sudo apt-get install --quiet --quiet --no-install-recommends libboost-all-dev libtolua-dev bc libcdb-dev libnet-dns-perl unbound-host ldnsutils dnsutils bind9utils libtool libcdb-dev xmlto links ruby-json ruby-sqlite3 rubygems libcurl4-openssl-dev ruby1.9.1 socat time pkg-config daemontools authbind liblua5.1-posix1 libopendbx1-dev libopendbx1-sqlite3 python-virtualenv libldap2-dev softhsm libp11-kit-dev p11-kit moreutils libgeoip-dev geoip-database faketime - sudo sh -c 'sed s/precise/trusty/g /etc/apt/sources.list > /etc/apt/sources.list.d/trusty.list' - sudo apt-get update --quiet --quiet - sudo apt-get install --quiet --quiet liblmdb0 liblmdb-dev lmdb-utils libyaml-cpp-dev libzmq3-dev pandoc @@ -49,7 +49,6 @@ script: - make -k -j 4 - cd .. - ln -s pdns-recursor*/pdns_recursor . - - make -k -C docs html-new/index.html manpages - cd ../regression-tests.recursor - cp vars.sample vars - ./config.sh diff --git a/Makefile.am b/Makefile.am index 86f7c394c..38fd09771 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = modules codedocs +SUBDIRS = modules codedocs pdns/docs if WITH_PDNS_SERVER SUBDIRS += pdns @@ -16,37 +16,11 @@ EXTRA_DIST = \ contrib/systemd-pdns.service \ debian \ pdns.spec \ - pdns/docs/dnsdist.1 \ - pdns/docs/dnstcpbench.1 \ pdns/named.conf.parsertest \ regression-tests/zones/unit.test ACLOCAL_AMFLAGS = -I m4 -man8_MANS = \ - pdns/docs/pdns_control.8 \ - pdns/docs/pdns_server.8 \ - pdns/docs/pdnssec.8 \ - pdns/docs/zone2ldap.8 \ - pdns/docs/zone2sql.8 - -if TOOLS -man8_MANS += \ - pdns/docs/dnsreplay.8 \ - pdns/docs/dnsscope.8 \ - pdns/docs/dnswasher.8 - -man1_MANS = \ - pdns/docs/dnsdist.1 \ - pdns/docs/dnstcpbench.1 -endif - -pdns/docs/dnstcpbench.1: - cd pdns/docs && $(MAKE) dnstcpbench.1 - -pdns/docs/dnsdist.1: - cd pdns/docs && $(MAKE) dnsdist.1 - install-exec-local: -@chmod +x pdns/pdns.init @echo "***********************************************************" diff --git a/configure.ac b/configure.ac index 19cda8696..29894fbf8 100644 --- a/configure.ac +++ b/configure.ac @@ -78,7 +78,6 @@ AC_CHECK_HEADERS( ) PDNS_CHECK_RAGEL -AC_CHECK_PROG([ASCIIDOC], [asciidoc], [asciidoc]) PDNS_WITH_LUA @@ -101,6 +100,9 @@ AS_IF([test "x$with_sqlite3" != "xno"], [ needsqlite3=yes ]) +PDNS_CHECK_PANDOC +PDNS_CHECK_MKDOCS + dnl Checks for typedefs, structures, and compiler characteristics. AC_TYPE_SIZE_T @@ -330,12 +332,14 @@ AC_SUBST([AM_CPPFLAGS], AC_SUBST([YAHTTP_CFLAGS], ['-I$(top_srcdir)/pdns/ext/yahttp']) AC_SUBST([YAHTTP_LIBS], ['-L$(top_builddir)/pdns/ext/yahttp/yahttp -lyahttp']) + AC_CONFIG_FILES([ Makefile modules/Makefile pdns/Makefile codedocs/Makefile pdns/pdns.init + pdns/docs/Makefile pdns/ext/Makefile pdns/ext/yahttp/Makefile pdns/ext/yahttp/yahttp/Makefile diff --git a/debian/control b/debian/control index ad5c6c292..10614ddb8 100644 --- a/debian/control +++ b/debian/control @@ -3,7 +3,7 @@ Section: net Priority: extra Standards-Version: 3.5.8 Maintainer: bert hubert -Build-Depends: autoconf, libtool, flex, bison, docbook-utils, libmysqlclient-dev, postgresql-dev | libpq-dev, tdb-dev, libgdbm-dev, libldap2-dev, libsqlite3-dev, dpkg-dev (>= 1.10.17), libboost-dev (>=1.34), libboost-program-options-dev, libboost-serialization-dev, pkg-config, ragel, libbotan1.10-dev, liblua5.1-dev, asciidoc +Build-Depends: autoconf, libtool, flex, bison, docbook-utils, libmysqlclient-dev, postgresql-dev | libpq-dev, tdb-dev, libgdbm-dev, libldap2-dev, libsqlite3-dev, dpkg-dev (>= 1.10.17), libboost-dev (>=1.34), libboost-program-options-dev, libboost-serialization-dev, pkg-config, ragel, libbotan1.10-dev, liblua5.1-dev Package: pdns-static Architecture: any diff --git a/m4/pdns_check_mkdocs.m4 b/m4/pdns_check_mkdocs.m4 new file mode 100644 index 000000000..dbea24c2d --- /dev/null +++ b/m4/pdns_check_mkdocs.m4 @@ -0,0 +1,10 @@ +AC_DEFUN([PDNS_CHECK_MKDOCS], [ + AC_REQUIRE([AC_PROG_EGREP]) + AC_CHECK_PROG([MKDOCS], [mkdocs], [yes], [no]) + + AS_IF([test "x$MKDOCS" = "xno"], [ + AS_IF([test ! -d "$scrdir/pdns/docs/html" ], + [AC_MSG_WARN([mkdocs is missing, unable to build documentation.])] + ) + ]) +]) diff --git a/m4/pdns_check_pandoc.m4 b/m4/pdns_check_pandoc.m4 new file mode 100644 index 000000000..d30c54131 --- /dev/null +++ b/m4/pdns_check_pandoc.m4 @@ -0,0 +1,10 @@ +AC_DEFUN([PDNS_CHECK_PANDOC], [ + AC_CHECK_PROG([PANDOC], [pandoc], [yes], [no]) + AC_REQUIRE([AC_PROG_EGREP]) + + AS_IF([test "x$PANDOC" = "xno"], [ + AS_IF([test ! -d "$srcdir/pdns/docs/html" -o ! -f "$srcdir/pdns/docs/pdns_server.1"], + [AC_MSG_WARN([pandoc is missing, unable to build documentation and manpages.])] + ) + ]) +]) diff --git a/pdns/Makefile.am b/pdns/Makefile.am index f86aaba87..3e92a633c 100644 --- a/pdns/Makefile.am +++ b/pdns/Makefile.am @@ -36,16 +36,6 @@ EXTRA_DIST = \ dnslabeltext.cc \ mtasker.cc \ inflighter.cc \ - docs/pdns_control.8 \ - docs/pdns_server.8 \ - docs/zone2sql.8 \ - docs/zone2ldap.8 \ - docs/pdnssec.8 \ - docs/dnsreplay.8 \ - docs/dnsscope.8 \ - docs/dnswasher.8 \ - docs/pdnssec.8 \ - docs/zone2ldap.8 \ bind-dnssec.schema.sqlite3.sql \ bindparser.h \ named.conf.parsertest \ diff --git a/pdns/docs/.gitignore b/pdns/docs/.gitignore index ee585bb42..0a0ffb791 100644 --- a/pdns/docs/.gitignore +++ b/pdns/docs/.gitignore @@ -1,13 +1,12 @@ -/dnstcpbench.1 /html /pdns /pdns.pdf /pdns.txt /html.tar.bz2 /pdns-expanded.xml -/pdns_recursor.1 -/rec_control.1 /pdns-expanded.html -/dnsdist.1 -/html-new +/html /doc-build +/*.[0-9] +/Makefile +/Makefile.in diff --git a/pdns/docs/Makefile b/pdns/docs/Makefile deleted file mode 100644 index 6880ee371..000000000 --- a/pdns/docs/Makefile +++ /dev/null @@ -1,29 +0,0 @@ -# $Id$ - -all: html-new/index.html manpages - -clean: - rm -rf *.dvi *.pdf *.tex *.toc *.aux *.ps *.bak *.tmp *~ *.log pdns.txt html.tar.bz2 html pdns pdns-expanded.html pdns-expanded.xml pdns_recursor.1 rec_control.1 html-new/* - -manpages: dnsdist.1 pdns_recursor.1 rec_control.1 dnstcpbench.1 - -html-new/index.html: process-md.sh mkdocs.yml markdown/** markdown/*/** - rm -rf html-new/* - mkdir -p html-new - mkdir -p doc-build - rsync -a --delete markdown/. doc-build/. - ./process-md.sh pre - mkdocs build --clean - ./process-md.sh post - -%1.xml: %1.txt - asciidoc -b docbook -d manpage $< - -%.1: %.1.xml - xmlto man $< - -%.html: %1.txt - asciidoc -b xhtml11 -d manpage $< - -publish3: - rsync -crv ./html-new/ pdnsdocs@xs.powerdns.com:md/ diff --git a/pdns/docs/Makefile.am b/pdns/docs/Makefile.am new file mode 100644 index 000000000..81b652cb4 --- /dev/null +++ b/pdns/docs/Makefile.am @@ -0,0 +1,41 @@ +MANPAGES_TARGET = dnsdist.1 \ + dnsreplay.1 \ + dnsscope.1 \ + dnstcpbench.1 \ + dnswasher.1 \ + pdns_control.1 \ + pdns_recursor.1 \ + pdnssec.1 \ + pdns_server.1 \ + rec_control.1 \ + zone2ldap.1 \ + zone2sql.1 + +man_MANS = $(MANPAGES_TARGET) + +EXTRA_DIST = manpages \ + markdown \ + $(MANPAGES_TARGET) \ + html + +.PHONY: html +html: html/index.html + +html/index.html: process-md.sh mkdocs.yml markdown/** markdown/*/** + mkdir -p doc-build + rsync -a --delete markdown/. doc-build/. + ./process-md.sh pre + mkdocs build --clean + ./process-md.sh post + +.PHONY: manpages +manpages: $(MANPAGES_TARGET) + +$(MANPAGES_TARGET): %: manpages/%.md + pandoc -s -t man $< -o $@ + +clean: + rm -rf html *.8 *.1 + +publish3: + rsync -crv ./html/ pdnsdocs@xs.powerdns.com:md/ diff --git a/pdns/docs/dnsreplay.8 b/pdns/docs/dnsreplay.8 deleted file mode 100644 index 638a1746d..000000000 --- a/pdns/docs/dnsreplay.8 +++ /dev/null @@ -1,47 +0,0 @@ -.TH DNSREPLAY 8 "September 2012" "PowerDNS" -.SH NAME -dnsreplay \- A PowerDNS nameserver debugging tool -.SH SYNOPSIS -.B dnsreplay \fI[options]\fR \fIfilename\fR \fIip-address\fR \fI[port]\fR -.SH DESCRIPTION -This program takes recorded questions and answers and replays them to a specified -nameserver and reporting afterwards which percentage of answers matched, were worse or better. - -\fIfilename\fR is expected to be an PCAP file. -The queries are send to the DNS server specified as \fIip-address\fR and \fI[port]\fR. -\fIip-address\fR is mandatory. If \fI[port]\fR is omitted, 53 will be used. -dnsreplay compares the answers and some other metrics with the actual ones with those found in the dumpfile. - -By default it only replay queries with recursion-desired flag set. -.SH OPTIONS -.TP -.B \-\-help | \-h -.br -Show summary of options. -.TP -.B \-\-packet\-limit \fInum\fR -.br -Stop after replaying \fInum\fR packets. Default for \fInum\fR is 0, which means no limit. -.TP -.B \-\-quiet \fIflag\fR -.br -If \fIflag\fR is set to 1. dnsreplay will not be very noisy with its output. This is the default. -.TP -.B \-\-recursive \fIflag\fR -.br -If \fIflag\fR is set to 1. dnsreplay will only replay queries with recursion desired flag set. This is the default. -.TP -.B \-\-speedup \fIfactor\fR -.br -Replay queries with this speedup factor. Default is 1. -.TP -.B \-\-timeout-msec \fItime\fR -.br -Wait at least this many milliseconds for a reply. Default is 500. -.SH BUGS -dnsreplay has no certain handling for timeouts. It handles around at most 65536 outstanding answers. -.SH SEE ALSO -pcap(3PCAP), tcpdump(8), dnswascher(8) -.SH AUTHORS -This manpage was written by Joerg Jungermann (jj+debian At borkum.net) for the -Debian Project and the PowerDNS versatile DNS server. diff --git a/pdns/docs/dnsscope.8 b/pdns/docs/dnsscope.8 deleted file mode 100644 index a50e13ae8..000000000 --- a/pdns/docs/dnsscope.8 +++ /dev/null @@ -1,14 +0,0 @@ -.TH DNSSCOPE 8 "September 2012" "PowerDNS" -.SH NAME -dnsscope \- A PowerDNS nameserver debugging tool -.SH SYNOPSIS -.B dnsscope \fI[infile]\fR -.SH DESCRIPTION -dnsscope takes an \fIinfile\fR in PCAP format. It generates some simple statistics outputs these to STDOUT. -.SH OPTIONS -None. -.SH SEE ALSO -pcap(3PCAP), tcpdump(8) -.SH AUTHORS -This manpage was written by Joerg Jungermann (jj+debian At borkum.net) for the -Debian Project and the PowerDNS versatile DNS server. diff --git a/pdns/docs/dnstcpbench.1.txt b/pdns/docs/dnstcpbench.1.txt deleted file mode 100644 index c966d4621..000000000 --- a/pdns/docs/dnstcpbench.1.txt +++ /dev/null @@ -1,87 +0,0 @@ -DNSTCPBENCH(1) -============== - -NAME ----- -dnstcpbench - tool to perform TCP benchmarking of nameservers - -SYNOPSIS --------- -'dnstcpbench' [--help] [--file=filename] [--verbose] [--udp-first, -u] [--workers] [--timeout-msec] remote-ip-address [remote-port] - -DESCRIPTION ------------ -dnstcpbench reads DNS queries (by default from standard input) and sends -them out in parallel to a remote nameserver. By default TCP/IP is used, but -optionally, UDP is tried first, which allows for the benchmarking of TCP/IP -fallback. - -The input format is one query per line: qname single-space qtype. An -example: - www.powerdns.com ANY - powerdns.com MX - -When benchmarking extended runs, it may be necessary to enable TIME_WAIT -recycling, as TCP/IP port tuples may otherwise run out. On Linux this is -performed by running: - - # echo 1 > /proc/sys/net/ipv4/tcp_tw_recycle - -The equivalent for IPv6 is not known. - - -OPTIONS -------- - --f,--file:: - Filename from which to read queries. Defaults to standard input if - unspecified. - --h,--help:: - Provide a helpful message - ---timeout-msec:: - Number of milliseconds to wait for an answer - ---udp-first, -u:: - Attempt resolution via UDP first, only do TCP if truncated answer is - received - --v,--verbose:: - Be wordy on what the program is doing - ---workers:: - Number of parallel worker threads to use. - - -Remote IP address can be IPv4 or IPv6. Remote port defaults to 53. - -STATISTICAL OUTPUT ------------------- -The program reports both mean and median numbers for queries per second and -UDP and TCP latency. Each query only counts once, even if it is tried over -UDP first. This effectively means that passing '-u' can lower query rates if -many queries get shunted to TCP. - -BUGS ----- -Currently the timeout code does not actually perform non-blocking connects -or writes. So a slow connect or slow writes will still cause low -performance and delays. - -Median queries per second statistics are reported as 0 for sub-second runs. - -AUTHOR ------- -Written by PowerDNS.COM BV, bert hubert, - -RESOURCES ---------- -Website: http://www.powerdns.com - -COPYING -------- -Copyright (C) 2013 PowerDNS.COM BV. Free use of this software -is granted under the terms of the GNU General Public License (GPL) version -2. - diff --git a/pdns/docs/dnswasher.8 b/pdns/docs/dnswasher.8 deleted file mode 100644 index 39af22b83..000000000 --- a/pdns/docs/dnswasher.8 +++ /dev/null @@ -1,17 +0,0 @@ -.TH DNSWASHER 8 "September 2012" "PowerDNS" -.SH NAME -dnswasher \- A PowerDNS nameserver debugging tool -.SH SYNOPSIS -.B dnswasher \fI[infile]\fR \fI[outfile]\fR -.SH DESCRIPTION -dnswasher takes an \fIinfile\fR in PCAP format and writtes out \fIoutfile\fR -also in PCAP format. It copies all network traffic found in \fIinfile\fR to \fIoutfile\fR -except for non DNS traffic. -This might be handy when creating bug reports or test cases for DNS software e.g. PowerDNS. -.SH OPTIONS -None. -.SH SEE ALSO -pcap(3PCAP), tcpdump(8) -.SH AUTHORS -This manpage was written by Joerg Jungermann (jj+debian At borkum.net) for the -Debian Project and the PowerDNS versatile DNS server. diff --git a/pdns/docs/dnsdist.1.txt b/pdns/docs/manpages/dnsdist.1.md similarity index 56% rename from pdns/docs/dnsdist.1.txt rename to pdns/docs/manpages/dnsdist.1.md index 77b6c7d5a..5c0e12d21 100644 --- a/pdns/docs/dnsdist.1.txt +++ b/pdns/docs/manpages/dnsdist.1.md @@ -1,17 +1,15 @@ -DNSDIST(1) -========== +% DNSDIST(1) +% PowerDNS.com BV +% 2013 -NAME ----- -dnsdist - tool to balance DNS queries over downstream servers +# NAME +**dnsdist** - tool to balance DNS queries over downstream servers -SYNOPSIS --------- -'dnsdist' [--help] [--verbose] [--local address] downstream-address downstream-address +# SYNOPSIS +dnsdist [*OPTION*]... *ADDRESS*... -DESCRIPTION ------------ -dnsdist receives DNS queries and relays them to one or more downstream +# DESCRIPTION +**dnsdist** receives DNS queries and relays them to one or more downstream servers. It subsequently sends back responses to the original requestor. dnsdist operates over TCP and UDP, and strives to deliver very high @@ -28,8 +26,7 @@ traffic. IPv4 and IPv6 operation can be mixed and matched, in other words, queries coming in over IPv6 could be forwarded to IPv4 and vice versa. -SCOPE ------ +# SCOPE dnsdist does not 'think' about DNS, and does not perform any kind of caching, nor is it aware of the quality of the answers it is relaying. @@ -40,39 +37,26 @@ The goal for dnsdist is to remain simple. If more powerful loadbalancing is required, dedicated hardware or software is recommended. Linux Virtual Server for example is often mentioned. -OPTIONS -------- +# OPTIONS +--help +: Show a brief summary of the options. ---verbose:: - Be wordy on what the program is doing +--verbose +: Be wordy on what the program is doing ---local:: - Supply as many addresses to listen on as required. Specify IPv4 as - 0.0.0.0:53 and IPv6 as [::]:53. +--local *ADDRESS* +: Bind to ADDRESS, Supply as many addresses (using multiple **--local** + statements) to listen on as required. Specify IPv4 as 0.0.0.0:53 and IPv6 + as [::]:53. ---daemon:: - Daemonize and run in the background +--daemon +: Daemonize and run in the background ---help:: - Provide a helpful message +Finally, supply as many downstream addresses as required. Remote port defaults +to 53. -Finally, supply as many downstream addresses as required. Remote port defaults to 53. +# BUGS +Right now, the TCP support has some rather arbitrary limits. -BUGS ----- -Right now, the TCP support has some rather arbitrary limits. - -AUTHOR ------- -Written by PowerDNS.COM BV, powerdns.documentation@powerdns.com - -RESOURCES ---------- +# RESOURCES Website: http://www.powerdns.com - -COPYING -------- -Copyright (C) 2013 PowerDNS.COM BV. Free use of this software -is granted under the terms of the GNU General Public License (GPL) version -2. - diff --git a/pdns/docs/manpages/dnsreplay.1.md b/pdns/docs/manpages/dnsreplay.1.md new file mode 100644 index 000000000..36887687b --- /dev/null +++ b/pdns/docs/manpages/dnsreplay.1.md @@ -0,0 +1,59 @@ +% DNSREPLAY(8) +% Joerg Jungermann (jj+debian At borkum.net) +% September 2012 + +# NAME +**dnsreplay** - A PowerDNS nameserver debugging tool + +# SYNOPSIS +**dnsreplay** [*OPTION*]... *FILENAME* *ADDRESS* [*PORT*] + +# DESCRIPTION +This program takes recorded questions and answers and replays them to the +specified nameserver and reporting afterwards which percentage of answers +matched, were worse or better. + +dnsreplay compares the answers and some other metrics with the actual ones with +those found in the dumpfile. + +By default it only replay queries with recursion-desired flag set. + +# OPTIONS +FILENAME +: is expected to be an PCAP file. + The queries are send to the DNS server specified as *ADDRESS* and + *PORT*. + +ADDRESS +: IPv4 or IPv6 address of the nameserver to replay *FILENAME* to. + +PORT +: if omitted, 53 will be used. + +--help | -h +: Show summary of options. + +--packet-limit *NUM* +: Stop after replaying *NUM* packets. Default for *NUM* is 0, which means no + limit. + +--quiet *FLAG* +: If *FLAG* is set to 1. dnsreplay will not be very noisy with its output. + This is the default. + +--recursive *FLAG* +: If *FLAG* is set to 1. dnsreplay will only replay queries with recursion + desired flag set. This is the default. + +--speedup *FACTOR* +: Replay queries with this speedup *FACTOR*. Default is 1. + +--timeout-msec *MSEC* +: Wait at least *MSEC* milliseconds for a reply. Default is 500. + +# BUGS +dnsreplay has no certain handling for timeouts. It handles around at most 65536 +outstanding answers. + +# SEE ALSO +pcap(3PCAP), tcpdump(8), dnswascher(8) diff --git a/pdns/docs/manpages/dnsscope.1.md b/pdns/docs/manpages/dnsscope.1.md new file mode 100644 index 000000000..1ddd8508f --- /dev/null +++ b/pdns/docs/manpages/dnsscope.1.md @@ -0,0 +1,45 @@ +% DNSSCOPE(8) +% Joerg Jungermann (jj+debian At borkum.net) +% September 2012 + +# NAME +**dnsscope** - A PowerDNS nameserver debugging tool + +# SYNOPSIS +**dnsscope** [*OPTION*]... *INFILE* + +# DESCRIPTION +**dnsscope** takes an *INFILE* in PCAP format. It generates some simple +statistics outputs these to STDOUT. + +# OPTIONS +INFILE +: Path to a PCAP file. + +-h | --help +: Show the help. + +--rd +: Only process packets in *INFILE* with the RD (Recursion Desired) flag set. + By default, we process all DNS packets in *INFILE*. + +--ipv4 +: Process IPv4 packets. On by default, disable with **--ipv4 false**. + +--ipv6 +: Process IPv6 packets. On by default, disable with **--ipv6 false**. + +--servfail-tree +: Figure out subtrees that generate servfails. + +-l | --load-stats +: Emit per-second load statistics (questions, answers, outstanding). + +-w | --write-failures *FILENAME* +: Write weird packets to a PCAP file at *FILENAME*. + +-v | --verbose +: Be more verbose. + +# SEE ALSO +pcap(3PCAP), tcpdump(8) diff --git a/pdns/docs/manpages/dnstcpbench.1.md b/pdns/docs/manpages/dnstcpbench.1.md new file mode 100644 index 000000000..b8adcf0f1 --- /dev/null +++ b/pdns/docs/manpages/dnstcpbench.1.md @@ -0,0 +1,68 @@ +% DNSTCPBENCH(1) +% PowerDNS.COM BV - Bert Hubert +% July 2013 + +# NAME +**dnstcpbench** - tool to perform TCP benchmarking of nameservers + +# SYNOPSIS +**dnstcpbench** [*OPTION*]... *REMOTE-ADDRESS* [*REMOTE-PORT*] + +# DESCRIPTION +**dnstcpbench** reads DNS queries (by default from standard input) and sends +them out in parallel to a remote nameserver. By default TCP/IP is used, but +optionally, UDP is tried first, which allows for the benchmarking of TCP/IP +fallback. + +The program reports both mean and median numbers for queries per second and +UDP and TCP latency. Each query only counts once, even if it is tried over +UDP first. This effectively means that passing '-u' can lower query rates if +many queries get shunted to TCP. + +The input format is one query per line: qname single-space qtype. An +example: + +www.powerdns.com ANY + +When benchmarking extended runs, it may be necessary to enable TIME_WAIT +recycling, as TCP/IP port tuples may otherwise run out. On Linux this is +performed by running: + +echo 1 > /proc/sys/net/ipv4/tcp_tw_recycle + +The equivalent for IPv6 is not known. + +# OPTIONS +-f | --file *FILENAME* +: *FILENAME* from which to read queries. Defaults to standard input if + unspecified. + +-h | --help +: Provide a helpful message. + +--timeout-msec *MSEC* +: *MSEC* milliseconds to wait for an answer. + +-u | --udp-first +: Attempt resolution via UDP first, only do TCP if truncated answer is + received. + +-v | --verbose +: Be wordy on what the program is doing. + +--workers *NUM* +: Use *NUM* parallel worker threads. + + +REMOTE-ADDRESS +: IPv4 or IPv6 to test against. + +REMOTE-PORT +: Port to test against, defaults to 53. + +# BUGS +Currently the timeout code does not actually perform non-blocking connects +or writes. So a slow connect or slow writes will still cause low +performance and delays. + +Median queries per second statistics are reported as 0 for sub-second runs. diff --git a/pdns/docs/manpages/dnswasher.1.md b/pdns/docs/manpages/dnswasher.1.md new file mode 100644 index 000000000..08af37ffe --- /dev/null +++ b/pdns/docs/manpages/dnswasher.1.md @@ -0,0 +1,21 @@ +% DNSWASHER(8) +% Joerg Jungermann (jj+debian At borkum.net) +% September 2012 + +# NAME +**dnswasher** - A PowerDNS nameserver debugging tool + +# SYNOPSIS +**dnswasher** *INFILE* *OUTFILE* + +# DESCRIPTION +dnswasher takes an *INFILE* in PCAP format and writes out *OUTFILE* also in +PCAP format. It copies all network traffic found in *INFILE* to *OUTFILE* +except for non DNS traffic. This might be handy when creating bug reports or +test cases for DNS software e.g. PowerDNS. + +# OPTIONS +None + +# SEE ALSO +pcap(3PCAP), tcpdump(8) diff --git a/pdns/docs/manpages/pdns_control.1.md b/pdns/docs/manpages/pdns_control.1.md new file mode 100644 index 000000000..e4edb8c36 --- /dev/null +++ b/pdns/docs/manpages/pdns_control.1.md @@ -0,0 +1,92 @@ +% PDNS_CONTROL(8) +% PowerDNS.com BV +% December 2002 + +# NAME +**pdns_control** - Contreol the PowerDNS nameserver + +# SYNOPSIS +**pdns_control** [*OPTION*]... *COMMAND* + +# DESCRIPTION +**pdns_control** is used to send commands to a running PowerDNS nameserver. + +# OPTIONS +--help +: Show summary of options. + +--chroot=*DIR* +: Directory where PowerDNS is chrooted. + +--config-dir=*DIR* +: Location of configuration directory (pdns.conf). + +--config-name=*NAME* +: Name of this virtual configuration - will rename the binary image. + +--remote-address=*ADDRESS* +: Remote address to query. + +--remote-port=*PORT* +: Remote port to query. + +--secret=*SECRET* +: Secret needed to connect to remote PowerDNS. + +--socket-dir=*DIR* +: Where the controlsocket lives. + + +# COMMANDS +ccounts +: Show the content of the cache + +cycle +: Restart the nameserver so it reloads its configuration. Only works when the + server is running in guardian mode. + +notify *DOMAIN* +: Adds *DOMAIN* to the notification list, causing PDNS to send out + notifications to the nameservers of a domain. Can be used if a slave missed + previous notifications or is generally hard of hearing. + +notify-host *DOMAIN* *HOST* +: Same as above but with operator specified IP address as destination, to be + used if you know better than PowerDNS. + +ping +: Check if the server is alive. + +purge [*RECORD*] +: Purge entries from the packet cache. If *RECORD* ends with a dollar ($) + all entries that end with that name are removed. If no record is specified + the entire cache is purged. + +quit +: Tell a running pdns_server to quit. + +rediscover +: Instructs backends that new domains may have appeared in the database, or, + in the case of the Bind backend, in named.conf. + +retrieve *DOMAIN* +: Retrieve slave *DOMAIN* from its master. Done nearly immediately. + +set *VARIABLE* *VALUE* +: Set the configuration parameter *VARIABLE* to *VALUE*. Currently only the + query-logging can be set. + +show *VARIABLE* +: Show a single statistic, as present in the output of the list command. + +status +: Show usage statistics. + +uptime +: Show the uptime of the running server. + +version +: Print the version of the running pdns daemon. + +# SEE ALSO +pdns_server(8) diff --git a/pdns/docs/manpages/pdns_recursor.1.md b/pdns/docs/manpages/pdns_recursor.1.md new file mode 100644 index 000000000..fc53fa317 --- /dev/null +++ b/pdns/docs/manpages/pdns_recursor.1.md @@ -0,0 +1,173 @@ +% PDNS_RECURSOR(1) +% PowerDNS.COM BV - Bert Hubert +% March 2008 + +# NAME +**pdns_recursor** - high-performance, simple and secure recursing nameserver + +# SYNOPSIS +**pdns_recursor** [*OPTION*]... + +# DESCRIPTION +pdns_recursor(1) is a high performance, simple and secure recursing +nameserver. It currently powers over two million internet connections. + +The recursor is configured via a configuration file, but each item in +that file can be overridden on the command line. + +This manpage lists the core set of features needed to get the PowerDNS +recursor working, for full and up to date details head to +http://doc.powerdns.com/built-in-recursor.html + +# EXAMPLES +To listen on 192.0.2.53 and allow the 192.0.2.0/24 subnet to recurse, and run +as a daemon, execute: + +`# pdns_recursor --local-address=192.0.2.53 --allow-from=192.0.2.0/24 --daemon` + +To stop the recursor by hand, run: + +`# rec_control quit` + +However, the recommended way of starting and stopping the recursor is to use +the init.d script provided. + +# OPTIONS +For authoritative listing of options, consult the online documentation at +http://doc.powerdns.com/md/recursor/settings/ + +--aaaa-additional-processing +: Turn on to do AAAA additional processing (slow). + +--allow-from=*NETWORK*[,*NETWORK*]... +: If set, only allow these comma separated *NETWORK*s, with network mask to + recurse. For example: 192.0.2.0/24,203.0.113.128/25. + +--auth-can-lower-ttl +: Authoritative zones can transmit a TTL value that is lower than that + specified in the parent zone. This is called a 'delegation inconsistency'. + To follow RFC 2181 paragraphs 5.2 and 5.4 to the letter, enable this + feature. This will mean a slight deterioration of performance, and it will + not solve any problems, but does make the recursor more standards + compliant. Not recommended unless you have to tick an 'RFC 2181 compliant' + box. Off by default. + +--auth-zones=*ZONENAME*=*FILENAME*[,*ZONENAME*=*FILENAME*]... +: Serve *ZONENAME* from *FILENAME* authoritatively. For example: + ds9a.nl=/var/zones/ds9a.nl,powerdns.com=/var/zones/powerdns.com. + +--chroot=*DIRECTORY* +: chroot the process to *DIRECTORY*. + +--client-tcp-timeout=*NUM* +: Timeout in seconds when talking to TCP clients. + +--config-dir=*DIRECTORY* +: Location of configuration directory (recursor.conf), /etc/powerdns by + default. + +--daemon +: Operate as a daemon. + +--delegation-only +: Which domains we only accept delegations from (a Verisign special). + +--entropy-source=*FILE* +: Read new entropy from *FILE*, defaults to /dev/urandom. + +--export-etc-hosts +: If set, this flag will export the hostnames and IP addresses mentioned in + /etc/hosts. + +--fork +: If set, fork the daemon for possible double performance. + +--forward-zones=*ZONENAME*=*ADDRESS*[,*ZONENAME*=*ADDRESS*]... +: Queries for *ZONENAME* will be forwarded to *ADDRESS*. *ADDRESS* + should be an IP address, not a hostname (to prevent chicken and egg + problems). Example: + forward-zones= ds9a.nl=213.244.168.210, powerdns.com=127.0.0.1. + +--forward-zones-file=*FILENAME* +: Similar to *--forward-zones*, but read the options from *FILENAME*. + *FILENAME* should contain one zone per line, like: ds9a.nl=213.244.168.210. + +--help +: Show a summary of options. + +--hint-file=*FILENAME* +: Load root hints from this *FILENAME* + +--local-address=*ADDRESS*[,*ADDRESS*]... +: Listen on *ADDRESS*, separated by spaces or commas. + +--local-port=*PORT* +: Listen on *PORT*. + +--log-common-errors +: If we should log rather common errors. + +--max-cache-entries=*NUM* +: Maximum number of entries in the main cache. + +--max-negative-ttl=*NUM* +: maximum number of seconds to keep a negative cached entry in memory. + +--max-tcp-clients=*NUM* +: Maximum number of simultaneous TCP clients. + +--max-tcp-per-client +: If set, maximum number of TCP sessions per client (IP address). + +--query-local-address=*ADDRESS* +: Use *ADDRESS* as Source IP address when sending queries. + +--query-local-address6=*ADDRESS* +: Send out local IPv6 queries from *ADDRESS*. Disabled by default, + which also disables outgoing IPv6 support. A useful setting is + '::0'. + +--quiet +: Suppress logging of questions and answers. + +--remotes-ringbuffer-entries=*NUM* +: maximum number of packets to store statistics for. + +--server-id=*TEXT* +: Return *TEXT* when queried for 'server.id' TXT, defaults to hostname. + +--serve-rfc1918 +: On by default, this makes the server authoritatively aware of: + 10.in-addr.arpa, 168.192.in-addr.arpa and 16-31.172.in-addr.arpa, which + saves load on the AS112 servers. Individual parts of these zones can still + be loaded or forwarded. + +--setgid=*GID* +: If set, change group id to *GID* for more security. + +--setuid=*UID* +: If set, change user id to *UID* for more security. + +--single-socket +: If set, only use a single socket for outgoing queries. + +--socket-dir=*DIRECTORY* +: The controlsocket will live in *DIRECTORY*. + +--spoof-nearmiss-max=*NUM* +: If non-zero, assume spoofing after this many near misses. + +--trace +: if we should output heaps of logging. + +--version-string=*TEXT* +: *TEXT* will be reported on version.pdns or version.bind queries. + +# BUGS +None known. File new ones at https://github.com/PowerDNS/pdns/issues. + +# RESOURCES +Website: http://www.powerdns.com, https://github.com/PowerDNS/pdns + +# SEE ALSO +rec_control(1) diff --git a/pdns/docs/manpages/pdns_server.1.md b/pdns/docs/manpages/pdns_server.1.md new file mode 100644 index 000000000..9aeaa83cc --- /dev/null +++ b/pdns/docs/manpages/pdns_server.1.md @@ -0,0 +1,40 @@ +% PDNS_SERVER(8) +% PowerDNS.COM BV +% December 2012 + +# NAME +**pdns_server** - The PowerDNS Authoritative Namserver + +# SYNOPSIS +**pdns_server** [*OPTION*] + +# DESCRIPTION +The PowerDNS Authoritative Server is a versatile nameserver which supports a +large number of backends. These backends can either be plain zone files or be +more dynamic in nature. Please see the online documentation for more +information. + +# OPTIONS +See the online documentation for all options + +--daemon={**yes**,**no**} +: Indicate if the server should run in the background as a real daemon, + or in the foreground. + +--guardian={**yes**,**no**} +: Run **pdns_server** inside a guardian. This guardian monitors the performance + of the inner **pdns_server** instance. It is also this guardian that + **pdns_control**(8) talks to. + +--control-console +: Run the server in a special monitor mode. This enables detailed logging + and exposes the raw control socket. + +--loglevel=*LEVEL* +: Set the logging level. + +--help +To view more options that are available use this program. + +# SEE ALSO +pdns_control(8), pdnssec(8), http://doc.powerdns.com/md/authoritative/ diff --git a/pdns/docs/manpages/pdnssec.1.md b/pdns/docs/manpages/pdnssec.1.md new file mode 100644 index 000000000..bd2ce8c0a --- /dev/null +++ b/pdns/docs/manpages/pdnssec.1.md @@ -0,0 +1,196 @@ +% PDNSSEC(8) PowerDNS DNSSEC command and control +% Matthijs Möhlmann +% November 2011 + +# NAME +pdnssec - PowerDNS dnssec command and control + +# SYNOPSIS +pdnssec [OPTION]... *COMMAND* + +# DESCRIPTION +**pdnssec** is a powerful command that is the operator-friendly gateway into +PowerDNSSEC configuration. Behind the scenes, **pdnssec** manipulates a PowerDNS +backend database, which also means that for many databases, **pdnssec** can be +run remotely, and can configure key material on different servers. + +# OPTIONS +-h | -help +: Show summary of options + +-v | --verbose +: Be more verbose. + +--force +: force an action + +--config-name *NAME* +: Virtual configuration name + +--config-dir *DIR* +: Location of pdns.conf. Default is /etc/powerdns. + +# COMMANDS +There are many available commands, this section splits them up into their +respective uses + +## DNSSEC RELATED COMMANDS +Several commands manipulate the DNSSEC keys and options for zones. Some of these +commands require an *ALGORITHM* to be set. The following algorithms are +supported: + + * rsasha1 + * rsasha256 + * rsasha512 + * gost + * ecdsa256 + * ecdsa384 + +activate-zone-key *ZONE* *KEY-ID* +: Activate a key with id *KEY-ID* within a zone called *ZONE*. + +add-zone-key *ZONE* {**KSK**,**ZSK**} [**active**,**passive**] *KEYBITS* *ALGORITHM* +: Create a new key for zone *ZONE*, and make it a KSK or a ZSK, with the + specified algorithm. The key is passive by default, set it to **active** to + immediately use it to sign *ZONE*. + +create-bind-db *FILE* +: Create DNSSEC database (sqlite3) at *FILE* for the BIND backend. + Remember to set `bind-dnssec-db=*FILE*` in your `pdns.conf`. + +deactivate-zone-key *ZONE* *KEY-ID* +: Deactivate a key with id KEY-ID within a zone called *ZONE*. + +disable-dnssec *ZONE* +: Deactivate all keys and unset PRESIGNED in *ZONE*. + +export-zone-dnskey *ZONE* *KEY-ID* +: Export to standard output DNSKEY and DS of key with key id *KEY-ID* within + zone called *ZONE*. + +export-zone-key *ZONE* *KEY-ID* +: Export to standard output full (private) key with key id *KEY-ID* within + zone called *ZONE*. The format used is compatible with BIND and NSD/LDNS. + +generate-zone-key {**KSK**,**ZSK**} [*ALGORITHM*] [*KEYBITS*] +: Generate a ZSK or KSK to stdout with specified algorithm and bits and print + it on STDOUT. If *ALGORITHM* is not set, RSASHA512 is used. If *KEYBITS* is + not set, an appropriate keysize is selected for *ALGORITHM*. + +import-zone-key *ZONE* *FILE* {**KSK**,**ZSK**} +: Import from *FILE* a full (private) key for zone called *ZONE*. The format + used is compatible with BIND and NSD/LDNS. **KSK** or **ZSK** specifies the + flags this key should have on import. + +remove-zone-key *ZONE* *KEY-ID* +: Remove a key with id *KEY-ID* from a zone called *ZONE*. + +set-nsec3 *ZONE* '*HASH-ALGORITHM* *FLAGS* *ITERATIONS* *SALT*' [**narrow**] +: Sets NSEC3 parameters for this zone. The quoted parameters are 4 values + that are used for the the NSEC3PARAM record and decide how NSEC3 records + are created. The NSEC3 parameters must be quoted on the command line. + + *HASH-ALGORITHM* must be 1 (SHA-1). + + Setting *FLAGS* to 1 enables NSEC3 opt-out operation. Only do this if you + know you need it. + + For *ITERATIONS*, please consult RFC 5155, section 10.3. And be aware + that a high number might overload validating resolvers. + + The *SALT* is a hexadecimal string encoding the bits for the salt. + + Setting **narrow** will make PowerDNS send out "white lies" about the next + secure record. Instead of looking it up in the database, it will send out + the hash + 1 as the next secure record. + + A sample commandline is: "pdnssec set-nsec3 powerdnssec.org '1 1 1 ab' narrow". + + **WARNING**: If running in RSASHA1 mode (algorithm 5 or 7), switching from + NSEC to NSEC3 will require a DS update in the parent zone. + +unset-nsec3 *ZONE* +: Converts *ZONE* to NSEC operations. **WARNING**: If running in RSASHA1 mode + (algorithm 5 or 7), switching from NSEC to NSEC3 will require a DS update + at the parent zone! + +## TSIG RELATED COMMANDS +These commands manipulate TSIG key information in the database. Some commands +require an *ALGORITHM*, the following are available: + + * hmac-md5 + * hmac-sha1 + * hmac-sha224 + * hmac-sha256 + * hmac-sha384 + * hmac-sha512 + +activate-tsig-key *ZONE* *NAME* {**master**,**slave**} +: Enable TSIG key *NAME* for zone *ZONE*. + +deactivate-tsig-key *ZONE* *NAME* {**master**,**slave**} +: Disable TSIG key *NAME* for zone *ZONE*. + +delete-tsig-key *NAME* +: Delete the TSIG key *NAME*. Warning, this does not deactivate said key. + +generate-tsig-key *NAME* *ALGORITHM* +: Generate new TSIG key with name *NAME* and the specified algorithm. + +## ZONE MANIPULATION COMMANDS +create-zone *ZONE* +: Create an empty zone named *ZONE*. + +check-all-zones +: Check all zones for correctness. + +check-zone *ZONE* +: Check zone *ZONE* for correctness. + +delete-zone *ZONE*: +: Delete the zone named *ZONE*. + +get-meta *ZONE* [*ATTRIBUTE*]... +: Get zone metadata. If no *ATTRIBUTE* given, lists all known. + +hash-zone-record *ZONE* *RNAME* +: This convenience command hashes the name *RNAME* according to the NSEC3 + settings of *ZONE*. Refuses to hash for zones with no NSEC3 settings. + +list-all-zones: +: List all zone names. + +list-zone *ZONE* +: Show all records for *ZONE*. + +load-zone *ZONE* *FILE* +: Load records for *ZONE* from *FILE*. If *ZONE* already exists, all records + are overwritten, this operation is atomic. If *ZONE* doesn't exist, it is + created. + +rectify-zone *ZONE* +: Calculates the 'ordername' and 'auth' fields for a zone called *ZONE* so + they comply with DNSSEC settings. Can be used to fix up migrated data. Can + always safely be run, it does no harm. + +secure-zone *ZONE* +: Configures a zone called *ZONE* with reasonable DNSSEC settings. You should + manually run 'pdnssec rectify-zone' afterwards. + +set-meta *ZONE* *ATTRIBUTE* [*VALUE*] +: Set domainmetadata *ATTRIBUTE* for *ZONE* to *VALUE*. An empty value clears it. + +set-presigned *ZONE* +: Switches *ZONE* to presigned operation, utilizing in-zone RRSIGs. + +show-zone *ZONE* +: Shows all DNSSEC related settings of a zone called *ZONE*. + +test-schema *ZONE* +: Test database schema, this creates the zone *ZONE* + +unset-presigned *ZONE* +: Disables presigned operation for *ZONE*. + +# SEE ALSO +pdns_server (8), pdns_control (8) diff --git a/pdns/docs/manpages/rec_control.1.md b/pdns/docs/manpages/rec_control.1.md new file mode 100644 index 000000000..c0da46fad --- /dev/null +++ b/pdns/docs/manpages/rec_control.1.md @@ -0,0 +1,129 @@ +% REC_CONTROL(1) +% PowerDNS.COM BV - Bert Hubert +% April 2006 + +# NAME +rec_control - control pdns_recursor + +# SYNOPSIS +**rec_control** [*OPTION*]... *COMMAND* [*COMMAND-OPTION*]... + +DESCRIPTION +----------- +rec_control(1) allows the operator to control a running instance +of the pdns_recursor. + +The commands that can be passed to the recursor are described on +http://doc.powerdns.com/md/recursor/running/\#rec_control-commands + +# EXAMPLES +To stop the recursor by hand, run: + +`# rec_control quit` + +To dump the cache to disk, execute: + +`# rec_control dump-cache /tmp/the-cache` + +# OPTIONS +--help +: provide this helpful message. + +--socket-dir=*PATH* +: Where the controlsocket will live. + +--socket-pid=*PID* +: When running in SMP mode, pid of **pdns_recursor** to control. + +--timeout=*NUM* +: Number of seconds to wait for the remote PowerDNS Recursor to + respond. Set to 0 for infinite. + +# COMMANDS +current-queries +: Shows the currently active queries. + +dump-cache *FILENAME* +: Dumps the entire cache to *FILENAME*. This file should + not exist already, PowerDNS will refuse to overwrite it. While + dumping, the recursor will not answer questions. + +dump-edns *FILENAME* +: Dumps the EDNS status to the filename mentioned. This file should + not exist already, PowerDNS will refuse to overwrite it. While + dumping, the recursor will not answer questions. + +dump-nsspeeds *FILENAME* +: Dumps the nameserver speed statistics to the *FILENAME* mentioned. + This file should not exist already, PowerDNS will refuse to + overwrite it. While dumping, the recursor will not answer questions. + +get *STATISTIC* [*STATISTIC*]... +: Retrieve a statistic. For items that can be queried, see + http://doc.powerdns.com/md/recursor/stats/ + +get-all +: Retrieve all known statistics. + +get-parameter *KEY* [*KEY*]... +: Retrieves the specified configuration parameter(s). + +get-qtypelist +: Retrieves QType statistics. Queries from cache aren't being counted yet. + +help +: Shows a list of supported commands. + +ping +: Check if server is alive. + +quit +: Request shutdown of the recursor. + +quit-nicely +: Request nice shutdown of the recursor. + +reload-acls +: Reloads ACLs. + +reload-lua-script *FILENAME* +: (Re)loads Lua script *FILENAME*. + +reload-zones +: Reload authoritative and forward zones. Retains current configuration + in case of errors. + +set-minimum-ttl *NUM* +: Set minimum-ttl-override to *NUM*. + +top-remotes +: Shows the top-20 most active remote hosts. Statistics are over the + last 'remotes-ringbuffer-entries' queries, which defaults to 0. + +trace-regex *REGEX* +: Emit resolution trace for matching queries. Empty regex to disable trace. + +unload-lua-script +: Unloads Lua script. + +version +: Report running version. + +wipe-cache *DOMAIN* [*DOMAIN*] [...] +: Wipe entries for *DOMAIN* from the cache. This is useful if, for example, + an important server has a new IP address, but the TTL has not yet + expired. Multiple domain names can be passed. Note that you must + terminate a domain with a .! So to wipe powerdns.org, issue + 'rec_control wipe-cache powerdns.org.'. + Versions beyond 3.1 don't need the trailing dot. Consider not only + wiping 'www.domain.com.' but also 'domain.com.', as the cached nameservers + or target of CNAME may continue to be undesired. + +# BUGS +None known. File new ones at https://github.com/PowerDNS/pdns/issues. + +# RESOURCES +Website: http://wiki.powerdns.com, http://www.powerdns.com + +# SEE ALSO +pdns_recursor(1) diff --git a/pdns/docs/manpages/zone2ldap.1.md b/pdns/docs/manpages/zone2ldap.1.md new file mode 100644 index 000000000..2f1124605 --- /dev/null +++ b/pdns/docs/manpages/zone2ldap.1.md @@ -0,0 +1,45 @@ +% ZONE2LDAP(8) +% Matthijs Möhlmann +% November 2004 + +# NAME +**zone2ldap** - convert zonefiles to ldif + +# SYNOPSIS +**zone2ldap** {**--named-conf=***PATH*,**--zone-file=***PATH* +**--zone-name=***NAME*} [*OPTION*]... + +# DESCRIPTION +**zone2ldap** is a program that converts bind zonefiles to ldif format which can +inserted to an LDAP server. + +# OPTIONS +--help +: Show summary of options. + +--basedn=*DN* +: Base DN to store objects below + +--dnsttl +: Add dnsttl attribute to every entry + +--layout={**simple,tree**} +: How to arrange entries in the directory (simple or as tree) + +--named-conf=*PATH* +: Path to a Bind 8 named.conf to parse + +--resume +: Continue after errors + +--verbose +: verbose comments on operation + +--zone-file=*PATH* +: Zone file to parse + +--zone-name=*NAME* +: Specify a zone name if zone is set + +# SEE ALSO +pdns_server(8) diff --git a/pdns/docs/manpages/zone2sql.1.md b/pdns/docs/manpages/zone2sql.1.md new file mode 100644 index 000000000..52ff0725c --- /dev/null +++ b/pdns/docs/manpages/zone2sql.1.md @@ -0,0 +1,68 @@ +% ZONE2SQL(8) +% PowerDNS +% December 2002 + +# NAME +**zone2sql** - convert BIND zones to SQL + +# SYNOPSIS +**zone2sql** {**--named-conf=***PATH*,**--zone-file=***PATH* **--zone-name=***NAME*} [*OPTIONS*] + +# DESCRIPTION +**zone2sql** parses Bind named.conf files and zonefiles and outputs SQL +on standard out, which can then be fed to your database. + +**zone2sql** understands the Bind master file extension `$GENERATE` and will +also honour `$ORIGIN` and `$TTL`. + +For backends supporting slave operation there is also an option to keep slave +zones as slaves, and not convert them to native operation. + +**zone2sql** can generate SQL for the Generic MySQL, Generic PostgreSQL and +Oracle backends. + +# OPTIONS +## INPUT OPTIONS +--named-conf=*PATH* +: Read *PATH* to get the bind configuration + +--zone=*PATH* +: Parse only the zone file at *PATH* Conflicts with **--named-conf** parameter. + +--zone-name=*NAME* +: When parsing a single zone without $ORIGIN statement, set *ZONE* as the zone + name. + +## OUTPUT OPTIONS +--gmysql +: Output in format suitable for the default configuration of the Generic MySQL + backend. + +--gpgsql +: Output in format suitable for the default configuration of the Generic + PostgreSQL backend. + +--oracle +: Output in format suitable for the default configuration of the Generic Oracle + backend. + +--transactions +: For Oracle and PostgreSQL output, wrap each domain in a transaction for higher + speed and integrity. + +## OTHER OPTIONS +--slave +: Maintain slave status of zones listed in named.conf as being slaves. The + default behaviour is to convert all zones to native operation. + +--on-error-resume-next +: Ignore missing files during parsing. Dangerous. + +--help +: List all options + +--verbose +: Be verbose during conversion. + +# SEE ALSO +pdns_server(8) diff --git a/pdns/docs/markdown/authoritative/dnssec.md b/pdns/docs/markdown/authoritative/dnssec.md index 17b8bb746..0396728a3 100644 --- a/pdns/docs/markdown/authoritative/dnssec.md +++ b/pdns/docs/markdown/authoritative/dnssec.md @@ -211,6 +211,7 @@ The following pdnssec commands are available: * `check-zone ZONE`: Check a zone for DNSSEC correctness. Main goals is to check if the auth flag is set correctly. * `check-all-zones`: Check all zones for DNSSEC correctness. Added in 3.1. * `deactivate-zone-key ZONE KEY-ID`: Deactivate a key with id KEY-ID within a zone called ZONE. +* `disable-dnssec ZONE`: Deactivate all keys and unset PRESIGNED in ZONE. * `export-zone-dnskey ZONE KEY-ID`: Export to standard output DNSKEY and DS of key with key id KEY-ID within zone called ZONE. * `export-zone-key ZONE KEY-ID`: Export to standard output full (private) key with key id KEY-ID within zone called ZONE. The format used is compatible with BIND and NSD/LDNS. * `hash-zone-record ZONE RECORDNAME`: @@ -295,7 +296,7 @@ pdnssec remove-zone-key ZONE prev-key-id ``` ## Going insecure -`pdnssec disable-dnssec` +`pdnssec disable-dnssec ZONE` ## NSEC(3) change This section describes how to change NSEC(3) parameters when they are already set. diff --git a/pdns/docs/mkdocs.yml b/pdns/docs/mkdocs.yml index ffc53cfa3..2fe6b122f 100644 --- a/pdns/docs/mkdocs.yml +++ b/pdns/docs/mkdocs.yml @@ -1,7 +1,7 @@ site_name: PowerDNS repo_url: https://github.com/PowerDNS/pdns docs_dir: doc-build -site_dir: html-new +site_dir: html theme_dir: markdown/theme pages: - [index.md, 'PowerDNS Server', 'Introduction'] diff --git a/pdns/docs/pdns_control.8 b/pdns/docs/pdns_control.8 deleted file mode 100644 index 440889b93..000000000 --- a/pdns/docs/pdns_control.8 +++ /dev/null @@ -1,116 +0,0 @@ -.TH PDNS_CONTROL 8 "December 2002" "PowerDNS" -.SH NAME -pdns_control \- Control the PowerDNS nameserver -.SH SYNOPSIS -.B pdns_control \fI[options]\fR command -.SH DESCRIPTION -\fBpdns_control\fR is used to send commands to a running PowerDNS nameserver. -.SH OPTIONS -A summary of options is included below. -.TP -.B \-\-help -.br -Show summary of options. -.TP -.B \-\-chroot\=... -.br -Where PowerDNS is chrooted -.TP -.B \-\-config\-dir\=... -.br -Location of configuration directory (pdns.conf) -.TP -.B \-\-config\-name\=... -.br -Name of this virtual configuration - will rename the binary image -.TP -.B \-\-remote\-address\=... -.br -Remote address to query -.TP -.B \-\-remote\-port\=... -.br -Remote port to query -.TP -.B \-\-secret\=... -.br -Secret needed to connect to remote PowerDNS -.TP -.B \-\-socket\-dir\=... -Where the controlsocket will live -.SH COMMANDS -.TP -.B ccounts -Show the content of the cache. -.TP -.B current-config -Retrieve the current configuration. -.TP -.B cycle -Restart the nameserver so it reloads its configuration. Only works when you are running in guardian mode. -.TP -.B help -Show summary of options. -.TP -.B list-zones [\fImaster\fR | \fIslave\fR | \fInative\fR] -Show list of zones. -.TP -.B notify \fI\fR -Adds a domain to the notification list, causing PDNS to send out notifications to the nameservers of a domain. Can be used if a slave missed previous notifications or is generally hard of hearing. -.TP -.B notify-host \fI\fR \fI\fR -Same as above but with operator specified IP address as destination, to be used if you know better than PowerDNS. -.TP -.B ping -Check if the guardian is alive. Will return 'PONG' when available. Only works when you are running in guardian mode. -.TP -.B purge \fI[]\fR -Purge entries from the packet cache. If the record name ends with a -dollar ($) all entries that end with that name are removed. If no record is -specified the entire cache is purged. -.TP -.B qtypes -Get QType statistics. -.TP -.B quit -Tell a running \fBpdns_server\fR to quit. -.TP -.B rediscover -Instructs backends that new domains may have appeared in the database, or, in the case of the Bind backend, in named.conf. -.TP -.B reload -Reload all zones. -.TP -.B remotes -Get top remotes. -.TP -.B respsizes -Get histogram of response sizes. -.TP -.B retrieve \fI\fR -Retrieve a slave domain from its master. Done nearly immediately. -.TP -.B rping -Check if the server is alive. Will return 'PONG' when available. -.TP -.B set \fI \fR -Set the configuration parameter \fI\fR to \fI\fR. Currently -only the \fIquery\-logging\fR can be set. -.TP -.B show \fI\fR -Show a single statistic, as present in the output of the list command. -.TP -.B status -Show usage statistics. Only works when running under guardian. -.TP -.B uptime -Show the uptime of the running server. -.TP -.B version -Print the version of the running pdns daemon. -.SH FILES -.TP -.I -Control socket used to communicate with \fBpdns_server\fR. -.SH SEE ALSO -.BR pdns_server (8) diff --git a/pdns/docs/pdns_recursor.1.txt b/pdns/docs/pdns_recursor.1.txt deleted file mode 100644 index cfdddf3ef..000000000 --- a/pdns/docs/pdns_recursor.1.txt +++ /dev/null @@ -1,188 +0,0 @@ -PDNS_RECURSOR(1) -================ - -NAME ----- -pdns_recursor - high-performance, simple and secure recursing nameserver - -SYNOPSIS --------- -'pdns_recursor' [--daemon] [--local-address] [--help, -h] [--allow-from] - -DESCRIPTION ------------ -pdns_recursor(1) is a high performance, simple and secure recursing -nameserver. It currently powers over two million internet connections. - - -The recursor is configured via a configuration file, but each item in -that file can be overridden on the command line. - - -This manpage lists the core set of features needed to get the PowerDNS -recursor working, for full and up to date details head to -http://doc.powerdns.com/built-in-recursor.html - - -EXAMPLES --------- -To listen on 1.2.3.4 and allow the 1.2.3.0/8 subnet to recurse, and run -as a daemon, execute: - - # pdns_recursor --local-address=1.2.3.4 --allow-from=1.2.3.0/8 --daemon - -To stop the recursor by hand, run: - - # rec_control quit - - - Alternatively, use the init.d script provided. - -OPTIONS -------- -For authoritative listing of options, consult the documentation referenced above. - ---aaaa-additional-processing:: - turn on to do AAAA additional processing (slow) - ---allow-from:: - If set, only allow these comma separated netmasks to recurse - ---auth-can-lower-ttl:: - Authoritative zones can transmit a TTL value that is lower than that specified in the parent zone. This is called a - 'delegation inconsistency'. To follow RFC 2181 paragraphs 5.2 and 5.4 to the letter, enable this feature. - This will mean a slight deterioration of performance, and it will not solve any problems, but does make - the recursor more standards compliant. Not recommended unless you have to tick an 'RFC 2181 compliant' box. Off by default. - ---auth-zones:: - Comma separated list of 'zonename=filename' pairs. Zones read from - these files are served authoritatively. Example: auth-zones= - ds9a.nl=/var/zones/ds9a.nl, powerdns.com=/var/zones/powerdns.com. - Available since 3.1. - ---chroot:: - switch to chroot jail - ---client-tcp-timeout:: - Timeout in seconds when talking to TCP clients - ---config-dir:: - Location of configuration directory (recursor.conf) - ---daemon:: - Operate as a daemon - ---delegation-only:: - Which domains we only accept delegations from - ---entropy-source:: - Where to read new entropy from, defaults to /dev/urandom. - ---export-etc-hosts:: - If set, this flag will export the host names and IP addresses - mentioned in /etc/hosts. Available since 3.1. ---fork:: - If set, fork the daemon for possible double performance - ---forward-zones:: - Comma separated list of 'zonename=IP' pairs. Queries for zones - listed here will be forwarded to the IP address listed. - forward-zones= ds9a.nl=213.244.168.210, powerdns.com=127.0.0.1. - Available since 3.1. For more details, see the manual. - ---forward-zones-file:: - listed here will be forwarded to the IP address listed. - One zone per line, like: ds9a.nl=213.244.168.210 - Available since 3.1.5. For more details, see the manual. - ---hint-file:: - If set, load root hints from this file - ---local-address:: - IP addresses to listen on, separated by spaces or commas - ---local-port:: - port to listen on - ---log-common-errors:: - If we should log rather common errors - ---max-cache-entries:: - If set, maximum number of entries in the main cache - ---max-negative-ttl:: - maximum number of seconds to keep a negative cached entry in memory - ---max-tcp-clients:: - Maximum number of simultaneous TCP clients - ---max-tcp-per-client:: - If set, maximum number of TCP sessions per client (IP address) - ---query-local-address:: - Source IP address for sending queries - ---query-local-address6:: - Send out local IPv6 queries from this address. Disabled by default, - which also disables outgoing IPv6 support. A useful setting is - '::0'. - ---quiet:: - Suppress logging of questions and answers - ---remotes-ringbuffer-entries:: - maximum number of packets to store statistics for - ---server-id:: - Returned when queried for 'server.id' TXT, defaults to hostname - ---serve-rfc1918:: - On by default, this makes the server authoritatively aware of: 10.in-addr.arpa, - 168.192.in-addr.arpa and 16-31.172.in-addr.arpa, which saves load on the AS112 - servers. Individual parts of these zones can still be loaded or forwarded. - ---setgid:: - If set, change group id to this gid for more security - ---setuid:: - If set, change user id to this uid for more security - ---single-socket:: - If set, only use a single socket for outgoing queries - ---socket-dir:: - Where the controlsocket will live - ---spoof-nearmiss-max:: - If non-zero, assume spoofing after this many near misses - ---trace:: - if we should output heaps of logging - ---version-string:: - string reported on version.pdns or version.bind - - -BUGS ----- -None known. File new ones at http://wiki.powerdns.com. - -AUTHOR ------- -Written by PowerDNS.COM BV, bert hubert, -v3.0, 22 March 2008 - -RESOURCES ---------- -Website: http://wiki.powerdns.com, http://www.powerdns.com - -SEE ALSO --------- -rec_control(1) - -COPYING -------- -Copyright (C) 2006 PowerDNS.COM BV. Free use of this software -is granted under the terms of the GNU General Public License (GPL) version -2. - diff --git a/pdns/docs/pdns_server.8 b/pdns/docs/pdns_server.8 deleted file mode 100644 index 7a0000de2..000000000 --- a/pdns/docs/pdns_server.8 +++ /dev/null @@ -1,33 +0,0 @@ -.TH PDNS_SERVER 8 "December 2002" "PowerDNS" -.SH NAME -pdns_server \- The PowerDNS nameserver -.SH SYNOPSIS -.B pdns_server [options] -.SH DESCRIPTION -\fB -.SH OPTIONS -.TP -.B \-\-daemon=\fIyes|no\fR -Indicate if the server should run in the background as a real daemon, -or in the foreground. -.TP -.B \-\-guardian=\fIyes|no\fR -Run \fBpdns_server\fR inside a guardian. This guardian monitors the performance -of the inner \fBpdns_server\fR instance. It is also this guardian that -\fBpdns_control\fR talks to. -.TP -.B \-\-control\-console -Run the server in a special monitor mode. This enables detailed logging -and exposes the raw control socket. -.TP -.B \-\-loglevel=\fI\fR -Set the logging level. -.TP -.B \-\-help -To view more options that are available use this option. -.SH FILES -.TP -.I -Control socket used to communicate with \fBpdns_server\fR. -.SH SEE ALSO -.BR pdns_control (8) diff --git a/pdns/docs/pdnssec.8 b/pdns/docs/pdnssec.8 deleted file mode 100644 index ddb6dd6b2..000000000 --- a/pdns/docs/pdnssec.8 +++ /dev/null @@ -1,97 +0,0 @@ -.TH PDNSSEC 8 "November 2011" "PowerDNS" -.SH NAME -pdnssec \- PowerDNSSEC command and control -.SH SYNOPSIS -.B pdnssec \fI[options]\fR command -.SH DESCRIPTION -\fIpdnssec\fR is a powerful command that is the operator-friendly gateway into PowerDNSSEC configuration. Behind the scenes, \fIpdnssec\fR manipulates a PowerDNS backend database, which also means that for many databases, \fIpdnssec\fR can be run remotely, and can configure key material on different servers. -.SH OPTIONS -A summary of options is included below. -.TP -.B \-h [ \-\-help ] -.br -Show summary of options. -.TP -.B \-v [ \-\-verbose ] -.br -Be more verbose. -.TP -.B \-\-force -.br -force an action -.TP -.B \-\-config\-name arg -.br -Virtual configuration name -.TP -.B \-\-config\-dir arg (\=/etc/powerdns) -.br -Location of pdns.conf -.TP -.B \-\-commands arg -.br -Commands given as an argument -.SH COMMANDS -.TP -.B activate\-zone\-key ZONE KEY\-ID -Activate a key with id KEY-ID within a zone called ZONE. -.TP -.B add\-zone\-key ZONE [zsk|ksk] [bits] [rsasha1|rsasha256|rsasha512|gost|ecdsa256|ecdsa384] -Create a new key for zone ZONE, and make it a KSK or a ZSK, with the specified algorithm. -.TP -.B check\-zone ZONE -Check a zone for correctness -.TP -.B deactivate\-zone\-key ZONE KEY\-ID -Deactivate a key with id KEY-ID within a zone called ZONE. -.TP -.B disable\-dnssec ZONE -Deactivate all keys and unset PRESIGNED in ZONE -.TP -.B export\-zone\-dnskey ZONE KEY\-ID -Export to standard output DNSKEY and DS of key with key id KEY-ID within zone called ZONE. -.TP -.B export\-zone\-key ZONE KEY\-ID -Export to standard output full (private) key with key id KEY-ID within zone called ZONE. The format used is compatible with BIND and NSD/LDNS. -.TP -.B hash\-zone\-record ZONE RNAME -This convenience command hashes the name 'recordname' according to the NSEC3 settings of ZONE. Refuses to hash for zones with no NSEC3 settings. -.TP -.B import\-zone\-key ZONE FILE [ksk|zsk] -Import from 'filename' a full (private) key for zone called ZONE. The format used is compatible with BIND and NSD/LDNS. KSK or ZSK specifies the flags this key should have on import. -.TP -.B rectify\-zone ZONE -Calculates the 'ordername' and 'auth' fields for a zone called ZONE so they comply with DNSSEC settings. Can be used to fix up migrated data. Can always safely be run, it does no harm. -.TP -.B remove\-zone\-key ZONE KEY\-ID -Remove a key with id KEY-ID from a zone called ZONE. -.TP -.B secure\-zone ZONE -Configures a zone called ZONE with reasonable DNSSEC settings. You should manually run 'pdnssec rectify-zone' afterwards. -.TP -.B set\-nsec3 ZONE 'params' [narrow] -Sets NSEC3 parameters for this zone. A sample commandline is: "pdnssec set-nsec3 powerdnssec.org '1 1 1 ab' narrow". The NSEC3 parameters must be quoted on the command line. -.br -.B WARNING: -.br -If running in RSASHA1 mode (algorithm 5 or 7), switching from NSEC to NSEC3 will require a DS update at the parent zone! -.TP -.B set\-presigned ZONE -Switches zone to presigned operation, utilizing in-zone RRSIGs. -.TP -.B show\-zone ZONE -Shows all DNSSEC related settings of a zone called ZONE. -.TP -.B unset\-nsec3 ZONE -Converts a zone to NSEC operations. -.br -.B WARNING: -.br -If running in RSASHA1 mode (algorithm 5 or 7), switching from NSEC to NSEC3 will require a DS update at the parent zone! -.TP -.B unset\-presigned ZONE -Disables presigned operation for ZONE. -.SH AUTHOR -This manual page was written by Matthijs Möhlmann for the Debian Project (but may be used by others) -.SH SEE ALSO -.BR pdns_server (8), pdns_control (8) diff --git a/pdns/docs/process-md.sh b/pdns/docs/process-md.sh index 94075121d..02a6e54fd 100755 --- a/pdns/docs/process-md.sh +++ b/pdns/docs/process-md.sh @@ -12,7 +12,7 @@ pre() { post() { # Change the following: # Add class="table-bordered" to tables - find html-new -type f -name '*.html' -exec perl -i -p \ + find html -type f -name '*.html' -exec perl -i -p \ -e 's/\/
/;' \ {} + } diff --git a/pdns/docs/rec_control.1.txt b/pdns/docs/rec_control.1.txt deleted file mode 100644 index 1c3b3d1de..000000000 --- a/pdns/docs/rec_control.1.txt +++ /dev/null @@ -1,150 +0,0 @@ -REC_CONTROL(1) -============== - -NAME ----- -rec_control - control pdns_recursor - -SYNOPSIS --------- -'rec_control' [--help] [--socket-dir] [--socket-pid] command .. - -DESCRIPTION ------------ -rec_control(1) allows the operator to control a running instance -of the pdns_recursor. - -The commands that can be passed to the recursor are described on -http://doc.powerdns.com/rec-control.html - -EXAMPLES --------- - -To stop the recursor by hand, run: - - # rec_control quit - -To dump the cache to disk, execute: - - # rec_control dump-cache /tmp/the-cache - -OPTIONS -------- - ---help:: - provide this helpful message - ---socket-dir:: - Where the controlsocket will live - ---socket-pid:: - When running in SMP mode, pid of pdns_recursor to control - ---timeout:: - Number of seconds to wait for the remote PowerDNS Recursor to - respond. Set to 0 for infinite. - -COMMANDS --------- -current-queries:: - Shows the currently active queries. - -dump-cache :: - Dumps the entire cache to the filename mentioned. This file should - not exist already, PowerDNS will refuse to overwrite it. While - dumping, the recursor will not answer questions. - -dump-edns[status] :: - Dumps the EDNS status to the filename mentioned. This file should - not exist already, PowerDNS will refuse to overwrite it. While - dumping, the recursor will not answer questions. - -dump-nsspeeds :: - Dumps the nameserver speed statistics to the filename mentioned. - This file should not exist already, PowerDNS will refuse to - overwrite it. While dumping, the recursor will not answer questions. - -get [statistic1]:: - Retrieve a statistic. For items that can be queried, see - http://doc.powerdns.com/recursor-stats.html - -get-all:: - Retrieve all known statistics. - -get-parameter [key1]:: - Retrieves the specified configuration parameter(s). - -get-qtypelist:: - Retrieves QType statistics. Queries from cache aren't being counted yet. - -help:: - Shows a list of supported commands. - -ping:: - Check if server is alive. - -quit:: - Request shutdown of the recursor - -quit-nicely:: - Request nice shutdown of the recursor - -reload-acls:: - Reloads ACLs. - -reload-lua-script [filename]:: - (Re)loads Lua script - -reload-zones:: - Reload authoritative and forward zones. Retains current configuration - in case of errors. - -set-minimum-ttl :: - Set minimum-ttl-override. - -top-remotes:: - Shows the top-20 most active remote hosts. Statistics are over the - last 'remotes-ringbuffer-entries' queries, which defaults to 0. - -trace-regex [regex]:: - Emit resolution trace for matching queries. Empty regex to disable trace. - -unload-lua-script:: - Unloads Lua script. - -version:: - Report running version (available after 3.6.1) - -wipe-cache [domain1]:: - Wipe entries from the cache. This is useful if, for example, an - important server has a new IP address, but the TTL has not yet - expired. Multiple domain names can be passed. Note that you must - terminate a domain with a .! So to wipe powerdns.org, issue - 'rec_control wipe-cache powerdns.org.'. - Versions beyond 3.1 don't need the trailing dot. Consider not only - wiping 'www.domain.com.' but also 'domain.com.', as the cached nameservers - or target of CNAME may continue to be undesired. - -BUGS ----- -None known. File new ones at https://github.com/PowerDNS/pdns/issues. - -AUTHOR ------- -Written by PowerDNS.COM BV, bert hubert, -v3.0, 19 April 2006 - -RESOURCES ---------- -Website: http://wiki.powerdns.com, http://www.powerdns.com - -SEE ALSO --------- -pdns_recursor(1) - -COPYING -------- -Copyright (C) 2006-2014 PowerDNS.COM BV. Free use of this software -is granted under the terms of the GNU General Public License (GPL) version -2. - diff --git a/pdns/docs/zone2ldap.8 b/pdns/docs/zone2ldap.8 deleted file mode 100644 index f0ec6feab..000000000 --- a/pdns/docs/zone2ldap.8 +++ /dev/null @@ -1,76 +0,0 @@ -.\" Hey, EMACS: -*- nroff -*- -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH PDNS 8 "November 23, 2004" -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for manpage-specific macros, see man(7) -.SH NAME -zone2ldap \- convert zonefiles to ldif -.SH SYNOPSIS -.B zone2ldap -.RI [ options ] -.br -.SH DESCRIPTION -This manual page documents briefly the -.B zone2ldap -command. -.PP -.\" TeX users may be more comfortable with the \fB\fP and -.\" \fI\fP escape sequences to invode bold face and italics, -.\" respectively. -\fBzone2ldap\fP is a program that converts bind zonefiles to ldif format which can inserted to an LDAP server -.SH OPTIONS -A summary of options is included below. -.TP -.B \-\-help -.br -Show summary of options. -.TP -.B \-\-basedn\=... -.br -Base DN to store objects below -.TP -.B \-\-dnsttl\=[yes|no] -.br -Add dnsttl attribute to every entry -.TP -.B \-\-layout\=... -.br -How to arrange entries in the directory (simple or as tree) -.TP -.B \-\-named\-conf\=... -.br -Bind 8 named.conf to parse -.TP -.B \-\-resume\=[yes|no] -.br -Continue after errors -.TP -.B \-\-verbose\=[yes|no] -.br -Verbose comments on operation -.TP -.B \-\-zone\-file=... -.br -Zone file to parse -.TP -.B \-\-zone\-name=... -.br -Specify a zone name if zone is set -.SH SEE ALSO -.BR pdns_server (8) -.br -.SH AUTHOR -This manual page was written by Matthijs Möhlmann , -for the Debian project (but may be used by others). diff --git a/pdns/docs/zone2sql.8 b/pdns/docs/zone2sql.8 deleted file mode 100644 index 833f58167..000000000 --- a/pdns/docs/zone2sql.8 +++ /dev/null @@ -1,64 +0,0 @@ -.TH ZONE2SQL 8 "December 2002" "PowerDNS" -.SH NAME -zone2sql \- Convert ISC Bind zones to SQL -.SH SYNOPSIS -.B zone2sql [OPTIONS] -.SH DESCRIPTION -\fBZone2sql\fR parses Bind \fInamed.conf\fR files and zonefiles and outputs SQL -on standard out, which can then be fed to your database. -.PP -\fBzone2sql\fR understands the Bind master file extension '$GENERATE' and will -also honour '$ORIGIN' and '$TTL'. -.PP -For backends supporting slave operation there is also an option to keep slave -zones as slaves, and not convert them to native operation. -.PP -zone2sql can generate SQL for the Generic MySQL, Generic PostgreSQL and Oracle -backends. -.SH OPTIONS -Input options: -.TP -.B \-\-named-conf=\fI\fR -Read \fI\fR to get the bind configuration -.TP -.B \-\-zone=\fI\fR -Parse only this zone file. Conflicts with \fB\-\-named-conf\fR parameter. -.TP -.B \-\-zone-name=\fI\fR -When parsing a single zone without $ORIGIN statement, set this as the zone -name. -.PP -Output options: -.TP -.B \-\-gmysql -Output in format suitable for the default configuration of the Generic MySQL -backend. -.TP -.B \-\-gpgsql -Output in format suitable for the default configuration of the Generic -PostgreSQL backend. -.TP -.B \-\-oracle -Output in format suitable for the default configuration of the Generic Oracle -backend. -.TP -.B \-\-transactions -For Oracle and PostgreSQL output, wrap each domain in a transaction for higher -speed and integrity. -.PP -Other options: -.TP -.B \-\-slave -Maintain slave status of zones listed in named.conf as being slaves. The -default behaviour is to convert all zones to native operation. -.TP -.B \-\-on\-error\-resume\-next -Ignore missing files during parsing. Dangerous. -.TP -.B \-\-help -List all options -.TP -.B \-\-verbose -Be verbose during conversion. -.SH SEE ALSO -.BR pdns_server (8) -- 2.40.0