summaryrefslogtreecommitdiffstats
path: root/man/systemd-timesyncd.service.xml
blob: 1f504deac14afd7d5dd1c273c096e512561d25b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->

<refentry id="systemd-timesyncd.service" conditional='ENABLE_TIMESYNCD'
          xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>systemd-timesyncd.service</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-timesyncd.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-timesyncd.service</refname>
    <refname>systemd-timesyncd</refname>
    <refpurpose>Network Time Synchronization</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <para><filename>systemd-timesyncd.service</filename></para>
    <para><filename>/usr/lib/systemd/systemd-timesyncd</filename></para>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><filename>systemd-timesyncd</filename> is a system service that may be used to synchronize the
    local system clock with a remote Network Time Protocol (NTP) server. It also saves the local time to disk
    every time the clock has been synchronized and uses this to possibly advance the system realtime clock on
    subsequent reboots to ensure it (roughly) monotonically advances even if the system lacks a
    battery-buffered RTC chip.</para>

    <para>The <filename>systemd-timesyncd</filename> service implements SNTP only. This minimalistic service
    will step the system clock for large offsets or slowly adjust it for smaller deltas. Complex use cases
    that require full NTP support (and where SNTP is not sufficient) are not covered by
    <filename>systemd-timesyncd</filename>.</para>

    <para>The NTP servers contacted are determined from the global settings in
    <citerefentry><refentrytitle>timesyncd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, the
    per-link static settings in <filename>.network</filename> files, and the per-link dynamic settings
    received over DHCP. See
    <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
    further details.</para>

    <para><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
    <command>set-ntp</command> command may be used to enable and start, or disable and stop this
    service.</para>

    <para><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
    <command>timesync-status</command> or <command>show-timesync</command> command can be used to show the
    current status of this service.</para>

    <para><filename>systemd-timesyncd</filename> initialization delays the start of units that are ordered
    after <filename>time-set.target</filename> (see
    <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
    details) until the local time has been updated from <filename>/var/lib/systemd/timesync/clock</filename>
    (see below) in order to make it roughly monotonic. It does not delay other units until synchronization
    with an accurate reference time sources has been reached. Use
    <citerefentry><refentrytitle>systemd-time-wait-sync.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    to achieve that, which will delay start of units that are ordered after
    <filename>time-sync.target</filename> until synchronization to an accurate reference clock is
    reached.</para>

    <para><filename>systemd</filename> and <filename>systemd-timesyncd</filename> advance the system clock to
    the "epoch" (the lowest date above which the system clock time is assumed to be set correctly). See
    "System clock epoch" section in
    <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> for details.
    <filename>systemd</filename> will set the clock when initializing, but
    <filename>/var/lib/systemd/timesync/clock</filename> might not yet be available at that point.
    <filename>systemd-timesyncd</filename> will advance the clock when it is started and notices that the
    system clock is before the modification time of <filename>/var/lib/systemd/timesync/clock</filename>.
    </para>
  </refsect1>

  <refsect1>
    <title>Files</title>

    <variablelist>
      <varlistentry>
        <term><filename>/var/lib/systemd/timesync/clock</filename></term>

        <listitem>
          <para>The modification time ("mtime") of this file is updated on each successful NTP
          synchronization or after each <varname>SaveIntervalSec=</varname> time interval, as specified in
          <citerefentry><refentrytitle>timesyncd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
          </para>

          <para>If present, the modification time of this file is used for the epoch by
          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> and
          <filename>systemd-timesyncd.service</filename>.</para>

          <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><filename>/run/systemd/timesync/synchronized</filename></term>

        <listitem>
          <para>A file that is touched on each successful synchronization to assist
          <filename>systemd-time-wait-sync</filename> and other applications in detecting synchronization to
          an accurate reference clock.</para>

          <xi:include href="version-info.xml" xpointer="v239"/>
        </listitem>

      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para><simplelist type="inline">
      <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>timesyncd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd-time-wait-sync.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
      <member><citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
    </simplelist></para>
  </refsect1>

</refentry>