chiark / gitweb /
doc: balance C indirections in function prototypes
[elogind.git] / man / timedatectl.xml
index 9aade29a787cc155d97002543b2c9f2a5c5d1e22..a82e6468cb8a7901f7522d93aa6e97934fe187f4 100644 (file)
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="timedatectl" conditional='ENABLE_TIMEDATED'>
+<refentry id="timedatectl" conditional='ENABLE_TIMEDATED'
+        xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>timedatectl</title>
                                 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>
+                                <term><option>--host=</option></term>
 
                                 <listitem><para>Execute the operation
                                 remotely. Specify a hostname, or
                                 username and hostname separated by <literal>@</literal>,
                                 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>
+                                <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>
 
                                 <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
-                                account. Otherwise the RTC is
+                                account. Otherwise, the RTC is
                                 synchronized from the system
                                 clock.</para></listitem>
                         </varlistentry>
                                 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
+                                local time, this will also update the
                                 RTC time. This call will alter the
                                 <filename>/etc/localtime</filename>
                                 symlink. See
                                 <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
-                                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
                                 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
+                                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
                                 <option>--adjust-system-clock</option> is
         <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>
 
-        <refsect1>
-                <title>Environment</title>
-
-                <variablelist class='environment-variables'>
-                        <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>
-        </refsect1>
+        <xi:include href="less-variables.xml" />
 
         <refsect1>
                 <title>Examples</title>
                 <para>Show current settings:
-                <programlisting>
-$ timedatectl
+                <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
@@ -262,27 +249,22 @@ NTP synchronized: no
  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>
+                  Sun, 2013-03-31 03:00:00 CEST</programlisting>
                 </para>
 
                 <para>Enable an NTP daemon (chronyd):
-                <programlisting>
-$ timedatectl set-ntp true
+                <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>
+==== AUTHENTICATION COMPLETE ===</programlisting>
 
-                <programlisting>
-$ systemctl status chronyd.service
+                <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>
+...</programlisting>
                 </para>
         </refsect1>