]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/org.freedesktop.machine1.xml
man: use --bus-introspect to autogenerate dbus api docs
[thirdparty/systemd.git] / man / org.freedesktop.machine1.xml
index bc9779c5212431a8027536fad216b7205c7d53f5..c18e133e7cbc6ff1a0b340b4ced3612110330eca 100644 (file)
 
     <para>The service exposes the following interfaces on the Manager object on the bus:</para>
 
-    <programlisting>
-$ gdbus introspect --system \
-        --dest org.freedesktop.machine1 \
-        --object-path /org/freedesktop/machine1
-
+    <programlisting executable="systemd-machined" node="/org/freedesktop/machine1" interface="org.freedesktop.machine1.Manager">
 node /org/freedesktop/machine1 {
   interface org.freedesktop.machine1.Manager {
     methods:
@@ -435,11 +431,7 @@ node /org/freedesktop/machine1 {
   <refsect1>
     <title>Machine Objects</title>
 
-    <programlisting>
-$ gdbus introspect --system \
-        --dest org.freedesktop.machine1 \
-        --object-path /org/freedesktop/machine1/machine/rawhide
-
+    <programlisting executable="systemd-machined" node="/org/freedesktop/machine1/machine/rawhide" interface="org.freedesktop.machine1.Machine">
 node /org/freedesktop/machine1/machine/rawhide {
   interface org.freedesktop.machine1.Machine {
     methods:
@@ -617,6 +609,30 @@ node /org/freedesktop/machine1/machine/rawhide {
     </refsect2>
   </refsect1>
 
+  <refsect1>
+    <title>Examples</title>
+
+    <example>
+      <title>Introspect <interfacename>org.freedesktop.machine1.Manager</interfacename> on the bus</title>
+
+      <programlisting>
+$ gdbus introspect --system \
+  --dest org.freedesktop.machine1 \
+  --object-path /org/freedesktop/machine1
+      </programlisting>
+    </example>
+
+    <example>
+      <title>Introspect <interfacename>org.freedesktop.machine1.Machine</interfacename> on the bus</title>
+
+      <programlisting>
+$ gdbus introspect --system \
+  --dest org.freedesktop.machine1 \
+  --object-path /org/freedesktop/machine1/machine/rawhide
+      </programlisting>
+    </example>
+  </refsect1>
+
   <refsect1>
     <title>Versioning</title>