[systembsd.git] / doc / timedated-docbook.xml-org.freedesktop.timedate1.xml

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="gdbus-org.freedesktop.timedate1">
  <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-timedate1.top_of_page">org.freedesktop.timedate1</refentrytitle>
  <indexterm zone="gdbus-interface-org-freedesktop-timedate1.top_of_page"><primary sortas="timedate1">org.freedesktop.timedate1</primary></indexterm>
  </refmeta>  <refnamediv>    <refname>org.freedesktop.timedate1</refname>    <refpurpose></refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
    <title role="synopsis.title">Methods</title>
    <synopsis>
<link linkend="gdbus-method-org-freedesktop-timedate1.SetTime">SetTime</link>     (IN  x unnamed_arg0,
             IN  b unnamed_arg1,
             IN  b unnamed_arg2);
<link linkend="gdbus-method-org-freedesktop-timedate1.SetTimezone">SetTimezone</link> (IN  s unnamed_arg0,
             IN  b unnamed_arg1);
<link linkend="gdbus-method-org-freedesktop-timedate1.SetLocalRTC">SetLocalRTC</link> (IN  b unnamed_arg0,
             IN  b unnamed_arg1,
             IN  b unnamed_arg2);
<link linkend="gdbus-method-org-freedesktop-timedate1.SetNTP">SetNTP</link>      (IN  b unnamed_arg0,
             IN  b unnamed_arg1);
</synopsis>
  </refsynopsisdiv>
  <refsect1 role="properties">
    <title role="properties.title">Properties</title>
    <synopsis>
<link linkend="gdbus-property-org-freedesktop-timedate1.Timezone">Timezone</link>         readable   s
<link linkend="gdbus-property-org-freedesktop-timedate1.LocalRTC">LocalRTC</link>         readable   b
<link linkend="gdbus-property-org-freedesktop-timedate1.CanNTP">CanNTP</link>           readable   b
<link linkend="gdbus-property-org-freedesktop-timedate1.NTP">NTP</link>              readable   b
<link linkend="gdbus-property-org-freedesktop-timedate1.NTPSynchronized">NTPSynchronized</link>  readable   b
<link linkend="gdbus-property-org-freedesktop-timedate1.TimeUSec">TimeUSec</link>         readable   t
<link linkend="gdbus-property-org-freedesktop-timedate1.RTCTimeUSec">RTCTimeUSec</link>      readable   t
</synopsis>
  </refsect1>
<refsect1 role="desc" id="gdbus-interface-org-freedesktop-timedate1">
  <title role="desc.title">Description</title>
  <para></para>
</refsect1>
<refsect1 role="details" id="gdbus-methods-org.freedesktop.timedate1">
  <title role="details.title">Method Details</title>
<refsect2 role="method" id="gdbus-method-org-freedesktop-timedate1.SetTime">
  <title>The SetTime() method</title>
  <indexterm zone="gdbus-method-org-freedesktop-timedate1.SetTime"><primary sortas="timedate1.SetTime">org.freedesktop.timedate1.SetTime()</primary></indexterm>
<programlisting>
SetTime (IN  x unnamed_arg0,
         IN  b unnamed_arg1,
         IN  b unnamed_arg2);
</programlisting>
<para></para>
<variablelist role="params">
<varlistentry>
  <term><literal>IN x <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>
<varlistentry>
  <term><literal>IN b <parameter>unnamed_arg2</parameter></literal>:</term>
  <listitem><para></para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-org-freedesktop-timedate1.SetTimezone">
  <title>The SetTimezone() method</title>
  <indexterm zone="gdbus-method-org-freedesktop-timedate1.SetTimezone"><primary sortas="timedate1.SetTimezone">org.freedesktop.timedate1.SetTimezone()</primary></indexterm>
<programlisting>
SetTimezone (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-timedate1.SetLocalRTC">
  <title>The SetLocalRTC() method</title>
  <indexterm zone="gdbus-method-org-freedesktop-timedate1.SetLocalRTC"><primary sortas="timedate1.SetLocalRTC">org.freedesktop.timedate1.SetLocalRTC()</primary></indexterm>
<programlisting>
SetLocalRTC (IN  b unnamed_arg0,
             IN  b unnamed_arg1,
             IN  b unnamed_arg2);
</programlisting>
<para></para>
<variablelist role="params">
<varlistentry>
  <term><literal>IN b <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>
<varlistentry>
  <term><literal>IN b <parameter>unnamed_arg2</parameter></literal>:</term>
  <listitem><para></para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-org-freedesktop-timedate1.SetNTP">
  <title>The SetNTP() method</title>
  <indexterm zone="gdbus-method-org-freedesktop-timedate1.SetNTP"><primary sortas="timedate1.SetNTP">org.freedesktop.timedate1.SetNTP()</primary></indexterm>
<programlisting>
SetNTP (IN  b unnamed_arg0,
        IN  b unnamed_arg1);
</programlisting>
<para></para>
<variablelist role="params">
<varlistentry>
  <term><literal>IN b <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>
</refsect1>
<refsect1 role="details" id="gdbus-properties-org.freedesktop.timedate1">
  <title role="details.title">Property Details</title>
<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.Timezone">
  <title>The "Timezone" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-timedate1.Timezone"><primary sortas="timedate1:Timezone">org.freedesktop.timedate1:Timezone</primary></indexterm>
<programlisting>
Timezone  readable   s
</programlisting>
<para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.LocalRTC">
  <title>The "LocalRTC" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-timedate1.LocalRTC"><primary sortas="timedate1:LocalRTC">org.freedesktop.timedate1:LocalRTC</primary></indexterm>
<programlisting>
LocalRTC  readable   b
</programlisting>
<para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.CanNTP">
  <title>The "CanNTP" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-timedate1.CanNTP"><primary sortas="timedate1:CanNTP">org.freedesktop.timedate1:CanNTP</primary></indexterm>
<programlisting>
CanNTP  readable   b
</programlisting>
<para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.NTP">
  <title>The "NTP" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-timedate1.NTP"><primary sortas="timedate1:NTP">org.freedesktop.timedate1:NTP</primary></indexterm>
<programlisting>
NTP  readable   b
</programlisting>
<para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.NTPSynchronized">
  <title>The "NTPSynchronized" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-timedate1.NTPSynchronized"><primary sortas="timedate1:NTPSynchronized">org.freedesktop.timedate1:NTPSynchronized</primary></indexterm>
<programlisting>
NTPSynchronized  readable   b
</programlisting>
<para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.TimeUSec">
  <title>The "TimeUSec" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-timedate1.TimeUSec"><primary sortas="timedate1:TimeUSec">org.freedesktop.timedate1:TimeUSec</primary></indexterm>
<programlisting>
TimeUSec  readable   t
</programlisting>
<para></para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.RTCTimeUSec">
  <title>The "RTCTimeUSec" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-timedate1.RTCTimeUSec"><primary sortas="timedate1:RTCTimeUSec">org.freedesktop.timedate1:RTCTimeUSec</primary></indexterm>
<programlisting>
RTCTimeUSec  readable   t
</programlisting>
<para></para>
</refsect2>
</refsect1>
</refentry>
Commit	Line	Data
5047f6bf	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="timedate1">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>
1aa981f7	11	<link linkend="gdbus-method-org-freedesktop-timedate1.SetTime">SetTime</link> (IN x unnamed_arg0,
	12	IN b unnamed_arg1,
	13	IN b unnamed_arg2);
	14	<link linkend="gdbus-method-org-freedesktop-timedate1.SetTimezone">SetTimezone</link> (IN s unnamed_arg0,
	15	IN b unnamed_arg1);
	16	<link linkend="gdbus-method-org-freedesktop-timedate1.SetLocalRTC">SetLocalRTC</link> (IN b unnamed_arg0,
	17	IN b unnamed_arg1,
	18	IN b unnamed_arg2);
	19	<link linkend="gdbus-method-org-freedesktop-timedate1.SetNTP">SetNTP</link> (IN b unnamed_arg0,
	20	IN b unnamed_arg1);
5047f6bf	21	</synopsis>
	22	</refsynopsisdiv>
	23	<refsect1 role="properties">
	24	<title role="properties.title">Properties</title>
	25	<synopsis>
1aa981f7	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.CanNTP">CanNTP</link> readable b
	29	<link linkend="gdbus-property-org-freedesktop-timedate1.NTP">NTP</link> readable b
	30	<link linkend="gdbus-property-org-freedesktop-timedate1.NTPSynchronized">NTPSynchronized</link> readable b
	31	<link linkend="gdbus-property-org-freedesktop-timedate1.TimeUSec">TimeUSec</link> readable t
	32	<link linkend="gdbus-property-org-freedesktop-timedate1.RTCTimeUSec">RTCTimeUSec</link> readable t
5047f6bf	33	</synopsis>
	34	</refsect1>
	35	<refsect1 role="desc" id="gdbus-interface-org-freedesktop-timedate1">
	36	<title role="desc.title">Description</title>
	37	<para></para>
	38	</refsect1>
	39	<refsect1 role="details" id="gdbus-methods-org.freedesktop.timedate1">
	40	<title role="details.title">Method Details</title>
	41	<refsect2 role="method" id="gdbus-method-org-freedesktop-timedate1.SetTime">
	42	<title>The SetTime() method</title>
	43	<indexterm zone="gdbus-method-org-freedesktop-timedate1.SetTime"><primary sortas="timedate1.SetTime">org.freedesktop.timedate1.SetTime()</primary></indexterm>
	44	<programlisting>
1aa981f7	45	SetTime (IN x unnamed_arg0,
	46	IN b unnamed_arg1,
	47	IN b unnamed_arg2);
5047f6bf	48	</programlisting>
	49	<para></para>
	50	<variablelist role="params">
	51	<varlistentry>
1aa981f7	52	<term><literal>IN x <parameter>unnamed_arg0</parameter></literal>:</term>
5047f6bf	53	<listitem><para></para></listitem>
	54	</varlistentry>
	55	<varlistentry>
1aa981f7	56	<term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
5047f6bf	57	<listitem><para></para></listitem>
	58	</varlistentry>
	59	<varlistentry>
1aa981f7	60	<term><literal>IN b <parameter>unnamed_arg2</parameter></literal>:</term>
5047f6bf	61	<listitem><para></para></listitem>
	62	</varlistentry>
	63	</variablelist>
	64	</refsect2>
	65	<refsect2 role="method" id="gdbus-method-org-freedesktop-timedate1.SetTimezone">
	66	<title>The SetTimezone() method</title>
	67	<indexterm zone="gdbus-method-org-freedesktop-timedate1.SetTimezone"><primary sortas="timedate1.SetTimezone">org.freedesktop.timedate1.SetTimezone()</primary></indexterm>
	68	<programlisting>
1aa981f7	69	SetTimezone (IN s unnamed_arg0,
1aa981f7	70	IN b unnamed_arg1);
5047f6bf	71	</programlisting>
	72	<para></para>
	73	<variablelist role="params">
	74	<varlistentry>
1aa981f7	75	<term><literal>IN s <parameter>unnamed_arg0</parameter></literal>:</term>
5047f6bf	76	<listitem><para></para></listitem>
	77	</varlistentry>
	78	<varlistentry>
1aa981f7	79	<term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
5047f6bf	80	<listitem><para></para></listitem>
	81	</varlistentry>
	82	</variablelist>
	83	</refsect2>
	84	<refsect2 role="method" id="gdbus-method-org-freedesktop-timedate1.SetLocalRTC">
	85	<title>The SetLocalRTC() method</title>
	86	<indexterm zone="gdbus-method-org-freedesktop-timedate1.SetLocalRTC"><primary sortas="timedate1.SetLocalRTC">org.freedesktop.timedate1.SetLocalRTC()</primary></indexterm>
	87	<programlisting>
1aa981f7	88	SetLocalRTC (IN b unnamed_arg0,
	89	IN b unnamed_arg1,
	90	IN b unnamed_arg2);
5047f6bf	91	</programlisting>
	92	<para></para>
	93	<variablelist role="params">
	94	<varlistentry>
1aa981f7	95	<term><literal>IN b <parameter>unnamed_arg0</parameter></literal>:</term>
5047f6bf	96	<listitem><para></para></listitem>
	97	</varlistentry>
	98	<varlistentry>
1aa981f7	99	<term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
5047f6bf	100	<listitem><para></para></listitem>
	101	</varlistentry>
	102	<varlistentry>
1aa981f7	103	<term><literal>IN b <parameter>unnamed_arg2</parameter></literal>:</term>
5047f6bf	104	<listitem><para></para></listitem>
	105	</varlistentry>
	106	</variablelist>
	107	</refsect2>
	108	<refsect2 role="method" id="gdbus-method-org-freedesktop-timedate1.SetNTP">
	109	<title>The SetNTP() method</title>
	110	<indexterm zone="gdbus-method-org-freedesktop-timedate1.SetNTP"><primary sortas="timedate1.SetNTP">org.freedesktop.timedate1.SetNTP()</primary></indexterm>
	111	<programlisting>
1aa981f7	112	SetNTP (IN b unnamed_arg0,
1aa981f7	113	IN b unnamed_arg1);
5047f6bf	114	</programlisting>
	115	<para></para>
	116	<variablelist role="params">
	117	<varlistentry>
1aa981f7	118	<term><literal>IN b <parameter>unnamed_arg0</parameter></literal>:</term>
5047f6bf	119	<listitem><para></para></listitem>
	120	</varlistentry>
	121	<varlistentry>
1aa981f7	122	<term><literal>IN b <parameter>unnamed_arg1</parameter></literal>:</term>
5047f6bf	123	<listitem><para></para></listitem>
	124	</varlistentry>
	125	</variablelist>
	126	</refsect2>
	127	</refsect1>
	128	<refsect1 role="details" id="gdbus-properties-org.freedesktop.timedate1">
	129	<title role="details.title">Property Details</title>
	130	<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.Timezone">
	131	<title>The "Timezone" property</title>
	132	<indexterm zone="gdbus-property-org-freedesktop-timedate1.Timezone"><primary sortas="timedate1:Timezone">org.freedesktop.timedate1:Timezone</primary></indexterm>
	133	<programlisting>
	134	Timezone readable s
	135	</programlisting>
	136	<para></para>
	137	</refsect2>
	138	<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.LocalRTC">
	139	<title>The "LocalRTC" property</title>
	140	<indexterm zone="gdbus-property-org-freedesktop-timedate1.LocalRTC"><primary sortas="timedate1:LocalRTC">org.freedesktop.timedate1:LocalRTC</primary></indexterm>
	141	<programlisting>
	142	LocalRTC readable b
	143	</programlisting>
	144	<para></para>
	145	</refsect2>
1aa981f7	146	<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.CanNTP">
	147	<title>The "CanNTP" property</title>
	148	<indexterm zone="gdbus-property-org-freedesktop-timedate1.CanNTP"><primary sortas="timedate1:CanNTP">org.freedesktop.timedate1:CanNTP</primary></indexterm>
	149	<programlisting>
	150	CanNTP readable b
	151	</programlisting>
	152	<para></para>
	153	</refsect2>
5047f6bf	154	<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.NTP">
	155	<title>The "NTP" property</title>
	156	<indexterm zone="gdbus-property-org-freedesktop-timedate1.NTP"><primary sortas="timedate1:NTP">org.freedesktop.timedate1:NTP</primary></indexterm>
	157	<programlisting>
	158	NTP readable b
	159	</programlisting>
	160	<para></para>
	161	</refsect2>
1aa981f7	162	<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.NTPSynchronized">
	163	<title>The "NTPSynchronized" property</title>
	164	<indexterm zone="gdbus-property-org-freedesktop-timedate1.NTPSynchronized"><primary sortas="timedate1:NTPSynchronized">org.freedesktop.timedate1:NTPSynchronized</primary></indexterm>
	165	<programlisting>
	166	NTPSynchronized readable b
	167	</programlisting>
	168	<para></para>
	169	</refsect2>
	170	<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.TimeUSec">
	171	<title>The "TimeUSec" property</title>
	172	<indexterm zone="gdbus-property-org-freedesktop-timedate1.TimeUSec"><primary sortas="timedate1:TimeUSec">org.freedesktop.timedate1:TimeUSec</primary></indexterm>
	173	<programlisting>
	174	TimeUSec readable t
	175	</programlisting>
	176	<para></para>
	177	</refsect2>
	178	<refsect2 role="property" id="gdbus-property-org-freedesktop-timedate1.RTCTimeUSec">
	179	<title>The "RTCTimeUSec" property</title>
	180	<indexterm zone="gdbus-property-org-freedesktop-timedate1.RTCTimeUSec"><primary sortas="timedate1:RTCTimeUSec">org.freedesktop.timedate1:RTCTimeUSec</primary></indexterm>
	181	<programlisting>
	182	RTCTimeUSec readable t
	183	</programlisting>
	184	<para></para>
	185	</refsect2>
5047f6bf	186	</refsect1>
	187	</refentry>
	188