mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-27 04:03:36 +08:00
Code Issues Packages Projects Releases Wiki Activity
main
systemd/man/timedatectl.xml

362 lines
15 KiB
XML
Raw Permalink Normal View History

timedatectl: introduce new command line client for timedated Much like logind has a client in loginctl, and journald in journalctl introduce timedatectl, to change the system time (incl. RTC), timezones and related settings.
2012-10-17 08:50:09 +08:00
<?xml version='1.0'?> <!--*-nxml-*-->
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 21:40:58 +08:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 22:48:33 +08:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 12:23:58 +08:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
timedatectl: introduce new command line client for timedated Much like logind has a client in loginctl, and journald in journalctl introduce timedatectl, to change the system time (incl. RTC), timezones and related settings.
2012-10-17 08:50:09 +08:00
man: add explanations of show-timesync and timesync-status commands
2018-04-30 21:42:40 +08:00
<refentry id="timedatectl" conditional='ENABLE_TIMEDATECTL'
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>timedatectl</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>timedatectl</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>timedatectl</refname>
<refpurpose>Control the system time and date</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
timedated: add back support for ntp-units.d/ We removed support for foreign services (and ntp-units.d/) in b72ddf0f4. Support for foreign services was added back in 5d280742, but through an environment variable. The problem with the env var approach is that it only works as a mechanism to select one item, and doesn't work nicely as a mechinism to create a list of items through drop-ins (because the env var can be easily overridden, but not extended). Having a list of "ntp providers" is important to be able to reliably disable all of them when that is requested. Another problem is that nobody ever bothered to care about our new "standard". ntp-units.d/ is a nice simple format that works and is already supported by chrony and ntpd and timedatex. If we were to introduce and ask people to follow a new standard, there should be some good reason for this. The idea with env vars has lower functionality, requires systemd-specific syntax. We should just re-adopt the format that we originally introduced and that seems to work for everyone, and more on to more interesting problems.
2019-07-21 21:06:35 +08:00
<command>timedatectl</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="req">COMMAND</arg>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
timedated: add back support for ntp-units.d/ We removed support for foreign services (and ntp-units.d/) in b72ddf0f4. Support for foreign services was added back in 5d280742, but through an environment variable. The problem with the env var approach is that it only works as a mechanism to select one item, and doesn't work nicely as a mechinism to create a list of items through drop-ins (because the env var can be easily overridden, but not extended). Having a list of "ntp providers" is important to be able to reliably disable all of them when that is requested. Another problem is that nobody ever bothered to care about our new "standard". ntp-units.d/ is a nice simple format that works and is already supported by chrony and ntpd and timedatex. If we were to introduce and ask people to follow a new standard, there should be some good reason for this. The idea with env vars has lower functionality, requires systemd-specific syntax. We should just re-adopt the format that we originally introduced and that seems to work for everyone, and more on to more interesting problems.
2019-07-21 21:06:35 +08:00
<para><command>timedatectl</command> may be used to query and change the system clock and its settings,
and enable or disable time synchronization services.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<para>Use
<citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
to initialize the system time zone for mounted (but not booted)
system images.</para>
man: add explanations of show-timesync and timesync-status commands
2018-04-30 21:42:40 +08:00
timedated: add back support for ntp-units.d/ We removed support for foreign services (and ntp-units.d/) in b72ddf0f4. Support for foreign services was added back in 5d280742, but through an environment variable. The problem with the env var approach is that it only works as a mechanism to select one item, and doesn't work nicely as a mechinism to create a list of items through drop-ins (because the env var can be easily overridden, but not extended). Having a list of "ntp providers" is important to be able to reliably disable all of them when that is requested. Another problem is that nobody ever bothered to care about our new "standard". ntp-units.d/ is a nice simple format that works and is already supported by chrony and ntpd and timedatex. If we were to introduce and ask people to follow a new standard, there should be some good reason for this. The idea with env vars has lower functionality, requires systemd-specific syntax. We should just re-adopt the format that we originally introduced and that seems to work for everyone, and more on to more interesting problems.
2019-07-21 21:06:35 +08:00
<para><command>timedatectl</command> may be used to show the current status of time synchronization
services, for example
man: add explanations of show-timesync and timesync-status commands
2018-04-30 21:42:40 +08:00
<citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
man: mention 'status' is the default command for timedatectl
2018-03-14 14:10:46 +08:00
<refsect1>
<title>Commands</title>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<para>The following commands are understood:</para>
<variablelist>
<varlistentry>
<term><command>status</command></term>
timedated: add back support for ntp-units.d/ We removed support for foreign services (and ntp-units.d/) in b72ddf0f4. Support for foreign services was added back in 5d280742, but through an environment variable. The problem with the env var approach is that it only works as a mechanism to select one item, and doesn't work nicely as a mechinism to create a list of items through drop-ins (because the env var can be easily overridden, but not extended). Having a list of "ntp providers" is important to be able to reliably disable all of them when that is requested. Another problem is that nobody ever bothered to care about our new "standard". ntp-units.d/ is a nice simple format that works and is already supported by chrony and ntpd and timedatex. If we were to introduce and ask people to follow a new standard, there should be some good reason for this. The idea with env vars has lower functionality, requires systemd-specific syntax. We should just re-adopt the format that we originally introduced and that seems to work for everyone, and more on to more interesting problems.
2019-07-21 21:06:35 +08:00
<listitem><para>Show current settings of the system clock and RTC, including whether network time
synchronization is active. If no command is specified, this is the implied default.
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v195"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
timedatectl: add 'show' command to display machine-readable output Closes #9249.
2018-06-10 16:17:34 +08:00
<varlistentry>
<term><command>show</command></term>
<listitem><para>Show the same information as <option>status</option>, but in machine readable form.
This command is intended to be used whenever computer-parsable output is required.
Use <option>status</option> if you are looking for formatted human-readable output.</para>
<para>By default, empty properties are suppressed. Use <option>--all</option> to show those too.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
To select specific properties to show, use <option>--property=</option>.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
timedatectl: add 'show' command to display machine-readable output Closes #9249.
2018-06-10 16:17:34 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
<term><command>set-time [TIME]</command></term>
<listitem><para>Set the system clock to the specified time.
This will also update the RTC time accordingly. The time may
be specified in the format "2012-10-30
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
18:17:16".</para>
<xi:include href="version-info.xml" xpointer="v195"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><command>set-timezone [TIMEZONE]</command></term>
<listitem><para>Set the system time zone to the specified
value. Available 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 RTC time. This
call will alter the <filename>/etc/localtime</filename>
symlink. See
<citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
for more information.</para>
<xi:include href="version-info.xml" xpointer="v195"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><command>list-timezones</command></term>
<listitem><para>List available time zones, one per line.
Entries from the list can be set as the system timezone with
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<command>set-timezone</command>.</para>
<xi:include href="version-info.xml" xpointer="v195"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><command>set-local-rtc [BOOL]</command></term>
<listitem><para>Takes a boolean argument. If
<literal>0</literal>, the system is configured to maintain the
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, 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 passed (see above).
This command will change the 3rd line of
<filename>/etc/adjtime</filename>, as documented in
<citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v195"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><command>set-ntp [BOOL]</command></term>
timedated: add back support for ntp-units.d/ We removed support for foreign services (and ntp-units.d/) in b72ddf0f4. Support for foreign services was added back in 5d280742, but through an environment variable. The problem with the env var approach is that it only works as a mechanism to select one item, and doesn't work nicely as a mechinism to create a list of items through drop-ins (because the env var can be easily overridden, but not extended). Having a list of "ntp providers" is important to be able to reliably disable all of them when that is requested. Another problem is that nobody ever bothered to care about our new "standard". ntp-units.d/ is a nice simple format that works and is already supported by chrony and ntpd and timedatex. If we were to introduce and ask people to follow a new standard, there should be some good reason for this. The idea with env vars has lower functionality, requires systemd-specific syntax. We should just re-adopt the format that we originally introduced and that seems to work for everyone, and more on to more interesting problems.
2019-07-21 21:06:35 +08:00
<listitem><para>Takes a boolean argument. Controls whether network time synchronization is active and
enabled (if available). If the argument is true, this enables and starts the first existing network
synchronization service. If the argument is false, then this disables and stops the known network
man: fix a reference in timedatectl man page timedatectl(1) says the synchronization service list generation is described "below", but in reality it is documented in systemd-timedated.service(8). Fix the sentence to reference the correct man page.
2021-09-24 20:26:21 +08:00
synchronization services. The way that the list of services is built is described in
<citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v195"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
</variablelist>
timedatectl: add 'show' command to display machine-readable output Closes #9249.
2018-06-10 16:17:34 +08:00
<refsect2>
<title>systemd-timesyncd Commands</title>
man: add explanations of show-timesync and timesync-status commands
2018-04-30 21:42:40 +08:00
timedatectl: add 'show' command to display machine-readable output Closes #9249.
2018-06-10 16:17:34 +08:00
<para>The following commands are specific to
<citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
man: add explanations of show-timesync and timesync-status commands
2018-04-30 21:42:40 +08:00
<variablelist>
<varlistentry>
<term><command>timesync-status</command></term>
<listitem><para>Show current status of
<citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
If <option>--monitor</option> is specified, then this will monitor the status updates.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
man: add explanations of show-timesync and timesync-status commands
2018-04-30 21:42:40 +08:00
</varlistentry>
<varlistentry>
<term><command>show-timesync</command></term>
timedatectl: add 'show' command to display machine-readable output Closes #9249.
2018-06-10 16:17:34 +08:00
<listitem><para>Show the same information as <option>timesync-status</option>, but in machine readable form.
This command is intended to be used whenever computer-parsable output is required.
Use <option>timesync-status</option> if you are looking for formatted human-readable output.</para>
<para>By default, empty properties are suppressed. Use <option>--all</option> to show those too.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
To select specific properties to show, use <option>--property=</option>.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
man: add explanations of show-timesync and timesync-status commands
2018-04-30 21:42:40 +08:00
</varlistentry>
timedatectl: add 'ntp-servers' and 'revert' commands to modify link NTP servers
2019-05-28 11:07:47 +08:00
<varlistentry>
<term><command>ntp-servers <replaceable>INTERFACE</replaceable> <replaceable>SERVER</replaceable>…</command></term>
<listitem><para>Set the interface specific NTP servers. This command can be used only when the
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
interface is managed by <command>systemd-networkd</command>.</para>
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
timedatectl: add 'ntp-servers' and 'revert' commands to modify link NTP servers
2019-05-28 11:07:47 +08:00
</varlistentry>
<varlistentry>
<term><command>revert <replaceable>INTERFACE</replaceable></command></term>
<listitem><para>Revert the interface specific NTP servers. This command can be used only when
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
the interface is managed by <command>systemd-networkd</command>.</para>
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
timedatectl: add 'ntp-servers' and 'revert' commands to modify link NTP servers
2019-05-28 11:07:47 +08:00
</varlistentry>
man: add explanations of show-timesync and timesync-status commands
2018-04-30 21:42:40 +08:00
</variablelist>
</refsect2>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
<refsect1>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--adjust-system-clock</option></term>
<listitem><para>If <command>set-local-rtc</command> is 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 synchronized from the system
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
clock.</para>
<xi:include href="version-info.xml" xpointer="v195"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>--monitor</option></term>
<listitem><para>If <command>timesync-status</command> is invoked and this option is passed, then
<command>timedatectl</command> monitors the status of
<citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
and updates the outputs. Use <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> to terminate the
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
monitoring.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>-a</option></term>
<term><option>--all</option></term>
<listitem><para>When showing properties of
<citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
show all properties regardless of whether they are set or not.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<term><option>--property=</option></term>
<listitem><para>When showing properties of
<citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
limit display to certain properties as specified as argument. If not specified, all set properties are shown.
The argument should be a property name, such as <literal>ServerName</literal>. If specified more than once,
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
all properties with the specified names are shown.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
<varlistentry>
<term><option>--value</option></term>
<listitem>
<para>When printing properties with <command>show-timesync</command>, only print the value, and skip the
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
property name and <literal>=</literal>.</para>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
</varlistentry>
machinectl: add -P
2024-03-02 19:25:22 +08:00
<varlistentry id='option-P'>
timedatectl: add -P
2024-03-02 19:17:54 +08:00
<term><option>-P</option></term>
<listitem>
<xi:include href="standard-options.xml" xpointer="xpointer(//varlistentry[@id='option-P']/listitem/para)" />
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<xi:include href="user-system-options.xml" xpointer="host" />
<xi:include href="user-system-options.xml" xpointer="machine" />
man: use standard-options for --no-ask-password everywhere
2024-08-20 18:32:57 +08:00
<xi:include href="standard-options.xml" xpointer="no-ask-password" />
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 23:58:44 +08:00
<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>
</refsect1>
<refsect1>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<title>Exit status</title>
timedated: add back support for ntp-units.d/ We removed support for foreign services (and ntp-units.d/) in b72ddf0f4. Support for foreign services was added back in 5d280742, but through an environment variable. The problem with the env var approach is that it only works as a mechanism to select one item, and doesn't work nicely as a mechinism to create a list of items through drop-ins (because the env var can be easily overridden, but not extended). Having a list of "ntp providers" is important to be able to reliably disable all of them when that is requested. Another problem is that nobody ever bothered to care about our new "standard". ntp-units.d/ is a nice simple format that works and is already supported by chrony and ntpd and timedatex. If we were to introduce and ask people to follow a new standard, there should be some good reason for this. The idea with env vars has lower functionality, requires systemd-specific syntax. We should just re-adopt the format that we originally introduced and that seems to work for everyone, and more on to more interesting problems.
2019-07-21 21:06:35 +08:00
<para>On success, 0 is returned, a non-zero failure code otherwise.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
man: rename less-variables→common-variables Some are not about less, e.g. $SYSTEMD_URLIFY.
2021-02-28 19:18:25 +08:00
<xi:include href="common-variables.xml" />
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refsect1>
<title>Examples</title>
<para>Show current settings:
<programlisting>$ timedatectl
man: update timedatectl and systemd-timedated
2018-04-17 12:57:27 +08:00
Local time: Thu 2017-09-21 16:08:56 CEST
Universal time: Thu 2017-09-21 14:08:56 UTC
RTC time: Thu 2017-09-21 14:08:56
Time zone: Europe/Warsaw (CEST, +0200)
System clock synchronized: yes
NTP service: active
RTC in local TZ: no</programlisting>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</para>
man: throw in an example of timedatectl output timedatectl is too cool not to advertise it a bit.
2012-11-02 17:55:59 +08:00
man: avoid confusion regarding "time synchronization state" Also, update example in the timedatectl man page to match the actual timedatectl output.
2015-04-09 00:34:08 +08:00
<para>Enable network time synchronization:
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<programlisting>$ timedatectl set-ntp true
man: throw in an example of timedatectl output timedatectl is too cool not to advertise it a bit.
2012-11-02 17:55:59 +08:00
==== AUTHENTICATING FOR org.freedesktop.timedate1.set-ntp ===
Authentication is required to control whether network time synchronization shall be enabled.
Authenticating as: user
Password: ********
man: always place <programlisting> and </programlisting> in a line with actual sources, so that we don't get spurious newlines in the man page output
2014-02-14 22:56:19 +08:00
==== AUTHENTICATION COMPLETE ===</programlisting>
man: throw in an example of timedatectl output timedatectl is too cool not to advertise it a bit.
2012-11-02 17:55:59 +08:00
man: update timedatectl(1)'s examples The output didn't match what we output these days. Also, "set-ntp" cannot be used to control chronyd anymore.
2015-04-07 22:29:21 +08:00
<programlisting>$ systemctl status systemd-timesyncd.service
● systemd-timesyncd.service - Network Time Synchronization
man: revert dynamic paths for split-usr setups This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all.
2015-06-19 01:47:44 +08:00
Loaded: loaded (/usr/lib/systemd/system/systemd-timesyncd.service; enabled)
man: update timedatectl(1)'s examples The output didn't match what we output these days. Also, "set-ntp" cannot be used to control chronyd anymore.
2015-04-07 22:29:21 +08:00
Active: active (running) since Mo 2015-03-30 14:20:38 CEST; 5s ago
Docs: man:systemd-timesyncd.service(8)
Main PID: 595 (systemd-timesyn)
Status: "Using Time Server 216.239.38.15:123 (time4.google.com)."
CGroup: /system.slice/systemd-timesyncd.service
man: revert dynamic paths for split-usr setups This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all.
2015-06-19 01:47:44 +08:00
└─595 /usr/lib/systemd/systemd-timesyncd
man: use unicode ellipsis in more places As requested in https://github.com/systemd/systemd/pull/4864#pullrequestreview-12372557. docbook will substitute triple dots for the ellipsis in man output, so this has no effect on the troff output, only on HTML, making it infinitesimally nicer. In some places we show output from programs, which use dots, and those places should not be changed. In some tables, the alignment would change if dots were changed to the ellipsis which is only one character. Since docbook replaces the ellipsis automatically, we should leave those be. This patch changes all other places.
2016-12-12 06:01:07 +08:00
…</programlisting>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</para>
man: add explanations of show-timesync and timesync-status commands
2018-04-30 21:42:40 +08:00
<para>Show current status of
<citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>:
<programlisting>$ timedatectl timesync-status
Server: 216.239.38.15 (time4.google.com)
Poll interval: 1min 4s (min: 32s; max 34min 8s)
Leap: normal
Version: 4
Stratum: 1
Reference: GPS
Precision: 1us (-20)
Root distance: 335us (max: 5s)
Offset: +316us
Delay: 349us
Jitter: 0
Packet count: 1
Frequency: -8.802ppm</programlisting>
</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-23 02:09:32 +08:00
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry project='man-pages'><refentrytitle>date</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
</simplelist></para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
timedatectl: introduce new command line client for timedated Much like logind has a client in loginctl, and journald in journalctl introduce timedatectl, to change the system time (incl. RTC), timezones and related settings.
2012-10-17 08:50:09 +08:00
</refentry>
Reference in New Issue Copy Permalink