doc/hostnamed-docbook.xml-org.freedesktop.hostname1.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 ]>
   5 <refentry id="gdbus-org.freedesktop.hostname1">
   6   <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-hostname1.top_of_page">org.freedesktop.hostname1</refentrytitle>
   7   <indexterm zone="gdbus-interface-org-freedesktop-hostname1.top_of_page"><primary sortas="hostname1">org.freedesktop.hostname1</primary></indexterm>
   8   </refmeta>  <refnamediv>    <refname>org.freedesktop.hostname1</refname>    <refpurpose></refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
   9     <title role="synopsis.title">Methods</title>
  10     <synopsis>
  11 <link linkend="gdbus-method-org-freedesktop-hostname1.SetHostname">SetHostname</link>       (IN  s unnamed_arg0,
  12                    IN  b unnamed_arg1);
  13 <link linkend="gdbus-method-org-freedesktop-hostname1.SetStaticHostname">SetStaticHostname</link> (IN  s unnamed_arg0,
  14                    IN  b unnamed_arg1);
  15 <link linkend="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname">SetPrettyHostname</link> (IN  s unnamed_arg0,
  16                    IN  b unnamed_arg1);
  17 <link linkend="gdbus-method-org-freedesktop-hostname1.SetIconName">SetIconName</link>       (IN  s unnamed_arg0,
  18                    IN  b unnamed_arg1);
  19 <link linkend="gdbus-method-org-freedesktop-hostname1.SetChassis">SetChassis</link>        (IN  s unnamed_arg0,
  20                    IN  b unnamed_arg1);
  21 <link linkend="gdbus-method-org-freedesktop-hostname1.SetDeployment">SetDeployment</link>     (IN  s unnamed_arg0,
  22                    IN  b unnamed_arg1);
  23 <link linkend="gdbus-method-org-freedesktop-hostname1.SetLocation">SetLocation</link>       (IN  s unnamed_arg0,
  24                    IN  b unnamed_arg1);
  25 </synopsis>
  26   </refsynopsisdiv>
  27   <refsect1 role="properties">
  28     <title role="properties.title">Properties</title>
  29     <synopsis>
  30 <link linkend="gdbus-property-org-freedesktop-hostname1.Hostname">Hostname</link>                   readable   s
  31 <link linkend="gdbus-property-org-freedesktop-hostname1.StaticHostname">StaticHostname</link>             readable   s
  32 <link linkend="gdbus-property-org-freedesktop-hostname1.PrettyHostname">PrettyHostname</link>             readable   s
  33 <link linkend="gdbus-property-org-freedesktop-hostname1.IconName">IconName</link>                   readable   s
  34 <link linkend="gdbus-property-org-freedesktop-hostname1.Chassis">Chassis</link>                    readable   s
  35 <link linkend="gdbus-property-org-freedesktop-hostname1.Location">Location</link>                   readable   s
  36 <link linkend="gdbus-property-org-freedesktop-hostname1.Deployment">Deployment</link>                 readable   s
  37 <link linkend="gdbus-property-org-freedesktop-hostname1.KernelName">KernelName</link>                 readable   s
  38 <link linkend="gdbus-property-org-freedesktop-hostname1.KernelRelease">KernelRelease</link>              readable   s
  39 <link linkend="gdbus-property-org-freedesktop-hostname1.KernelVersion">KernelVersion</link>              readable   s
  40 <link linkend="gdbus-property-org-freedesktop-hostname1.OperatingSystemPrettyName">OperatingSystemPrettyName</link>  readable   s
  41 <link linkend="gdbus-property-org-freedesktop-hostname1.OperatingSystemCPEName">OperatingSystemCPEName</link>     readable   s
  42 </synopsis>
  43   </refsect1>
  44 <refsect1 role="desc" id="gdbus-interface-org-freedesktop-hostname1">
  45   <title role="desc.title">Description</title>
  46   <para></para>
  47 </refsect1>
  48 <refsect1 role="details" id="gdbus-methods-org.freedesktop.hostname1">
  49   <title role="details.title">Method Details</title>
  50 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetHostname">
  51   <title>The SetHostname() method</title>
  52   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetHostname"><primary sortas="hostname1.SetHostname">org.freedesktop.hostname1.SetHostname()</primary></indexterm>
  53 <programlisting>
  54 SetHostname (IN  s unnamed_arg0,
  55              IN  b unnamed_arg1);
  56 </programlisting>
  57 <para></para>
  58 <variablelist role="params">
  59 <varlistentry>
  60   <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
  61   <listitem><para></para></listitem>
  62 </varlistentry>
  63 <varlistentry>
  64   <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
  65   <listitem><para></para></listitem>
  66 </varlistentry>
  67 </variablelist>
  68 </refsect2>
  69 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetStaticHostname">
  70   <title>The SetStaticHostname() method</title>
  71   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetStaticHostname"><primary sortas="hostname1.SetStaticHostname">org.freedesktop.hostname1.SetStaticHostname()</primary></indexterm>
  72 <programlisting>
  73 SetStaticHostname (IN  s unnamed_arg0,
  74                    IN  b unnamed_arg1);
  75 </programlisting>
  76 <para></para>
  77 <variablelist role="params">
  78 <varlistentry>
  79   <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
  80   <listitem><para></para></listitem>
  81 </varlistentry>
  82 <varlistentry>
  83   <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
  84   <listitem><para></para></listitem>
  85 </varlistentry>
  86 </variablelist>
  87 </refsect2>
  88 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname">
  89   <title>The SetPrettyHostname() method</title>
  90   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname"><primary sortas="hostname1.SetPrettyHostname">org.freedesktop.hostname1.SetPrettyHostname()</primary></indexterm>
  91 <programlisting>
  92 SetPrettyHostname (IN  s unnamed_arg0,
  93                    IN  b unnamed_arg1);
  94 </programlisting>
  95 <para></para>
  96 <variablelist role="params">
  97 <varlistentry>
  98   <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
  99   <listitem><para></para></listitem>
 100 </varlistentry>
 101 <varlistentry>
 102   <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
 103   <listitem><para></para></listitem>
 104 </varlistentry>
 105 </variablelist>
 106 </refsect2>
 107 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetIconName">
 108   <title>The SetIconName() method</title>
 109   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetIconName"><primary sortas="hostname1.SetIconName">org.freedesktop.hostname1.SetIconName()</primary></indexterm>
 110 <programlisting>
 111 SetIconName (IN  s unnamed_arg0,
 112              IN  b unnamed_arg1);
 113 </programlisting>
 114 <para></para>
 115 <variablelist role="params">
 116 <varlistentry>
 117   <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
 118   <listitem><para></para></listitem>
 119 </varlistentry>
 120 <varlistentry>
 121   <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
 122   <listitem><para></para></listitem>
 123 </varlistentry>
 124 </variablelist>
 125 </refsect2>
 126 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetChassis">
 127   <title>The SetChassis() method</title>
 128   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetChassis"><primary sortas="hostname1.SetChassis">org.freedesktop.hostname1.SetChassis()</primary></indexterm>
 129 <programlisting>
 130 SetChassis (IN  s unnamed_arg0,
 131             IN  b unnamed_arg1);
 132 </programlisting>
 133 <para></para>
 134 <variablelist role="params">
 135 <varlistentry>
 136   <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
 137   <listitem><para></para></listitem>
 138 </varlistentry>
 139 <varlistentry>
 140   <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
 141   <listitem><para></para></listitem>
 142 </varlistentry>
 143 </variablelist>
 144 </refsect2>
 145 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetDeployment">
 146   <title>The SetDeployment() method</title>
 147   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetDeployment"><primary sortas="hostname1.SetDeployment">org.freedesktop.hostname1.SetDeployment()</primary></indexterm>
 148 <programlisting>
 149 SetDeployment (IN  s unnamed_arg0,
 150                IN  b unnamed_arg1);
 151 </programlisting>
 152 <para></para>
 153 <variablelist role="params">
 154 <varlistentry>
 155   <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
 156   <listitem><para></para></listitem>
 157 </varlistentry>
 158 <varlistentry>
 159   <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
 160   <listitem><para></para></listitem>
 161 </varlistentry>
 162 </variablelist>
 163 </refsect2>
 164 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetLocation">
 165   <title>The SetLocation() method</title>
 166   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetLocation"><primary sortas="hostname1.SetLocation">org.freedesktop.hostname1.SetLocation()</primary></indexterm>
 167 <programlisting>
 168 SetLocation (IN  s unnamed_arg0,
 169              IN  b unnamed_arg1);
 170 </programlisting>
 171 <para></para>
 172 <variablelist role="params">
 173 <varlistentry>
 174   <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
 175   <listitem><para></para></listitem>
 176 </varlistentry>
 177 <varlistentry>
 178   <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
 179   <listitem><para></para></listitem>
 180 </varlistentry>
 181 </variablelist>
 182 </refsect2>
 183 </refsect1>
 184 <refsect1 role="details" id="gdbus-properties-org.freedesktop.hostname1">
 185   <title role="details.title">Property Details</title>
 186 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Hostname">
 187   <title>The "Hostname" property</title>
 188   <indexterm zone="gdbus-property-org-freedesktop-hostname1.Hostname"><primary sortas="hostname1:Hostname">org.freedesktop.hostname1:Hostname</primary></indexterm>
 189 <programlisting>
 190 Hostname  readable   s
 191 </programlisting>
 192 <para></para>
 193 </refsect2>
 194 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.StaticHostname">
 195   <title>The "StaticHostname" property</title>
 196   <indexterm zone="gdbus-property-org-freedesktop-hostname1.StaticHostname"><primary sortas="hostname1:StaticHostname">org.freedesktop.hostname1:StaticHostname</primary></indexterm>
 197 <programlisting>
 198 StaticHostname  readable   s
 199 </programlisting>
 200 <para></para>
 201 </refsect2>
 202 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.PrettyHostname">
 203   <title>The "PrettyHostname" property</title>
 204   <indexterm zone="gdbus-property-org-freedesktop-hostname1.PrettyHostname"><primary sortas="hostname1:PrettyHostname">org.freedesktop.hostname1:PrettyHostname</primary></indexterm>
 205 <programlisting>
 206 PrettyHostname  readable   s
 207 </programlisting>
 208 <para></para>
 209 </refsect2>
 210 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.IconName">
 211   <title>The "IconName" property</title>
 212   <indexterm zone="gdbus-property-org-freedesktop-hostname1.IconName"><primary sortas="hostname1:IconName">org.freedesktop.hostname1:IconName</primary></indexterm>
 213 <programlisting>
 214 IconName  readable   s
 215 </programlisting>
 216 <para></para>
 217 </refsect2>
 218 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Chassis">
 219   <title>The "Chassis" property</title>
 220   <indexterm zone="gdbus-property-org-freedesktop-hostname1.Chassis"><primary sortas="hostname1:Chassis">org.freedesktop.hostname1:Chassis</primary></indexterm>
 221 <programlisting>
 222 Chassis  readable   s
 223 </programlisting>
 224 <para></para>
 225 </refsect2>
 226 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Location">
 227   <title>The "Location" property</title>
 228   <indexterm zone="gdbus-property-org-freedesktop-hostname1.Location"><primary sortas="hostname1:Location">org.freedesktop.hostname1:Location</primary></indexterm>
 229 <programlisting>
 230 Location  readable   s
 231 </programlisting>
 232 <para></para>
 233 </refsect2>
 234 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Deployment">
 235   <title>The "Deployment" property</title>
 236   <indexterm zone="gdbus-property-org-freedesktop-hostname1.Deployment"><primary sortas="hostname1:Deployment">org.freedesktop.hostname1:Deployment</primary></indexterm>
 237 <programlisting>
 238 Deployment  readable   s
 239 </programlisting>
 240 <para></para>
 241 </refsect2>
 242 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.KernelName">
 243   <title>The "KernelName" property</title>
 244   <indexterm zone="gdbus-property-org-freedesktop-hostname1.KernelName"><primary sortas="hostname1:KernelName">org.freedesktop.hostname1:KernelName</primary></indexterm>
 245 <programlisting>
 246 KernelName  readable   s
 247 </programlisting>
 248 <para></para>
 249 </refsect2>
 250 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.KernelRelease">
 251   <title>The "KernelRelease" property</title>
 252   <indexterm zone="gdbus-property-org-freedesktop-hostname1.KernelRelease"><primary sortas="hostname1:KernelRelease">org.freedesktop.hostname1:KernelRelease</primary></indexterm>
 253 <programlisting>
 254 KernelRelease  readable   s
 255 </programlisting>
 256 <para></para>
 257 </refsect2>
 258 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.KernelVersion">
 259   <title>The "KernelVersion" property</title>
 260   <indexterm zone="gdbus-property-org-freedesktop-hostname1.KernelVersion"><primary sortas="hostname1:KernelVersion">org.freedesktop.hostname1:KernelVersion</primary></indexterm>
 261 <programlisting>
 262 KernelVersion  readable   s
 263 </programlisting>
 264 <para></para>
 265 </refsect2>
 266 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.OperatingSystemPrettyName">
 267   <title>The "OperatingSystemPrettyName" property</title>
 268   <indexterm zone="gdbus-property-org-freedesktop-hostname1.OperatingSystemPrettyName"><primary sortas="hostname1:OperatingSystemPrettyName">org.freedesktop.hostname1:OperatingSystemPrettyName</primary></indexterm>
 269 <programlisting>
 270 OperatingSystemPrettyName  readable   s
 271 </programlisting>
 272 <para></para>
 273 </refsect2>
 274 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.OperatingSystemCPEName">
 275   <title>The "OperatingSystemCPEName" property</title>
 276   <indexterm zone="gdbus-property-org-freedesktop-hostname1.OperatingSystemCPEName"><primary sortas="hostname1:OperatingSystemCPEName">org.freedesktop.hostname1:OperatingSystemCPEName</primary></indexterm>
 277 <programlisting>
 278 OperatingSystemCPEName  readable   s
 279 </programlisting>
 280 <para></para>
 281 </refsect2>
 282 </refsect1>
 283 </refentry>
 284