From: Lennart Poettering Date: Tue, 5 Nov 2024 13:20:01 +0000 (+0100) Subject: man: link up D-Bus API docs from daemon man pages X-Git-Tag: v257-rc1~21^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=607d2974870e9769f44ee179dcaf26cbec64cb20;p=thirdparty%2Fsystemd.git man: link up D-Bus API docs from daemon man pages Let's systematically make sure that we link up the D-Bus interfaces from the daemon man pages once in prose and once in short form at the bottom ("See Also"), for all daemons. Also, add reverse links at the bottom of the D-Bus API docs. Fixes: #34996 --- diff --git a/man/org.freedesktop.hostname1.xml b/man/org.freedesktop.hostname1.xml index d16ae9ab1c2..6c329cbd2c0 100644 --- a/man/org.freedesktop.hostname1.xml +++ b/man/org.freedesktop.hostname1.xml @@ -427,8 +427,6 @@ node /org/freedesktop/hostname1 { name. - - Examples @@ -442,12 +440,7 @@ node /org/freedesktop/hostname1 { - - See Also - - David Zeuthen's original Fedora - Feature page about xdg-hostname - + History @@ -462,4 +455,16 @@ node /org/freedesktop/hostname1 { VSockCID were added in version 256. + + + See Also + + + systemd1 + systemd-hostnamed.service8 + hostnamectl1 + David Zeuthen's original Fedora + Feature page about xdg-hostname + + diff --git a/man/org.freedesktop.import1.xml b/man/org.freedesktop.import1.xml index 2486eea4b38..cfcf1339755 100644 --- a/man/org.freedesktop.import1.xml +++ b/man/org.freedesktop.import1.xml @@ -453,6 +453,7 @@ node /org/freedesktop/import1/transfer/_1 { + History @@ -469,4 +470,13 @@ node /org/freedesktop/import1/transfer/_1 { + + See Also + + systemd1 + systemd-importd.service8 + importctl1 + + + diff --git a/man/org.freedesktop.locale1.xml b/man/org.freedesktop.locale1.xml index 6e0d118e255..0fd8876ca89 100644 --- a/man/org.freedesktop.locale1.xml +++ b/man/org.freedesktop.locale1.xml @@ -185,4 +185,14 @@ $ gdbus introspect --system \ These D-Bus interfaces follow the usual interface versioning guidelines. + + + See Also + + systemd1 + systemd-localed.service8 + localectl1 + + + diff --git a/man/org.freedesktop.login1.xml b/man/org.freedesktop.login1.xml index 00ca82487a8..750d68518e8 100644 --- a/man/org.freedesktop.login1.xml +++ b/man/org.freedesktop.login1.xml @@ -1648,4 +1648,13 @@ node /org/freedesktop/login1/session/1 { SetClass() was added in version 256. + + + See Also + + systemd1 + systemd-logind.service8 + loginctl1 + + diff --git a/man/org.freedesktop.machine1.xml b/man/org.freedesktop.machine1.xml index 602c04bf4fc..50d9aa6792a 100644 --- a/man/org.freedesktop.machine1.xml +++ b/man/org.freedesktop.machine1.xml @@ -719,4 +719,13 @@ $ gdbus introspect --system \ and SSHPrivateKeyPath were added in version 256. + + + See Also + + systemd1 + systemd-machined.service8 + machinectl1 + + diff --git a/man/org.freedesktop.network1.xml b/man/org.freedesktop.network1.xml index 1d8ce0de811..c7f1a687989 100644 --- a/man/org.freedesktop.network1.xml +++ b/man/org.freedesktop.network1.xml @@ -602,4 +602,13 @@ $ gdbus introspect --system \ NamespaceNSID was added in version 256. + + + See Also + + systemd1 + systemd-networkd.service8 + networkctl1 + + diff --git a/man/org.freedesktop.oom1.xml b/man/org.freedesktop.oom1.xml index 1b549c347ca..4b61119d6b9 100644 --- a/man/org.freedesktop.oom1.xml +++ b/man/org.freedesktop.oom1.xml @@ -103,4 +103,14 @@ node /org/freedesktop/oom1 { Killed() was added in version 252. + + + See Also + + systemd1 + systemd-oomd.service8 + oomctl1 + + + diff --git a/man/org.freedesktop.portable1.xml b/man/org.freedesktop.portable1.xml index 4de3da2905d..af5e303e6e4 100644 --- a/man/org.freedesktop.portable1.xml +++ b/man/org.freedesktop.portable1.xml @@ -591,4 +591,13 @@ node /org/freedesktop/portable1 { ReattachWithExtensions() was added in version 254. + + + See Also + + systemd1 + systemd-portabled.service8 + portablectl1 + + diff --git a/man/org.freedesktop.resolve1.xml b/man/org.freedesktop.resolve1.xml index f6b70d6e4f4..07c0528b5c5 100644 --- a/man/org.freedesktop.resolve1.xml +++ b/man/org.freedesktop.resolve1.xml @@ -935,4 +935,13 @@ $ gdbus introspect --system \ + + + See Also + + systemd1 + systemd-resolved.service8 + resolvectl1 + + diff --git a/man/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml index 05afb93f9b0..e554e860cab 100644 --- a/man/org.freedesktop.systemd1.xml +++ b/man/org.freedesktop.systemd1.xml @@ -12489,4 +12489,13 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ DeferReactivation was added in version 257. + + + See Also + + systemd1 + systemctl1 + + + diff --git a/man/org.freedesktop.sysupdate1.xml b/man/org.freedesktop.sysupdate1.xml index 29b938f1a61..a109cef04a4 100644 --- a/man/org.freedesktop.sysupdate1.xml +++ b/man/org.freedesktop.sysupdate1.xml @@ -582,4 +582,13 @@ node /org/freedesktop/sysupdate1/job/_1 { Progress were added in version 257. + + + See Also + + systemd1 + systemd-sysupdated.service8 + updatectl1 + + diff --git a/man/org.freedesktop.timedate1.xml b/man/org.freedesktop.timedate1.xml index 1dfb630545c..d0271145f9f 100644 --- a/man/org.freedesktop.timedate1.xml +++ b/man/org.freedesktop.timedate1.xml @@ -194,7 +194,11 @@ $ gdbus introspect --system \ See Also - - More information on how the system clock and RTC interact + + systemd1 + systemd-timedate.service8 + timedatectl.service1 + More information on how the system clock and RTC interact + diff --git a/man/org.freedesktop.timesync1.xml b/man/org.freedesktop.timesync1.xml index 22bf73103d7..70f8b70b3a8 100644 --- a/man/org.freedesktop.timesync1.xml +++ b/man/org.freedesktop.timesync1.xml @@ -153,4 +153,11 @@ $ gdbus introspect --system \ + + See Also + + systemd1 + systemd-timesync.service8 + + diff --git a/man/systemd-hostnamed.service.xml b/man/systemd-hostnamed.service.xml index c2a4015ff0b..e7dc8792014 100644 --- a/man/systemd-hostnamed.service.xml +++ b/man/systemd-hostnamed.service.xml @@ -76,6 +76,7 @@ machine-info5 hostnamectl1 sethostname2 + org.freedesktop.hostname15 diff --git a/man/systemd-importd.service.xml b/man/systemd-importd.service.xml index dfeaff4fd77..cc5ac6af220 100644 --- a/man/systemd-importd.service.xml +++ b/man/systemd-importd.service.xml @@ -50,6 +50,7 @@ importctl1 systemd-machined.service8 systemd-nspawn1 + org.freedesktop.import15 diff --git a/man/systemd-localed.service.xml b/man/systemd-localed.service.xml index ef597de278b..43a4f66b5a7 100644 --- a/man/systemd-localed.service.xml +++ b/man/systemd-localed.service.xml @@ -55,6 +55,7 @@ vconsole.conf5 localectl1 loadkeys1 + org.freedesktop.locale15 diff --git a/man/systemd-logind.service.xml b/man/systemd-logind.service.xml index 4ecd700f8b2..93bcd6bc8f9 100644 --- a/man/systemd-logind.service.xml +++ b/man/systemd-logind.service.xml @@ -104,6 +104,7 @@ logind.conf5 pam_systemd8 sd-login3 + org.freedesktop.login15 diff --git a/man/systemd-machined.service.xml b/man/systemd-machined.service.xml index bb931ac50be..7ad35c85846 100644 --- a/man/systemd-machined.service.xml +++ b/man/systemd-machined.service.xml @@ -135,6 +135,7 @@ systemd-nspawn1 nss-mymachines8 systemd.special7 + org.freedesktop.machine15 diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml index b33a7f65108..2ded90f0f3e 100644 --- a/man/systemd-networkd.service.xml +++ b/man/systemd-networkd.service.xml @@ -63,6 +63,12 @@ systemd-networkd may be introspected and controlled at runtime using networkctl1. + + See + org.freedesktop.network15 + and + org.freedesktop.LogControl15 + for a description of the D-Bus API. Configuration Files @@ -91,6 +97,7 @@ systemd.netdev5 systemd-networkd-wait-online.service8 systemd-network-generator.service8 + org.freedesktop.network15 diff --git a/man/systemd-oomd.service.xml b/man/systemd-oomd.service.xml index 51a9377ea02..53a92509830 100644 --- a/man/systemd-oomd.service.xml +++ b/man/systemd-oomd.service.xml @@ -57,6 +57,12 @@ See oomd.conf5 for more information about the configuration of this service. + + See + org.freedesktop.oom15 + and + org.freedesktop.LogControl15 + for a description of the D-Bus API. @@ -129,6 +135,7 @@ systemd.resource-control5 oomd.conf5 oomctl1 + org.freedesktop.oom15 diff --git a/man/systemd-portabled.service.xml b/man/systemd-portabled.service.xml index abf42cff2fc..894b47bf270 100644 --- a/man/systemd-portabled.service.xml +++ b/man/systemd-portabled.service.xml @@ -37,6 +37,12 @@ See the Portable Services page for details about the concepts this service implements. + + See + org.freedesktop.portable15 + and + org.freedesktop.LogControl15 + for a description of the D-Bus API. diff --git a/man/systemd-resolved.service.xml b/man/systemd-resolved.service.xml index 210a8432336..b7673dc6c40 100644 --- a/man/systemd-resolved.service.xml +++ b/man/systemd-resolved.service.xml @@ -516,6 +516,7 @@ search foobar.com barbar.com hosts5 systemd.network5 systemd-networkd.service8 + org.freedesktop.resolve15 diff --git a/man/systemd-sysupdated.service.xml b/man/systemd-sysupdated.service.xml index 30a9bd8d696..768b19ef8d3 100644 --- a/man/systemd-sysupdated.service.xml +++ b/man/systemd-sysupdated.service.xml @@ -45,11 +45,12 @@ See Also - - systemd1, - systemd-sysupdate8 - updatectl1 - + + systemd1 + systemd-sysupdate8 + updatectl1 + org.freedesktop.sysupdate15 + diff --git a/man/systemd-timedated.service.xml b/man/systemd-timedated.service.xml index eb4fc180963..9f119189d2d 100644 --- a/man/systemd-timedated.service.xml +++ b/man/systemd-timedated.service.xml @@ -99,6 +99,7 @@ systemd-timesyncd.service localtime5 hwclock8 systemd-timesyncd8 + org.freedesktop.timedate15 diff --git a/man/systemd.xml b/man/systemd.xml index 71da1ec8f1d..e4eac906b35 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -1590,6 +1590,7 @@ kernel-command-line7 bootup7 systemd.directives7 + org.freedesktop.systemd15 For more information about the concepts and