man: xinclude --help/--version/--no-pager

[elogind.git] / man / timedatectl.xml

diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 8fb4e38f3738dedb8f0ec4a6edaf099093b2a145..7ac19e6be43c1e9e77b5d0975780d6c96170c33a 100644 (file)
--- a/man/timedatectl.xml
+++ b/man/timedatectl.xml
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 

-<refentry id="timedatectl">
+<refentry id="timedatectl" conditional='ENABLE_TIMEDATED'
+        xmlns:xi="http://www.w3.org/2001/XInclude">

 
         <refentryinfo>
                 <title>timedatectl</title>
 
         <refentryinfo>
                 <title>timedatectl</title>


@@ -67,60 +68,51 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
                 <para>The following options are understood:</para>
 
                 <variablelist>

-                        <varlistentry>
-                                <term><option>--help</option></term>
-                                <term><option>-h</option></term>
-
-                                <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>
 
                         <varlistentry>
                                 <term><option>--no-ask-password</option></term>
 

-                                <listitem><para>Don't query the user
+                                <listitem><para>Do not query the user

                                 for authentication for privileged
                                 operations.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><option>-H</option></term>
                                 for authentication for privileged
                                 operations.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><option>-H</option></term>

-                                <term><option>--host</option></term>
+                                <term><option>--host=</option></term>

 
 

-                                <listitem><para>Execute operation
+                                <listitem><para>Execute the operation

                                 remotely. Specify a hostname, or
                                 remotely. Specify a hostname, or

-                                username and hostname separated by @,
+                                username and hostname separated by <literal>@</literal>,

                                 to connect to. This will use SSH to
                                 to connect to. This will use SSH to

-                                talk to a remote
-                                system.</para></listitem>
+                                talk to the remote machine manager
+                                instance.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--fix-system</option></term>
+                                <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
 
                                 <listitem><para>If
                                 <command>set-local-rtc</command> is

-                                invoked and this option is passed the
+                                invoked and this option is passed, the

                                 system clock is synchronized from the
                                 RTC again, taking the new setting into
                                 system clock is synchronized from the
                                 RTC again, taking the new setting into

-                                account. Otherwise the RTC is
-                                synchonized from the system
+                                account. Otherwise, the RTC is
+                                synchronized from the system

                                 clock.</para></listitem>
                         </varlistentry>
                                 clock.</para></listitem>
                         </varlistentry>

+
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
+                        <xi:include href="standard-options.xml" xpointer="no-pager" />

                 </variablelist>
 
                 <para>The following commands are understood:</para>
                 </variablelist>
 
                 <para>The following commands are understood:</para>


@@ -150,11 +142,16 @@
 
                                 <listitem><para>Set the system time
                                 zone to the specified value. Available
 
                                 <listitem><para>Set the system time
                                 zone to the specified value. Available

-                                time zones my be listed with
+                                timezones can be listed with

                                 <command>list-timezones</command>. If
                                 the RTC is configured to be in the
                                 <command>list-timezones</command>. If
                                 the RTC is configured to be in the

-                                local time this will also update the
-                                RTC time.</para></listitem>
+                                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>
                         </varlistentry>
 
                         <varlistentry>


@@ -162,7 +159,7 @@
 
                                 <listitem><para>List available time
                                 zones, one per line. Entries from the
 
                                 <listitem><para>List available time
                                 zones, one per line. Entries from the

-                                list may selected as the system
+                                list can be set as the system

                                 timezone with
                                 <command>set-timezone</command>.</para></listitem>
                         </varlistentry>
                                 timezone with
                                 <command>set-timezone</command>.</para></listitem>
                         </varlistentry>


@@ -171,20 +168,20 @@
                                 <term><command>set-local-rtc [BOOL]</command></term>
 
                                 <listitem><para>Takes a boolean
                                 <term><command>set-local-rtc [BOOL]</command></term>
 
                                 <listitem><para>Takes a boolean

-                                argument. If <literal>0</literal> the
+                                argument. If <literal>0</literal>, the

                                 system is configured to maintain the
                                 system is configured to maintain the

-                                RTC in universal time, if
-                                <literal>1</literal> it will maintain
+                                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
                                 the RTC in local time instead. Note
                                 that maintaining the RTC in the local

-                                timezone is is not fully supported and
+                                timezone is not fully supported and

                                 will create various problems with time
                                 zone changes and daylight saving
                                 will create various problems with time
                                 zone changes and daylight saving

-                                adjustments. If at all possible use
-                                RTC in UTC. Note that invoking this
+                                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
                                 will also synchronize the RTC from the
                                 system clock, unless

-                                <option>--fix-system</option> is
+                                <option>--adjust-system-clock</option> is

                                 passed (see above). This command will
                                 change the 3rd line of
                                 <filename>/etc/adjtime</filename>, as
                                 passed (see above). This command will
                                 change the 3rd line of
                                 <filename>/etc/adjtime</filename>, as


@@ -209,24 +206,48 @@
         <refsect1>
                 <title>Exit status</title>
 
         <refsect1>
                 <title>Exit status</title>
 

-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure

                 code otherwise.</para>
         </refsect1>
 
                 code otherwise.</para>
         </refsect1>
 

+        <xi:include href="less-variables.xml" />
+

         <refsect1>
         <refsect1>

-                <title>Environment</title>
+                <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>

 
 

-                <variablelist>
-                        <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>
+                <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>
         </refsect1>
 
         <refsect1>


@@ -235,6 +256,7 @@
                         <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>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>
                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 </para>