From 9c970e5f55108456e45b3b2f7617be599ddff516 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 9 Apr 2020 17:17:16 +0200 Subject: man: import org.freedesktop.timedate1(3) from the wiki --- man/org.freedesktop.timedate1.xml | 132 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 man/org.freedesktop.timedate1.xml (limited to 'man/org.freedesktop.timedate1.xml') diff --git a/man/org.freedesktop.timedate1.xml b/man/org.freedesktop.timedate1.xml new file mode 100644 index 0000000000..65a5f5b2fb --- /dev/null +++ b/man/org.freedesktop.timedate1.xml @@ -0,0 +1,132 @@ + + + + + + + org.freedesktop.timedate1 + systemd + + + + org.freedesktop.timedate1 + 5 + + + + org.freedesktop.timedate1 + The D-Bus interface of systemd-timedated + + + + Introduction + + + systemd-timedated.service8 + is a system service that can be used to control the system time and related settings. This page + describes the D-Bus interface. + + + + The D-Bus API + + The service exposes the following interfaces on the bus: + + +$ gdbus introspect --system \ + --dest org.freedesktop.timedate1 \ + --object-path /org/freedesktop/timedate1 + +node /org/freedesktop/timedate1 { + interface org.freedesktop.timedate1 { + methods: + SetTime(in x usec_utc, + in b relative, + in b user_interaction); + SetTimezone(in s timezone, + in b user_interaction); + SetLocalRTC(in b local_rtc, + in b fix_system, + in b user_interaction); + SetNTP(in b use_ntp, + in b user_interaction); + signals: + properties: + readonly s Timezone = 'Europe/Berlin'; + readonly b LocalRTC = false; + readonly b NTP = true; + }; + interface org.freedesktop.DBus.Properties { + }; + interface org.freedesktop.DBus.Introspectable { + }; + interface org.freedesktop.DBus.Peer { + }; +}; + + + + Methods + + Use SetTime() to change the system clock. Pass a value of microseconds since + the UNIX epoch (1 Jan 1970 UTC). If relative is true, the passed usec value will be + added to the current system time, if it is false the current system time will be set to the passed usec + value. If the system time is set with this call the RTC will be updated as well. + + Use SetTimezone() to set the system timezone. Pass a value like + Europe/Berlin to set the timezone. Valid timezones are listed in + /usr/share/zoneinfo/zone.tab. If the RTC is configured to be maintained in local + time, it will be updated accordingly. + + Use SetLocalRTC() to control whether the RTC is in local time or UTC. It is + strongly recommended to maintain the RTC in UTC. Some OSes (Windows) however maintain the RTC in local + time, which might make it necessary to enable this feature. However, this creates various problems as + daylight changes might be missed. If fix_system is passed true, + the time from the RTC is read again and the system clock adjusted according to the new setting. If + fix_system is passed false the system time is written to the RTC + taking the new setting into account. Use fix_system=true in installers and livecds + where the RTC is probably more reliable than the system time. Use fix_system=false + in configuration UIs that are run during normal operation and where the system clock is probably more + reliable than the RTC. + + Use SetNTP() to control whether the system clock is synchronized with the + network using systemd-timesyncd. This will enable and start or disable and stop + the chosen time synchronization service. + + Whenever the timezone and local_rtc settings are changed via the daemon + PropertyChanged signals are sent out to which clients can subscribe. Changing the + time settings using this interface is authenticated via PolicyKit. + + Note that this service will not inform you about system time changes. Use + timerfd3 + with CLOCK_REALTIME and TFD_TIMER_CANCEL_ON_SET for that. + + + The user_interaction boolean parameters can be used to control whether + PolicyKit should interactively ask the user for authentication credentials if it needs to. + + The PolicyKit action for SetTimezone() is + org.freedesktop.timedate1.set-timezone. For + SetLocalRTC() it is + org.freedesktop.timedate1.set-local-rtc, for + SetTime() it is org.freedesktop.timedate1.set-time + and for SetNTP() it is + org.freedesktop.timedate1.set-ntp. + + + + + Versioning + + These D-Bus interfaces follow + the usual interface versioning guidelines. + + + + See also + + More information on how the system clock and RTC interact + + -- cgit v1.2.1