From: Lennart Poettering Date: Mon, 27 Nov 2023 21:34:12 +0000 (+0100) Subject: man: update D-Bus docs with new calls X-Git-Tag: v256-rc1~862^2~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=955502121d8252637f61c0faea3b14d0388c2a6e;p=thirdparty%2Fsystemd.git man: update D-Bus docs with new calls --- diff --git a/man/org.freedesktop.home1.xml b/man/org.freedesktop.home1.xml index 7c604d2e0c1..b1bb6587dc4 100644 --- a/man/org.freedesktop.home1.xml +++ b/man/org.freedesktop.home1.xml @@ -63,9 +63,10 @@ node /org/freedesktop/home1 { out b incomplete, out o bus_path); ListHomes(out a(susussso) home_areas); - @org.freedesktop.systemd1.Privileged("true") ActivateHome(in s user_name, in s secret); + ActivateHomeIfReferenced(in s user_name, + in s secret); @org.freedesktop.systemd1.Privileged("true") DeactivateHome(in s user_name); RegisterHome(in s user_record); @@ -100,6 +101,10 @@ node /org/freedesktop/home1 { in b please_suspend, out h send_fd); @org.freedesktop.systemd1.Privileged("true") + RefHomeUnrestricted(in s user_name, + in b please_suspend, + out h send_fd); + @org.freedesktop.systemd1.Privileged("true") ReleaseHome(in s user_name); InhibitSuspendHome(in s user_name, out h send_fd); @@ -136,6 +141,8 @@ node /org/freedesktop/home1 { + + @@ -166,6 +173,8 @@ node /org/freedesktop/home1 { + + @@ -224,6 +233,11 @@ node /org/freedesktop/home1 { org.freedesktop.home1.Home interface documented below, but may be called on the manager object and takes a user name as additional argument, instead. + ActivateHomeIfReferenced() is identical to + ActivateHome(). However, the call only succeeds if the home directory is currently + referenced. Useful in conjunction with RefHomeUnrestricted(), which allows + creating a reference to a home directory even if the home directory is not active. + DeactivateHome() deactivates (i.e. unmounts) the home directory of the specified user. It is equivalent to the Deactivate() method on the org.freedesktop.home1.Home interface documented below. @@ -355,6 +369,10 @@ node /org/freedesktop/home1 { Ref() on the org.freedesktop.home1.Home interface. + RefHomeUnrestricted() is identical to RefHome() but + succeeds even if the home area is not active currently. This is useful on conjunction with + ActivateHomeIfReferenced(). + ReleaseHome() releases a home directory again, if all file descriptors referencing it are already closed, that where acquired through AcquireHome() or RefHome(). Note that this call does not actually cause the deactivation of the @@ -409,8 +427,8 @@ node /org/freedesktop/home1 { node /org/freedesktop/home1/home { interface org.freedesktop.home1.Home { methods: - @org.freedesktop.systemd1.Privileged("true") Activate(in s secret); + ActivateIfReferenced(in s secret); @org.freedesktop.systemd1.Privileged("true") Deactivate(); Unregister(); @@ -436,6 +454,9 @@ node /org/freedesktop/home1/home { Ref(in b please_suspend, out h send_fd); @org.freedesktop.systemd1.Privileged("true") + RefUnrestricted(in b please_suspend, + out h send_fd); + @org.freedesktop.systemd1.Privileged("true") Release(); InhibitSuspend(out h send_fd); properties: @@ -467,6 +488,8 @@ node /org/freedesktop/home1/home { + + @@ -493,6 +516,8 @@ node /org/freedesktop/home1/home { + + @@ -512,12 +537,13 @@ node /org/freedesktop/home1/home { Methods - Activate(), Deactivate(), - Unregister(), Realize(), Remove(), - Fixate(), Authenticate(), Update(), - Resize(), ChangePassword(), Lock(), - Unlock(), Acquire(), Ref(), - Release(), InhibitSuspend() operate like their matching counterparts on the + Activate(), ActivateIfReferenced(), + Deactivate(), Unregister(), Realize(), + Remove(), Fixate(), Authenticate(), + Update(), Resize(), ChangePassword(), + Lock(), Unlock(), Acquire(), + Ref(), RefUnrestricted(), Release(), + InhibitSuspend() operate like their matching counterparts on the org.freedesktop.home1.Manager interface (see above). The main difference is that they are methods of the home directory objects, and hence carry no additional user name parameter. Which of the two flavors of methods to call depends on the handles to the user known on the @@ -549,11 +575,11 @@ node /org/freedesktop/home1/home { History The Manager Object - InhibitSuspendHome() was added in version 256. + InhibitSuspendHome(), ActivateHomeIfReferenced(), RefHomeUnrestricted() wer added in version 256. Home Objects - InhibitSuspend() was added in version 256. + InhibitSuspend(), ActivateIfReferenced() and RefUnrestricted() were added in version 256. diff --git a/man/org.freedesktop.login1.xml b/man/org.freedesktop.login1.xml index ea466531607..dffd16e3256 100644 --- a/man/org.freedesktop.login1.xml +++ b/man/org.freedesktop.login1.xml @@ -1146,6 +1146,7 @@ node /org/freedesktop/login1/session/1 { TakeControl(in b force); ReleaseControl(); SetType(in s type); + SetClass(in s class); SetDisplay(in s display); SetTTY(in h tty_fd); TakeDevice(in u major, @@ -1242,6 +1243,8 @@ node /org/freedesktop/login1/session/1 { + + @@ -1342,6 +1345,12 @@ node /org/freedesktop/login1/session/1 { connection. This should help prevent a session from entering an inconsistent state, for example if the controller crashes. The only argument type is the new session type. + SetClass() allows the caller to change the class of the session dynamically. + It may only be called by session's owening user. Currently, this call may be exclusively used to change + the class from user-incomplete to user. The call is synchronous, + and will return only once the user's service manager has successfully been started, if necessary. The + only argument type is the new session type. + SetDisplay() allows the display name of the graphical session to be changed. This is useful if the display server is started as part of the session. It can only be called by session's current controller. If TakeControl() has not been called, this method will fail. The only argument @@ -1578,6 +1587,7 @@ node /org/freedesktop/login1/session/1 { Session Objects SetDisplay() was added in version 252. SetTTY() was added in version 254. + SetClass() was added in version 256.