]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: reword --raw= explanation a bit
authorLennart Poettering <lennart@poettering.net>
Thu, 5 Jun 2025 10:22:34 +0000 (12:22 +0200)
committerLuca Boccassi <luca.boccassi@gmail.com>
Wed, 25 Jun 2025 12:36:10 +0000 (13:36 +0100)
Explain what we mean by "payload", and for which RR types this is
intended.

And don#t claim we'd output a full packet, because we don't. We output
only the RR in binary.

Fixes: #37737
(cherry picked from commit 317054365eb11d98ac9d2439ef537e2ee6a3228c)

man/resolvectl.xml

index 680d16ad14302cae086903a7a246c195b0824bd3..4422c2707b5aeab82b659b41946a1e0124e465b5 100644 (file)
       <varlistentry>
         <term><option>--raw</option><optional>=payload|packet</optional></term>
 
-        <listitem><para>Dump the answer as binary data. If there is no argument or if the argument is
-        <literal>payload</literal>, the payload of the packet is exported. If the argument is
-        <literal>packet</literal>, the whole packet is dumped in wire format, prefixed by
-        length specified as a little-endian 64-bit number. This format allows multiple packets
-        to be dumped and unambiguously parsed.</para>
+        <listitem><para>Dump the answer records as binary data. If there is no argument or if the argument is
+        <literal>payload</literal>, the payload of the resource record data is exported, i.e. not the whole
+        "RDATA", but just primary contents. If the argument is <literal>packet</literal>,
+        the whole resource record is dumped in wire format, prefixed by length specified as a little-endian
+        64-bit integer. This format allows multiple record to be dumped and unambiguously parsed.</para>
+
+        <para>Note that <literal>payload</literal> is only supported for a small subset of resource record
+        types: SSHFP, TLSA, OPENPGPKEY where this dumps the key material only; and A, AAAA where
+        this dumps the address data.</para>
 
         <xi:include href="version-info.xml" xpointer="v239"/></listitem>
       </varlistentry>