man: we need to be more careful with the unit search paths we document

[elogind.git] / man / timedatectl.xml

diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 8fb4e38f3738dedb8f0ec4a6edaf099093b2a145..faccc5086df95ca0892b4e219ea89fd0bba1c658 100644 (file)
--- a/man/timedatectl.xml
+++ b/man/timedatectl.xml
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="timedatectl">
+<refentry id="timedatectl" conditional='ENABLE_TIMEDATED'>
 
         <refentryinfo>
                 <title>timedatectl</title>
@@ -68,8 +68,8 @@
 
                 <variablelist>
                         <varlistentry>
-                                <term><option>--help</option></term>
                                 <term><option>-h</option></term>
+                                <term><option>--help</option></term>
 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>
@@ -101,7 +101,7 @@
                                 <term><option>-H</option></term>
                                 <term><option>--host</option></term>
 
-                                <listitem><para>Execute operation
+                                <listitem><para>Execute the operation
                                 remotely. Specify a hostname, or
                                 username and hostname separated by @,
                                 to connect to. This will use SSH to
@@ -110,7 +110,7 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--fix-system</option></term>
+                                <term><option>--adjust-system-clock</option></term>
 
                                 <listitem><para>If
                                 <command>set-local-rtc</command> is
@@ -118,7 +118,7 @@
                                 system clock is synchronized from the
                                 RTC again, taking the new setting into
                                 account. Otherwise the RTC is
-                                synchonized from the system
+                                synchronized from the system
                                 clock.</para></listitem>
                         </varlistentry>
                 </variablelist>
@@ -150,11 +150,16 @@
 
                                 <listitem><para>Set the system time
                                 zone to the specified value. Available
-                                time zones my be listed with
+                                time zones 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.</para></listitem>
+                                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>
@@ -162,8 +167,8 @@
 
                                 <listitem><para>List available time
                                 zones, one per line. Entries from the
-                                list may selected as the system
-                                timezone with
+                                list can be set as the system
+                                time zone with
                                 <command>set-timezone</command>.</para></listitem>
                         </varlistentry>
 
@@ -177,14 +182,14 @@
                                 <literal>1</literal> it will maintain
                                 the RTC in local time instead. Note
                                 that maintaining the RTC in the local
-                                timezone is is not fully supported and
+                                time zone is not fully supported and
                                 will create various problems with time
                                 zone changes and daylight saving
                                 adjustments. If at all possible use
                                 RTC in UTC. Note that invoking this
                                 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
@@ -216,7 +221,7 @@
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
@@ -229,12 +234,57 @@
                 </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>