busctl: add "tree" command to explore object trees

[elogind.git] / man / busctl.xml

diff --git a/man/busctl.xml b/man/busctl.xml
index b358bc4cd9c2ba70a893df1e642b0bebde7df291..f9bcea3c2d43930fa5d2af804fc594b97e384ffa 100644 (file)
--- a/man/busctl.xml
+++ b/man/busctl.xml
@@ -143,6 +143,15 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         </listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>--list</option></term>
+
+        <listitem>
+          <para>When used with the <command>tree</command> shows a
+          flat list of object paths instead of a tree.</para>
+        </listitem>
+      </varlistentry>
+
       <xi:include href="user-system-options.xml" xpointer="user" />
       <xi:include href="user-system-options.xml" xpointer="system" />
       <xi:include href="user-system-options.xml" xpointer="host" />
@@ -163,8 +172,18 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       <varlistentry>
         <term><command>list</command></term>
 
-        <listitem><para>Show endpoints attached to the bus. This is
-        the default if no command is specified.</para></listitem>
+        <listitem><para>Show service names on the bus. This is the
+        default if no command is specified.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><command>tree</command>  <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg></term>
+
+        <listitem><para>Shows an object tree of one or more
+        services. If <replaceable>NAME</replaceable> is specified,
+        show object tree of the specified services only. Otherwise,
+        show all object trees of all services on the bus that acquired
+        at least one well-known name.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -193,7 +212,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><command>status</command>  <arg choice="plain"><replaceable>NAME</replaceable></arg></term>
 
         <listitem><para>Show process information and credentials of a
-        bus endpoint.</para></listitem>
+        bus service.</para></listitem>
       </varlistentry>
 
       <varlistentry>