man: improve grammar and word formatting in numerous man pages

[elogind.git] / man / timedatectl.xml

diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 83ae1f6f177e89b4de04a053f27719be8c3f5b7d..77af2ad4600edfecd3fd18701f32bd41b265dda8 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/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 

-<refentry id="timedatectl">
+<refentry id="timedatectl" conditional='ENABLE_TIMEDATED'>

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


@@ -68,8 +68,8 @@
 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>

-                                <term><option>--help</option></term>

                                 <term><option>-h</option></term>
                                 <term><option>-h</option></term>

+                                <term><option>--help</option></term>

 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>
 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>


@@ -97,6 +97,14 @@
                                 operations.</para></listitem>
                         </varlistentry>
 
                                 operations.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>-P</option></term>
+                                <term><option>--privileged</option></term>
+
+                                <listitem><para>Acquire privileges via PolicyKit
+                                before executing the operation.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>-H</option></term>
                                 <term><option>--host</option></term>
                         <varlistentry>
                                 <term><option>-H</option></term>
                                 <term><option>--host</option></term>


@@ -150,7 +158,7 @@
 
                                 <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 can be listed with
+                                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
                                 <command>list-timezones</command>. If
                                 the RTC is configured to be in the
                                 local time this will also update the


@@ -168,7 +176,7 @@
                                 <listitem><para>List available time
                                 zones, one per line. Entries from the
                                 list can be set as the system
                                 <listitem><para>List available time
                                 zones, one per line. Entries from the
                                 list can be set as the system

-                                time zone with
+                                timezone with

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


@@ -182,7 +190,7 @@
                                 <literal>1</literal> it will maintain
                                 the RTC in local time instead. Note
                                 that maintaining the RTC in the local
                                 <literal>1</literal> it will maintain
                                 the RTC in local time instead. Note
                                 that maintaining the RTC in the local

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

                                 will create various problems with time
                                 zone changes and daylight saving
                                 adjustments. If at all possible use
                                 will create various problems with time
                                 zone changes and daylight saving
                                 adjustments. If at all possible use


@@ -221,7 +229,7 @@
         <refsect1>
                 <title>Environment</title>
 
         <refsect1>
                 <title>Environment</title>
 

-                <variablelist>
+                <variablelist class='environment-variables'>

                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when


@@ -234,6 +242,50 @@
                 </variablelist>
         </refsect1>
 
                 </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>
         <refsect1>
                 <title>See Also</title>
                 <para>