From: Petr Špaček <pspacek@isc.org>
Date: Thu, 29 May 2025 15:24:39 +0000 (+0200)
Subject: Clarify named-rrchecker input format
X-Git-Tag: v9.21.9~12^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5c370d9e6baa92c8dcc3ff1b330f3268c1ba3db1;p=thirdparty%2Fbind9.git

Clarify named-rrchecker input format
---

diff --git a/bin/tools/named-rrchecker.rst b/bin/tools/named-rrchecker.rst
index 28da236b726..470f28fdd4b 100644
--- a/bin/tools/named-rrchecker.rst
+++ b/bin/tools/named-rrchecker.rst
@@ -26,15 +26,24 @@ Synopsis
 Description
 ~~~~~~~~~~~
 
-:program:`named-rrchecker` reads a individual DNS resource record from standard
+:program:`named-rrchecker` reads a single DNS resource record (RR) from standard
 input and checks whether it is syntactically correct.
 
-Options
-~~~~~~~
+The input format is a minimal subset of the DNS zone file format. The entire input must be:
+  CLASS TYPE RDATA
+
+* Input must not start with an owner (domain) name
+* The `CLASS` field is mandatory (typically ``IN``).
+* The `TTL` field **must not** be present.
+* RDATA format is specific to each RRTYPE.
+* Leading and trailing whitespace in each field is ignored.
 
-.. option:: -h
+Format details can be found in :rfc:`1035#section-5.1` under ``<rr>``
+specification. :rfc:`3597` format is also accepted in any of the input fields.
 
-   This option prints out the help menu.
+
+Options
+~~~~~~~
 
 .. option:: -o origin
 
@@ -59,4 +68,4 @@ Options
 See Also
 ~~~~~~~~
 
-:rfc:`1034`, :rfc:`1035`, :iscman:`named(8) <named>`.
+:rfc:`1034`, :rfc:`1035`, :rfc:`3957`, :iscman:`named(8) <named>`.