diff options
author | Lennart Poettering <lennart@poettering.net> | 2021-04-28 15:59:13 +0200 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2021-04-29 16:39:09 +0200 |
commit | 97a72436506a08ee001eb8bbb1f28176ddb1f168 (patch) | |
tree | dfbb249d531581a6e4316c9805df3991a3dbd7e4 /man/org.freedesktop.hostname1.xml | |
parent | ac8a4f6b78fe70680d3bc1704b1f85bbcbe7bb55 (diff) | |
download | systemd-97a72436506a08ee001eb8bbb1f28176ddb1f168.tar.gz |
man: document new dbus method
Diffstat (limited to 'man/org.freedesktop.hostname1.xml')
-rw-r--r-- | man/org.freedesktop.hostname1.xml | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/man/org.freedesktop.hostname1.xml b/man/org.freedesktop.hostname1.xml index 3a5088eded..cc61caca71 100644 --- a/man/org.freedesktop.hostname1.xml +++ b/man/org.freedesktop.hostname1.xml @@ -58,6 +58,7 @@ node /org/freedesktop/hostname1 { in b interactive); GetProductUUID(in b interactive, out ay uuid); + Describe(out s UNNAMED); properties: readonly s Hostname = '...'; readonly s StaticHostname = '...'; @@ -118,6 +119,8 @@ node /org/freedesktop/hostname1 { <variablelist class="dbus-method" generated="True" extra-ref="GetProductUUID()"/> + <variablelist class="dbus-method" generated="True" extra-ref="Describe()"/> + <variablelist class="dbus-property" generated="True" extra-ref="Hostname"/> <variablelist class="dbus-property" generated="True" extra-ref="StaticHostname"/> @@ -232,6 +235,17 @@ node /org/freedesktop/hostname1 { <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>3</manvolnum></citerefentry> for that. For more information on these files and syscalls see the respective man pages.</para> + <para><varname>KernelName</varname>, <varname>KernelRelease</varname>, and + <varname>KernelVersion</varname> expose the kernel name (e.g. <literal>Linux</literal>), release + (e.g. <literal>5.0.0-11</literal>), and version (i.e. the build number, e.g. <literal>#11</literal>) as + reported by <citerefentry project="man-pages"><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry>. + <varname>OperatingSystemPrettyName</varname>, <varname>OperatingSystemCPEName</varname>, and + <varname>HomeURL</varname> expose the <varname>PRETTY_NAME=</varname>, <varname>CPE_NAME=</varname> and + <varname>HOME_URL=</varname> fields from + <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The + purpose of those properties is to allow remote clients to access this information over D-Bus. Local + clients can access the information directly.</para> + <refsect2> <title>Methods</title> @@ -261,22 +275,12 @@ node /org/freedesktop/hostname1 { <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the semantics of those settings.</para> - <para><function>GetProductUUID()</function> returns the "product uuid" as exposed by the kernel based + <para><function>GetProductUUID()</function> returns the "product UUID" as exposed by the kernel based on DMI information in <filename>/sys/class/dmi/id/product_uuid</filename>. Reading the file directly requires root privileges, and this method allows access to unprivileged clients through the polkit framework.</para> - <para><varname>KernelName</varname>, <varname>KernelRelease</varname>, and - <varname>KernelVersion</varname> expose the kernel name (e.g. <literal>Linux</literal>), release - (e.g. <literal>5.0.0-11</literal>), and version (i.e. the build number, e.g. <literal>#11</literal>) as - reported by - <citerefentry project="man-pages"><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry>. - <varname>OperatingSystemPrettyName</varname>, <varname>OperatingSystemCPEName</varname>, and - <varname>HomeURL</varname> expose the <varname>PRETTY_NAME=</varname>, <varname>CPE_NAME=</varname> and - <varname>HOME_URL=</varname> fields from - <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The - purpose of those properties is to allow remote clients to access this information over D-Bus. Local - clients can access the information directly.</para> + <para><function>Describe()</function> returns a JSON representation of all properties in one.</para> </refsect2> <refsect2> |