From: Christian Hofstaedtler <christian@hofstaedtler.name>
Date: Tue, 9 Dec 2014 22:34:28 +0000 (+0100)
Subject: docs: recursor/running: add new(er) commands
X-Git-Tag: rec-3.7.0-rc1~109^2~14^2~8^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F1927%2Fhead;p=thirdparty%2Fpdns.git

docs: recursor/running: add new(er) commands
---

diff --git a/pdns/docs/markdown/recursor/running.md b/pdns/docs/markdown/recursor/running.md
index 44b2b94f8a..6fba5d182c 100644
--- a/pdns/docs/markdown/recursor/running.md
+++ b/pdns/docs/markdown/recursor/running.md
@@ -14,6 +14,19 @@ When not running as root, `--socket-dir=/tmp` might be appropriate.
 dump-cache filename  
 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.
 
+### `current-queries`
+Show currently outstanding queries.
+
+### `dump-cache <filename>`
+Dump cache contents to the named file `filename`. Note that the file MUST NOT exist beforehand. \\
+Typical PowerDNS Recursors run multiple threads, therefore you'll see duplicate, different entries for the same domains. The negative cache is also dumped to the same file. The per-thread positive and negative cache dumps are separated with an appropiate comment.
+
+### `dump-edns[status] <filename>`
+Dump EDNS Status for remotes to the named file `filename`. Note that the file MUST NOT exist beforehand.
+
+### `dump-nsspeeds <filename>`
+Dump remote nameserver speed statistics to the named file `filename`. Note that the file MUST NOT exist beforehand. Again, statistics are kept per thread, and the dumps end up in the same file.
+
 ### `get statistic`
 Retrieve a statistic. For items that can be queried, see below.
 
@@ -23,21 +36,33 @@ Retrieve all statistics in one go. Available since version 3.2.
 ### `get-parameter parameter1 [parameter2 ..]`
 Retrieve a configuration parameter. All parameters from the configuration and command line can be queried. Available since version 3.2.
 
+### `help`
+List all commands understood by your running `pdns_recursor` process.
+
 ### `ping`
 Check if server is alive.
 
 ### `quit`
 Request shutdown of the recursor.
 
+### `quit-nicely`
+Request a nice shutdown of the recursor.
+
 ### `reload-acls`
 Reload access control lists.
 
+### `reload-lua-script [filename]`
+(Re-)Load Lua script.
+
 ### `reload-zones`
 Reload data about all authoritative and forward zones. The configuration file is also scanned to see if the **auth-domain**, **forward-domain** and **export-etc-hosts** statements have changed, and if so, these changes are incorporated.
 
-### `set-minimum-ttl`
+### `set-minimum-ttl value`
 Available since 3.6, this setting artificially raises all TTLs to be at least this long. While this is a gross hack, and violates RFCs, under conditions of DoS, it may enable you to continue serving your customers. Corresponds to the configuration file setting 'minimum-ttl-override'.
 
+### `set-carbon-server server ourname`
+Set a Carbon server for telemetry purposes. The parameter `server` corresponds to the configuration setting **carbon-server**, and `ourname` corresponds to **carbon-ourname**.
+
 ### `top-remotes`
 Shows the top-20 most active remote hosts. Statistics are over the last **remotes-ringbuffer-entries** queries, which defaults to 0.
 
@@ -52,6 +77,9 @@ In addition, since this is a regular expression, to exclusively match queries fo
 
 Multiple matches can be chained with the | operator. For example, to match all queries for Dutch (.nl) and German (.de) domain names, use: `\.nl\.$|\.de\.$`.
 
+### `unload-lua-script`
+Unload Lua script, if one is loaded.
+
 ### `version`
 Available after 3.6.1, report currently running version.