Debian Codegraph @

upstream/debian-unstable/man5/org.freedesktop.login1.5

raw
1 '\" t
2 .TH "ORG\&.FREEDESKTOP\&.LOGIN1" "5" "" "systemd 261~rc3" "org.freedesktop.login1"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 org.freedesktop.login1 \- The D\-Bus interface of systemd\-logind
24 .SH "INTRODUCTION"
25 .PP
26 \fBsystemd-logind.service\fR(8)
27 is a system service that keeps track of user logins and seats\&.
28 .PP
29 The daemon provides both a C library interface as well as a D\-Bus interface\&. The library interface may be used to introspect and watch the state of user logins and seats\&. The bus interface provides the same functionality but in addition may also be used to make changes to the system state\&. For more information please consult
30 \fBsd-login\fR(3)\&.
31 .SH "THE MANAGER OBJECT"
32 .PP
33 The service exposes the following interfaces on the Manager object on the bus:
34 .sp
35 .if n \{\
36 .RS 4
37 .\}
38 .nf
39 node /org/freedesktop/login1 {
40 interface org\&.freedesktop\&.login1\&.Manager {
41 methods:
42 GetSession(in s session_id,
43 out o object_path);
44 GetSessionByPID(in u pid,
45 out o object_path);
46 GetUser(in u uid,
47 out o object_path);
48 GetUserByPID(in u pid,
49 out o object_path);
50 GetSeat(in s seat_id,
51 out o object_path);
52 ListSessions(out a(susso) sessions);
53 ListSessionsEx(out a(sussussbto) sessions);
54 ListUsers(out a(uso) users);
55 ListSeats(out a(so) seats);
56 ListInhibitors(out a(ssssuu) inhibitors);
57 @org\&.freedesktop\&.systemd1\&.Privileged("true")
58 CreateSession(in u uid,
59 in u pid,
60 in s service,
61 in s type,
62 in s class,
63 in s desktop,
64 in s seat_id,
65 in u vtnr,
66 in s tty,
67 in s display,
68 in b remote,
69 in s remote_user,
70 in s remote_host,
71 in a(sv) properties,
72 out s session_id,
73 out o object_path,
74 out s runtime_path,
75 out h fifo_fd,
76 out u uid,
77 out s seat_id,
78 out u vtnr,
79 out b existing);
80 @org\&.freedesktop\&.systemd1\&.Privileged("true")
81 CreateSessionWithPIDFD(in u uid,
82 in h pidfd,
83 in s service,
84 in s type,
85 in s class,
86 in s desktop,
87 in s seat_id,
88 in u vtnr,
89 in s tty,
90 in s display,
91 in b remote,
92 in s remote_user,
93 in s remote_host,
94 in t flags,
95 in a(sv) properties,
96 out s session_id,
97 out o object_path,
98 out s runtime_path,
99 out h fifo_fd,
100 out u uid,
101 out s seat_id,
102 out u vtnr,
103 out b existing);
104 ReleaseSession(in s session_id);
105 ActivateSession(in s session_id);
106 ActivateSessionOnSeat(in s session_id,
107 in s seat_id);
108 LockSession(in s session_id);
109 UnlockSession(in s session_id);
110 LockSessions();
111 UnlockSessions();
112 KillSession(in s session_id,
113 in s whom,
114 in i signal_number);
115 KillUser(in u uid,
116 in i signal_number);
117 TerminateSession(in s session_id);
118 TerminateUser(in u uid);
119 TerminateSeat(in s seat_id);
120 SetUserLinger(in u uid,
121 in b enable,
122 in b interactive);
123 AttachDevice(in s seat_id,
124 in s sysfs_path,
125 in b interactive);
126 FlushDevices(in b interactive);
127 PowerOff(in b interactive);
128 PowerOffWithFlags(in t flags);
129 Reboot(in b interactive);
130 RebootWithFlags(in t flags);
131 Halt(in b interactive);
132 HaltWithFlags(in t flags);
133 Suspend(in b interactive);
134 SuspendWithFlags(in t flags);
135 Hibernate(in b interactive);
136 HibernateWithFlags(in t flags);
137 HybridSleep(in b interactive);
138 HybridSleepWithFlags(in t flags);
139 SuspendThenHibernate(in b interactive);
140 SuspendThenHibernateWithFlags(in t flags);
141 Sleep(in t flags);
142 CanPowerOff(out s result);
143 CanReboot(out s result);
144 CanHalt(out s result);
145 CanSuspend(out s result);
146 CanHibernate(out s result);
147 CanHybridSleep(out s result);
148 CanSuspendThenHibernate(out s result);
149 CanSleep(out s result);
150 ScheduleShutdown(in s type,
151 in t usec);
152 CancelScheduledShutdown(out b cancelled);
153 Inhibit(in s what,
154 in s who,
155 in s why,
156 in s mode,
157 out h pipe_fd);
158 CanRebootParameter(out s result);
159 SetRebootParameter(in s parameter);
160 CanRebootToFirmwareSetup(out s result);
161 SetRebootToFirmwareSetup(in b enable);
162 CanRebootToBootLoaderMenu(out s result);
163 SetRebootToBootLoaderMenu(in t timeout);
164 CanRebootToBootLoaderEntry(out s result);
165 SetRebootToBootLoaderEntry(in s boot_loader_entry);
166 SetWallMessage(in s wall_message,
167 in b enable);
168 signals:
169 SecureAttentionKey(s seat_id,
170 o object_path);
171 SessionNew(s session_id,
172 o object_path);
173 SessionRemoved(s session_id,
174 o object_path);
175 UserNew(u uid,
176 o object_path);
177 UserRemoved(u uid,
178 o object_path);
179 SeatNew(s seat_id,
180 o object_path);
181 SeatRemoved(s seat_id,
182 o object_path);
183 PrepareForShutdown(b start);
184 PrepareForShutdownWithMetadata(b start,
185 a{sv} metadata);
186 PrepareForSleep(b start);
187 properties:
188 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
189 @org\&.freedesktop\&.systemd1\&.Privileged("true")
190 readwrite b EnableWallMessages = \&.\&.\&.;
191 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
192 @org\&.freedesktop\&.systemd1\&.Privileged("true")
193 readwrite s WallMessage = \*(Aq\&.\&.\&.\*(Aq;
194 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
195 readonly u NAutoVTs = \&.\&.\&.;
196 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
197 readonly as KillOnlyUsers = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
198 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
199 readonly as KillExcludeUsers = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
200 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
201 readonly b KillUserProcesses = \&.\&.\&.;
202 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
203 readonly s RebootParameter = \*(Aq\&.\&.\&.\*(Aq;
204 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
205 readonly b RebootToFirmwareSetup = \&.\&.\&.;
206 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
207 readonly t RebootToBootLoaderMenu = \&.\&.\&.;
208 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
209 readonly s RebootToBootLoaderEntry = \*(Aq\&.\&.\&.\*(Aq;
210 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
211 readonly as BootLoaderEntries = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
212 readonly b IdleHint = \&.\&.\&.;
213 readonly t IdleSinceHint = \&.\&.\&.;
214 readonly t IdleSinceHintMonotonic = \&.\&.\&.;
215 readonly s BlockInhibited = \*(Aq\&.\&.\&.\*(Aq;
216 readonly s BlockWeakInhibited = \*(Aq\&.\&.\&.\*(Aq;
217 readonly s DelayInhibited = \*(Aq\&.\&.\&.\*(Aq;
218 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
219 readonly t InhibitDelayMaxUSec = \&.\&.\&.;
220 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
221 readonly t UserStopDelayUSec = \&.\&.\&.;
222 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
223 readonly as SleepOperation = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
224 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
225 readonly s HandlePowerKey = \*(Aq\&.\&.\&.\*(Aq;
226 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
227 readonly s HandlePowerKeyLongPress = \*(Aq\&.\&.\&.\*(Aq;
228 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
229 readonly s HandleRebootKey = \*(Aq\&.\&.\&.\*(Aq;
230 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
231 readonly s HandleRebootKeyLongPress = \*(Aq\&.\&.\&.\*(Aq;
232 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
233 readonly s HandleSuspendKey = \*(Aq\&.\&.\&.\*(Aq;
234 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
235 readonly s HandleSuspendKeyLongPress = \*(Aq\&.\&.\&.\*(Aq;
236 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
237 readonly s HandleHibernateKey = \*(Aq\&.\&.\&.\*(Aq;
238 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
239 readonly s HandleHibernateKeyLongPress = \*(Aq\&.\&.\&.\*(Aq;
240 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
241 readonly s HandleLidSwitch = \*(Aq\&.\&.\&.\*(Aq;
242 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
243 readonly s HandleLidSwitchExternalPower = \*(Aq\&.\&.\&.\*(Aq;
244 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
245 readonly s HandleLidSwitchDocked = \*(Aq\&.\&.\&.\*(Aq;
246 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
247 readonly s HandleSecureAttentionKey = \*(Aq\&.\&.\&.\*(Aq;
248 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
249 readonly t HoldoffTimeoutUSec = \&.\&.\&.;
250 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
251 readonly s IdleAction = \*(Aq\&.\&.\&.\*(Aq;
252 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
253 readonly t IdleActionUSec = \&.\&.\&.;
254 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
255 readonly b PreparingForShutdown = \&.\&.\&.;
256 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
257 readonly a{sv} PreparingForShutdownWithMetadata = [\&.\&.\&.];
258 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
259 readonly b PreparingForSleep = \&.\&.\&.;
260 readonly (st) ScheduledShutdown = \&.\&.\&.;
261 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
262 readonly s DesignatedMaintenanceTime = \*(Aq\&.\&.\&.\*(Aq;
263 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
264 readonly b Docked = \&.\&.\&.;
265 readonly b LidClosed = \&.\&.\&.;
266 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
267 readonly b OnExternalPower = \&.\&.\&.;
268 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
269 readonly b RemoveIPC = \&.\&.\&.;
270 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
271 readonly t RuntimeDirectorySize = \&.\&.\&.;
272 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
273 readonly t RuntimeDirectoryInodesMax = \&.\&.\&.;
274 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
275 readonly t InhibitorsMax = \&.\&.\&.;
276 readonly t NCurrentInhibitors = \&.\&.\&.;
277 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
278 readonly t SessionsMax = \&.\&.\&.;
279 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
280 readonly t NCurrentSessions = \&.\&.\&.;
281 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
282 readonly t StopIdleSessionUSec = \&.\&.\&.;
283 };
284 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
285 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
286 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
287 };
288 .fi
289 .if n \{\
290 .RE
291 .\}
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416 .SS "Methods"
417 .PP
418 \fBGetSession()\fR
419 may be used to get the session object path for the session with the specified ID\&. Similarly,
420 \fBGetUser()\fR
421 and
422 \fBGetSeat()\fR
423 get the user and seat objects, respectively\&.
424 \fBGetSessionByPID()\fR
425 and
426 \fBGetUserByPID()\fR
427 get the session/user object the specified PID belongs to if there is any\&.
428 .PP
429 \fBListSessions()\fR
430 returns an array of all current sessions\&. The structures in the array consist of the following fields:
431 \fIsession id\fR,
432 \fIuser id\fR,
433 \fIuser name\fR,
434 \fIseat id\fR, and
435 \fIsession object path\fR\&. If a session does not have a seat attached, the seat id field will be an empty string\&.
436 .PP
437 \fBListSessionsEx()\fR
438 returns an array of all current sessions with more metadata than
439 \fBListSessions()\fR\&. The structures in the array consist of the following fields:
440 \fIsession id\fR,
441 \fIuser id\fR,
442 \fIuser name\fR,
443 \fIseat id\fR,
444 \fIleader pid\fR,
445 \fIsession class\fR,
446 \fItty name\fR,
447 \fIidle hint\fR,
448 \fIidle hint monotonic timestamp\fR, and
449 \fIsession object path\fR\&.
450 \fItty\fR
451 and
452 \fIseat id\fR
453 fields could be empty, if the session has no associated tty or session has no seat attached, respectively\&.
454 .PP
455 \fBListUsers()\fR
456 returns an array of all currently logged in users\&. The structures in the array consist of the following fields: user id, user name, user object path\&.
457 .PP
458 \fBListSeats()\fR
459 returns an array of all currently available seats\&. The structure in the array consists of the following fields: seat id, seat object path\&.
460 .PP
461 \fBListInhibitors()\fR
462 lists all currently active inhibitors\&. It returns an array of structures consisting of
463 \fIwhat\fR,
464 \fIwho\fR,
465 \fIwhy\fR,
466 \fImode\fR,
467 \fIuid\fR
468 (user ID), and
469 \fIpid\fR
470 (process ID)\&.
471 .PP
472 \fBCreateSession()\fR,
473 \fBCreateSessionWithPIDFD()\fR, and
474 \fBReleaseSession()\fR
475 may be used to open or close login sessions\&. These calls should
476 \fInever\fR
477 be invoked directly by clients\&. Creating/closing sessions is exclusively the job of PAM and its
478 \fBpam_systemd\fR(8)
479 module\&.
480 .PP
481 \fBActivateSession()\fR
482 brings the session with the specified ID into the foreground\&.
483 \fBActivateSessionOnSeat()\fR
484 does the same, but only if the seat id matches\&.
485 .PP
486 \fBLockSession()\fR
487 asks the session with the specified ID to activate the screen lock\&.
488 \fBUnlockSession()\fR
489 asks the session with the specified ID to remove an active screen lock, if there is any\&. This is implemented by sending out the Lock() and Unlock() signals from the respective session object which session managers are supposed to listen on\&.
490 .PP
491 \fBLockSessions()\fR
492 asks all sessions to activate their screen locks\&. This may be used to lock access to the entire machine in one action\&. Similarly,
493 \fBUnlockSessions()\fR
494 asks all sessions to deactivate their screen locks\&.
495 .PP
496 \fBKillSession()\fR
497 may be used to send a Unix signal to one or all processes of a session\&. As arguments it takes the session id, either the string
498 "leader"
499 or
500 "all"
501 and a signal number\&. If
502 "leader"
503 is passed only the session
504 "leader"
505 is killed\&. If
506 "all"
507 is passed all processes of the session are killed\&.
508 .PP
509 \fBKillUser()\fR
510 may be used to send a Unix signal to all processes of a user\&. As arguments it takes the user id and a signal number\&.
511 .PP
512 \fBTerminateSession()\fR,
513 \fBTerminateUser()\fR,
514 \fBTerminateSeat()\fR
515 may be used to forcibly terminate one specific session, all processes of a user, and all sessions attached to a specific seat, respectively\&. The session, user, and seat are identified by their respective IDs\&.
516 .PP
517 \fBSetUserLinger()\fR
518 enables or disables user lingering\&. If enabled, the runtime directory of a user is kept around and they may continue to run processes while logged out\&. If disabled, the runtime directory goes away as soon as they log out\&.
519 \fBSetUserLinger()\fR
520 expects three arguments: the UID, a boolean whether to enable/disable and a boolean controlling the
521 \m[blue]\fBpolkit\fR\m[]\&\s-2\u[1]\d\s+2
522 authorization interactivity (see below)\&. Note that the user linger state is persistently stored on disk\&.
523 .PP
524 \fBAttachDevice()\fR
525 may be used to assign a specific device to a specific seat\&. The device is identified by its
526 /sys/
527 path and must be eligible for seat assignments\&.
528 \fBAttachDevice()\fR
529 takes three arguments: the seat id, the sysfs path, and a boolean for controlling polkit interactivity (see below)\&. Device assignments are persistently stored on disk\&. To create a new seat, simply specify a previously unused seat id\&. For more information about the seat assignment logic see
530 \fBsd-login\fR(3)\&.
531 .PP
532 \fBFlushDevices()\fR
533 removes all explicit seat assignments for devices, resetting all assignments to the automatic defaults\&. The only argument it takes is the polkit interactivity boolean (see below)\&.
534 .PP
535 \fBPowerOff()\fR,
536 \fBReboot()\fR,
537 \fBHalt()\fR,
538 \fBSuspend()\fR, and
539 \fBHibernate()\fR
540 result in the system being powered off, rebooted, halted (shut down without turning off power), suspended (the system state is saved to RAM and the CPU is turned off), or hibernated (the system state is saved to disk and the machine is powered down)\&.
541 \fBHybridSleep()\fR
542 results in the system entering a hybrid\-sleep mode, i\&.e\&. the system is both hibernated and suspended\&.
543 \fBSuspendThenHibernate()\fR
544 results in the system being suspended, then later woken using an RTC timer and hibernated\&. The only argument is the polkit interactivity boolean
545 \fIinteractive\fR
546 (see below)\&. The main purpose of these calls is that they enforce polkit policy and hence allow powering off/rebooting/suspending/hibernating even by unprivileged users\&. They also enforce inhibition locks for non\-privileged users\&.
547 \fBSleep()\fR
548 automatically selects the most suitable sleep operation supported by the machine\&. The candidate sleep operations to check for support can be configured through
549 \fISleepOperation=\fR
550 setting in
551 \fBlogind.conf\fR(5)\&. UIs should expose these calls as the primary mechanism to poweroff/reboot/suspend/hibernate the machine\&. Methods
552 \fBPowerOffWithFlags()\fR,
553 \fBRebootWithFlags()\fR,
554 \fBHaltWithFlags()\fR,
555 \fBSuspendWithFlags()\fR,
556 \fBHibernateWithFlags()\fR,
557 \fBHybridSleepWithFlags()\fR,
558 \fBSuspendThenHibernateWithFlags()\fR, and
559 \fBSleep()\fR
560 take
561 \fIflags\fR
562 to allow for extendability, defined as follows:
563 .sp
564 .if n \{\
565 .RS 4
566 .\}
567 .nf
568 #define SD_LOGIND_ROOT_CHECK_INHIBITORS (UINT64_C(1) << 0)
569 #define SD_LOGIND_KEXEC_REBOOT (UINT64_C(1) << 1)
570 #define SD_LOGIND_SOFT_REBOOT (UINT64_C(1) << 2)
571 #define SD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP (UINT64_C(1) << 3)
572 #define SD_LOGIND_SKIP_INHIBITORS (UINT64_C(1) << 4)
573 .fi
574 .if n \{\
575 .RE
576 .\}
577 .PP
578 When the
579 \fIflags\fR
580 is 0 then these methods behave just like the versions without flags\&. Since systemd version 257 inhibitors of type
581 "block"
582 are enforced on operations requested by both privileged and unprivileged users\&. Previously they were honoured only by unprivileged users, excluding the user owning the inhibitor\&. The latter behaviour is now available through the
583 "block\-weak"
584 inhibitor lock type\&.
585 \fBSD_LOGIND_ROOT_CHECK_INHIBITORS\fR
586 (0x01) makes
587 "block\-weak"
588 locks behave like regular
589 "block"
590 locks, i\&.e\&. ensures they are honoured for any user\&. A flag
591 \fBSD_LOGIND_SKIP_INHIBITORS\fR
592 (0x10) can be specified to bypass both
593 "block"
594 and
595 "block\-weak"
596 inhibitors (it has no effect on
597 "delay"
598 inhibitors)\&. When
599 \fBSD_LOGIND_KEXEC_REBOOT\fR
600 (0x02) is set, then
601 \fBRebootWithFlags()\fR
602 performs a kexec reboot if kexec kernel is loaded\&. When
603 \fBSD_LOGIND_SOFT_REBOOT\fR
604 (0x04) is set, or
605 \fBSD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP\fR
606 (0x08) is set and a new root file system has been set up on
607 "/run/nextroot/", then
608 \fBRebootWithFlags()\fR
609 performs a userspace reboot only\&.
610 \fBSD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP\fR
611 and
612 \fBSD_LOGIND_KEXEC_REBOOT\fR
613 can be combined, with soft\-reboot having precedence\&.
614 .PP
615 \fBSetRebootParameter()\fR
616 sets a parameter for a subsequent reboot operation\&. See the description of
617 \fBreboot\fR
618 in
619 \fBsystemctl\fR(1)
620 and
621 \fBreboot\fR(2)
622 for more information\&.
623 .PP
624 \fBSetRebootToFirmwareSetup()\fR,
625 \fBSetRebootToBootLoaderMenu()\fR, and
626 \fBSetRebootToBootLoaderEntry()\fR
627 configure the action to be taken from the boot loader after a reboot: respectively entering firmware setup mode, the boot loader menu, or a specific boot loader entry\&. See
628 \fBsystemctl\fR(1)
629 for the corresponding command line interface\&.
630 .PP
631 \fBCanPowerOff()\fR,
632 \fBCanReboot()\fR,
633 \fBCanHalt()\fR,
634 \fBCanSuspend()\fR,
635 \fBCanHibernate()\fR,
636 \fBCanHybridSleep()\fR,
637 \fBCanSuspendThenHibernate()\fR,
638 \fBCanSleep()\fR,
639 \fBCanRebootParameter()\fR,
640 \fBCanRebootToFirmwareSetup()\fR,
641 \fBCanRebootToBootLoaderMenu()\fR, and
642 \fBCanRebootToBootLoaderEntry()\fR
643 test whether the system supports the respective operation and whether the calling user is allowed to execute it\&. Returns one of
644 "na",
645 "yes",
646 "no",
647 "challenge",
648 "inhibited",
649 "inhibitor\-blocked", and
650 "challenge\-inhibitor\-blocked"\&. If
651 "na"
652 is returned, the operation is not available because hardware, kernel, or drivers do not support it\&. If
653 "yes"
654 is returned, the operation is supported and the user may execute the operation without further authentication\&. If
655 "no"
656 is returned, the operation is available but the user is not allowed to execute the operation\&. If
657 "challenge"
658 is returned, the operation is available but only after authorization\&. If
659 "inhibited"
660 is returned, the operation is normally available without authorization but is currently inhibited\&. The operation is available only if inhibitors are ignored and after authorization\&. If
661 "inhibitor\-blocked"
662 is returned, the operation is normally available without authorization but is currently inhibited\&. While the inhibitor remains active, the user is not allowed to execute the operation\&.
663 "challenge\-inhibitor\-blocked"
664 is similar: the operation is normally available after authorization but a held inhibitor disallows the user from executing the operation\&.
665 .PP
666 \fBScheduleShutdown()\fR
667 schedules a shutdown operation
668 \fItype\fR
669 at time
670 \fIusec\fR
671 in microseconds since the UNIX epoch\&. Alternatively, if
672 \fIusec\fR
673 "UINT64_MAX"
674 and a maintenance window is configured,
675 systemd\-logind
676 will use the next time of the maintenance window instead\&.
677 \fItype\fR
678 can be one of
679 "poweroff",
680 "dry\-poweroff",
681 "reboot",
682 "dry\-reboot",
683 "halt", and
684 "dry\-halt"\&. (The
685 "dry\-"
686 variants do not actually execute the shutdown action\&.)
687 \fBCancelScheduledShutdown()\fR
688 cancels a scheduled shutdown\&. The output parameter
689 \fIcancelled\fR
690 is true if a shutdown operation was scheduled\&.
691 .PP
692 \fBSetWallMessage()\fR
693 sets the wall message (the message that will be sent out to all terminals and stored in a
694 \fButmp\fR(5)
695 record) for a subsequent scheduled shutdown operation\&. The parameter
696 \fIwall_message\fR
697 specifies the shutdown reason (and may be empty) which will be included in the shutdown message\&. The parameter
698 \fIenable\fR
699 specifies whether to print a wall message on shutdown\&.
700 .PP
701 \fBInhibit()\fR
702 creates an inhibition lock\&. It takes four parameters:
703 \fIwhat\fR,
704 \fIwho\fR,
705 \fIwhy\fR, and
706 \fImode\fR\&.
707 \fIwhat\fR
708 is one or more of
709 "shutdown",
710 "sleep",
711 "idle",
712 "handle\-power\-key",
713 "handle\-suspend\-key",
714 "handle\-hibernate\-key",
715 "handle\-lid\-switch", separated by colons, for inhibiting poweroff/reboot, suspend/hibernate, the automatic idle logic, or hardware key handling\&.
716 \fIwho\fR
717 should be a short human\-readable string identifying the application taking the lock\&.
718 \fIwhy\fR
719 should be a short human\-readable string identifying the reason why the lock is taken\&. Finally,
720 \fImode\fR
721 is either
722 "block"
723 or
724 "delay"
725 which encodes whether the inhibit shall be consider mandatory or whether it should just delay the operation to a certain maximum time, while the
726 "block\-weak"
727 and variants will create an inhibitor that is automatically ignored in some circumstances\&. The method returns a file descriptor\&. The lock is released the moment this file descriptor and all its duplicates are closed\&. For more information on the inhibition logic see
728 \m[blue]\fBInhibitor Locks\fR\m[]\&\s-2\u[2]\d\s+2\&.
729 .SS "Signals"
730 .PP
731 Whenever the inhibition state or idle hint changes,
732 \fBPropertyChanged\fR
733 signals are sent out to clients which have subscribed\&.
734 .PP
735 The
736 \fBSecureAttentionKey()\fR
737 signal is sent when the user presses Ctrl+Alt+Shift+Esc to request the login manager to display the greeter, for instance in the case of a deadlocked compositor\&.
738 .PP
739 The
740 \fBSessionNew()\fR,
741 \fBSessionRemoved()\fR,
742 \fBUserNew()\fR,
743 \fBUserRemoved()\fR,
744 \fBSeatNew()\fR, and
745 \fBSeatRemoved()\fR
746 signals are sent each time a session is created or removed, a user logs in or out, or a seat is added or removed\&. They each contain the ID of the object plus the object path\&.
747 .PP
748 The
749 \fBPrepareForShutdown()\fR,
750 \fBPrepareForShutdownWithMetadata()\fR, and
751 \fBPrepareForSleep()\fR
752 signals are sent right before (with the argument
753 "true") or after (with the argument
754 "false") the system goes down for reboot/poweroff and suspend/hibernate, respectively\&. This may be used by applications to save data on disk, release memory, or do other jobs that should be done shortly before shutdown/sleep, in conjunction with delay inhibitor locks\&. After completion of this work they should release their inhibition locks in order to not delay the operation any further\&. For more information see
755 \m[blue]\fBInhibitor Locks\fR\m[]\&\s-2\u[2]\d\s+2\&. The
756 \fBPrepareForShutdownWithMetadata()\fR
757 signal additionally sends a list of key/value pair metadata fields\&. Currently it sends a
758 \fItype\fR
759 string which defines the type of shutdown\&. The type can be one of
760 "power\-off",
761 "reboot",
762 "halt",
763 "kexec"
764 or
765 "soft\-reboot"\&. This signal is sent first, followed by
766 \fBPrepareForShutdown()\fR
767 (for backward compatibility)\&.
768 .SS "Properties"
769 .PP
770 Most properties simply reflect the configuration, see
771 \fBlogind.conf\fR(5)\&. This includes:
772 \fINAutoVTs\fR,
773 \fIKillOnlyUsers\fR,
774 \fIKillExcludeUsers\fR,
775 \fIKillUserProcesses\fR,
776 \fIIdleAction\fR,
777 \fIInhibitDelayMaxUSec\fR,
778 \fIInhibitorsMax\fR,
779 \fIUserStopDelayUSec\fR,
780 \fIHandlePowerKey\fR,
781 \fIHandleSuspendKey\fR,
782 \fIHandleHibernateKey\fR,
783 \fIHandleLidSwitch\fR,
784 \fIHandleLidSwitchExternalPower\fR,
785 \fIHandleLidSwitchDocked\fR,
786 \fIIdleActionUSec\fR,
787 \fIHoldoffTimeoutUSec\fR,
788 \fIRemoveIPC\fR,
789 \fIRuntimeDirectorySize\fR,
790 \fIRuntimeDirectoryInodesMax\fR,
791 \fIInhibitorsMax\fR, and
792 \fISessionsMax\fR\&.
793 .PP
794 The
795 \fIIdleHint\fR
796 property reflects the idle hint state of the system\&. If the system is idle it might get into automatic suspend or shutdown depending on the configuration\&.
797 .PP
798 \fIIdleSinceHint\fR
799 and
800 \fIIdleSinceHintMonotonic\fR
801 encode the timestamps of the last change of the idle hint boolean, in
802 \fBCLOCK_REALTIME\fR
803 and
804 \fBCLOCK_MONOTONIC\fR
805 timestamps, respectively, in microseconds since the epoch\&.
806 .PP
807 The
808 \fIBlockInhibited\fR,
809 \fIBlockWeakInhibited\fR, and
810 \fIDelayInhibited\fR
811 properties encode the currently active locks of the respective modes\&. They are colon separated lists of
812 "shutdown",
813 "sleep", and
814 "idle"
815 (see above)\&.
816 .PP
817 \fINCurrentSessions\fR
818 and
819 \fINCurrentInhibitors\fR
820 contain the number of currently registered sessions and inhibitors\&.
821 .PP
822 The
823 \fIBootLoaderEntries\fR
824 property contains a list of boot loader entries\&. This includes boot loader entries defined in configuration and any additional loader entries reported by the boot loader\&. See
825 \fBsystemd-boot\fR(7)
826 for more information\&.
827 .PP
828 The
829 \fIPreparingForShutdown\fR
830 and
831 \fIPreparingForSleep\fR
832 boolean properties are true during the interval between the two
833 \fBPrepareForShutdown()\fR
834 and
835 \fBPrepareForSleep()\fR
836 signals respectively\&. The
837 \fIPreparingForShutdownWithMetadata\fR
838 property provides a list of key/value pair metadata fields\&. Currently it lists a
839 \fIpreparing\fR
840 boolean that corresponds to the
841 \fIPreparingForShutdown\fR
842 property, and, if a shutdown is being prepared, it will also contain a
843 \fItype\fR
844 string which defines the type of shutdown\&. The type can be one of
845 "power\-off",
846 "reboot",
847 "halt",
848 "kexec"
849 or
850 "soft\-reboot"\&. Note that these properties do not send out
851 \fBPropertyChanged\fR
852 signals\&.
853 .PP
854 The
855 \fIRebootParameter\fR
856 property shows the value set with the
857 \fBSetRebootParameter()\fR
858 method described above\&.
859 .PP
860 \fIScheduledShutdown\fR
861 shows the value pair set with the
862 \fBScheduleShutdown()\fR
863 method described above\&.
864 .PP
865 \fIRebootToFirmwareSetup\fR,
866 \fIRebootToBootLoaderMenu\fR, and
867 \fIRebootToBootLoaderEntry\fR
868 are true when the resprective post\-reboot operation was selected with
869 \fBSetRebootToFirmwareSetup()\fR,
870 \fBSetRebootToBootLoaderMenu()\fR, or
871 \fBSetRebootToBootLoaderEntry()\fR\&.
872 .PP
873 The
874 \fIWallMessage\fR
875 and
876 \fIEnableWallMessages\fR
877 properties reflect the shutdown reason and wall message enablement switch which can be set with the
878 \fBSetWallMessage()\fR
879 method described above\&.
880 .PP
881 \fIDocked\fR
882 is true if the machine is connected to a dock\&.
883 \fILidClosed\fR
884 is true when the lid (of a laptop) is closed\&.
885 \fIOnExternalPower\fR
886 is true when the machine is connected to an external power supply\&.
887 .SS "Security"
888 .PP
889 A number of operations are protected via the polkit privilege system\&.
890 \fBSetUserLinger()\fR
891 requires the
892 org\&.freedesktop\&.login1\&.set\-user\-linger
893 privilege\&.
894 \fBAttachDevice()\fR
895 requires
896 org\&.freedesktop\&.login1\&.attach\-device
897 and
898 \fBFlushDevices()\fR
899 requires
900 org\&.freedesktop\&.login1\&.flush\-devices\&.
901 \fBPowerOff()\fR,
902 \fBReboot()\fR,
903 \fBHalt()\fR,
904 \fBSuspend()\fR,
905 \fBHibernate()\fR
906 require
907 org\&.freedesktop\&.login1\&.power\-off,
908 org\&.freedesktop\&.login1\&.power\-off\-multiple\-sessions,
909 org\&.freedesktop\&.login1\&.power\-off\-ignore\-inhibit,
910 org\&.freedesktop\&.login1\&.reboot,
911 org\&.freedesktop\&.login1\&.reboot\-multiple\-sessions,
912 org\&.freedesktop\&.login1\&.reboot\-ignore\-inhibit,
913 org\&.freedesktop\&.login1\&.halt,
914 org\&.freedesktop\&.login1\&.halt\-multiple\-sessions,
915 org\&.freedesktop\&.login1\&.halt\-ignore\-inhibit,
916 org\&.freedesktop\&.login1\&.suspend,
917 org\&.freedesktop\&.login1\&.suspend\-multiple\-sessions,
918 org\&.freedesktop\&.login1\&.suspend\-ignore\-inhibit,
919 org\&.freedesktop\&.login1\&.hibernate,
920 org\&.freedesktop\&.login1\&.hibernate\-multiple\-sessions,
921 org\&.freedesktop\&.login1\&.hibernate\-ignore\-inhibit, respectively depending on whether there are other sessions around or active inhibits are present\&.
922 \fBHybridSleep()\fR
923 and
924 \fBSuspendThenHibernate()\fR
925 use the same privileges as
926 \fBHibernate()\fR\&.
927 \fBSleep()\fR
928 uses the inhibits of the auto\-selected sleep operation\&.
929 \fBSetRebootParameter()\fR
930 requires
931 org\&.freedesktop\&.login1\&.set\-reboot\-parameter\&.
932 .PP
933 \fBSetRebootToFirmwareSetup()\fR
934 requires
935 org\&.freedesktop\&.login1\&.set\-reboot\-to\-firmware\-setup\&.
936 \fBSetRebootToBootLoaderMenu()\fR
937 requires
938 org\&.freedesktop\&.login1\&.set\-reboot\-to\-boot\-loader\-menu\&.
939 \fBSetRebootToBootLoaderEntry()\fR
940 requires
941 org\&.freedesktop\&.login1\&.set\-reboot\-to\-boot\-loader\-entry\&.
942 .PP
943 \fBScheduleShutdown()\fR
944 and
945 \fBCancelScheduledShutdown()\fR
946 require the same privileges (listed above) as the immediate poweroff/reboot/halt operations\&.
947 .PP
948 \fBInhibit()\fR
949 is protected via one of
950 org\&.freedesktop\&.login1\&.inhibit\-block\-shutdown,
951 org\&.freedesktop\&.login1\&.inhibit\-delay\-shutdown,
952 org\&.freedesktop\&.login1\&.inhibit\-block\-sleep,
953 org\&.freedesktop\&.login1\&.inhibit\-delay\-sleep,
954 org\&.freedesktop\&.login1\&.inhibit\-block\-idle,
955 org\&.freedesktop\&.login1\&.inhibit\-handle\-power\-key,
956 org\&.freedesktop\&.login1\&.inhibit\-handle\-suspend\-key,
957 org\&.freedesktop\&.login1\&.inhibit\-handle\-hibernate\-key,
958 org\&.freedesktop\&.login1\&.inhibit\-handle\-lid\-switch
959 depending on the lock type and mode taken\&.
960 .PP
961 The
962 \fIinteractive\fR
963 boolean parameters can be used to control whether polkit should interactively ask the user for authentication credentials if required\&.
964 .SH "SEAT OBJECTS"
965 .sp
966 .if n \{\
967 .RS 4
968 .\}
969 .nf
970 node /org/freedesktop/login1/seat/seat0 {
971 interface org\&.freedesktop\&.login1\&.Seat {
972 methods:
973 Terminate();
974 ActivateSession(in s session_id);
975 SwitchTo(in u vtnr);
976 SwitchToNext();
977 SwitchToPrevious();
978 properties:
979 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
980 readonly s Id = \*(Aq\&.\&.\&.\*(Aq;
981 readonly (so) ActiveSession = \&.\&.\&.;
982 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
983 readonly b CanTTY = \&.\&.\&.;
984 readonly b CanGraphical = \&.\&.\&.;
985 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
986 readonly a(so) Sessions = [\&.\&.\&.];
987 readonly b IdleHint = \&.\&.\&.;
988 readonly t IdleSinceHint = \&.\&.\&.;
989 readonly t IdleSinceHintMonotonic = \&.\&.\&.;
990 };
991 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
992 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
993 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
994 };
995 .fi
996 .if n \{\
997 .RE
998 .\}
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013 .SS "Methods"
1014 .PP
1015 \fBTerminate()\fR
1016 and
1017 \fBActivateSession()\fR
1018 work similarly to
1019 \fBTerminateSeat()\fR
1020 and
1021 \fBActivationSessionOnSeat()\fR
1022 on the Manager object\&.
1023 .PP
1024 \fBSwitchTo()\fR
1025 switches to the session on the virtual terminal
1026 \fIvtnr\fR\&.
1027 \fBSwitchToNext()\fR
1028 and
1029 \fBSwitchToPrevious()\fR
1030 switch to, respectively, the next and previous sessions on the seat in the order of virtual terminals\&. If there is no active session, they switch to, respectively, the first and last session on the seat\&.
1031 .SS "Signals"
1032 .PP
1033 Whenever
1034 \fBActiveSession\fR,
1035 \fBSessions\fR,
1036 \fBCanGraphical\fR,
1037 \fBCanTTY\fR, or the idle state changes,
1038 \fBPropertyChanged\fR
1039 signals are sent out to clients which have subscribed\&.
1040 .PP
1041 Signals are only emitted on objects referencing a specific seat ID, not on the
1042 "/org/freedesktop/login1/seat/self"
1043 or
1044 "/org/freedesktop/login1/seat/auto"
1045 convenience objects, as they can only be dereferenced relative to a method caller\&.
1046 .SS "Properties"
1047 .PP
1048 The
1049 \fIId\fR
1050 property encodes the ID of the seat\&.
1051 .PP
1052 \fIActiveSession\fR
1053 encodes the currently active session if there is one\&. It is a structure consisting of the session id and the object path\&.
1054 .PP
1055 \fICanTTY\fR
1056 encodes whether the session is suitable for text logins, and
1057 \fICanGraphical\fR
1058 whether it is suitable for graphical sessions\&.
1059 .PP
1060 The
1061 \fISessions\fR
1062 property is an array of all current sessions of this seat, each encoded in a structure consisting of the ID and the object path\&.
1063 .PP
1064 The
1065 \fIIdleHint\fR,
1066 \fIIdleSinceHint\fR, and
1067 \fIIdleSinceHintMonotonic\fR
1068 properties encode the idle state, similarly to the ones exposed on the
1069 Manager
1070 object, but specific for this seat\&.
1071 .SH "USER OBJECTS"
1072 .sp
1073 .if n \{\
1074 .RS 4
1075 .\}
1076 .nf
1077 node /org/freedesktop/login1/user/_1000 {
1078 interface org\&.freedesktop\&.login1\&.User {
1079 methods:
1080 Terminate();
1081 Kill(in i signal_number);
1082 properties:
1083 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1084 readonly u UID = \&.\&.\&.;
1085 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1086 readonly u GID = \&.\&.\&.;
1087 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1088 readonly s Name = \*(Aq\&.\&.\&.\*(Aq;
1089 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1090 readonly t Timestamp = \&.\&.\&.;
1091 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1092 readonly t TimestampMonotonic = \&.\&.\&.;
1093 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1094 readonly s RuntimePath = \*(Aq\&.\&.\&.\*(Aq;
1095 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1096 readonly s Service = \*(Aq\&.\&.\&.\*(Aq;
1097 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1098 readonly s Slice = \*(Aq\&.\&.\&.\*(Aq;
1099 readonly (so) Display = \&.\&.\&.;
1100 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
1101 readonly s State = \*(Aq\&.\&.\&.\*(Aq;
1102 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
1103 readonly a(so) Sessions = [\&.\&.\&.];
1104 readonly b IdleHint = \&.\&.\&.;
1105 readonly t IdleSinceHint = \&.\&.\&.;
1106 readonly t IdleSinceHintMonotonic = \&.\&.\&.;
1107 readonly b Linger = \&.\&.\&.;
1108 };
1109 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
1110 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
1111 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
1112 };
1113 .fi
1114 .if n \{\
1115 .RE
1116 .\}
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135 .SS "Methods"
1136 .PP
1137 \fBTerminate()\fR
1138 and
1139 \fBKill()\fR
1140 work similarly to the
1141 \fBTerminateUser()\fR
1142 and
1143 \fBKillUser()\fR
1144 methods on the manager object\&.
1145 .SS "Signals"
1146 .PP
1147 Whenever
1148 \fISessions\fR
1149 or the idle state changes,
1150 \fBPropertyChanged\fR
1151 signals are sent out to clients which have subscribed\&.
1152 .PP
1153 Signals are only emitted on objects referencing a specific UID, not on the
1154 "/org/freedesktop/login1/user/self"
1155 convenience object, as
1156 \fIself\fR
1157 can only be dereferenced relative to a method caller\&.
1158 .SS "Properties"
1159 .PP
1160 The
1161 \fIUID\fR
1162 and
1163 \fIGID\fR
1164 properties encode the Unix UID and primary GID of the user\&.
1165 .PP
1166 The
1167 \fIName\fR
1168 property encodes the user name\&.
1169 .PP
1170 \fITimestamp\fR
1171 and
1172 \fITimestampMonotonic\fR
1173 encode the login time of the user in microseconds since the epoch, in the
1174 \fBCLOCK_REALTIME\fR
1175 and
1176 \fBCLOCK_MONOTONIC\fR
1177 clocks, respectively\&.
1178 .PP
1179 \fIRuntimePath\fR
1180 encodes the runtime path of the user, i\&.e\&.
1181 \fI$XDG_RUNTIME_DIR\fR\&. For details see the
1182 \m[blue]\fBXDG Basedir Specification\fR\m[]\&\s-2\u[3]\d\s+2\&.
1183 .PP
1184 \fIService\fR
1185 contains the unit name of the user systemd service of this user\&. Each logged in user is assigned a user service that runs a user systemd instance\&. This is usually an instance of
1186 user@\&.service\&.
1187 .PP
1188 \fISlice\fR
1189 contains the unit name of the user systemd slice of this user\&. Each logged in user gets a private slice\&.
1190 .PP
1191 \fIDisplay\fR
1192 encodes which graphical session should be used as the primary UI display for the user\&. It is a structure encoding the session ID and the object path of the session to use\&.
1193 .PP
1194 \fIState\fR
1195 encodes the user state and is one of
1196 "offline",
1197 "lingering",
1198 "online",
1199 "active", or
1200 "closing"\&. See
1201 \fBsd_uid_get_state\fR(3)
1202 for more information about the states\&.
1203 .PP
1204 \fISessions\fR
1205 is an array of structures encoding all current sessions of the user\&. Each structure consists of the ID and object path\&.
1206 .PP
1207 The
1208 \fIIdleHint\fR,
1209 \fIIdleSinceHint\fR, and
1210 \fIIdleSinceHintMonotonic\fR
1211 properties encode the idle hint state of the user, similarly to the
1212 Manager\*(Aqs properties, but specific for this user\&.
1213 .PP
1214 The
1215 \fILinger\fR
1216 property shows whether lingering is enabled for this user\&.
1217 .SH "SESSION OBJECTS"
1218 .sp
1219 .if n \{\
1220 .RS 4
1221 .\}
1222 .nf
1223 node /org/freedesktop/login1/session/1 {
1224 interface org\&.freedesktop\&.login1\&.Session {
1225 methods:
1226 Terminate();
1227 Activate();
1228 Lock();
1229 Unlock();
1230 SetIdleHint(in b idle);
1231 SetLockedHint(in b locked);
1232 Kill(in s whom,
1233 in i signal_number);
1234 TakeControl(in b force);
1235 ReleaseControl();
1236 SetType(in s type);
1237 SetClass(in s class);
1238 SetDisplay(in s display);
1239 SetTTY(in h tty_fd);
1240 TakeDevice(in u major,
1241 in u minor,
1242 out h fd,
1243 out b inactive);
1244 ReleaseDevice(in u major,
1245 in u minor);
1246 PauseDeviceComplete(in u major,
1247 in u minor);
1248 SetBrightness(in s subsystem,
1249 in s name,
1250 in u brightness);
1251 signals:
1252 PauseDevice(u major,
1253 u minor,
1254 s type);
1255 ResumeDevice(u major,
1256 u minor,
1257 h fd);
1258 Lock();
1259 Unlock();
1260 properties:
1261 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1262 readonly s Id = \*(Aq\&.\&.\&.\*(Aq;
1263 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1264 readonly (uo) User = \&.\&.\&.;
1265 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1266 readonly s Name = \*(Aq\&.\&.\&.\*(Aq;
1267 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1268 readonly t Timestamp = \&.\&.\&.;
1269 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1270 readonly t TimestampMonotonic = \&.\&.\&.;
1271 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1272 readonly u VTNr = \&.\&.\&.;
1273 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1274 readonly (so) Seat = \&.\&.\&.;
1275 readonly s TTY = \*(Aq\&.\&.\&.\*(Aq;
1276 readonly s Display = \*(Aq\&.\&.\&.\*(Aq;
1277 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1278 readonly b Remote = \&.\&.\&.;
1279 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1280 readonly s RemoteHost = \*(Aq\&.\&.\&.\*(Aq;
1281 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1282 readonly s RemoteUser = \*(Aq\&.\&.\&.\*(Aq;
1283 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1284 readonly as ExtraDeviceAccess = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
1285 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1286 readonly s Service = \*(Aq\&.\&.\&.\*(Aq;
1287 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1288 readonly s Desktop = \*(Aq\&.\&.\&.\*(Aq;
1289 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1290 readonly s Scope = \*(Aq\&.\&.\&.\*(Aq;
1291 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1292 readonly u Leader = \&.\&.\&.;
1293 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1294 readonly t LeaderPIDFDId = \&.\&.\&.;
1295 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1296 readonly u Audit = \&.\&.\&.;
1297 readonly s Type = \*(Aq\&.\&.\&.\*(Aq;
1298 readonly s Class = \*(Aq\&.\&.\&.\*(Aq;
1299 readonly b Active = \&.\&.\&.;
1300 readonly s State = \*(Aq\&.\&.\&.\*(Aq;
1301 readonly b IdleHint = \&.\&.\&.;
1302 readonly t IdleSinceHint = \&.\&.\&.;
1303 readonly t IdleSinceHintMonotonic = \&.\&.\&.;
1304 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1305 readonly b CanIdle = \&.\&.\&.;
1306 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
1307 readonly b CanLock = \&.\&.\&.;
1308 readonly b LockedHint = \&.\&.\&.;
1309 };
1310 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
1311 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
1312 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
1313 };
1314 .fi
1315 .if n \{\
1316 .RE
1317 .\}
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369 .SS "Methods"
1370 .PP
1371 \fBTerminate()\fR,
1372 \fBActivate()\fR,
1373 \fBLock()\fR,
1374 \fBUnlock()\fR, and
1375 \fBKill()\fR
1376 work similarly to the respective calls on the
1377 Manager
1378 object\&.
1379 .PP
1380 \fBSetIdleHint()\fR
1381 is called by the session object to update the idle state of the session whenever it changes\&.
1382 .PP
1383 \fBTakeControl()\fR
1384 allows a process to take exclusive managed device access\-control for that session\&. Only one D\-Bus connection can be a controller for a given session at any time\&. If the
1385 \fIforce\fR
1386 argument is set (root only), an existing controller is kicked 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\&.
1387 .PP
1388 \fBReleaseControl()\fR
1389 drops control of a given session\&. Closing the D\-Bus connection implicitly releases control as well\&. See
1390 \fBTakeControl()\fR
1391 for more information\&. This method also releases all devices for which the controller requested ownership via
1392 \fBTakeDevice()\fR\&.
1393 .PP
1394 \fBSetType()\fR
1395 allows the type of the session to be changed dynamically\&. It can only be called by session\*(Aqs current controller\&. If
1396 \fBTakeControl()\fR
1397 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
1398 \fBReleaseControl()\fR
1399 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
1400 \fItype\fR
1401 is the new session type\&.
1402 .PP
1403 \fBSetClass()\fR
1404 allows the caller to change the class of the session dynamically\&. It may only be called by session\*(Aqs owning user\&. Currently, this call may be exclusively used to change the class from
1405 "user\-incomplete"
1406 to
1407 "user"\&. The call is synchronous, and will return only once the user\*(Aqs service manager has successfully been started, if necessary\&. The only argument
1408 \fItype\fR
1409 is the new session type\&.
1410 .PP
1411 \fBSetDisplay()\fR
1412 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\*(Aqs current controller\&. If
1413 \fBTakeControl()\fR
1414 has not been called, this method will fail\&. The only argument
1415 \fIdisplay\fR
1416 is the new display name\&.
1417 .PP
1418 \fBSetTTY()\fR
1419 allows the device name of the session to be changed\&. This is useful if the tty device is only known after authentication\&. It can only be called by session\*(Aqs current controller\&. If
1420 \fBTakeControl()\fR
1421 has not been called, this method will fail\&. The only argument
1422 \fItty_fd\fR
1423 is a file handle to the new tty device\&.
1424 .PP
1425 \fBTakeDevice()\fR
1426 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
1427 systemd\-logind
1428 will return a file descriptor for the device\&. Only a limited set of device\-types is currently supported (but may be extended)\&.
1429 systemd\-logind
1430 automatically mutes the file descriptor if the session is inactive and resumes it once the session is activated again\&. This guarantees that a session can only access session devices if the session is active\&. Note that this revoke/resume mechanism is asynchronous and may happen at any given time\&. This only works on devices that are attached to the seat of the given session\&. A process is not required to have direct access to the device node\&.
1431 systemd\-logind
1432 only requires you to be the active session controller (see
1433 \fBTakeControl()\fR)\&. Also note that any device can only be requested once\&. As long as you do not release it, further
1434 \fBTakeDevice()\fR
1435 calls will fail\&.
1436 .PP
1437 \fBReleaseDevice()\fR
1438 releases a device again (see
1439 \fBTakeDevice()\fR)\&. This is also implicitly done by
1440 \fBReleaseControl()\fR
1441 or when closing the D\-Bus connection\&.
1442 .PP
1443 \fBPauseDeviceComplete()\fR
1444 allows a session controller to synchronously pause a device after receiving a
1445 \fBPauseDevice(\fR\fB"pause"\fR\fB)\fR
1446 signal\&. Forced signals (or after an internal timeout) are automatically completed by
1447 systemd\-logind
1448 asynchronously\&.
1449 .PP
1450 \fBSetLockedHint()\fR
1451 may be used to set the "locked hint" to
1452 \fIlocked\fR, i\&.e\&. information whether the session is locked\&. This is intended to be used by the desktop environment to tell
1453 \fBsystemd\-logind\fR
1454 when the session is locked and unlocked\&.
1455 .PP
1456 \fBSetBrightness()\fR
1457 may be used to set the display brightness\&. This is intended to be used by the desktop environment and allows unprivileged programs to access hardware settings in a controlled way\&. The
1458 \fIsubsystem\fR
1459 parameter specifies a kernel subsystem, either
1460 "backlight"
1461 or
1462 "leds"\&. The
1463 \fIname\fR
1464 parameter specifies a device name under the specified subsystem\&. The
1465 \fIbrightness\fR
1466 parameter specifies the brightness\&. The range is defined by individual drivers, see
1467 /sys/class/\fIsubsystem\fR/\fIname\fR/max_brightness\&.
1468 .SS "Signals"
1469 .PP
1470 The active session controller exclusively gets
1471 \fBPauseDevice()\fR
1472 and
1473 \fBResumeDevice()\fR
1474 events for any device it requested via
1475 \fBTakeDevice()\fR\&. They notify the controller whenever a device is paused or resumed\&. A device is never resumed if its session is inactive\&. Also note that
1476 \fBPauseDevice()\fR
1477 signals are sent before the
1478 \fBPropertyChanged\fR
1479 signal for the
1480 \fBActive\fR
1481 state\&. The inverse is true for
1482 \fBResumeDevice()\fR\&. A device may remain paused for unknown reasons even though the
1483 Session
1484 is active\&.
1485 .PP
1486 A
1487 \fBPauseDevice()\fR
1488 signal carries the major and minor numbers and a string describing the type as arguments\&.
1489 \fBforce\fR
1490 means the device was already paused by
1491 systemd\-logind
1492 and the signal is only an asynchronous notification\&.
1493 \fBpause\fR
1494 means
1495 systemd\-logind
1496 grants you a limited amount of time to pause the device\&. You must respond to this via
1497 \fBPauseDeviceComplete()\fR\&. This synchronous pausing mechanism is used for backwards\-compatibility to VTs and
1498 systemd\-logind
1499 is free to not make use of it\&. It is also free to send a forced
1500 \fBPauseDevice()\fR
1501 if you do not respond in a timely manner (or for any other reason)\&.
1502 \fBgone\fR
1503 means the device was unplugged from the system and you will no longer get any notifications about it\&. There is no need to call
1504 \fBReleaseDevice()\fR\&. You may call
1505 \fBTakeDevice()\fR
1506 again if a new device is assigned the major+minor combination\&.
1507 .PP
1508 \fBResumeDevice()\fR
1509 is sent whenever a session is active and a device is resumed\&. It carries the major/minor numbers as arguments and provides a new open file descriptor\&. You should switch to the new descriptor and close the old one\&. They are not guaranteed to have the same underlying open file descriptor in the kernel (except for a limited set of device types)\&.
1510 .PP
1511 Whenever
1512 \fBActive\fR
1513 or the idle state changes,
1514 \fBPropertyChanged\fR
1515 signals are sent out to clients which have subscribed\&.
1516 .PP
1517 \fBLock()\fR/\fBUnlock()\fR
1518 is sent when the session is asked to be screen\-locked/unlocked\&. A session manager of the session should listen to this signal and act accordingly\&. This signal is sent out as a result of the
1519 \fBLock()\fR
1520 and
1521 \fBUnlock()\fR
1522 methods, respectively\&.
1523 .PP
1524 Signals are only emitted on objects referencing a specific session ID, not on the
1525 "/org/freedesktop/login1/session/self"
1526 or
1527 "/org/freedesktop/login1/session/auto"
1528 convenience objects, as they can only be dereferenced relative to a method caller\&.
1529 .SS "Properties"
1530 .PP
1531 \fIId\fR
1532 encodes the session ID\&.
1533 .PP
1534 \fIUser\fR
1535 encodes the user ID of the user this session belongs to\&. This is a structure consisting of the Unix UID and the object path\&.
1536 .PP
1537 \fIName\fR
1538 encodes the user name\&.
1539 .PP
1540 \fITimestamp\fR
1541 and
1542 \fITimestampMonotonic\fR
1543 encode the microseconds since the epoch when the session was created, in
1544 \fBCLOCK_REALTIME\fR
1545 or
1546 \fBCLOCK_MONOTONIC\fR, respectively\&.
1547 .PP
1548 \fIVTNr\fR
1549 encodes the virtual terminal number of the session if there is any, 0 otherwise\&.
1550 .PP
1551 \fISeat\fR
1552 encodes the seat this session belongs to if there is any\&. This is a structure consisting of the ID and the seat object path\&.
1553 .PP
1554 \fITTY\fR
1555 encodes the kernel TTY path of the session if this is a text login\&. If not this is an empty string\&.
1556 .PP
1557 \fIDisplay\fR
1558 encodes the X11 display name if this is a graphical login\&. If not, this is an empty string\&.
1559 .PP
1560 \fIRemote\fR
1561 encodes whether the session is local or remote\&.
1562 .PP
1563 \fIRemoteHost\fR
1564 and
1565 \fIRemoteUser\fR
1566 encode the remote host and user if this is a remote session, or an empty string otherwise\&.
1567 .PP
1568 \fIExtraDeviceAccess\fR
1569 encodes the set of additional hardware devices that the session is granted access to\&. For every
1570 "\fIID\fR"
1571 in the list, the session is granted access to all devices tagged with
1572 "xaccess\-\fIID\fR"
1573 in udev\&.
1574 .PP
1575 \fIService\fR
1576 encodes the PAM service name that registered the session\&.
1577 .PP
1578 \fIDesktop\fR
1579 describes the desktop environment running in the session (if known)\&.
1580 .PP
1581 \fIScope\fR
1582 contains the systemd scope unit name of this session\&.
1583 .PP
1584 \fILeader\fR
1585 encodes the PID of the process that registered the session\&.
1586 .PP
1587 \fILeaderPIDFDId\fR
1588 encodes the Linux pidfd inode ID of the process that registered the session\&.
1589 .PP
1590 \fIAudit\fR
1591 encodes the Kernel Audit session ID of the session if auditing is available\&.
1592 .PP
1593 \fIType\fR
1594 encodes the session type\&. It\*(Aqs one of
1595 "unspecified"
1596 (for cron PAM sessions and suchlike),
1597 "tty"
1598 (for text logins),
1599 "web"
1600 (for web\-based logins), or
1601 "x11"/"mir"/"wayland"
1602 (for graphical logins)\&.
1603 .PP
1604 \fIClass\fR
1605 encodes the session class\&. It\*(Aqs one of
1606 "user"
1607 (for normal user sessions),
1608 "greeter"
1609 (for display manager pseudo\-sessions), or
1610 "lock\-screen"
1611 (for display lock screens)\&.
1612 .PP
1613 \fIActive\fR
1614 is a boolean that is true if the session is active, i\&.e\&. currently in the foreground\&. This field is semi\-redundant due to
1615 \fIState\fR\&.
1616 .PP
1617 \fIState\fR
1618 encodes the session state and one of
1619 "online",
1620 "active", or
1621 "closing"\&. See
1622 \fBsd_session_get_state\fR(3)
1623 for more information about the states\&.
1624 .PP
1625 \fIIdleHint\fR,
1626 \fIIdleSinceHint\fR, and
1627 \fIIdleSinceHintMonotonic\fR
1628 encapsulate the idle hint state of this session, similarly to how the respective properties on the manager object do it for the whole system\&.
1629 .PP
1630 \fILockedHint\fR
1631 shows the locked hint state of this session, as set by the
1632 \fBSetLockedHint()\fR
1633 method described above\&.
1634 .PP
1635 \fICanIdle\fR
1636 indicates whether the session supports the idle hint concept\&. Similarly,
1637 \fICanLock\fR
1638 indicates whether the session supports the screen lock concept\&.
1639 .SH "EXAMPLES"
1640 .PP
1641 \fBExample\ \&1.\ \&Introspect the logind manager on the bus\fR
1642 .sp
1643 .if n \{\
1644 .RS 4
1645 .\}
1646 .nf
1647 $ gdbus introspect \-\-system \-\-dest org\&.freedesktop\&.login1 \e
1648 \-\-object\-path /org/freedesktop/login1
1649 .fi
1650 .if n \{\
1651 .RE
1652 .\}
1653 .PP
1654 or
1655 .sp
1656 .if n \{\
1657 .RS 4
1658 .\}
1659 .nf
1660 $ busctl introspect org\&.freedesktop\&.login1 /org/freedesktop/login1
1661 .fi
1662 .if n \{\
1663 .RE
1664 .\}
1665 .PP
1666 \fBExample\ \&2.\ \&Introspect the default seat on the bus\fR
1667 .sp
1668 .if n \{\
1669 .RS 4
1670 .\}
1671 .nf
1672 $ gdbus introspect \-\-system \-\-dest org\&.freedesktop\&.login1 \e
1673 \-\-object\-path /org/freedesktop/login1/seat/seat0
1674 .fi
1675 .if n \{\
1676 .RE
1677 .\}
1678 .PP
1679 or
1680 .sp
1681 .if n \{\
1682 .RS 4
1683 .\}
1684 .nf
1685 $ busctl introspect org\&.freedesktop\&.login1 /org/freedesktop/login1/seat/seat0
1686 .fi
1687 .if n \{\
1688 .RE
1689 .\}
1690 .PP
1691 Seat
1692 "seat0"
1693 is the default seat, so it\*(Aqll be present unless local configuration is made to reassign all devices to a different seat\&. The list of seats and users can be acquired with
1694 \fBloginctl list\-sessions\fR\&.
1695 .PP
1696 \fBExample\ \&3.\ \&Introspect a single user on the bus\fR
1697 .sp
1698 .if n \{\
1699 .RS 4
1700 .\}
1701 .nf
1702 $ gdbus introspect \-\-system \-\-dest org\&.freedesktop\&.login1 \e
1703 \-\-object\-path /org/freedesktop/login1/user/_1000
1704 .fi
1705 .if n \{\
1706 .RE
1707 .\}
1708 .PP
1709 or
1710 .sp
1711 .if n \{\
1712 .RS 4
1713 .\}
1714 .nf
1715 $ busctl introspect org\&.freedesktop\&.login1 /org/freedesktop/login1/user/_1000
1716 .fi
1717 .if n \{\
1718 .RE
1719 .\}
1720 .PP
1721 \fBExample\ \&4.\ \&Introspect org\&.freedesktop\&.login1\&.Session on the bus\fR
1722 .sp
1723 .if n \{\
1724 .RS 4
1725 .\}
1726 .nf
1727 $ gdbus introspect \-\-system \-\-dest org\&.freedesktop\&.login1 \e
1728 \-\-object\-path /org/freedesktop/login1/session/45
1729 .fi
1730 .if n \{\
1731 .RE
1732 .\}
1733 .PP
1734 or
1735 .sp
1736 .if n \{\
1737 .RS 4
1738 .\}
1739 .nf
1740 $ busctl introspect org\&.freedesktop\&.login1 /org/freedesktop/login1/session/45
1741 .fi
1742 .if n \{\
1743 .RE
1744 .\}
1745 .SH "VERSIONING"
1746 .PP
1747 These D\-Bus interfaces follow
1748 \m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[4]\d\s+2\&.
1749 .SH "HISTORY"
1750 .SS "The Manager Object"
1751 .PP
1752 \fIHandlePowerKeyLongPress\fR,
1753 \fIHandleRebootKey\fR,
1754 \fIHandleRebootKeyLongPress\fR,
1755 \fIHandleSuspendKeyLongPress\fR, and
1756 \fIHandleHibernateKeyLongPress\fR
1757 were added in version 251\&.
1758 .PP
1759 \fIStopIdleSessionUSec\fR
1760 was added in version 252\&.
1761 .PP
1762 \fBPrepareForShutdownWithMetadata()\fR
1763 and
1764 \fBCreateSessionWithPIDFD()\fR
1765 were added in version 255\&.
1766 .PP
1767 \fBSleep()\fR,
1768 \fBCanSleep()\fR,
1769 \fISleepOperation\fR, and
1770 \fBListSessionsEx()\fR
1771 were added in version 256\&.
1772 .PP
1773 \fIHandleSecureAttentionKey\fR,
1774 \fBSecureAttentionKey()\fR,
1775 \fIPreparingForShutdownWithMetadata\fR,
1776 \fIDesignatedMaintenanceTime\fR,
1777 \fICanIdle\fR,
1778 \fICanLock\fR, and
1779 \fIBlockWeakInhibited\fR
1780 were added in version 257\&.
1781 .SS "Session Objects"
1782 .PP
1783 \fBSetDisplay()\fR
1784 was added in version 252\&.
1785 .PP
1786 \fBSetTTY()\fR
1787 was added in version 254\&.
1788 .PP
1789 \fBSetClass()\fR
1790 was added in version 256\&.
1791 .PP
1792 \fILeaderPIDFDId\fR
1793 was added in version 258\&.
1794 .PP
1795 \fIExtraDeviceAccess\fR
1796 was added in version 260\&.
1797 .SH "SEE ALSO"
1798 .PP
1799 \fBsystemd\fR(1), \fBsystemd-logind.service\fR(8), \fBloginctl\fR(1)
1800 .SH "NOTES"
1801 .IP " 1." 4
1802 polkit
1803 .RS 4
1804 \%https://www.freedesktop.org/software/polkit/docs/latest/
1805 .RE
1806 .IP " 2." 4
1807 Inhibitor Locks
1808 .RS 4
1809 \%https://systemd.io/INHIBITOR_LOCKS
1810 .RE
1811 .IP " 3." 4
1812 XDG Basedir Specification
1813 .RS 4
1814 \%https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
1815 .RE
1816 .IP " 4." 4
1817 the usual interface versioning guidelines
1818 .RS 4
1819 \%https://0pointer.de/blog/projects/versioning-dbus.html
1820 .RE