man: describe sd_bus_default_flush_close()

1 files changed, 15 insertions, 0 deletions

diff --git a/man/sd_bus_close.xml b/man/sd_bus_close.xml
index d81c593878..953f16ac34 100644
--- a/man/sd_bus_close.xml
+++ b/man/sd_bus_close.xml
@@ -19,6 +19,7 @@
   <refnamediv>
     <refname>sd_bus_close</refname>
     <refname>sd_bus_flush</refname>
+    <refname>sd_bus_default_flush_close</refname>
 
     <refpurpose>Close and flush a bus connection</refpurpose>
   </refnamediv>
@@ -36,6 +37,11 @@
         <funcdef>int <function>sd_bus_flush</function></funcdef>
         <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
       </funcprototype>
+
+      <funcprototype>
+        <funcdef>void <function>sd_bus_default_flush_close</function></funcdef>
+        <paramdef>void</paramdef>
+      </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
 
@@ -59,6 +65,15 @@
     bus object so that it may be freed. Since these three operations are frequently done together a helper call
     <citerefentry><refentrytitle>sd_bus_flush_close_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> is
     provided that combines them into one.</para>
+
+    <para><function>sd_bus_default_flush_close()</function> is similar to
+    <function>sd_bus_flush_close_unref</function>, but does not take a bus pointer argument and instead
+    iterates over any of the "default" busses opened by
+    <citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>sd_bus_default_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>sd_bus_default_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+    and similar calls. <function>sd_bus_default_flush_close()</function> is particularly useful to clean up
+    any busses opened using those calls before the program exits.</para>
   </refsect1>
 
   <refsect1>