tizen 2.4 release
[external/systemd.git] / man / timesyncd.conf.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6 <!--
7   This file is part of systemd.
8
9   Copyright 2014 Lennart Poettering
10
11   systemd is free software; you can redistribute it and/or modify it
12   under the terms of the GNU Lesser General Public License as published by
13   the Free Software Foundation; either version 2.1 of the License, or
14   (at your option) any later version.
15
16   systemd is distributed in the hope that it will be useful, but
17   WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   Lesser General Public License for more details.
20
21   You should have received a copy of the GNU Lesser General Public License
22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 -->
24
25 <refentry id="timesyncd.conf" conditional='ENABLE_TIMESYNCD'>
26         <refentryinfo>
27                 <title>timesyncd.conf</title>
28                 <productname>systemd</productname>
29
30                 <authorgroup>
31                         <author>
32                                 <contrib>Developer</contrib>
33                                 <firstname>Lennart</firstname>
34                                 <surname>Poettering</surname>
35                                 <email>lennart@poettering.net</email>
36                         </author>
37                 </authorgroup>
38         </refentryinfo>
39
40         <refmeta>
41                 <refentrytitle>timesyncd.conf</refentrytitle>
42                 <manvolnum>5</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>timesyncd.conf</refname>
47                 <refpurpose>Network Time Synchronization configuration file</refpurpose>
48         </refnamediv>
49
50         <refsynopsisdiv>
51                 <para><filename>/etc/systemd/timesyncd.conf</filename></para>
52         </refsynopsisdiv>
53
54         <refsect1>
55                 <title>Description</title>
56
57                 <para>When starting, systemd-timesyncd will read the
58                 configuration file
59                 <filename>timesyncd.conf</filename>.  This
60                 configuration file controls NTP network time
61                 synchronization.</para>
62
63         </refsect1>
64
65         <refsect1>
66                 <title>Options</title>
67
68                 <variablelist class='network-directives'>
69
70                         <varlistentry>
71                                 <term><varname>NTP=</varname></term>
72                                 <listitem><para>A space separated list
73                                 of NTP servers host names or IP
74                                 addresses. During runtime this list is
75                                 combined with any per-interface NTP
76                                 servers acquired from
77                                 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. systemd-timesyncd
78                                 will contact all configured system or
79                                 per-interface servers in turn until
80                                 one is found that responds. This
81                                 setting defaults to the empty
82                                 list.</para></listitem>
83                         </varlistentry>
84
85                         <varlistentry>
86                                 <term><varname>FallbackNTP=</varname></term>
87                                 <listitem><para>A space separated list
88                                 of NTP server host names or IP
89                                 addresses to be used as the fallback
90                                 NTP servers. Any per-interface NTP
91                                 servers obtained from
92                                 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
93                                 take precedence over this setting, as
94                                 do any servers set via
95                                 <varname>NTP=</varname> above. This
96                                 setting is hence only used if no other
97                                 NTP server information is known. If
98                                 this option is not given, a
99                                 compiled-in list of NTP servers is
100                                 used instead.</para></listitem>
101                         </varlistentry>
102
103                 </variablelist>
104         </refsect1>
105
106         <refsect1>
107                   <title>See Also</title>
108                   <para>
109                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
110                         <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
111                         <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
112                   </para>
113         </refsect1>
114
115 </refentry>