From: Otto Moerbeek <otto.moerbeek@open-xchange.com>
Date: Wed, 20 Nov 2024 08:48:48 +0000 (+0100)
Subject: rec: rec_control docs update to reflect current state of dump-cache
X-Git-Tag: rec-5.2.0-beta1~11^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c3da5f5741835a8051736f43eda77c165f97011f;p=thirdparty%2Fpdns.git

rec: rec_control docs update to reflect current state of dump-cache

Plus some minor style edits
---

diff --git a/pdns/recursordist/docs/manpages/rec_control.1.rst b/pdns/recursordist/docs/manpages/rec_control.1.rst
index 53bf488543..2b1bbdf182 100644
--- a/pdns/recursordist/docs/manpages/rec_control.1.rst
+++ b/pdns/recursordist/docs/manpages/rec_control.1.rst
@@ -27,7 +27,7 @@ To stop the recursor by hand, run::
 
   # rec_control quit
 
-To dump the cache to disk, execute::
+To dump the caches to disk, execute::
 
   # rec_control dump-cache /tmp/the-cache
 
@@ -53,10 +53,10 @@ Options
 
 Commands
 --------
-add-dont-throttle-names NAME [NAME...]
+add-dont-throttle-names *NAME* [*NAME*...]
     Add names for nameserver domains that may not be throttled.
 
-add-dont-throttle-netmasks NETMASK [NETMASK...]
+add-dont-throttle-netmasks *NETMASK* [*NETMASK*...]
     Add netmasks for nameservers that may not be throttled.
 
 add-nta *DOMAIN* [*REASON*]
@@ -70,10 +70,10 @@ add-ta *DOMAIN* *DSRECORD*
 current-queries
     Shows the currently active queries.
 
-clear-dont-throttle-names NAME [NAME...]
+clear-dont-throttle-names *NAME* [*NAME*...]
     Remove names that are not allowed to be throttled. If *NAME* is ``*``, remove all
 
-clear-dont-throttle-netmasks NETMASK [NETMASK...]
+clear-dont-throttle-netmasks *NETMASK* [*NETMASK*...]
     Remove netmasks that are not allowed to be throttled. If *NETMASK* is ``*``, remove all
 
 clear-nta *DOMAIN*...
@@ -84,15 +84,15 @@ clear-ta [*DOMAIN*]...
     Remove Trust Anchor for one or more *DOMAIN*\ s. Note that removing the
     root trust anchor is not possible.
 
-dump-cache *FILENAME*
-    Dumps the entire cache to *FILENAME*. This file should not exist already,
+dump-cache *FILENAME* [*TYPE*...]
+    Dumps caches to *FILENAME*. This file should not exist already,
     PowerDNS will refuse to overwrite it. While dumping, the recursor
     might not answer questions.
 
-    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 appropriate comment.
+    If no *TYPE* is specified the record cache, the negative cache,
+    the packet cache and the aggressive NSEC cache are dumped. To
+    select specific caches specify one or more *TYPE*s, separated
+    by spaces. The value of *TYPE* can be r, n, p or a.
 
 dump-dot-probe-map *FILENAME*
     Dump the contents of the DoT probe map to the *FILENAME* mentioned.
diff --git a/pdns/recursordist/rec_channel_rec.cc b/pdns/recursordist/rec_channel_rec.cc
index caec8886e3..5a53aa1fa0 100644
--- a/pdns/recursordist/rec_channel_rec.cc
+++ b/pdns/recursordist/rec_channel_rec.cc
@@ -1861,7 +1861,7 @@ static RecursorControlChannel::Answer help()
           "                                 remove netmasks that are not allowed to be throttled. If N is '*', remove all\n"
           "clear-nta [DOMAIN]...            Clear the Negative Trust Anchor for DOMAINs, if no DOMAIN is specified, remove all\n"
           "clear-ta [DOMAIN]...             Clear the Trust Anchor for DOMAINs\n"
-          "dump-cache <filename>            dump cache contents to the named file\n"
+          "dump-cache <filename> [type...]  dump cache contents to the named file, type is r, n, p or a\n"
           "dump-dot-probe-map <filename>    dump the contents of the DoT probe map to the named file\n"
           "dump-edns [status] <filename>    dump EDNS status to the named file\n"
           "dump-failedservers <filename>    dump the failed servers to the named file\n"