summaryrefslogtreecommitdiffstats
path: root/man/org.freedesktop.hostname1.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-04-24 12:08:10 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-05-05 22:41:23 +0200
commit48f99d7c069e07671e570161aecbe109af1285e0 (patch)
tree42768a6ed1fd37707c24ca93bedc84bd28fc31c3 /man/org.freedesktop.hostname1.xml
parentupdate-dbus-docs: use executables in build/ (diff)
downloadsystemd-48f99d7c069e07671e570161aecbe109af1285e0.tar.xz
systemd-48f99d7c069e07671e570161aecbe109af1285e0.zip
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.hostname1.xml')
-rw-r--r--man/org.freedesktop.hostname1.xml19
1 files changed, 14 insertions, 5 deletions
diff --git a/man/org.freedesktop.hostname1.xml b/man/org.freedesktop.hostname1.xml
index 406a6a369e..d17d9a5521 100644
--- a/man/org.freedesktop.hostname1.xml
+++ b/man/org.freedesktop.hostname1.xml
@@ -38,11 +38,7 @@
<para>The service exposes the following interfaces on the bus:</para>
- <programlisting>
-$ gdbus introspect --system \
- --dest org.freedesktop.hostname1 \
- --object-path /org/freedesktop/hostname1
-
+ <programlisting executable="systemd-hostnamed" node="/org/freedesktop/hostname1" interface="org.freedesktop.hostname1">
node /org/freedesktop/hostname1 {
interface org.freedesktop.hostname1 {
methods:
@@ -350,6 +346,19 @@ node /org/freedesktop/hostname1 {
</refsect1>
<refsect1>
+ <title>Examples</title>
+
+ <example>
+ <title>Introspect <interfacename>org.freedesktop.hostname1</interfacename> on the bus</title>
+
+ <programlisting>$ gdbus introspect --system \
+ --dest org.freedesktop.hostname1 \
+ --object-path /org/freedesktop/hostname1
+ </programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1>
<title>See also</title>
<para>David Zeuthen's original Fedora