add new method handlers/properties for new location & deployment elements
[systembsd.git] / doc / hostnamed-docbook.xml-org.freedesktop.hostname1.xml
index c2381f05f54207aa1b96486c3e249f87af246e96..7dc21df0109b492ed703bbc3e2091802798e24c6 100644 (file)
@@ -8,23 +8,37 @@
   </refmeta>  <refnamediv>    <refname>org.freedesktop.hostname1</refname>    <refpurpose></refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
     <title role="synopsis.title">Methods</title>
     <synopsis>
-<link linkend="gdbus-method-org-freedesktop-hostname1.SetHostname">SetHostname</link>       (IN  s name,
-                   IN  b user_interaction);
-<link linkend="gdbus-method-org-freedesktop-hostname1.SetStaticHostname">SetStaticHostname</link> (IN  s name,
-                   IN  b user_interaction);
-<link linkend="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname">SetPrettyHostname</link> (IN  s name,
-                   IN  b user_interaction);
-<link linkend="gdbus-method-org-freedesktop-hostname1.SetIconName">SetIconName</link>       (IN  s name,
-                   IN  b user_interaction);
+<link linkend="gdbus-method-org-freedesktop-hostname1.SetHostname">SetHostname</link>       (IN  s unnamed_arg0,
+                   IN  b unnamed_arg1);
+<link linkend="gdbus-method-org-freedesktop-hostname1.SetStaticHostname">SetStaticHostname</link> (IN  s unnamed_arg0,
+                   IN  b unnamed_arg1);
+<link linkend="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname">SetPrettyHostname</link> (IN  s unnamed_arg0,
+                   IN  b unnamed_arg1);
+<link linkend="gdbus-method-org-freedesktop-hostname1.SetIconName">SetIconName</link>       (IN  s unnamed_arg0,
+                   IN  b unnamed_arg1);
+<link linkend="gdbus-method-org-freedesktop-hostname1.SetChassis">SetChassis</link>        (IN  s unnamed_arg0,
+                   IN  b unnamed_arg1);
+<link linkend="gdbus-method-org-freedesktop-hostname1.SetDeployment">SetDeployment</link>     (IN  s unnamed_arg0,
+                   IN  b unnamed_arg1);
+<link linkend="gdbus-method-org-freedesktop-hostname1.SetLocation">SetLocation</link>       (IN  s unnamed_arg0,
+                   IN  b unnamed_arg1);
 </synopsis>
   </refsynopsisdiv>
   <refsect1 role="properties">
     <title role="properties.title">Properties</title>
     <synopsis>
-<link linkend="gdbus-property-org-freedesktop-hostname1.Hostname">Hostname</link>        readable   s
-<link linkend="gdbus-property-org-freedesktop-hostname1.StaticHostname">StaticHostname</link>  readable   s
-<link linkend="gdbus-property-org-freedesktop-hostname1.PrettyHostname">PrettyHostname</link>  readable   s
-<link linkend="gdbus-property-org-freedesktop-hostname1.IconName">IconName</link>        readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.Hostname">Hostname</link>                   readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.StaticHostname">StaticHostname</link>             readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.PrettyHostname">PrettyHostname</link>             readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.IconName">IconName</link>                   readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.Chassis">Chassis</link>                    readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.Location">Location</link>                   readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.Deployment">Deployment</link>                 readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.KernelName">KernelName</link>                 readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.KernelRelease">KernelRelease</link>              readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.KernelVersion">KernelVersion</link>              readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.OperatingSystemPrettyName">OperatingSystemPrettyName</link>  readable   s
+<link linkend="gdbus-property-org-freedesktop-hostname1.OperatingSystemCPEName">OperatingSystemCPEName</link>     readable   s
 </synopsis>
   </refsect1>
 <refsect1 role="desc" id="gdbus-interface-org-freedesktop-hostname1">
   <title>The SetHostname() method</title>
   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetHostname"><primary sortas="hostname1.SetHostname">org.freedesktop.hostname1.SetHostname()</primary></indexterm>
 <programlisting>
-SetHostname (IN  s name,
-             IN  b user_interaction);
+SetHostname (IN  s unnamed_arg0,
+             IN  b unnamed_arg1);
 </programlisting>
 <para></para>
 <variablelist role="params">
 <varlistentry>
-  <term><literal>IN s <parameter>name</parameter></literal>:</term>
+  <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
   <listitem><para></para></listitem>
 </varlistentry>
 <varlistentry>
-  <term><literal>IN b <parameter>user_interaction</parameter></literal>:</term>
+  <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
   <listitem><para></para></listitem>
 </varlistentry>
 </variablelist>
@@ -56,17 +70,17 @@ SetHostname (IN  s name,
   <title>The SetStaticHostname() method</title>
   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetStaticHostname"><primary sortas="hostname1.SetStaticHostname">org.freedesktop.hostname1.SetStaticHostname()</primary></indexterm>
 <programlisting>
-SetStaticHostname (IN  s name,
-                   IN  b user_interaction);
+SetStaticHostname (IN  s unnamed_arg0,
+                   IN  b unnamed_arg1);
 </programlisting>
 <para></para>
 <variablelist role="params">
 <varlistentry>
-  <term><literal>IN s <parameter>name</parameter></literal>:</term>
+  <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
   <listitem><para></para></listitem>
 </varlistentry>
 <varlistentry>
-  <term><literal>IN b <parameter>user_interaction</parameter></literal>:</term>
+  <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
   <listitem><para></para></listitem>
 </varlistentry>
 </variablelist>
@@ -75,17 +89,17 @@ SetStaticHostname (IN  s name,
   <title>The SetPrettyHostname() method</title>
   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname"><primary sortas="hostname1.SetPrettyHostname">org.freedesktop.hostname1.SetPrettyHostname()</primary></indexterm>
 <programlisting>
-SetPrettyHostname (IN  s name,
-                   IN  b user_interaction);
+SetPrettyHostname (IN  s unnamed_arg0,
+                   IN  b unnamed_arg1);
 </programlisting>
 <para></para>
 <variablelist role="params">
 <varlistentry>
-  <term><literal>IN s <parameter>name</parameter></literal>:</term>
+  <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
   <listitem><para></para></listitem>
 </varlistentry>
 <varlistentry>
-  <term><literal>IN b <parameter>user_interaction</parameter></literal>:</term>
+  <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
   <listitem><para></para></listitem>
 </varlistentry>
 </variablelist>
@@ -94,17 +108,74 @@ SetPrettyHostname (IN  s name,
   <title>The SetIconName() method</title>
   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetIconName"><primary sortas="hostname1.SetIconName">org.freedesktop.hostname1.SetIconName()</primary></indexterm>
 <programlisting>
-SetIconName (IN  s name,
-             IN  b user_interaction);
+SetIconName (IN  s unnamed_arg0,
+             IN  b unnamed_arg1);
 </programlisting>
 <para></para>
 <variablelist role="params">
 <varlistentry>
-  <term><literal>IN s <parameter>name</parameter></literal>:</term>
+  <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
   <listitem><para></para></listitem>
 </varlistentry>
 <varlistentry>
-  <term><literal>IN b <parameter>user_interaction</parameter></literal>:</term>
+  <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
+  <listitem><para></para></listitem>
+</varlistentry>
+</variablelist>
+</refsect2>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetChassis">
+  <title>The SetChassis() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetChassis"><primary sortas="hostname1.SetChassis">org.freedesktop.hostname1.SetChassis()</primary></indexterm>
+<programlisting>
+SetChassis (IN  s unnamed_arg0,
+            IN  b unnamed_arg1);
+</programlisting>
+<para></para>
+<variablelist role="params">
+<varlistentry>
+  <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
+  <listitem><para></para></listitem>
+</varlistentry>
+<varlistentry>
+  <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
+  <listitem><para></para></listitem>
+</varlistentry>
+</variablelist>
+</refsect2>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetDeployment">
+  <title>The SetDeployment() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetDeployment"><primary sortas="hostname1.SetDeployment">org.freedesktop.hostname1.SetDeployment()</primary></indexterm>
+<programlisting>
+SetDeployment (IN  s unnamed_arg0,
+               IN  b unnamed_arg1);
+</programlisting>
+<para></para>
+<variablelist role="params">
+<varlistentry>
+  <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
+  <listitem><para></para></listitem>
+</varlistentry>
+<varlistentry>
+  <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
+  <listitem><para></para></listitem>
+</varlistentry>
+</variablelist>
+</refsect2>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetLocation">
+  <title>The SetLocation() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetLocation"><primary sortas="hostname1.SetLocation">org.freedesktop.hostname1.SetLocation()</primary></indexterm>
+<programlisting>
+SetLocation (IN  s unnamed_arg0,
+             IN  b unnamed_arg1);
+</programlisting>
+<para></para>
+<variablelist role="params">
+<varlistentry>
+  <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
+  <listitem><para></para></listitem>
+</varlistentry>
+<varlistentry>
+  <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
   <listitem><para></para></listitem>
 </varlistentry>
 </variablelist>
@@ -144,6 +215,70 @@ IconName  readable   s
 </programlisting>
 <para></para>
 </refsect2>
+<refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Chassis">
+  <title>The "Chassis" property</title>
+  <indexterm zone="gdbus-property-org-freedesktop-hostname1.Chassis"><primary sortas="hostname1:Chassis">org.freedesktop.hostname1:Chassis</primary></indexterm>
+<programlisting>
+Chassis  readable   s
+</programlisting>
+<para></para>
+</refsect2>
+<refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Location">
+  <title>The "Location" property</title>
+  <indexterm zone="gdbus-property-org-freedesktop-hostname1.Location"><primary sortas="hostname1:Location">org.freedesktop.hostname1:Location</primary></indexterm>
+<programlisting>
+Location  readable   s
+</programlisting>
+<para></para>
+</refsect2>
+<refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Deployment">
+  <title>The "Deployment" property</title>
+  <indexterm zone="gdbus-property-org-freedesktop-hostname1.Deployment"><primary sortas="hostname1:Deployment">org.freedesktop.hostname1:Deployment</primary></indexterm>
+<programlisting>
+Deployment  readable   s
+</programlisting>
+<para></para>
+</refsect2>
+<refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.KernelName">
+  <title>The "KernelName" property</title>
+  <indexterm zone="gdbus-property-org-freedesktop-hostname1.KernelName"><primary sortas="hostname1:KernelName">org.freedesktop.hostname1:KernelName</primary></indexterm>
+<programlisting>
+KernelName  readable   s
+</programlisting>
+<para></para>
+</refsect2>
+<refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.KernelRelease">
+  <title>The "KernelRelease" property</title>
+  <indexterm zone="gdbus-property-org-freedesktop-hostname1.KernelRelease"><primary sortas="hostname1:KernelRelease">org.freedesktop.hostname1:KernelRelease</primary></indexterm>
+<programlisting>
+KernelRelease  readable   s
+</programlisting>
+<para></para>
+</refsect2>
+<refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.KernelVersion">
+  <title>The "KernelVersion" property</title>
+  <indexterm zone="gdbus-property-org-freedesktop-hostname1.KernelVersion"><primary sortas="hostname1:KernelVersion">org.freedesktop.hostname1:KernelVersion</primary></indexterm>
+<programlisting>
+KernelVersion  readable   s
+</programlisting>
+<para></para>
+</refsect2>
+<refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.OperatingSystemPrettyName">
+  <title>The "OperatingSystemPrettyName" property</title>
+  <indexterm zone="gdbus-property-org-freedesktop-hostname1.OperatingSystemPrettyName"><primary sortas="hostname1:OperatingSystemPrettyName">org.freedesktop.hostname1:OperatingSystemPrettyName</primary></indexterm>
+<programlisting>
+OperatingSystemPrettyName  readable   s
+</programlisting>
+<para></para>
+</refsect2>
+<refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.OperatingSystemCPEName">
+  <title>The "OperatingSystemCPEName" property</title>
+  <indexterm zone="gdbus-property-org-freedesktop-hostname1.OperatingSystemCPEName"><primary sortas="hostname1:OperatingSystemCPEName">org.freedesktop.hostname1:OperatingSystemCPEName</primary></indexterm>
+<programlisting>
+OperatingSystemCPEName  readable   s
+</programlisting>
+<para></para>
+</refsect2>
 </refsect1>
 </refentry>