man: wording and grammar updates

[elogind.git] / man / timedatectl.xml

diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 9065577692655c9195e6497dd36a6530d5442703..9aade29a787cc155d97002543b2c9f2a5c5d1e22 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>


@@ -92,25 +92,33 @@
                         <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>
 
                                 for authentication for privileged
                                 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>
 

-                                <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
                                 talk to a remote
                                 system.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 to connect to. This will use SSH to
                                 talk to a remote
                                 system.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--fix-system</option></term>
+                                <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


@@ -118,7 +126,7 @@
                                 system clock is synchronized from the
                                 RTC again, taking the new setting into
                                 account. Otherwise the RTC is
                                 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>
                                 clock.</para></listitem>
                         </varlistentry>
                 </variablelist>


@@ -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 my 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


@@ -167,7 +175,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>


@@ -182,14 +190,14 @@
                                 <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

-                                timezone is 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
                                 RTC in UTC. Note that invoking this
                                 will also synchronize the RTC from the
                                 system clock, unless
                                 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
                                 passed (see above). This command will
                                 change the 3rd line of
                                 <filename>/etc/adjtime</filename>, as


@@ -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>