man: document missing resolved D-Bus APIs

[thirdparty/systemd.git] / man / org.freedesktop.resolve1.xml

diff --git a/man/org.freedesktop.resolve1.xml b/man/org.freedesktop.resolve1.xml
index c70e5c1cb37302b88fc1d8a901280ed6fbcd8c50..1cf55fea7c1a75b68855224fc5a1eb088efba014 100644 (file)
--- a/man/org.freedesktop.resolve1.xml
+++ b/man/org.freedesktop.resolve1.xml
@@ -103,7 +103,7 @@ node /org/freedesktop/resolve1 {
       SetLinkDNSSECNegativeTrustAnchors(in  i ifindex,
                                         in  as names);
       RevertLink(in  i ifindex);
-      RegisterService(in  s name,
+      RegisterService(in  s id,
                       in  s name_template,
                       in  s type,
                       in  q service_port,
@@ -156,16 +156,6 @@ node /org/freedesktop/resolve1 {
 };
     </programlisting>
 
-    <!--method RegisterService is not documented!-->
-
-    <!--method UnregisterService is not documented!-->
-
-    <!--method FlushCaches is not documented!-->
-
-    <!--method ResetServerFeatures is not documented!-->
-
-    <!--property DNSSECNegativeTrustAnchors is not documented!-->
-
     <!--Autogenerated cross-references for systemd.directives, do not edit-->
 
     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Manager"/>
@@ -433,6 +423,30 @@ node /org/freedesktop/resolve1 {
       <para>The <function>RevertLink()</function> method may be used to revert all per-link settings
       described above to the defaults.</para>
 
+      <para>The <function>FlushCaches()</function> flushes all resource record caches maintained by the
+      resolver, and ensures that any subsequent lookups re-request their responses from their sources.</para>
+
+      <para>The <function>ResetServerFeatures()</function> flushes any feature information learned about
+      remote DNS servers. This ensures that subsequent lookups will be initially attempted at the highest DNS
+      protocol feature level again, possibly requiring a (potentially slow) downgrade cycle to recognize the
+      supported feature level again.</para>
+
+      <para>The <function>RegisterService()</function> method may be used to register a DNS-SD service on the
+      host. This functionality is closely related to the functionality provided by
+      <citerefentry><refentrytitle>systemd.dnssd</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+      files. It takes a server identifier string as first parameter (this is jus a local identifier, and
+      should be chosen so that it neither collides with the basename of <filename>*.dnssd</filename> files
+      nor with names chosen by other IPC clients). It also takes a name template string for the DNS-SD
+      service name visible on the network. This string is subject to specifier expansation, as documented for
+      the <varname>Name=</varname> setting in <filename>*.dnssd</filename> files. It also takes a service
+      type string containing the DNS-SD service type, as well as an IP port, a priority/weight pair for the
+      DNS-SD SRV record. Finally, it takes an array of TXT record data. It returns an object path which may be
+      used as handle to the registered service.</para>
+
+      <para>The <function>UnregisterService()</function> method undoes the effect of
+      <function>RegisterService()</function> and deletes a DNS-SD service previously created via IPC
+      again.</para>
+
       <refsect3>
         <title>The Flags Parameter</title>
 
@@ -636,6 +650,9 @@ node /org/freedesktop/resolve1 {
       enabled. Possible values are <literal>yes</literal> (enabled), <literal>no</literal> (disabled),
       <literal>udp</literal> (only the UDP listener is enabled), and <literal>tcp</literal> (only the TCP
       listener is enabled).</para>
+
+      <para>The <varname>DNSSECNegativeTrustAnchors</varname> property contains a list of recognized DNSSEC
+      negative trust anchors and contains a list of domains.</para>
     </refsect2>
   </refsect1>
 
@@ -690,8 +707,6 @@ node /org/freedesktop/resolve1/link/_1 {
 };
     </programlisting>
 
-    <!--property DNSSECNegativeTrustAnchors is not documented!-->
-
     <!--Autogenerated cross-references for systemd.directives, do not edit-->
 
     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.resolve1.Link"/>