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