X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_seat_get_active.xml;h=20c7b99daa312995ec97b9b9319f719a7e8edd43;hb=23bbb0de4e3f85d9704a5c12a5afa2dfa0159e41;hp=997c3889012e1bc4ef53fbda53459ca6ba7b133e;hpb=5430f7f2bc7330f3088b894166bf3524a067e3d8;p=elogind.git
diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml
index 997c38890..20c7b99da 100644
--- a/man/sd_seat_get_active.xml
+++ b/man/sd_seat_get_active.xml
@@ -21,7 +21,7 @@
along with systemd; If not, see .
-->
-
+
sd_seat_get_active
@@ -46,6 +46,8 @@
sd_seat_get_active
sd_seat_get_sessions
sd_seat_can_multi_session
+ sd_seat_can_tty
+ sd_seat_can_graphical
Determine state of a specific seat
@@ -55,22 +57,32 @@
int sd_seat_get_active
- const char* seat
- char** session
- uid_t* uid
+ const char *seat
+ char **session
+ uid_t *uid
int sd_seat_get_sessions
- const char* seat
- char*** sessions
- uid_t** uid
- unsigned* n_uids
+ const char *seat
+ char ***sessions
+ uid_t **uid
+ unsigned int *n_uids
int sd_seat_can_multi_session
- const char* seat
+ const char *seat
+
+
+
+ int sd_seat_can_tty
+ const char *seat
+
+
+
+ int sd_seat_can_graphical
+ const char *seat
@@ -83,51 +95,64 @@
a seat, if there is any. Returns the session
identifier and the user identifier of the Unix user
the session is belonging to. Either the session or the
- user identifier parameter can be be passed NULL, in
- case only one of the parameters shall be queried. The
- returned string needs to be freed with the libc
- free3
+ user identifier parameter can be passed
+ NULL, in case only one of the
+ parameters shall be queried. The returned string needs
+ to be freed with the libc
+ free3
call after use.
sd_seat_get_sessions() may
be used to determine all sessions on the specified
- seat. Returns two arrays, one (NULL terminated) with
+ seat. Returns two arrays, one (NULL terminated) with
the session identifiers of the sessions and one with
the user identifiers of the Unix users the sessions
belong to. An additional parameter may be used to
return the number of entries in the latter array. The
two arrays and the latter parameter may be passed as
- NULL in case these values need not to be
+ NULL in case these values need not to be
determined. The arrays and the strings referenced by
them need to be freed with the libc
- free3
+ free3
call after use. Note that instead of an empty array
- NULL may be returned and should be considered
+ NULL may be returned and should be considered
equivalent to an empty array.
sd_seat_can_multi_session()
may be used to determine whether a specific seat is
capable of multi-session, i.e. allows multiple login
- sessions in parallel (whith only one being active at a
+ sessions in parallel (with only one being active at a
time).
- If the seat parameter of any
- of these functions is passed as NULL the operation is
- executed for the seat of the session of the calling
- process, if there is any.
+ sd_seat_can_tty() may be
+ used to determine whether a specific seat provides TTY
+ functionality, i.e. is useful as a text console.
+
+ sd_seat_can_graphical() may
+ be used to determine whether a specific seat provides
+ graphics functionality, i.e. is useful as a graphics
+ display.
+
+ If the seat parameter of any
+ of these functions is passed as
+ NULL, the operation is executed
+ for the seat of the session of the calling process, if
+ there is any.
Return Value
- On success
- sd_seat_get_active() return
- return 0 or a positive integer. On success
+ On success,
+ sd_seat_get_active()
+ returns 0 or a positive integer. On success,
sd_seat_get_sessions() returns
the number of entries in the session identifier
- array. If the test succeeds
- sd_seat_can_multi_session returns
- a positive integer, if it fails 0. On failure, these
+ array. If the test succeeds,
+ sd_seat_can_multi_session,
+ sd_seat_can_tty and
+ sd_seat_can_graphical return a
+ positive integer, if it fails 0. On failure, these
calls return a negative errno-style error code.
@@ -135,12 +160,13 @@
Notes
The sd_seat_get_active(),
- sd_seat_get_sessions(), and
- sd_seat_can_multi_session() interfaces
- are available as shared library, which can be compiled
+ sd_seat_get_sessions(),
+ sd_seat_can_multi_session(),
+ sd_seat_can_tty() and
+ sd_seat_can_grapical() interfaces
+ are available as a shared library, which can be compiled
and linked to with the
- libsystemd-login
- pkg-config1
+ libsystemd pkg-config1
file.
@@ -149,7 +175,7 @@
systemd1,
- sd-login7,
+ sd-login3,
sd_session_get_seat3