minor, initialize counter to zero. i might be a bit tired.
[systembsd.git] / 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 </synopsis>
22 </refsynopsisdiv>
23 <refsect1 role="properties">
24 <title role="properties.title">Properties</title>
25 <synopsis>
26 <link linkend="gdbus-property-org-freedesktop-hostname1.Hostname">Hostname</link> readable s
27 <link linkend="gdbus-property-org-freedesktop-hostname1.StaticHostname">StaticHostname</link> readable s
28 <link linkend="gdbus-property-org-freedesktop-hostname1.PrettyHostname">PrettyHostname</link> readable s
29 <link linkend="gdbus-property-org-freedesktop-hostname1.IconName">IconName</link> readable s
30 <link linkend="gdbus-property-org-freedesktop-hostname1.Chassis">Chassis</link> readable s
31 <link linkend="gdbus-property-org-freedesktop-hostname1.KernelName">KernelName</link> readable s
32 <link linkend="gdbus-property-org-freedesktop-hostname1.KernelRelease">KernelRelease</link> readable s
33 <link linkend="gdbus-property-org-freedesktop-hostname1.KernelVersion">KernelVersion</link> readable s
34 <link linkend="gdbus-property-org-freedesktop-hostname1.OperatingSystemPrettyName">OperatingSystemPrettyName</link> readable s
35 <link linkend="gdbus-property-org-freedesktop-hostname1.OperatingSystemCPEName">OperatingSystemCPEName</link> readable s
36 </synopsis>
37 </refsect1>
38 <refsect1 role="desc" id="gdbus-interface-org-freedesktop-hostname1">
39 <title role="desc.title">Description</title>
40 <para></para>
41 </refsect1>
42 <refsect1 role="details" id="gdbus-methods-org.freedesktop.hostname1">
43 <title role="details.title">Method Details</title>
44 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetHostname">
45 <title>The SetHostname() method</title>
46 <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetHostname"><primary sortas="hostname1.SetHostname">org.freedesktop.hostname1.SetHostname()</primary></indexterm>
47 <programlisting>
48 SetHostname (IN s unnamed_arg0,
49 IN b unnamed_arg1);
50 </programlisting>
51 <para></para>
52 <variablelist role="params">
53 <varlistentry>
54 <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
55 <listitem><para></para></listitem>
56 </varlistentry>
57 <varlistentry>
58 <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
59 <listitem><para></para></listitem>
60 </varlistentry>
61 </variablelist>
62 </refsect2>
63 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetStaticHostname">
64 <title>The SetStaticHostname() method</title>
65 <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetStaticHostname"><primary sortas="hostname1.SetStaticHostname">org.freedesktop.hostname1.SetStaticHostname()</primary></indexterm>
66 <programlisting>
67 SetStaticHostname (IN s unnamed_arg0,
68 IN b unnamed_arg1);
69 </programlisting>
70 <para></para>
71 <variablelist role="params">
72 <varlistentry>
73 <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
74 <listitem><para></para></listitem>
75 </varlistentry>
76 <varlistentry>
77 <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
78 <listitem><para></para></listitem>
79 </varlistentry>
80 </variablelist>
81 </refsect2>
82 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname">
83 <title>The SetPrettyHostname() method</title>
84 <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetPrettyHostname"><primary sortas="hostname1.SetPrettyHostname">org.freedesktop.hostname1.SetPrettyHostname()</primary></indexterm>
85 <programlisting>
86 SetPrettyHostname (IN s unnamed_arg0,
87 IN b unnamed_arg1);
88 </programlisting>
89 <para></para>
90 <variablelist role="params">
91 <varlistentry>
92 <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
93 <listitem><para></para></listitem>
94 </varlistentry>
95 <varlistentry>
96 <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
97 <listitem><para></para></listitem>
98 </varlistentry>
99 </variablelist>
100 </refsect2>
101 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetIconName">
102 <title>The SetIconName() method</title>
103 <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetIconName"><primary sortas="hostname1.SetIconName">org.freedesktop.hostname1.SetIconName()</primary></indexterm>
104 <programlisting>
105 SetIconName (IN s unnamed_arg0,
106 IN b unnamed_arg1);
107 </programlisting>
108 <para></para>
109 <variablelist role="params">
110 <varlistentry>
111 <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
112 <listitem><para></para></listitem>
113 </varlistentry>
114 <varlistentry>
115 <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
116 <listitem><para></para></listitem>
117 </varlistentry>
118 </variablelist>
119 </refsect2>
120 <refsect2 role="method" id="gdbus-method-org-freedesktop-hostname1.SetChassis">
121 <title>The SetChassis() method</title>
122 <indexterm zone="gdbus-method-org-freedesktop-hostname1.SetChassis"><primary sortas="hostname1.SetChassis">org.freedesktop.hostname1.SetChassis()</primary></indexterm>
123 <programlisting>
124 SetChassis (IN s unnamed_arg0,
125 IN b unnamed_arg1);
126 </programlisting>
127 <para></para>
128 <variablelist role="params">
129 <varlistentry>
130 <term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
131 <listitem><para></para></listitem>
132 </varlistentry>
133 <varlistentry>
134 <term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
135 <listitem><para></para></listitem>
136 </varlistentry>
137 </variablelist>
138 </refsect2>
139 </refsect1>
140 <refsect1 role="details" id="gdbus-properties-org.freedesktop.hostname1">
141 <title role="details.title">Property Details</title>
142 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Hostname">
143 <title>The "Hostname" property</title>
144 <indexterm zone="gdbus-property-org-freedesktop-hostname1.Hostname"><primary sortas="hostname1:Hostname">org.freedesktop.hostname1:Hostname</primary></indexterm>
145 <programlisting>
146 Hostname readable s
147 </programlisting>
148 <para></para>
149 </refsect2>
150 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.StaticHostname">
151 <title>The "StaticHostname" property</title>
152 <indexterm zone="gdbus-property-org-freedesktop-hostname1.StaticHostname"><primary sortas="hostname1:StaticHostname">org.freedesktop.hostname1:StaticHostname</primary></indexterm>
153 <programlisting>
154 StaticHostname readable s
155 </programlisting>
156 <para></para>
157 </refsect2>
158 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.PrettyHostname">
159 <title>The "PrettyHostname" property</title>
160 <indexterm zone="gdbus-property-org-freedesktop-hostname1.PrettyHostname"><primary sortas="hostname1:PrettyHostname">org.freedesktop.hostname1:PrettyHostname</primary></indexterm>
161 <programlisting>
162 PrettyHostname readable s
163 </programlisting>
164 <para></para>
165 </refsect2>
166 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.IconName">
167 <title>The "IconName" property</title>
168 <indexterm zone="gdbus-property-org-freedesktop-hostname1.IconName"><primary sortas="hostname1:IconName">org.freedesktop.hostname1:IconName</primary></indexterm>
169 <programlisting>
170 IconName readable s
171 </programlisting>
172 <para></para>
173 </refsect2>
174 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.Chassis">
175 <title>The "Chassis" property</title>
176 <indexterm zone="gdbus-property-org-freedesktop-hostname1.Chassis"><primary sortas="hostname1:Chassis">org.freedesktop.hostname1:Chassis</primary></indexterm>
177 <programlisting>
178 Chassis readable s
179 </programlisting>
180 <para></para>
181 </refsect2>
182 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.KernelName">
183 <title>The "KernelName" property</title>
184 <indexterm zone="gdbus-property-org-freedesktop-hostname1.KernelName"><primary sortas="hostname1:KernelName">org.freedesktop.hostname1:KernelName</primary></indexterm>
185 <programlisting>
186 KernelName readable s
187 </programlisting>
188 <para></para>
189 </refsect2>
190 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.KernelRelease">
191 <title>The "KernelRelease" property</title>
192 <indexterm zone="gdbus-property-org-freedesktop-hostname1.KernelRelease"><primary sortas="hostname1:KernelRelease">org.freedesktop.hostname1:KernelRelease</primary></indexterm>
193 <programlisting>
194 KernelRelease readable s
195 </programlisting>
196 <para></para>
197 </refsect2>
198 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.KernelVersion">
199 <title>The "KernelVersion" property</title>
200 <indexterm zone="gdbus-property-org-freedesktop-hostname1.KernelVersion"><primary sortas="hostname1:KernelVersion">org.freedesktop.hostname1:KernelVersion</primary></indexterm>
201 <programlisting>
202 KernelVersion readable s
203 </programlisting>
204 <para></para>
205 </refsect2>
206 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.OperatingSystemPrettyName">
207 <title>The "OperatingSystemPrettyName" property</title>
208 <indexterm zone="gdbus-property-org-freedesktop-hostname1.OperatingSystemPrettyName"><primary sortas="hostname1:OperatingSystemPrettyName">org.freedesktop.hostname1:OperatingSystemPrettyName</primary></indexterm>
209 <programlisting>
210 OperatingSystemPrettyName readable s
211 </programlisting>
212 <para></para>
213 </refsect2>
214 <refsect2 role="property" id="gdbus-property-org-freedesktop-hostname1.OperatingSystemCPEName">
215 <title>The "OperatingSystemCPEName" property</title>
216 <indexterm zone="gdbus-property-org-freedesktop-hostname1.OperatingSystemCPEName"><primary sortas="hostname1:OperatingSystemCPEName">org.freedesktop.hostname1:OperatingSystemCPEName</primary></indexterm>
217 <programlisting>
218 OperatingSystemCPEName readable s
219 </programlisting>
220 <para></para>
221 </refsect2>
222 </refsect1>
223 </refentry>
224