man: add markup to dns resource record labels

1 files changed, 45 insertions, 31 deletions

diff --git a/man/resolvectl.xml b/man/resolvectl.xml
index bd1a636d60..b9c4d1d768 100644
--- a/man/resolvectl.xml
+++ b/man/resolvectl.xml
@@ -75,21 +75,26 @@
         [[<replaceable>NAME</replaceable>] <replaceable>TYPE</replaceable>]
         <replaceable>DOMAIN</replaceable></term>
 
-        <listitem><para>Resolve <ulink url="https://tools.ietf.org/html/rfc6763">DNS-SD</ulink> and
-        <ulink url="https://tools.ietf.org/html/rfc2782">SRV</ulink> services, depending on the specified list of parameters.
-        If three parameters are passed the first is assumed to be the DNS-SD service name, the second the SRV service type,
-        and the third the domain to search in. In this case a full DNS-SD style SRV and TXT lookup is executed. If only two
-        parameters are specified, the first is assumed to be the SRV service type, and the second the domain to look in. In
-        this case no TXT RR is requested. Finally, if only one parameter is specified, it is assumed to be a domain name,
-        that is already prefixed with an SRV type, and an SRV lookup is done (no TXT).</para></listitem>
+        <listitem><para>Resolve <ulink url="https://tools.ietf.org/html/rfc6763">DNS-SD</ulink> and <ulink
+        url="https://tools.ietf.org/html/rfc2782">SRV</ulink> services, depending on the specified list of
+        parameters.  If three parameters are passed the first is assumed to be the DNS-SD service name, the
+        second the <constant class='dns'>SRV</constant> service type, and the third the domain to search in.
+        In this case a full DNS-SD style <constant class='dns'>SRV</constant> and <constant
+        class='dns'>TXT</constant> lookup is executed. If only two parameters are specified, the first is
+        assumed to be the <constant class='dns'>SRV</constant> service type, and the second the domain to look
+        in. In this case no <constant class='dns'>TXT</constant> resource record is requested. Finally, if
+        only one parameter is specified, it is assumed to be a domain name, that is already prefixed with an
+        <constant class='dns'>SRV</constant> type, and an <constant class='dns'>SRV</constant> lookup is done
+        (no <constant class='dns'>TXT</constant>).</para></listitem>
       </varlistentry>
 
       <varlistentry>
         <term><command>openpgp</command> <replaceable>EMAIL@DOMAIN</replaceable>…</term>
 
-        <listitem><para>Query PGP keys stored as <ulink url="https://tools.ietf.org/html/rfc7929">OPENPGPKEY</ulink>
-        resource records. Specified e-mail addresses are converted to the corresponding DNS domain name, and any
-        OPENPGPKEY keys are printed.</para></listitem>
+        <listitem><para>Query PGP keys stored as <constant class='dns'>OPENPGPKEY</constant> resource records,
+        ssee <ulink url="https://tools.ietf.org/html/rfc7929">RFC 7929</ulink>. Specified e-mail addresses
+        are converted to the corresponding DNS domain name, and any <constant class='dns'>OPENPGPKEY</constant>
+        keys are printed.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -97,11 +102,13 @@
         [<replaceable>FAMILY</replaceable>]
         <replaceable>DOMAIN</replaceable>[:<replaceable>PORT</replaceable>]…</term>
 
-        <listitem><para>Query TLS public keys stored as <ulink url="https://tools.ietf.org/html/rfc6698">TLSA</ulink>
-        resource records. A query will be performed for each of the specified names prefixed with the port and family
+        <listitem><para>Query TLS public keys stored as <constant class='dns'>TLSA</constant> resource
+        records, see <ulink url="https://tools.ietf.org/html/rfc6698">RFC 6698</ulink>. A query will be
+        performed for each of the specified names prefixed with the port and family
         (<literal>_<replaceable>port</replaceable>._<replaceable>family</replaceable>.<replaceable>domain</replaceable></literal>).
-        The port number may be specified after a colon (<literal>:</literal>), otherwise <constant>443</constant> will be used
-        by default. The family may be specified as the first argument, otherwise <constant>tcp</constant> will be used.</para></listitem>
+        The port number may be specified after a colon (<literal>:</literal>), otherwise
+        <constant>443</constant> will be used by default. The family may be specified as the first argument,
+        otherwise <constant>tcp</constant> will be used.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -128,8 +135,8 @@
       <varlistentry>
         <term><command>flush-caches</command></term>
 
-        <listitem><para>Flushes all DNS resource record caches the service maintains locally. This is mostly equivalent
-        to sending the <constant>SIGUSR2</constant> to the <command>systemd-resolved</command>
+        <listitem><para>Flushes all DNS resource record caches the service maintains locally. This is mostly
+        equivalent to sending the <constant>SIGUSR2</constant> to the <command>systemd-resolved</command>
         service.</para></listitem>
       </varlistentry>
 
@@ -246,10 +253,11 @@
         <term><option>--class=</option><replaceable>CLASS</replaceable></term>
 
         <listitem><para>When used in conjunction with the <command>query</command> command, specifies the DNS
-        resource record type (e.g. A, AAAA, MX, …) and class (e.g. IN, ANY, …) to look up. If these options
-        are used a DNS resource record set matching the specified class and type is requested. The class
-        defaults to IN if only a type is specified. The special value <literal>help</literal> may be used to
-        list known values.</para>
+        resource record type (e.g. <constant class='dns'>A</constant>, <constant class='dns'>AAAA</constant>,
+        <constant class='dns'>MX</constant>, …) and class (e.g. <constant>IN</constant>,
+        <constant>ANY</constant>, …) to look up. If these options are used a DNS resource record set matching
+        the specified class and type is requested. The class defaults to <constant>IN</constant> if only a
+        type is specified. The special value <literal>help</literal> may be used to list known values.</para>
 
         <para>Without these options <command>resolvectl query</command> provides high-level domain name to
         address and address to domain name resolution. With these options it provides low-level DNS resource
@@ -264,20 +272,23 @@
         <term><option>--service-address=</option><replaceable>BOOL</replaceable></term>
 
         <listitem><para>Takes a boolean parameter. If true (the default), when doing a service lookup with
-        <option>--service</option> the hostnames contained in the SRV resource records are resolved as well.</para></listitem>
+        <option>--service</option> the hostnames contained in the <constant class='dns'>SRV</constant>
+        resource records are resolved as well.</para></listitem>
       </varlistentry>
 
       <varlistentry>
         <term><option>--service-txt=</option><replaceable>BOOL</replaceable></term>
 
-        <listitem><para>Takes a boolean parameter. If true (the default), when doing a DNS-SD service lookup with
-        <option>--service</option> the TXT service metadata record is resolved as well.</para></listitem>
+        <listitem><para>Takes a boolean parameter. If true (the default), when doing a DNS-SD service lookup
+        with <option>--service</option> the <constant class='dns'>TXT</constant> service metadata record is
+        resolved as well.</para></listitem>
       </varlistentry>
 
       <varlistentry>
         <term><option>--cname=</option><replaceable>BOOL</replaceable></term>
 
-        <listitem><para>Takes a boolean parameter. If true (the default), DNS CNAME or DNAME redirections are
+        <listitem><para>Takes a boolean parameter. If true (the default), DNS <constant
+        class='dns'>CNAME</constant> or <constant class='dns'>DNAME</constant> redirections are
         followed. Otherwise, if a CNAME or DNAME record is encountered while resolving, an error is
         returned.</para></listitem>
       </varlistentry>
@@ -465,7 +476,7 @@
     <title>Examples</title>
 
     <example>
-      <title>Retrieve the addresses of the <literal>www.0pointer.net</literal> domain</title>
+      <title>Retrieve the addresses of the <literal>www.0pointer.net</literal> domain (<constant class='dns'>A</constant> and <constant class='dns'>AAAA</constant> resource records)</title>
 
       <programlisting>$ resolvectl query www.0pointer.net
 www.0pointer.net: 2a01:238:43ed:c300:10c3:bcf3:3266:da74
@@ -477,7 +488,8 @@ www.0pointer.net: 2a01:238:43ed:c300:10c3:bcf3:3266:da74
     </example>
 
     <example>
-      <title>Retrieve the domain of the <literal>85.214.157.71</literal> IP address</title>
+      <title>Retrieve the domain of the <literal>85.214.157.71</literal> IP address
+      (<constant class='dns'>PTR</constant> resource record)</title>
 
       <programlisting>$ resolvectl query 85.214.157.71
 85.214.157.71: gardel.0pointer.net
@@ -488,7 +500,8 @@ www.0pointer.net: 2a01:238:43ed:c300:10c3:bcf3:3266:da74
     </example>
 
     <example>
-      <title>Retrieve the MX record of the <literal>yahoo.com</literal> domain</title>
+      <title>Retrieve the <constant class='dns'>MX</constant> record of the <literal>yahoo.com</literal>
+      domain</title>
 
       <programlisting>$ resolvectl --legend=no -t MX query yahoo.com
 yahoo.com. IN MX    1 mta7.am0.yahoodns.net
@@ -498,7 +511,7 @@ yahoo.com. IN MX    1 mta5.am0.yahoodns.net
     </example>
 
     <example>
-      <title>Resolve an SRV service</title>
+      <title>Resolve an <constant class='dns'>SRV</constant> service</title>
 
       <programlisting>$ resolvectl service _xmpp-server._tcp gmail.com
 _xmpp-server._tcp/gmail.com: alt1.xmpp-server.l.google.com:5269 [priority=20, weight=0]
@@ -510,7 +523,7 @@ _xmpp-server._tcp/gmail.com: alt1.xmpp-server.l.google.com:5269 [priority=20, we
     </example>
 
     <example>
-      <title>Retrieve a PGP key</title>
+      <title>Retrieve a PGP key (<constant class='dns'>OPENPGP</constant> resource record)</title>
 
       <programlisting>$ resolvectl openpgp zbyszek@fedoraproject.org
 d08ee310438ca124a6149ea5cc21b6313b390dce485576eff96f8722._openpgpkey.fedoraproject.org. IN OPENPGPKEY
@@ -521,8 +534,7 @@ d08ee310438ca124a6149ea5cc21b6313b390dce485576eff96f8722._openpgpkey.fedoraproje
     </example>
 
     <example>
-      <title>Retrieve a TLS key (<literal>tcp</literal> and
-      <literal>:443</literal> could be skipped)</title>
+      <title>Retrieve a TLS key (<constant class='dns'>TLSA</constant> resource record)</title>
 
       <programlisting>$ resolvectl tlsa tcp fedoraproject.org:443
 _443._tcp.fedoraproject.org IN TLSA 0 0 1 19400be5b7a31fb733917700789d2f0a2471c0c9d506c0e504c06c16d7cb17c0
@@ -530,6 +542,8 @@ _443._tcp.fedoraproject.org IN TLSA 0 0 1 19400be5b7a31fb733917700789d2f0a2471c0
         -- Selector: Full Certificate
         -- Matching type: SHA-256
 </programlisting>
+
+      <para><literal>tcp</literal> and <literal>:443</literal> are optional and could be skipped.</para>
     </example>
   </refsect1>