man/systemd-timesyncd.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   This file is part of systemd.
   9
  10   Copyright 2014 Kay Sievers
  11 -->
  12
  13 <refentry id="systemd-timesyncd.service" conditional='ENABLE_TIMESYNCD'>
  14
  15   <refentryinfo>
  16     <title>systemd-timesyncd.service</title>
  17     <productname>systemd</productname>
  18
  19     <authorgroup>
  20       <author>
  21         <contrib>Developer</contrib>
  22         <firstname>Kay</firstname>
  23         <surname>Sievers</surname>
  24         <email>kay@vrfy.org</email>
  25       </author>
  26     </authorgroup>
  27   </refentryinfo>
  28
  29   <refmeta>
  30     <refentrytitle>systemd-timesyncd.service</refentrytitle>
  31     <manvolnum>8</manvolnum>
  32   </refmeta>
  33
  34   <refnamediv>
  35     <refname>systemd-timesyncd.service</refname>
  36     <refname>systemd-timesyncd</refname>
  37     <refpurpose>Network Time Synchronization</refpurpose>
  38   </refnamediv>
  39
  40   <refsynopsisdiv>
  41     <para><filename>systemd-timesyncd.service</filename></para>
  42     <para><filename>/usr/lib/systemd/systemd-timesyncd</filename></para>
  43   </refsynopsisdiv>
  44
  45   <refsect1>
  46     <title>Description</title>
  47
  48     <para><filename>systemd-timesyncd</filename> is a system service
  49     that may be used to synchronize the local system clock with a
  50     remote Network Time Protocol server. It also saves the local time
  51     to disk every time the clock has been synchronized and uses this
  52     to possibly advance the system realtime clock on subsequent
  53     reboots to ensure it monotonically advances even if the system
  54     lacks a battery-buffered RTC chip.</para>
  55
  56     <para>The <filename>systemd-timesyncd</filename> service
  57     specifically implements only SNTP. This minimalistic
  58     service will set the system clock for large offsets or
  59     slowly adjust it for smaller deltas. More complex use
  60     cases are not covered by <filename>systemd-timesyncd</filename>.</para>
  61
  62     <para>The NTP servers contacted are determined from the global
  63     settings in
  64     <citerefentry><refentrytitle>timesyncd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  65     the per-link static settings in <filename>.network</filename>
  66     files, and the per-link dynamic settings received over DHCP. See
  67     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  68     for more details.</para>
  69
  70     <para><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
  71     <command>set-ntp</command> command may be used to enable and
  72     start, or disable and stop this service.</para>
  73
  74     <para><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
  75     <command>timesync-status</command> or <command>show-timesync</command> command can be used to show the
  76     current status of this service.</para>
  77   </refsect1>
  78
  79   <refsect1>
  80     <title>Files</title>
  81
  82     <variablelist>
  83       <varlistentry>
  84         <term><filename>/var/lib/systemd/timesync/clock</filename></term>
  85
  86         <listitem>
  87           <para>The modification time of this file indicates the timestamp of the last successful
  88           synchronization.</para>
  89         </listitem>
  90       </varlistentry>
  91
  92       <varlistentry>
  93         <term><filename>/run/systemd/timesync/synchronized</filename></term>
  94
  95         <listitem>
  96           <para>A file that is touched on each successful synchronization, to assist
  97           <filename>systemd-time-wait-sync</filename> and other applications to detecting synchronization
  98           events.</para>
  99         </listitem>
 100
 101       </varlistentry>
 102     </variablelist>
 103   </refsect1>
 104
 105   <refsect1>
 106     <title>See Also</title>
 107     <para>
 108       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 109       <citerefentry><refentrytitle>timesyncd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 110       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 111       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 112       <citerefentry><refentrytitle>systemd-time-wait-sync.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 113       <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 114       <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 115       <citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 116     </para>
 117   </refsect1>
 118
 119 </refentry>