From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Thu, 21 Nov 2019 19:18:42 +0000 (+0100)
Subject: man: use <command> not <option> for commands in resolvectl(1)
X-Git-Tag: v244-rc1~7^2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8eb6e6ed09bf037f97569701e409fca888f27309;p=thirdparty%2Fsystemd.git

man: use <command> not <option> for commands in resolvectl(1)
---

diff --git a/man/resolvectl.xml b/man/resolvectl.xml
index 8c1d6e5de4a..594e22c03f3 100644
--- a/man/resolvectl.xml
+++ b/man/resolvectl.xml
@@ -53,13 +53,15 @@
     <variablelist>
 
       <varlistentry>
-        <term><option>query <replaceable>HOSTNAME|ADDRESS</replaceable>…</option></term>
+        <term><command>query</command> <replaceable>HOSTNAME|ADDRESS</replaceable>…</term>
 
         <listitem><para>Resolve domain names, IPv4 and IPv6 addresses.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>service [[<replaceable>NAME</replaceable>] <replaceable>TYPE</replaceable>] <replaceable>DOMAIN</replaceable></option></term>
+        <term><command>service</command>
+        [[<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.
@@ -71,7 +73,7 @@
       </varlistentry>
 
       <varlistentry>
-        <term><option>openpgp <replaceable>EMAIL@DOMAIN</replaceable>…</option></term>
+        <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
@@ -79,7 +81,9 @@
       </varlistentry>
 
       <varlistentry>
-        <term><option>tlsa [<replaceable>FAMILY</replaceable>] <replaceable>DOMAIN</replaceable>[:<replaceable>PORT</replaceable>]…</option></term>
+        <term><command>tlsa</command>
+        [<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
@@ -89,28 +93,28 @@
       </varlistentry>
 
       <varlistentry>
-        <term><option>status [<replaceable>LINK</replaceable>…]</option></term>
+        <term><command>status</command> [<replaceable>LINK</replaceable>…]</term>
 
         <listitem><para>Shows the global and per-link DNS settings currently in effect. If no command is specified,
         this is the implied default.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>statistics</option></term>
+        <term><command>statistics</command></term>
 
         <listitem><para>Shows general resolver statistics, including information whether DNSSEC is
         enabled and available, as well as resolution and validation statistics.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>reset-statistics</option></term>
+        <term><command>reset-statistics</command></term>
 
-        <listitem><para>Resets the statistics counters shown in <option>statistics</option> to zero.
+        <listitem><para>Resets the statistics counters shown in <command>statistics</command> to zero.
         This operation requires root privileges.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>flush-caches</option></term>
+        <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>
@@ -118,7 +122,7 @@
       </varlistentry>
 
       <varlistentry>
-        <term><option>reset-server-features</option></term>
+        <term><command>reset-server-features</command></term>
 
         <listitem><para>Flushes all feature level information the resolver learnt about specific servers, and ensures
         that the server feature probing logic is started from the beginning with the next look-up request. This is
@@ -127,46 +131,48 @@
       </varlistentry>
 
       <varlistentry>
-        <term><option>dns [<replaceable>LINK</replaceable> [<replaceable>SERVER</replaceable>…]]</option></term>
-        <term><option>domain [<replaceable>LINK</replaceable> [<replaceable>DOMAIN</replaceable>…]]</option></term>
-        <term><option>default-route [<replaceable>LINK</replaceable> [<replaceable>BOOL</replaceable>…]]</option></term>
-        <term><option>llmnr [<replaceable>LINK</replaceable> [<replaceable>MODE</replaceable>]]</option></term>
-        <term><option>mdns [<replaceable>LINK</replaceable> [<replaceable>MODE</replaceable>]]</option></term>
-        <term><option>dnssec [<replaceable>LINK</replaceable> [<replaceable>MODE</replaceable>]]</option></term>
-        <term><option>dnsovertls [<replaceable>LINK</replaceable> [<replaceable>MODE</replaceable>]]</option></term>
-        <term><option>nta [<replaceable>LINK</replaceable> [<replaceable>DOMAIN</replaceable>…]]</option></term>
+        <term><command>dns</command> [<replaceable>LINK</replaceable> [<replaceable>SERVER</replaceable>…]]</term>
+        <term><command>domain</command> [<replaceable>LINK</replaceable> [<replaceable>DOMAIN</replaceable>…]]</term>
+        <term><command>default-route</command> [<replaceable>LINK</replaceable> [<replaceable>BOOL</replaceable>…]]</term>
+        <term><command>llmnr</command> [<replaceable>LINK</replaceable> [<replaceable>MODE</replaceable>]]</term>
+        <term><command>mdns</command> [<replaceable>LINK</replaceable> [<replaceable>MODE</replaceable>]]</term>
+        <term><command>dnssec</command> [<replaceable>LINK</replaceable> [<replaceable>MODE</replaceable>]]</term>
+        <term><command>dnsovertls</command> [<replaceable>LINK</replaceable> [<replaceable>MODE</replaceable>]]</term>
+        <term><command>nta</command> [<replaceable>LINK</replaceable> [<replaceable>DOMAIN</replaceable>…]]</term>
 
         <listitem>
-          <para>Get/set per-interface DNS configuration. These commands may be used to configure various DNS settings
-          for network interfaces. These commands may be used to inform <command>systemd-resolved</command> or
-          <command>systemd-networkd</command> about per-interface DNS configuration determined
-          through external means. The <option>dns</option> command expects IPv4 or IPv6 address specifications of DNS
-          servers to use. The <option>domain</option> command expects valid DNS domains, possibly prefixed with
-          <literal>~</literal>, and configures a per-interface search or route-only domain. The
-          <option>default-route</option> command expects a boolean parameter, and configures whether the link may be
-          used as default route for DNS lookups, i.e. if it is suitable for lookups on domains no other link explicitly
-          is configured for. The <option>llmnr</option>, <option>mdns</option>, <option>dnssec</option> and
-          <option>dnsovertls</option> commands may be used to configure the per-interface LLMNR, MulticastDNS, DNSSEC
-          and DNSOverTLS settings. Finally, <option>nta</option> command may be used to configure additional
-          per-interface DNSSEC NTA domains.</para>
-
-          <para>Options <option>dns</option>, <option>domain</option> and <option>nta</option> can take
+          <para>Get/set per-interface DNS configuration. These commands may be used to configure various DNS
+          settings for network interfaces. These commands may be used to inform
+          <command>systemd-resolved</command> or <command>systemd-networkd</command> about per-interface DNS
+          configuration determined through external means. The <command>dns</command> command expects IPv4 or
+          IPv6 address specifications of DNS servers to use. The <command>domain</command> command expects
+          valid DNS domains, possibly prefixed with <literal>~</literal>, and configures a per-interface
+          search or route-only domain. The <command>default-route</command> command expects a boolean
+          parameter, and configures whether the link may be used as default route for DNS lookups, i.e. if it
+          is suitable for lookups on domains no other link explicitly is configured for. The
+          <command>llmnr</command>, <command>mdns</command>, <command>dnssec</command> and
+          <command>dnsovertls</command> commands may be used to configure the per-interface LLMNR,
+          MulticastDNS, DNSSEC and DNSOverTLS settings. Finally, <command>nta</command> command may be used
+          to configure additional per-interface DNSSEC NTA domains.</para>
+
+          <para>Commands <command>dns</command>, <command>domain</command> and <command>nta</command> can take
           a single empty string argument to clear their respective value lists.</para>
 
-          <para>For details about these settings, their possible values and their effect, see the corresponding options in
+          <para>For details about these settings, their possible values and their effect, see the
+          corresponding settings in
           <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>revert <replaceable>LINK</replaceable></option></term>
+        <term><command>revert <replaceable>LINK</replaceable></command></term>
 
         <listitem><para>Revert the per-interface DNS configuration. If the DNS configuration is reverted all
-        per-interface DNS setting are reset to their defaults, undoing all effects of <option>dns</option>,
-        <option>domain</option>, <option>default-route</option>, <option>llmnr</option>, <option>mdns</option>,
-        <option>dnssec</option>, <option>dnsovertls</option>, <option>nta</option>. Note that when a network interface
-        disappears all configuration is lost automatically, an explicit reverting is not necessary in that
-        case.</para></listitem>
+        per-interface DNS setting are reset to their defaults, undoing all effects of <command>dns</command>,
+        <command>domain</command>, <command>default-route</command>, <command>llmnr</command>,
+        <command>mdns</command>, <command>dnssec</command>, <command>dnsovertls</command>,
+        <command>nta</command>. Note that when a network interface disappears all configuration is lost
+        automatically, an explicit reverting is not necessary in that case.</para></listitem>
       </varlistentry>
 
     </variablelist>