summaryrefslogtreecommitdiff
path: root/man/org.freedesktop.login1.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-05-05 23:03:36 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-05-06 09:13:42 +0200
commitb61cc5fdadbdaaa0071fba55117a5d07d3527bd7 (patch)
tree20dec19feeebd1de63eb6750452319fb48ee8095 /man/org.freedesktop.login1.xml
parentb856b346c17919e27f264496956f894e8362e291 (diff)
downloadsystemd-b61cc5fdadbdaaa0071fba55117a5d07d3527bd7.tar.gz
man: update login1(5) for SetType()
Added in db72aea4a952cdfdef51eda03408d7c4a11e7359.
Diffstat (limited to 'man/org.freedesktop.login1.xml')
-rw-r--r--man/org.freedesktop.login1.xml19
1 files changed, 14 insertions, 5 deletions
diff --git a/man/org.freedesktop.login1.xml b/man/org.freedesktop.login1.xml
index 0908b2ea10..44ad033752 100644
--- a/man/org.freedesktop.login1.xml
+++ b/man/org.freedesktop.login1.xml
@@ -1003,6 +1003,7 @@ node /org/freedesktop/login1/session/1 {
in i signal_number);
TakeControl(in b force);
ReleaseControl();
+ SetType(in s type);
TakeDevice(in u major,
in u minor,
out h fd,
@@ -1058,7 +1059,6 @@ node /org/freedesktop/login1/session/1 {
readonly u Leader = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly u Audit = ...;
- @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s Type = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s Class = '...';
@@ -1099,6 +1099,8 @@ node /org/freedesktop/login1/session/1 {
<variablelist class="dbus-method" generated="True" extra-ref="ReleaseControl()"/>
+ <variablelist class="dbus-method" generated="True" extra-ref="SetType()"/>
+
<variablelist class="dbus-method" generated="True" extra-ref="TakeDevice()"/>
<variablelist class="dbus-method" generated="True" extra-ref="ReleaseDevice()"/>
@@ -1183,10 +1185,17 @@ node /org/freedesktop/login1/session/1 {
out and replaced. Otherwise, this method fails if there is already a controller. Note that this method is
limited to D-Bus users with the effective UID set to the user of the session or root.</para>
- <para><function>ReleaseControl()</function> drops control of a given session. Closing the
- D-Bus connection implicitly releases control as well. See <function>TakeControl()</function> for more information. This
- method also releases all devices for which the controller requested ownership via <function>TakeDevice()</function>.
- </para>
+ <para><function>ReleaseControl()</function> drops control of a given session. Closing the D-Bus
+ connection implicitly releases control as well. See <function>TakeControl()</function> for more
+ information. This method also releases all devices for which the controller requested ownership via
+ <function>TakeDevice()</function>.</para>
+
+ <para><function>SetType()</function> allows the type of the session to be changed dynamically. It can
+ only be called by session's current controller. If <function>TakeControl()</function> has not been
+ called, this method will fail. In addition, the session type will be reset to its original value once
+ control is released, either by calling <function>ReleaseControl()</function> or closing the D-Bus
+ connection. This should help prevent a session from entering an inconsistent state, for example if the
+ controller crashes. The only argument <varname>type</varname> is the new session type.</para>
<para><function>TakeDevice()</function> allows a session controller to get a file descriptor for a
specific device. Pass in the major and minor numbers of the character device and