timedatectl.xml revision 2fc4f5bd924b9732afc70f8a6da80573f833fc9d
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering This file is part of systemd.
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Copyright 2012 Lennart Poettering
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering systemd is free software; you can redistribute it and/or modify it
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering under the terms of the GNU Lesser General Public License as published by
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering the Free Software Foundation; either version 2.1 of the License, or
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering (at your option) any later version.
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering systemd is distributed in the hope that it will be useful, but
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering WITHOUT ANY WARRANTY; without even the implied warranty of
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Lesser General Public License for more details.
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering You should have received a copy of the GNU Lesser General Public License
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering along with systemd; If not, see <http://www.gnu.org/licenses/>.
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering<refentry id="timedatectl" conditional='ENABLE_TIMEDATED'
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering xmlns:xi="http://www.w3.org/2001/XInclude">
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <refentryinfo>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </authorgroup>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </refentryinfo>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <refentrytitle>timedatectl</refentrytitle>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <refpurpose>Control the system time and date</refpurpose>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <refsynopsisdiv>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <command>timedatectl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg></command>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </cmdsynopsis>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </refsynopsisdiv>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <para><command>timedatectl</command> may be used to query and
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering change the system clock and its settings.</para>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering to initialize the system time zone for mounted (but not booted)
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering system images.</para>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <para>The following options are understood:</para>
7e8e0422aeb16f2a09a40546c61df753d10029b6Lennart Poettering <variablelist>
7e8e0422aeb16f2a09a40546c61df753d10029b6Lennart Poettering <varlistentry>
7e8e0422aeb16f2a09a40546c61df753d10029b6Lennart Poettering <term><option>--no-ask-password</option></term>
7e8e0422aeb16f2a09a40546c61df753d10029b6Lennart Poettering <listitem><para>Do not query the user for authentication for
7e8e0422aeb16f2a09a40546c61df753d10029b6Lennart Poettering </varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <term><option>--adjust-system-clock</option></term>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <listitem><para>If <command>set-local-rtc</command> is invoked
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering and this option is passed, the system clock is synchronized
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering from the RTC again, taking the new setting into account.
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Otherwise, the RTC is synchronized from the system
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <xi:include href="user-system-options.xml" xpointer="host" />
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <xi:include href="user-system-options.xml" xpointer="machine" />
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <xi:include href="standard-options.xml" xpointer="help" />
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <xi:include href="standard-options.xml" xpointer="version" />
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <xi:include href="standard-options.xml" xpointer="no-pager" />
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </variablelist>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <para>The following commands are understood:</para>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <variablelist>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <listitem><para>Show current settings of the system clock and
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering RTC, including whether network time synchronization is
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering enabled. Note that the network time synchronization state
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering simply reflects whether the
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <filename>systemd-timesyncd.service</filename> unit is
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering enabled. Even if the status is shown as off with this command
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering another service might still synchronize the network over the
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <term><command>set-time [TIME]</command></term>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <listitem><para>Set the system clock to the specified time.
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering This will also update the RTC time accordingly. The time may
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering be specified in the format "2012-10-30
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <term><command>set-timezone [TIMEZONE]</command></term>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <listitem><para>Set the system time zone to the specified
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering value. Available timezones can be listed with
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <command>list-timezones</command>. If the RTC is configured to
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering be in the local time, this will also update the RTC time. This
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering call will alter the <filename>/etc/localtime</filename>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <term><command>list-timezones</command></term>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <listitem><para>List available time zones, one per line.
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Entries from the list can be set as the system timezone with
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <command>set-timezone</command>.</para></listitem>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <term><command>set-local-rtc [BOOL]</command></term>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <listitem><para>Takes a boolean argument. If
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <literal>0</literal>, the system is configured to maintain the
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering RTC in universal time. If <literal>1</literal>, it will
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering maintain the RTC in local time instead. Note that maintaining
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering the RTC in the local timezone is not fully supported and will
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering create various problems with time zone changes and daylight
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering saving adjustments. If at all possible, keep the RTC in UTC
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering mode. Note that invoking this will also synchronize the RTC
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering from the system clock, unless
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <option>--adjust-system-clock</option> is passed (see above).
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering This command will change the 3rd line of
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <filename>/etc/adjtime</filename>, as documented in
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <term><command>set-ntp [BOOL]</command></term>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <listitem><para>Takes a boolean argument. Controls whether
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering network time synchronous is enabled (if available). This
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering enables or disables the
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <filename>systemd-timesyncd.service</filename> unit. Note that
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering even if time synchronization is turned off with this command
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering another system service might still synchronize the clock with
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </varlistentry>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering </variablelist>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <para>On success, 0 is returned, a non-zero failure
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering code otherwise.</para>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <para>Show current settings:
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <programlisting>$ timedatectl
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Local time: Di 2015-04-07 16:26:56 CEST
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Universal time: Di 2015-04-07 14:26:56 UTC
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering RTC time: Di 2015-04-07 14:26:56
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering NTP enabled: yes
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart PoetteringNTP synchronized: yes
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering RTC in local TZ: no</programlisting>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <para>Enable an NTP daemon:
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <programlisting>$ timedatectl set-ntp true
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering==== AUTHENTICATING FOR org.freedesktop.timedate1.set-ntp ===
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart PoetteringAuthentication is required to control whether network time synchronization shall be enabled.
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart PoetteringAuthenticating as: user
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart PoetteringPassword: ********
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering==== AUTHENTICATION COMPLETE ===</programlisting>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <programlisting>$ systemctl status systemd-timesyncd.service
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering● systemd-timesyncd.service - Network Time Synchronization
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Loaded: loaded (/usr/lib/systemd/system/systemd-timesyncd.service; enabled)
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Active: active (running) since Mo 2015-03-30 14:20:38 CEST; 5s ago
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Main PID: 595 (systemd-timesyn)
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering Status: "Using Time Server 216.239.38.15:123 (time4.google.com)."
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering CGroup: /system.slice/systemd-timesyncd.service
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering...</programlisting>
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry project='man-pages'><refentrytitle>date</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
faa133f3aa7a18f26563dc5d6b95898cb315c37aLennart Poettering <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>