TODO: Remove Elapsed Time DHCPv6 option as it is done

[thirdparty/systemd.git] / man / systemd-timedated.service.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="systemd-timedated.service" conditional='ENABLE_TIMEDATED'>

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

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

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

        <refnamediv>
                <refname>systemd-timedated.service</refname>
                <refname>systemd-timedated</refname>
                <refpurpose>Time and date bus mechanism</refpurpose>
        </refnamediv>

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

        <refsect1>
                <title>Description</title>

                <para><filename>systemd-timedated</filename> is a
                system service that may be used as a mechanism to change
                the system clock and timezone, as well as to
                enable/disable NTP time
                synchronization. <filename>systemd-timedated</filename>
                is automatically activated on request and terminates
                itself when it is unused.</para>

                <para>The tool
                <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                is a command-line client to this service.</para>

                <para>See the <ulink
                url="http://www.freedesktop.org/wiki/Software/systemd/timedated">
                developer documentation</ulink> for information about
                the APIs <filename>systemd-timedated</filename>
                provides.</para>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>