doc/hostnamed-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="">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 name,
  12                    IN  b user_interaction);
  13 <link linkend="gdbus-method-org-freedesktop-hostname1.SetStaticHostname">SetStaticHostname</link> (IN  s name,
  14                    IN  b user_interaction);
  15 <link linkend="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname">SetPrettyHostname</link> (IN  s name,
  16                    IN  b user_interaction);
  17 <link linkend="gdbus-method-org-freedesktop-hostname1.SetIconName">SetIconName</link>       (IN  s name,
  18                    IN  b user_interaction);
  19 </synopsis>
  20   </refsynopsisdiv>
  21   <refsect1 role="properties">
  22     <title role="properties.title">Properties</title>
  23     <synopsis>
  24 <link linkend="gdbus-property-org-freedesktop-hostname1.Hostname">Hostname</link>        readable   s
  25 <link linkend="gdbus-property-org-freedesktop-hostname1.StaticHostname">StaticHostname</link>  readable   s
  26 <link linkend="gdbus-property-org-freedesktop-hostname1.PrettyHostname">PrettyHostname</link>  readable   s
  27 <link linkend="gdbus-property-org-freedesktop-hostname1.IconName">IconName</link>        readable   s
  28 </synopsis>
  29   </refsect1>
  30 <refsect1 role="desc" id="gdbus-interface-org-freedesktop-hostname1">
  31   <title role="desc.title">Description</title>
  32   <para></para>
  33 </refsect1>
  34 <refsect1 role="details" id="gdbus-methods-org.freedesktop.hostname1">
  35   <title role="details.title">Method Details</title>
  36 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetHostname">
  37   <title>The SetHostname() method</title>
  38   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetHostname"><primary sortas=".SetHostname">org.freedesktop.hostname1.SetHostname()</primary></indexterm>
  39 <programlisting>
  40 SetHostname (IN  s name,
  41              IN  b user_interaction);
  42 </programlisting>
  43 <para></para>
  44 <variablelist role="params">
  45 <varlistentry>
  46   <term><literal>IN s <parameter>name</parameter></literal>:</term>
  47   <listitem><para></para></listitem>
  48 </varlistentry>
  49 <varlistentry>
  50   <term><literal>IN b <parameter>user_interaction</parameter></literal>:</term>
  51   <listitem><para></para></listitem>
  52 </varlistentry>
  53 </variablelist>
  54 </refsect2>
  55 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetStaticHostname">
  56   <title>The SetStaticHostname() method</title>
  57   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetStaticHostname"><primary sortas=".SetStaticHostname">org.freedesktop.hostname1.SetStaticHostname()</primary></indexterm>
  58 <programlisting>
  59 SetStaticHostname (IN  s name,
  60                    IN  b user_interaction);
  61 </programlisting>
  62 <para></para>
  63 <variablelist role="params">
  64 <varlistentry>
  65   <term><literal>IN s <parameter>name</parameter></literal>:</term>
  66   <listitem><para></para></listitem>
  67 </varlistentry>
  68 <varlistentry>
  69   <term><literal>IN b <parameter>user_interaction</parameter></literal>:</term>
  70   <listitem><para></para></listitem>
  71 </varlistentry>
  72 </variablelist>
  73 </refsect2>
  74 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname">
  75   <title>The SetPrettyHostname() method</title>
  76   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname"><primary sortas=".SetPrettyHostname">org.freedesktop.hostname1.SetPrettyHostname()</primary></indexterm>
  77 <programlisting>
  78 SetPrettyHostname (IN  s name,
  79                    IN  b user_interaction);
  80 </programlisting>
  81 <para></para>
  82 <variablelist role="params">
  83 <varlistentry>
  84   <term><literal>IN s <parameter>name</parameter></literal>:</term>
  85   <listitem><para></para></listitem>
  86 </varlistentry>
  87 <varlistentry>
  88   <term><literal>IN b <parameter>user_interaction</parameter></literal>:</term>
  89   <listitem><para></para></listitem>
  90 </varlistentry>
  91 </variablelist>
  92 </refsect2>
  93 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetIconName">
  94   <title>The SetIconName() method</title>
  95   <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetIconName"><primary sortas=".SetIconName">org.freedesktop.hostname1.SetIconName()</primary></indexterm>
  96 <programlisting>
  97 SetIconName (IN  s name,
  98              IN  b user_interaction);
  99 </programlisting>
 100 <para></para>
 101 <variablelist role="params">
 102 <varlistentry>
 103   <term><literal>IN s <parameter>name</parameter></literal>:</term>
 104   <listitem><para></para></listitem>
 105 </varlistentry>
 106 <varlistentry>
 107   <term><literal>IN b <parameter>user_interaction</parameter></literal>:</term>
 108   <listitem><para></para></listitem>
 109 </varlistentry>
 110 </variablelist>
 111 </refsect2>
 112 </refsect1>
 113 <refsect1 role="details" id="gdbus-properties-org.freedesktop.hostname1">
 114   <title role="details.title">Property Details</title>
 115 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Hostname">
 116   <title>The "Hostname" property</title>
 117   <indexterm zone="gdbus-property-org-freedesktop-hostname1.Hostname"><primary sortas=":Hostname">org.freedesktop.hostname1:Hostname</primary></indexterm>
 118 <programlisting>
 119 Hostname  readable   s
 120 </programlisting>
 121 <para></para>
 122 </refsect2>
 123 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.StaticHostname">
 124   <title>The "StaticHostname" property</title>
 125   <indexterm zone="gdbus-property-org-freedesktop-hostname1.StaticHostname"><primary sortas=":StaticHostname">org.freedesktop.hostname1:StaticHostname</primary></indexterm>
 126 <programlisting>
 127 StaticHostname  readable   s
 128 </programlisting>
 129 <para></para>
 130 </refsect2>
 131 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.PrettyHostname">
 132   <title>The "PrettyHostname" property</title>
 133   <indexterm zone="gdbus-property-org-freedesktop-hostname1.PrettyHostname"><primary sortas=":PrettyHostname">org.freedesktop.hostname1:PrettyHostname</primary></indexterm>
 134 <programlisting>
 135 PrettyHostname  readable   s
 136 </programlisting>
 137 <para></para>
 138 </refsect2>
 139 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.IconName">
 140   <title>The "IconName" property</title>
 141   <indexterm zone="gdbus-property-org-freedesktop-hostname1.IconName"><primary sortas=":IconName">org.freedesktop.hostname1:IconName</primary></indexterm>
 142 <programlisting>
 143 IconName  readable   s
 144 </programlisting>
 145 <para></para>
 146 </refsect2>
 147 </refsect1>
 148 </refentry>
 149