timedatectl.xml revision a281d9c7851b16c4c9195d042901540ee9ced799
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering<?xml version='1.0'?> <!--*-nxml-*-->
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering<!--
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering This file is part of systemd.
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering Copyright 2012 Lennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering systemd is free software; you can redistribute it and/or modify it
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering under the terms of the GNU Lesser General Public License as published by
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering the Free Software Foundation; either version 2.1 of the License, or
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering (at your option) any later version.
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering systemd is distributed in the hope that it will be useful, but
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering WITHOUT ANY WARRANTY; without even the implied warranty of
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering Lesser General Public License for more details.
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering You should have received a copy of the GNU Lesser General Public License
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering along with systemd; If not, see <http://www.gnu.org/licenses/>.
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering-->
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering
3c0cf502796be355431d4a64d738e75f543aa51dLennart Poettering<refentry id="timedatectl" conditional='ENABLE_TIMEDATED'>
3c0cf502796be355431d4a64d738e75f543aa51dLennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering <refentryinfo>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering <title>timedatectl</title>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering <productname>systemd</productname>
4e945a6f7971fd7d1f6b2c62ee3afdaff3c95ce4Lennart Poettering
4e945a6f7971fd7d1f6b2c62ee3afdaff3c95ce4Lennart Poettering <authorgroup>
4e945a6f7971fd7d1f6b2c62ee3afdaff3c95ce4Lennart Poettering <author>
4e945a6f7971fd7d1f6b2c62ee3afdaff3c95ce4Lennart Poettering <contrib>Developer</contrib>
4e945a6f7971fd7d1f6b2c62ee3afdaff3c95ce4Lennart Poettering <firstname>Lennart</firstname>
4e945a6f7971fd7d1f6b2c62ee3afdaff3c95ce4Lennart Poettering <surname>Poettering</surname>
3e684349c2cead2e6fd2f816c34eb17daba23a49Lennart Poettering <email>lennart@poettering.net</email>
3e684349c2cead2e6fd2f816c34eb17daba23a49Lennart Poettering </author>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering </authorgroup>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering </refentryinfo>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering
91b14d6ff362b938a72db17b095ee9903d07381bTom Gundersen <refmeta>
91b14d6ff362b938a72db17b095ee9903d07381bTom Gundersen <refentrytitle>timedatectl</refentrytitle>
4e945a6f7971fd7d1f6b2c62ee3afdaff3c95ce4Lennart Poettering <manvolnum>1</manvolnum>
4e945a6f7971fd7d1f6b2c62ee3afdaff3c95ce4Lennart Poettering </refmeta>
3c0cf502796be355431d4a64d738e75f543aa51dLennart Poettering
3c0cf502796be355431d4a64d738e75f543aa51dLennart Poettering <refnamediv>
0dd25fb9f005d8ab7ac4bc10a609d00569f8c56aLennart Poettering <refname>timedatectl</refname>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering <refpurpose>Control the system time and date</refpurpose>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering </refnamediv>
9df3ba6c6cb65eecec06f39dfe85a3596cedac4eTom Gundersen
9df3ba6c6cb65eecec06f39dfe85a3596cedac4eTom Gundersen <refsynopsisdiv>
9df3ba6c6cb65eecec06f39dfe85a3596cedac4eTom Gundersen <cmdsynopsis>
3c0cf502796be355431d4a64d738e75f543aa51dLennart Poettering <command>timedatectl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg></command>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering </cmdsynopsis>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering </refsynopsisdiv>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering <refsect1>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering <title>Description</title>
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering <para><command>timedatectl</command> may be used to
4e945a6f7971fd7d1f6b2c62ee3afdaff3c95ce4Lennart Poettering query and change the system clock and its
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering settings.</para>
0dd25fb9f005d8ab7ac4bc10a609d00569f8c56aLennart Poettering </refsect1>
3c0cf502796be355431d4a64d738e75f543aa51dLennart Poettering
74b2466e14a1961bf3ac0e8a60cfaceec705bd59Lennart Poettering <refsect1>
91b14d6ff362b938a72db17b095ee9903d07381bTom Gundersen <title>Options</title>
91b14d6ff362b938a72db17b095ee9903d07381bTom Gundersen
87f5a19343acf8ba697acc5a62bdb1a2b8c9eda3Lennart Poettering <para>The following options are understood:</para>
9df3ba6c6cb65eecec06f39dfe85a3596cedac4eTom Gundersen
9df3ba6c6cb65eecec06f39dfe85a3596cedac4eTom Gundersen <variablelist>
9df3ba6c6cb65eecec06f39dfe85a3596cedac4eTom Gundersen <varlistentry>
8300ba218e3cf5049496937be8bce10f22d09bbcTom Gundersen <term><option>-h</option></term>
8300ba218e3cf5049496937be8bce10f22d09bbcTom Gundersen <term><option>--help</option></term>
d5099efc47d4e6ac60816b5381a5f607ab03f06eMichal Schmidt
<listitem><para>Prints a short help
text and exits.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem><para>Prints a short version
string and exits.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-pager</option></term>
<listitem><para>Do not pipe output into a
pager.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-ask-password</option></term>
<listitem><para>Do not query the user
for authentication for privileged
operations.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-H</option></term>
<term><option>--host=</option></term>
<listitem><para>Execute operation
remotely. Specify a hostname, or
username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to
talk to the remote machine manager
instance.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-M</option></term>
<term><option>--machine=</option></term>
<listitem><para>Execute operation on a
local container. Specify a container
name to connect to.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--adjust-system-clock</option></term>
<listitem><para>If
<command>set-local-rtc</command> is
invoked and this option is passed, the
system clock is synchronized from the
RTC again, taking the new setting into
account. Otherwise, the RTC is
synchronized from the system
clock.</para></listitem>
</varlistentry>
</variablelist>
<para>The following commands are understood:</para>
<variablelist>
<varlistentry>
<term><command>status</command></term>
<listitem><para>Show current settings
of the system clock and
RTC.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>set-time [TIME]</command></term>
<listitem><para>Set the system clock
to the specified time. This will also
update the RTC time accordingly. The time
may be specified in the format
"2012-10-30
18:17:16".</para></listitem>
</varlistentry>
<varlistentry>
<term><command>set-timezone [TIMEZONE]</command></term>
<listitem><para>Set the system time
zone to the specified value. Available
timezones can be listed with
<command>list-timezones</command>. If
the RTC is configured to be in the
local time, this will also update the
RTC time. This call will alter the
<filename>/etc/localtime</filename>
symlink. See
<citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more
information.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>list-timezones</command></term>
<listitem><para>List available time
zones, one per line. Entries from the
list can be set as the system
timezone with
<command>set-timezone</command>.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>set-local-rtc [BOOL]</command></term>
<listitem><para>Takes a boolean
argument. If <literal>0</literal>, the
system is configured to maintain the
RTC in universal time. If
<literal>1</literal>, it will maintain
the RTC in local time instead. Note
that maintaining the RTC in the local
timezone is not fully supported and
will create various problems with time
zone changes and daylight saving
adjustments. If at all possible, keep the
RTC in UTC mode. Note that invoking this
will also synchronize the RTC from the
system clock, unless
<option>--adjust-system-clock</option> is
passed (see above). This command will
change the 3rd line of
<filename>/etc/adjtime</filename>, as
documented in
<citerefentry><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>set-ntp [BOOL]</command></term>
<listitem><para>Takes a boolean
argument. Controls whether NTP based
network time synchronization is
enabled (if
available).</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist class='environment-variables'>
<varlistentry>
<term><varname>$SYSTEMD_PAGER</varname></term>
<listitem><para>Pager to use when
<option>--no-pager</option> is not given;
overrides <varname>$PAGER</varname>. Setting
this to an empty string or the value
<literal>cat</literal> is equivalent to passing
<option>--no-pager</option>.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>Show current settings:
<programlisting>
$ timedatectl
Local time: Fri, 2012-11-02 09:26:46 CET
Universal time: Fri, 2012-11-02 08:26:46 UTC
RTC time: Fri, 2012-11-02 08:26:45
Timezone: Europe/Warsaw
UTC offset: +0100
NTP enabled: no
NTP synchronized: no
RTC in local TZ: no
DST active: no
Last DST change: CEST → CET, DST became inactive
Sun, 2012-10-28 02:59:59 CEST
Sun, 2012-10-28 02:00:00 CET
Next DST change: CET → CEST, DST will become active
the clock will jump one hour forward
Sun, 2013-03-31 01:59:59 CET
Sun, 2013-03-31 03:00:00 CEST
</programlisting>
</para>
<para>Enable an NTP daemon (chronyd):
<programlisting>
$ timedatectl set-ntp true
==== AUTHENTICATING FOR org.freedesktop.timedate1.set-ntp ===
Authentication is required to control whether network time synchronization shall be enabled.
Authenticating as: user
Password: ********
==== AUTHENTICATION COMPLETE ===
</programlisting>
<programlisting>
$ systemctl status chronyd.service
chronyd.service - NTP client/server
Loaded: loaded (/usr/lib/systemd/system/chronyd.service; enabled)
Active: active (running) since Fri, 2012-11-02 09:36:25 CET; 5s ago
...
</programlisting>
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>date</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>