diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-04-24 12:08:10 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-05-05 22:41:23 +0200 |
commit | 48f99d7c069e07671e570161aecbe109af1285e0 (patch) | |
tree | 42768a6ed1fd37707c24ca93bedc84bd28fc31c3 /man/org.freedesktop.login1.xml | |
parent | c351d568c3ddf5a10231f9d5e8c9d7059292767c (diff) | |
download | systemd-48f99d7c069e07671e570161aecbe109af1285e0.tar.gz |
man: use --bus-introspect to autogenerate dbus api docs
This has the advantage that the executables are always in place and we don't
need any units to exist on the bus, so we can eventually hook this up into
a normal build system. (Probably as a build time check.)
Diffstat (limited to 'man/org.freedesktop.login1.xml')
-rw-r--r-- | man/org.freedesktop.login1.xml | 151 |
1 files changed, 133 insertions, 18 deletions
diff --git a/man/org.freedesktop.login1.xml b/man/org.freedesktop.login1.xml index aedf5d7fc3..8de6cf513d 100644 --- a/man/org.freedesktop.login1.xml +++ b/man/org.freedesktop.login1.xml @@ -38,11 +38,7 @@ <para>The service exposes the following interfaces on the Manager object on the bus:</para> - <programlisting> -$ gdbus introspect --system \ - --dest org.freedesktop.login1 \ - --object-path /org/freedesktop/login1 - + <programlisting executable="systemd-logind" node="/org/freedesktop/login1" interface="org.freedesktop.login1.Manager"> node /org/freedesktop/login1 { interface org.freedesktop.login1.Manager { methods: @@ -741,10 +737,7 @@ node /org/freedesktop/login1 { <refsect1> <title>Seat Objects</title> - <programlisting> -$ gdbus introspect --system --dest org.freedesktop.login1 \ - --object-path /org/freedesktop/login1/seat/seat0 - + <programlisting executable="systemd-logind" node="/org/freedesktop/login1/seat/seat0" interface="org.freedesktop.login1.Seat"> node /org/freedesktop/login1/seat/seat0 { interface org.freedesktop.login1.Seat { methods: @@ -856,10 +849,7 @@ node /org/freedesktop/login1/seat/seat0 { <refsect1> <title>User Objects</title> - <programlisting> -$ gdbus introspect --system --dest org.freedesktop.login1 \ - --object-path /org/freedesktop/login1/user/_1000 - + <programlisting executable="systemd-logind" node="/org/freedesktop/login1/user/_1000" interface="org.freedesktop.login1.User"> node /org/freedesktop/login1/user/_1000 { interface org.freedesktop.login1.User { methods: @@ -1004,11 +994,8 @@ node /org/freedesktop/login1/user/_1000 { <refsect1> <title>Session Objects</title> - <programlisting> -$ gdbus introspect --system --dest org.freedesktop.login1 \ - --object-path /org/freedesktop/login1/session/45 - -node /org/freedesktop/login1/session/45 { + <programlisting executable="systemd-logind" node="/org/freedesktop/login1/session/1" interface="org.freedesktop.login1.Session"> +node /org/freedesktop/login1/session/1 { interface org.freedesktop.login1.Session { methods: Terminate(); @@ -1093,6 +1080,98 @@ node /org/freedesktop/login1/session/45 { }; </programlisting> + <!--Autogenerated cross-references for systemd.directives, do not edit--> + + <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.login1.Session"/> + + <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.login1.Session"/> + + <variablelist class="dbus-method" generated="True" extra-ref="Terminate()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="Activate()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="Lock()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="Unlock()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="SetIdleHint()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="SetLockedHint()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="Kill()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="TakeControl()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="ReleaseControl()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="TakeDevice()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="ReleaseDevice()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="PauseDeviceComplete()"/> + + <variablelist class="dbus-method" generated="True" extra-ref="SetBrightness()"/> + + <variablelist class="dbus-signal" generated="True" extra-ref="PauseDevice"/> + + <variablelist class="dbus-signal" generated="True" extra-ref="ResumeDevice"/> + + <variablelist class="dbus-signal" generated="True" extra-ref="Lock"/> + + <variablelist class="dbus-signal" generated="True" extra-ref="Unlock"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Id"/> + + <variablelist class="dbus-property" generated="True" extra-ref="User"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Name"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Timestamp"/> + + <variablelist class="dbus-property" generated="True" extra-ref="TimestampMonotonic"/> + + <variablelist class="dbus-property" generated="True" extra-ref="VTNr"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Seat"/> + + <variablelist class="dbus-property" generated="True" extra-ref="TTY"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Display"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Remote"/> + + <variablelist class="dbus-property" generated="True" extra-ref="RemoteHost"/> + + <variablelist class="dbus-property" generated="True" extra-ref="RemoteUser"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Service"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Desktop"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Scope"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Leader"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Audit"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Type"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Class"/> + + <variablelist class="dbus-property" generated="True" extra-ref="Active"/> + + <variablelist class="dbus-property" generated="True" extra-ref="State"/> + + <variablelist class="dbus-property" generated="True" extra-ref="IdleHint"/> + + <variablelist class="dbus-property" generated="True" extra-ref="IdleSinceHint"/> + + <variablelist class="dbus-property" generated="True" extra-ref="IdleSinceHintMonotonic"/> + + <variablelist class="dbus-property" generated="True" extra-ref="LockedHint"/> + + <!--End of Autogenerated section--> + <refsect2> <title>Methods</title> @@ -1258,6 +1337,42 @@ node /org/freedesktop/login1/session/45 { </refsect1> <refsect1> + <title>Examples</title> + + <example> + <title>Introspect <interfacename>org.freedesktop.login1.Manager</interfacename> on the bus</title> + + <programlisting>$ gdbus introspect --system --dest org.freedesktop.login1 \ + --object-path /org/freedesktop/login1 + </programlisting> + </example> + + <example> + <title>Introspect <interfacename>org.freedesktop.login1.Seat</interfacename> on the bus</title> + + <programlisting>$ gdbus introspect --system --dest org.freedesktop.login1 \ + --object-path /org/freedesktop/login1/seat/seat0 + </programlisting> + </example> + + <example> + <title>Introspect <interfacename>org.freedesktop.login1.User</interfacename> on the bus</title> + + <programlisting>$ gdbus introspect --system --dest org.freedesktop.login1 \ + --object-path /org/freedesktop/login1/user/_1000 + </programlisting> + </example> + + <example> + <title>Introspect <interfacename>org.freedesktop.login1.Session</interfacename> on the bus</title> + + <programlisting>$ gdbus introspect --system --dest org.freedesktop.login1 \ + --object-path /org/freedesktop/login1/session/45 + </programlisting> + </example> + </refsect1> + + <refsect1> <title>Versioning</title> <para>These D-Bus interfaces follow <ulink url="http://0pointer.de/blog/projects/versioning-dbus.html"> |