add dnsdist manpage!

diff --git a/pdns/dnsdist.cc b/pdns/dnsdist.cc
index f0b0d278ee936c40211b9c8abcd5f97f9c029ef6..ce02ab4e11a3104ac838e7a6534c34274c533bc4 100644 (file)
--- a/pdns/dnsdist.cc
+++ b/pdns/dnsdist.cc
@@ -331,7 +331,7 @@ void* tcpClientThread(void* p)
        ds->outstanding++;
        char query[qlen];
        readn2(ci.fd, query, qlen);
-       
+       // FIXME: drop AXFR queries here, they confuse us
       retry:; 
        if(!putMsgLen(dsock, qlen)) {
          infolog("Downstream connection to %s died on us, getting a new one!", ds->remote.toStringWithPort());

diff --git a/pdns/docs/dnsdist.1.txt b/pdns/docs/dnsdist.1.txt
new file mode 100644 (file)
index 0000000..bd04916
--- /dev/null
+++ b/pdns/docs/dnsdist.1.txt
@@ -0,0 +1,79 @@
+DNSDIST(1)\r
+==========
+powerdns.documentation@powerdns.com
+
+NAME
+----
+dnsdist - tool to balance DNS queries over downstream servers\r
+
+SYNOPSIS
+--------
+'dnsdist' [--help] [--verbose] [--local address] downstream-address downstream-address\r
+\r
+DESCRIPTION
+-----------
+dnsdist receives DNS queries and relays them to one or more downstream\r
+servers. It subsequently sends back responses to the original requestor.\r
+\r
+dnsdist operates over TCP and UDP, and strives to deliver very high\r
+performance over both.\r
+\r
+Currently, queries are sent to the downstream server with the least\r
+outstanding queries. This effectively implies load balancing, making sure\r
+that slower servers get less queries.\r
+\r
+If a reply has not come in after a few seconds, it is removed from the\r
+queue, but in the short term, timeouts do cause a server to get less\r
+traffic.\r
+\r
+IPv4 and IPv6 operation can be mixed and matched, in other words, queries\r
+coming in over IPv6 could be forwarded to IPv4 and vice versa.\r
+\r
+SCOPE\r
+-----\r
+dnsdist does not 'think' about DNS, and does not perform any kind of\r
+caching, nor is it aware of the quality of the answers it is relaying.\r
+\r
+dnsdist assumes that each query leads to exactly one response, which is true\r
+for all DNS except for AXFR, which is therefore not supported.\r
+\r
+The goal for dnsdist is to remain simple. If more powerful loadbalancing is\r
+required, dedicated hardware or software is recommended. Linux Virtual\r
+Server for example is often mentioned.\r
+\r
+OPTIONS
+-------
+
+--verbose::
+       Be wordy on what the program is doing
+\r
+--local::\r
+       Supply as many addresses to listen on as required. Specify IPv4 as\r
+       0.0.0.0:53 and IPv6 as [::]:53.\r
+\r
+--daemon::\r
+       Daemonize and run in the background\r
+\r
+--help::\r
+       Provide a helpful message\r
+\r
+Finally, supply as many downstream addresses as required. Remote port defaults to 53.\r
+\r
+BUGS
+----
+Right now, the TCP support has some rather arbitrary limits. \r
+\r
+AUTHOR
+------
+Written by PowerDNS.COM BV, powerdns.documentation@powerdns.com
+
+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.
+