man/systemd-timedated.service.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7 -->
   8
   9 <refentry id="systemd-timedated.service" conditional='ENABLE_TIMEDATED'>
  10
  11   <refentryinfo>
  12     <title>systemd-timedated.service</title>
  13     <productname>systemd</productname>
  14   </refentryinfo>
  15
  16   <refmeta>
  17     <refentrytitle>systemd-timedated.service</refentrytitle>
  18     <manvolnum>8</manvolnum>
  19   </refmeta>
  20
  21   <refnamediv>
  22     <refname>systemd-timedated.service</refname>
  23     <refname>systemd-timedated</refname>
  24     <refpurpose>Time and date bus mechanism</refpurpose>
  25   </refnamediv>
  26
  27   <refsynopsisdiv>
  28     <para><filename>systemd-timedated.service</filename></para>
  29     <para><filename>/usr/lib/systemd/systemd-timedated</filename></para>
  30   </refsynopsisdiv>
  31
  32   <refsect1>
  33     <title>Description</title>
  34
  35     <para><filename>systemd-timedated</filename> is a system service
  36     that may be used as a mechanism to change the system clock and
  37     timezone, as well as to enable/disable NTP time synchronization.
  38     <filename>systemd-timedated</filename> is automatically activated
  39     on request and terminates itself when it is unused.</para>
  40
  41     <para>The tool
  42     <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  43     is a command line client to this service.</para>
  44
  45     <para>See the <ulink
  46     url="https://www.freedesktop.org/wiki/Software/systemd/timedated">
  47     developer documentation</ulink> for information about the APIs
  48     <filename>systemd-timedated</filename> provides.</para>
  49   </refsect1>
  50
  51   <refsect1>
  52     <title>Environment</title>
  53
  54     <variablelist class='environment-variables'>
  55       <varlistentry>
  56         <term><varname>$SYSTEMD_TIMEDATED_NTP_SERVICES</varname></term>
  57
  58         <listitem><para>Colon-separated list of unit names of NTP client services.
  59         If not set, then
  60         <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  61         is used. See the entries of NTP related commands of
  62         <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  63         for details about this.</para>
  64
  65         <para>Example:
  66         <programlisting>SYSTEMD_TIMEDATED_NTP_SERVICES=ntpd.service:chronyd.service:systemd-timesyncd.service</programlisting>
  67         </para></listitem>
  68       </varlistentry>
  69     </variablelist>
  70   </refsect1>
  71   <refsect1>
  72     <title>See Also</title>
  73     <para>
  74       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  75       <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  76       <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  77       <citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  78       <citerefentry><refentrytitle>systemd-timesyncd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  79     </para>
  80   </refsect1>
  81
  82 </refentry>