Debian Codegraph @

upstream/debian-unstable/man5/timesyncd.conf.5

raw
1 '\" t
2 .TH "TIMESYNCD\&.CONF" "5" "" "systemd 261~rc3" "timesyncd.conf"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 timesyncd.conf, timesyncd.conf.d \- Network Time Synchronization configuration files
24 .SH "SYNOPSIS"
25 .PP
26 .RS 4
27 /etc/systemd/timesyncd\&.conf
28 .RE
29 .RS 4
30 /run/systemd/timesyncd\&.conf
31 .RE
32 .RS 4
33 /usr/local/lib/systemd/timesyncd\&.conf
34 .RE
35 .RS 4
36 /usr/lib/systemd/timesyncd\&.conf
37 .RE
38 .RS 4
39 /etc/systemd/timesyncd\&.conf\&.d/*\&.conf
40 .RE
41 .RS 4
42 /run/systemd/timesyncd\&.conf\&.d/*\&.conf
43 .RE
44 .RS 4
45 /usr/local/lib/systemd/timesyncd\&.conf\&.d/*\&.conf
46 .RE
47 .RS 4
48 /usr/lib/systemd/timesyncd\&.conf\&.d/*\&.conf
49 .RE
50 .SH "DESCRIPTION"
51 .PP
52 These configuration files control NTP network time synchronization\&. See
53 \fBsystemd.syntax\fR(7)
54 for a general description of the syntax\&.
55 .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE"
56 .PP
57 The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used:
58 /etc/systemd/,
59 /run/systemd/,
60 /usr/local/lib/systemd/
61 \&\s-2\u[1]\d\s+2,
62 /usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in
63 /etc/
64 if it is shipped under
65 /usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&.
66 .PP
67 In addition to the main configuration file, drop\-in configuration snippets are read from
68 /usr/lib/systemd/*\&.conf\&.d/,
69 /usr/local/lib/systemd/*\&.conf\&.d/, and
70 /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the
71 *\&.conf\&.d/
72 configuration subdirectories are sorted by their filename in lexicographic order, regardless of in which of the subdirectories they reside\&. When multiple files specify the same option, for options which accept just a single value, the entry in the file sorted last takes precedence, and for options which accept a list of values, entries are collected as they occur in the sorted files\&.
73 .PP
74 When packages need to customize the configuration, they can install drop\-ins under
75 /usr/\&. Files in
76 /etc/
77 are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in
78 /usr/
79 and the range 60\-90 for drop\-ins in
80 /etc/
81 and
82 /run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&.
83 .PP
84 To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to
85 /dev/null
86 in the configuration directory in
87 /etc/, with the same filename as the vendor configuration file\&.
88 .SH "OPTIONS"
89 .PP
90 The following settings are configured in the [Time] section:
91 .PP
92 \fINTP=\fR
93 .RS 4
94 A space\-separated list of NTP server host names or IP addresses\&. During runtime this list is combined with any per\-interface NTP servers acquired from
95 \fBsystemd-networkd.service\fR(8)\&.
96 \fBsystemd\-timesyncd\fR
97 will contact all configured system or per\-interface servers in turn, until one responds\&. When the empty string is assigned, the list of NTP servers is reset, and all prior assignments will have no effect\&. This setting defaults to an empty list\&.
98 .sp
99 Added in version 216\&.
100 .RE
101 .PP
102 \fIFallbackNTP=\fR
103 .RS 4
104 A space\-separated list of NTP server host names or IP addresses to be used as the fallback NTP servers\&. Any per\-interface NTP servers obtained from
105 \fBsystemd-networkd.service\fR(8)
106 take precedence over this setting, as do any servers set via
107 \fINTP=\fR
108 above\&. This setting is hence only relevant if no other NTP server information is known\&. When the empty string is assigned, the list of NTP servers is reset, and all prior assignments will have no effect\&. If this option is not given, a compiled\-in list of NTP servers is used\&.
109 .sp
110 Added in version 216\&.
111 .RE
112 .PP
113 \fIRootDistanceMaxSec=\fR
114 .RS 4
115 Maximum acceptable root distance, i\&.e\&. the maximum estimated time required for a packet to travel to the server we are connected to from the server with the reference clock\&. If the current server does not satisfy this limit,
116 \fBsystemd\-timesyncd\fR
117 will switch to a different server\&.
118 .sp
119 Takes a time span value\&. The default unit is seconds, but other units may be specified, see
120 \fBsystemd.time\fR(7)\&. Defaults to 5 seconds\&.
121 .sp
122 Added in version 236\&.
123 .RE
124 .PP
125 \fIPollIntervalMinSec=\fR, \fIPollIntervalMaxSec=\fR
126 .RS 4
127 The minimum and maximum poll intervals for NTP messages\&. Polling starts at the minimum poll interval, and is adjusted within the specified limits in response to received packets\&.
128 .sp
129 Each setting takes a time span value\&. The default unit is seconds, but other units may be specified, see
130 \fBsystemd.time\fR(7)\&.
131 \fIPollIntervalMinSec=\fR
132 defaults to 32 seconds and must not be smaller than 16\ \&seconds\&.
133 \fIPollIntervalMaxSec=\fR
134 defaults to 34\ \&min\ \&8\ \&s (2048\ \&seconds) and must be larger than
135 \fIPollIntervalMinSec=\fR\&.
136 .sp
137 Added in version 236\&.
138 .RE
139 .PP
140 \fIConnectionRetrySec=\fR
141 .RS 4
142 Specifies the minimum delay before subsequent attempts to contact a new NTP server are made\&.
143 .sp
144 Takes a time span value\&. The default unit is seconds, but other units may be specified, see
145 \fBsystemd.time\fR(7)\&. Defaults to 30 seconds and must not be smaller than 1 second\&.
146 .sp
147 Added in version 248\&.
148 .RE
149 .PP
150 \fISaveIntervalSec=\fR
151 .RS 4
152 The interval at which the current time is periodically saved to disk, in the absence of any recent synchronisation from an NTP server\&. This is especially useful for offline systems with no local RTC, as it will guarantee that the system clock remains roughly monotonic across reboots\&.
153 .sp
154 Takes a time interval value\&. The default unit is seconds, but other units may be specified, see
155 \fBsystemd.time\fR(7)\&. Defaults to 60 seconds\&.
156 .sp
157 Added in version 250\&.
158 .RE
159 .SH "SEE ALSO"
160 .PP
161 \fBsystemd\fR(1), \fBsystemd-timesyncd.service\fR(8), \fBsystemd-networkd.service\fR(8)
162 .SH "NOTES"
163 .IP " 1." 4
164 💣💥🧨💥💥💣 Please note that those configuration files must be available at all times. If
165 /usr/local/
166 is a separate partition, it may not be available during early boot, and must not be used for configuration.
167