]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/resolvectl.xml
tree-wide: use "hostname" spelling everywhere
[thirdparty/systemd.git] / man / resolvectl.xml
index 8c1d6e5de4a2924070d6e161d40f8e47bdb735fb..e2d00b9cf08c250598bb6138606c61b96ce50c2f 100644 (file)
@@ -45,7 +45,7 @@
     interface the data was discovered. It also contains information on whether the information could be
     authenticated. All data for which local DNSSEC validation succeeds is considered authenticated. Moreover all data
     originating from local, trusted sources is also reported authenticated, including resolution of the local host
-    name, the <literal>localhost</literal> host name or all data from <filename>/etc/hosts</filename>.</para>
+    name, the <literal>localhost</literal> hostname or all data from <filename>/etc/hosts</filename>.</para>
   </refsect1>
 
   <refsect1>
     <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
       </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>
       </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
       </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>
 
+      <xi:include href="systemctl.xml" xpointer="log-level" />
     </variablelist>
   </refsect1>
 
   </refsect1>
 
   <refsect1>
-    <title>Compatibility with <citerefentry><refentrytitle>resolvconf</refentrytitle><manvolnum>8</manvolnum></citerefentry></title>
+    <title>Compatibility with
+    <citerefentry project="debian"><refentrytitle>resolvconf</refentrytitle><manvolnum>8</manvolnum></citerefentry></title>
 
     <para><command>resolvectl</command> is a multi-call binary. When invoked as <literal>resolvconf</literal>
     (generally achieved by means of a symbolic link of this name to the <command>resolvectl</command> binary) it
-    is run in a limited <citerefentry><refentrytitle>resolvconf</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    is run in a limited
+    <citerefentry project="debian"><refentrytitle>resolvconf</refentrytitle><manvolnum>8</manvolnum></citerefentry>
     compatibility mode. It accepts mostly the same arguments and pushes all data into
     <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
     similar to how <option>dns</option> and <option>domain</option> commands operate. Note that
     <command>systemd-resolved.service</command> is the only supported backend, which is different from other
-    implementations of this command. Note that not all operations supported by other implementations are supported
-    natively. Specifically:</para>
+    implementations of this command.</para>
+
+    <para><filename>/etc/resolv.conf</filename> will only be updated with servers added with this command
+    when <filename>/etc/resolv.conf</filename> is a symlink to
+    <filename>/run/systemd/resolve/resolv.conf</filename>, and not a static file. See the discussion of
+    <filename>/etc/resolv.conf</filename> handling in
+    <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+    </para>
+
+    <para>Not all operations supported by other implementations are supported natively. Specifically:</para>
 
     <variablelist>
       <varlistentry>
 
     </variablelist>
 
-    <para>See <citerefentry><refentrytitle>resolvconf</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details on this command line options.</para>
+    <para>See
+    <citerefentry project="debian"><refentrytitle>resolvconf</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    for details on those command line options.</para>
   </refsect1>
 
   <refsect1>