HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

man/org.freedesktop.login1.xml

89,983 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: 9362f7d8732f1fc787b8e7e79a36ee844e5919e3

Lines 1–1000 of 1,708

<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" >
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
<refentry id="org.freedesktop.login1" conditional='ENABLE_LOGIND'
    xmlns:xi="http://www.w3.org/2001/XInclude">
  <refentryinfo>
    <title>org.freedesktop.login1</title>
    <productname>systemd</productname>
  </refentryinfo>
 
  <refmeta>
    <refentrytitle>org.freedesktop.login1</refentrytitle>
    <manvolnum>5</manvolnum>
  </refmeta>
 
  <refnamediv>
    <refname>org.freedesktop.login1</refname>
    <refpurpose>The D-Bus interface of systemd-logind</refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Introduction</title>
 
    <para><citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    is a system service that keeps track of user logins and seats.</para>
 
    <para>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 <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
    </para>
  </refsect1>
 
  <refsect1>
    <title>The Manager Object</title>
 
    <para>The service exposes the following interfaces on the Manager object on the bus:</para>
 
    <programlisting executable="systemd-logind" node="/org/freedesktop/login1" interface="org.freedesktop.login1.Manager">
node /org/freedesktop/login1 {
  interface org.freedesktop.login1.Manager {
    methods:
      GetSession(in  s session_id,
                 out o object_path);
      GetSessionByPID(in  u pid,
                      out o object_path);
      GetUser(in  u uid,
              out o object_path);
      GetUserByPID(in  u pid,
                   out o object_path);
      GetSeat(in  s seat_id,
              out o object_path);
      ListSessions(out a(susso) sessions);
      ListSessionsEx(out a(sussussbto) sessions);
      ListUsers(out a(uso) users);
      ListSeats(out a(so) seats);
      ListInhibitors(out a(ssssuu) inhibitors);
      @org.freedesktop.systemd1.Privileged("true")
      CreateSession(in  u uid,
                    in  u pid,
                    in  s service,
                    in  s type,
                    in  s class,
                    in  s desktop,
                    in  s seat_id,
                    in  u vtnr,
                    in  s tty,
                    in  s display,
                    in  b remote,
                    in  s remote_user,
                    in  s remote_host,
                    in  a(sv) properties,
                    out s session_id,
                    out o object_path,
                    out s runtime_path,
                    out h fifo_fd,
                    out u uid,
                    out s seat_id,
                    out u vtnr,
                    out b existing);
      @org.freedesktop.systemd1.Privileged("true")
      CreateSessionWithPIDFD(in  u uid,
                             in  h pidfd,
                             in  s service,
                             in  s type,
                             in  s class,
                             in  s desktop,
                             in  s seat_id,
                             in  u vtnr,
                             in  s tty,
                             in  s display,
                             in  b remote,
                             in  s remote_user,
                             in  s remote_host,
                             in  t flags,
                             in  a(sv) properties,
                             out s session_id,
                             out o object_path,
                             out s runtime_path,
                             out h fifo_fd,
                             out u uid,
                             out s seat_id,
                             out u vtnr,
                             out b existing);
      ReleaseSession(in  s session_id);
      ActivateSession(in  s session_id);
      ActivateSessionOnSeat(in  s session_id,
                            in  s seat_id);
      LockSession(in  s session_id);
      UnlockSession(in  s session_id);
      LockSessions();
      UnlockSessions();
      KillSession(in  s session_id,
                  in  s whom,
                  in  i signal_number);
      KillUser(in  u uid,
               in  i signal_number);
      TerminateSession(in  s session_id);
      TerminateUser(in  u uid);
      TerminateSeat(in  s seat_id);
      SetUserLinger(in  u uid,
                    in  b enable,
                    in  b interactive);
      AttachDevice(in  s seat_id,
                   in  s sysfs_path,
                   in  b interactive);
      FlushDevices(in  b interactive);
      PowerOff(in  b interactive);
      PowerOffWithFlags(in  t flags);
      Reboot(in  b interactive);
      RebootWithFlags(in  t flags);
      Halt(in  b interactive);
      HaltWithFlags(in  t flags);
      Suspend(in  b interactive);
      SuspendWithFlags(in  t flags);
      Hibernate(in  b interactive);
      HibernateWithFlags(in  t flags);
      HybridSleep(in  b interactive);
      HybridSleepWithFlags(in  t flags);
      SuspendThenHibernate(in  b interactive);
      SuspendThenHibernateWithFlags(in  t flags);
      Sleep(in  t flags);
      CanPowerOff(out s result);
      CanReboot(out s result);
      CanHalt(out s result);
      CanSuspend(out s result);
      CanHibernate(out s result);
      CanHybridSleep(out s result);
      CanSuspendThenHibernate(out s result);
      CanSleep(out s result);
      ScheduleShutdown(in  s type,
                       in  t usec);
      CancelScheduledShutdown(out b cancelled);
      Inhibit(in  s what,
              in  s who,
              in  s why,
              in  s mode,
              out h pipe_fd);
      CanRebootParameter(out s result);
      SetRebootParameter(in  s parameter);
      CanRebootToFirmwareSetup(out s result);
      SetRebootToFirmwareSetup(in  b enable);
      CanRebootToBootLoaderMenu(out s result);
      SetRebootToBootLoaderMenu(in  t timeout);
      CanRebootToBootLoaderEntry(out s result);
      SetRebootToBootLoaderEntry(in  s boot_loader_entry);
      SetWallMessage(in  s wall_message,
                     in  b enable);
    signals:
      SecureAttentionKey(s seat_id,
                         o object_path);
      SessionNew(s session_id,
                 o object_path);
      SessionRemoved(s session_id,
                     o object_path);
      UserNew(u uid,
              o object_path);
      UserRemoved(u uid,
                  o object_path);
      SeatNew(s seat_id,
              o object_path);
      SeatRemoved(s seat_id,
                  o object_path);
      PrepareForShutdown(b start);
      PrepareForShutdownWithMetadata(b start,
                                     a{sv} metadata);
      PrepareForSleep(b start);
    properties:
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      @org.freedesktop.systemd1.Privileged("true")
      readwrite b EnableWallMessages = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      @org.freedesktop.systemd1.Privileged("true")
      readwrite s WallMessage = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly u NAutoVTs = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly as KillOnlyUsers = ['...', ...];
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly as KillExcludeUsers = ['...', ...];
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly b KillUserProcesses = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly s RebootParameter = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly b RebootToFirmwareSetup = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly t RebootToBootLoaderMenu = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly s RebootToBootLoaderEntry = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly as BootLoaderEntries = ['...', ...];
      readonly b IdleHint = ...;
      readonly t IdleSinceHint = ...;
      readonly t IdleSinceHintMonotonic = ...;
      readonly s BlockInhibited = '...';
      readonly s BlockWeakInhibited = '...';
      readonly s DelayInhibited = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly t InhibitDelayMaxUSec = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly t UserStopDelayUSec = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly as SleepOperation = ['...', ...];
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandlePowerKey = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandlePowerKeyLongPress = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleRebootKey = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleRebootKeyLongPress = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleSuspendKey = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleSuspendKeyLongPress = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleHibernateKey = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleHibernateKeyLongPress = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleLidSwitch = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleLidSwitchExternalPower = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleLidSwitchDocked = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s HandleSecureAttentionKey = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly t HoldoffTimeoutUSec = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s IdleAction = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly t IdleActionUSec = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly b PreparingForShutdown = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly a{sv} PreparingForShutdownWithMetadata = [...];
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly b PreparingForSleep = ...;
      readonly (st) ScheduledShutdown = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s DesignatedMaintenanceTime = '...';
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly b Docked = ...;
      readonly b LidClosed = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly b OnExternalPower = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly b RemoveIPC = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly t RuntimeDirectorySize = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly t RuntimeDirectoryInodesMax = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly t InhibitorsMax = ...;
      readonly t NCurrentInhibitors = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly t SessionsMax = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly t NCurrentSessions = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly t StopIdleSessionUSec = ...;
  };
  interface org.freedesktop.DBus.Peer { ... };
  interface org.freedesktop.DBus.Introspectable { ... };
  interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
 
    <!--property SleepOperation is not documented!-->
 
    <!--property HandlePowerKeyLongPress is not documented!-->
 
    <!--property HandleRebootKey is not documented!-->
 
    <!--property HandleRebootKeyLongPress is not documented!-->
 
    <!--property HandleSuspendKeyLongPress is not documented!-->
 
    <!--property HandleHibernateKeyLongPress is not documented!-->
 
    <!--property HandleSecureAttentionKey is not documented!-->
 
    <!--property DesignatedMaintenanceTime is not documented!-->
 
    <!--property StopIdleSessionUSec is not documented!-->
 
    <!--Autogenerated cross-references for systemd.directives, do not edit-->
 
    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.login1.Manager"/>
 
    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.login1.Manager"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="GetSession()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="GetSessionByPID()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="GetUser()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="GetUserByPID()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="GetSeat()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ListSessions()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ListSessionsEx()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ListUsers()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ListSeats()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ListInhibitors()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CreateSession()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CreateSessionWithPIDFD()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ReleaseSession()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ActivateSession()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ActivateSessionOnSeat()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="LockSession()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="UnlockSession()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="LockSessions()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="UnlockSessions()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="KillSession()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="KillUser()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="TerminateSession()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="TerminateUser()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="TerminateSeat()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SetUserLinger()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="AttachDevice()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="FlushDevices()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="PowerOff()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="PowerOffWithFlags()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="Reboot()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="RebootWithFlags()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="Halt()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="HaltWithFlags()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="Suspend()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SuspendWithFlags()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="Hibernate()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="HibernateWithFlags()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="HybridSleep()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="HybridSleepWithFlags()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SuspendThenHibernate()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SuspendThenHibernateWithFlags()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="Sleep()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanPowerOff()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanReboot()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanHalt()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanSuspend()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanHibernate()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanHybridSleep()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanSuspendThenHibernate()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanSleep()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ScheduleShutdown()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CancelScheduledShutdown()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="Inhibit()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanRebootParameter()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SetRebootParameter()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanRebootToFirmwareSetup()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SetRebootToFirmwareSetup()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanRebootToBootLoaderMenu()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SetRebootToBootLoaderMenu()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="CanRebootToBootLoaderEntry()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SetRebootToBootLoaderEntry()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SetWallMessage()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="SecureAttentionKey()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="SessionNew()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="SessionRemoved()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="UserNew()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="UserRemoved()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="SeatNew()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="SeatRemoved()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdown()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdownWithMetadata()"/>
 
    <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForSleep()"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="EnableWallMessages"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="WallMessage"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="NAutoVTs"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="KillOnlyUsers"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="KillExcludeUsers"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="KillUserProcesses"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="RebootParameter"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="RebootToFirmwareSetup"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="RebootToBootLoaderMenu"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="RebootToBootLoaderEntry"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="BootLoaderEntries"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="IdleHint"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="IdleSinceHint"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="IdleSinceHintMonotonic"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="BlockInhibited"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="BlockWeakInhibited"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="DelayInhibited"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="InhibitDelayMaxUSec"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="UserStopDelayUSec"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="SleepOperation"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandlePowerKey"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandlePowerKeyLongPress"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleRebootKey"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleRebootKeyLongPress"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleSuspendKey"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleSuspendKeyLongPress"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleHibernateKey"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleHibernateKeyLongPress"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleLidSwitch"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleLidSwitchExternalPower"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleLidSwitchDocked"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HandleSecureAttentionKey"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="HoldoffTimeoutUSec"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="IdleAction"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="IdleActionUSec"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="PreparingForShutdown"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="PreparingForShutdownWithMetadata"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="PreparingForSleep"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="ScheduledShutdown"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="DesignatedMaintenanceTime"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="Docked"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="LidClosed"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="OnExternalPower"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="RemoveIPC"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="RuntimeDirectorySize"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="RuntimeDirectoryInodesMax"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="InhibitorsMax"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="NCurrentInhibitors"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="SessionsMax"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="NCurrentSessions"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="StopIdleSessionUSec"/>
 
    <!--End of Autogenerated section-->
 
    <refsect2>
      <title>Methods</title>
 
      <para><function>GetSession()</function> may be used to get the session object path for the session with
      the specified ID. Similarly, <function>GetUser()</function> and <function>GetSeat()</function> get the
      user and seat objects, respectively. <function>GetSessionByPID()</function> and
      <function>GetUserByPID()</function> get the session/user object the specified PID belongs to if there
      is any.</para>
 
      <para><function>ListSessions()</function> returns an array of all current sessions. The structures in
      the array consist of the following fields: <varname>session id</varname>, <varname>user id</varname>,
      <varname>user name</varname>, <varname>seat id</varname>, and <varname>session object path</varname>.
      If a session does not have a seat attached, the seat id field will be an empty string.</para>
 
      <para><function>ListSessionsEx()</function> returns an array of all current sessions with more metadata
      than <function>ListSessions()</function>. The structures in the array consist of the following fields:
      <varname>session id</varname>, <varname>user id</varname>, <varname>user name</varname>,
      <varname>seat id</varname>, <varname>leader pid</varname>, <varname>session class</varname>,
      <varname>tty name</varname>, <varname>idle hint</varname>, <varname>idle hint monotonic timestamp</varname>,
      and <varname>session object path</varname>. <varname>tty</varname> and <varname>seat id</varname> fields
      could be empty, if the session has no associated tty or session has no seat attached, respectively.</para>
 
      <para><function>ListUsers()</function> 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.</para>
 
      <para><function>ListSeats()</function> returns an array of all currently available seats. The
      structure in the array consists of the following fields: seat id, seat object path.</para>
 
      <para><function>ListInhibitors()</function> lists all currently active inhibitors. It returns an array of
      structures consisting of <varname>what</varname>, <varname>who</varname>, <varname>why</varname>,
      <varname>mode</varname>, <varname>uid</varname> (user ID), and <varname>pid</varname> (process ID).</para>
 
      <para><function>CreateSession()</function>, <function>CreateSessionWithPIDFD()</function>, and
      <function>ReleaseSession()</function> may be used to open or close login sessions. These calls should
      <emphasis>never</emphasis> be invoked directly by clients. Creating/closing sessions is exclusively the job
      of PAM and its <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
      module.</para>
 
      <para><function>ActivateSession()</function> brings the session with the specified ID into the
      foreground. <function>ActivateSessionOnSeat()</function> does the same, but only if the seat id
      matches.</para>
 
      <para><function>LockSession()</function> asks the session with the specified ID to activate the screen
      lock. <function>UnlockSession()</function> 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.</para>
 
      <para><function>LockSessions()</function> asks all sessions to activate their screen locks. This may be
      used to lock access to the entire machine in one action. Similarly, <function>UnlockSessions()</function>
      asks all sessions to deactivate their screen locks.</para>
 
      <para><function>KillSession()</function> 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 <literal>leader</literal> or
      <literal>all</literal> and a signal number. If <literal>leader</literal> is passed only the session
      <literal>leader</literal> is killed. If <literal>all</literal> is passed all processes of the session
      are killed.</para>
 
      <para><function>KillUser()</function> 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.</para>
 
      <para><function>TerminateSession()</function>, <function>TerminateUser()</function>,
      <function>TerminateSeat()</function> 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.</para>
 
      <para><function>SetUserLinger()</function> 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. <function>SetUserLinger()</function>
      expects three arguments: the UID, a boolean whether to enable/disable and a boolean controlling the
      <ulink url="https://www.freedesktop.org/software/polkit/docs/latest/">polkit</ulink>
      authorization interactivity (see below). Note that the user linger state is persistently
      stored on disk.</para>
 
      <para><function>AttachDevice()</function> may be used to assign a specific device to a specific
      seat. The device is identified by its <filename>/sys/</filename> path and must be eligible for seat
      assignments. <function>AttachDevice()</function> 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
      <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
 
      <para><function>FlushDevices()</function> 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).</para>
 
      <para><function>PowerOff()</function>, <function>Reboot()</function>, <function>Halt()</function>,
      <function>Suspend()</function>, and <function>Hibernate()</function> 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). <function>HybridSleep()</function> results in the system entering a hybrid-sleep mode,
      i.e. the system is both hibernated and suspended. <function>SuspendThenHibernate()</function> results
      in the system being suspended, then later woken using an RTC timer and hibernated. The only argument is
      the polkit interactivity boolean <varname>interactive</varname> (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.
      <function>Sleep()</function> automatically selects the most suitable sleep operation supported by the
      machine. The candidate sleep operations to check for support can be configured through <varname>SleepOperation=</varname>
      setting in <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
      UIs should expose these calls as the primary mechanism to poweroff/reboot/suspend/hibernate the machine. Methods
      <function>PowerOffWithFlags()</function>, <function>RebootWithFlags()</function>,
      <function>HaltWithFlags()</function>, <function>SuspendWithFlags()</function>,
      <function>HibernateWithFlags()</function>, <function>HybridSleepWithFlags()</function>,
      <function>SuspendThenHibernateWithFlags()</function>, and <function>Sleep()</function> take
      <varname>flags</varname> to allow for extendability, defined as follows:</para>
      <programlisting>
#define SD_LOGIND_ROOT_CHECK_INHIBITORS          (UINT64_C(1) &lt;&lt; 0)
#define SD_LOGIND_KEXEC_REBOOT                   (UINT64_C(1) &lt;&lt; 1)
#define SD_LOGIND_SOFT_REBOOT                    (UINT64_C(1) &lt;&lt; 2)
#define SD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP (UINT64_C(1) &lt;&lt; 3)
#define SD_LOGIND_SKIP_INHIBITORS                (UINT64_C(1) &lt;&lt; 4)
</programlisting>
      <para>When the <varname>flags</varname> is 0 then these methods behave just like the versions without
      flags. Since systemd version 257 inhibitors of type <literal>block</literal> 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
      <literal>block-weak</literal> inhibitor lock type. <constant>SD_LOGIND_ROOT_CHECK_INHIBITORS</constant>
      (0x01) makes <literal>block-weak</literal> locks behave like regular <literal>block</literal> locks,
      i.e. ensures they are honoured for any user. A flag <constant>SD_LOGIND_SKIP_INHIBITORS</constant>
      (0x10) can be specified to bypass both <literal>block</literal> and <literal>block-weak</literal>
      inhibitors (it has no effect on <literal>delay</literal> inhibitors). When
      <constant>SD_LOGIND_KEXEC_REBOOT</constant> (0x02) is set, then <function>RebootWithFlags()</function>
      performs a kexec reboot if kexec kernel is loaded. When <constant>SD_LOGIND_SOFT_REBOOT</constant>
      (0x04) is set, or <constant>SD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP</constant> (0x08) is set and a new
      root file system has been set up on <literal>/run/nextroot/</literal>, then
      <function>RebootWithFlags()</function> performs a userspace reboot
      only. <constant>SD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP</constant> and
      <constant>SD_LOGIND_KEXEC_REBOOT</constant> can be combined, with soft-reboot having precedence.
      </para>
 
      <para><function>SetRebootParameter()</function> sets a parameter for a subsequent reboot operation.
      See the description of <command>reboot</command> in
      <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> and
      <citerefentry project="man-pages"><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
      for more information.</para>
 
      <para><function>SetRebootToFirmwareSetup()</function>,
      <function>SetRebootToBootLoaderMenu()</function>, and <function>SetRebootToBootLoaderEntry()</function>
      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
      <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for the
      corresponding command line interface.</para>
 
      <para><function>CanPowerOff()</function>, <function>CanReboot()</function>, <function>CanHalt()</function>,
      <function>CanSuspend()</function>, <function>CanHibernate()</function>, <function>CanHybridSleep()</function>,
      <function>CanSuspendThenHibernate()</function>, <function>CanSleep()</function>,
      <function>CanRebootParameter()</function>, <function>CanRebootToFirmwareSetup()</function>,
      <function>CanRebootToBootLoaderMenu()</function>, and <function>CanRebootToBootLoaderEntry()</function>
      test whether the system supports the respective operation and whether the calling user is allowed to
      execute it. Returns one of <literal>na</literal>, <literal>yes</literal>, <literal>no</literal>,
      <literal>challenge</literal>, <literal>inhibited</literal>, <literal>inhibitor-blocked</literal>,
      and <literal>challenge-inhibitor-blocked</literal>. If <literal>na</literal> is returned, the operation
      is not available because hardware, kernel, or drivers do not support it. If <literal>yes</literal> is
      returned, the operation is supported and the user may execute the operation without further authentication.
      If <literal>no</literal> is returned, the operation is available but the user is not allowed to execute
      the operation. If <literal>challenge</literal> is returned, the operation is available but only after
      authorization. If <literal>inhibited</literal> 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 <literal>inhibitor-blocked</literal> 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. <literal>challenge-inhibitor-blocked</literal> is similar:
      the operation is normally available after authorization but a held inhibitor disallows the user from
      executing the operation.</para>
 
      <para><function>ScheduleShutdown()</function> schedules a shutdown operation <varname>type</varname> at
      time <varname>usec</varname> in microseconds since the UNIX epoch. Alternatively, if
      <varname>usec</varname> <literal>UINT64_MAX</literal> and a maintenance window is
      configured, <filename>systemd-logind</filename> will use the next time of the maintenance window
      instead. <varname>type</varname> can be one
      of <literal>poweroff</literal>, <literal>dry-poweroff</literal>, <literal>reboot</literal>,
      <literal>dry-reboot</literal>, <literal>halt</literal>, and <literal>dry-halt</literal>. (The
      <literal>dry-</literal> variants do not actually execute the shutdown action.)
      <function>CancelScheduledShutdown()</function> cancels a scheduled shutdown. The output parameter
      <varname>cancelled</varname> is true if a shutdown operation was scheduled.</para>
 
      <para>Note that <varname>usec</varname> is a lower bound only: the shutdown operation is executed as soon
      as possible, but not before the specified time. A timestamp in the past is not an error, it simply means
      the operation is executed immediately. This is important, since a request to shut down immediately, or a
      very short time into the future, typically already refers to the past by the time it is
      processed.</para>
 
      <para><function>SetWallMessage()</function> sets the wall message (the message that will be sent out to
      all terminals and stored in a
      <citerefentry project="man-pages"><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry> record) for a
      subsequent scheduled shutdown operation. The parameter <varname>wall_message</varname> specifies the
      shutdown reason (and may be empty) which will be included in the shutdown message. The parameter
      <varname>enable</varname> specifies whether to print a wall message on shutdown.</para>
 
      <para><function>Inhibit()</function> creates an inhibition lock. It takes four parameters:
      <varname>what</varname>, <varname>who</varname>, <varname>why</varname>, and
      <varname>mode</varname>. <varname>what</varname> is one or more of <literal>shutdown</literal>,
      <literal>sleep</literal>, <literal>idle</literal>, <literal>handle-power-key</literal>,
      <literal>handle-suspend-key</literal>, <literal>handle-hibernate-key</literal>,
      <literal>handle-lid-switch</literal>, separated by colons, for inhibiting poweroff/reboot,
      suspend/hibernate, the automatic idle logic, or hardware key handling. <varname>who</varname> should be
      a short human-readable string identifying the application taking the lock. <varname>why</varname>
      should be a short human-readable string identifying the reason why the lock is taken. Finally,
      <varname>mode</varname> is either <literal>block</literal> or <literal>delay</literal> which encodes
      whether the inhibit shall be consider mandatory or whether it should just delay the operation to a
      certain maximum time, while the <literal>block-weak</literal> 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 <ulink url="https://systemd.io/INHIBITOR_LOCKS">Inhibitor Locks</ulink>.
      </para>
    </refsect2>
 
    <refsect2>
      <title>Signals</title>
 
      <para>Whenever the inhibition state or idle hint changes, <function>PropertyChanged</function>
      signals are sent out to clients which have subscribed.</para>
 
      <para>The <function>SecureAttentionKey()</function> 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.
      </para>
 
      <para>The <function>SessionNew()</function>, <function>SessionRemoved()</function>,
      <function>UserNew()</function>, <function>UserRemoved()</function>, <function>SeatNew()</function>, and
      <function>SeatRemoved()</function> 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.</para>
 
      <para>The <function>PrepareForShutdown()</function>,
      <function>PrepareForShutdownWithMetadata()</function>, and <function>PrepareForSleep()</function>
      signals are sent right before (with the argument <literal>true</literal>) or after (with the argument
      <literal>false</literal>) 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
      <ulink url="https://systemd.io/INHIBITOR_LOCKS">Inhibitor Locks</ulink>. The
      <function>PrepareForShutdownWithMetadata()</function> signal additionally sends a list of key/value
      pair metadata fields. Currently it sends a <varname>type</varname> string which defines the type of
      shutdown. The type can be one of <literal>power-off</literal>, <literal>reboot</literal>,
      <literal>halt</literal>, <literal>kexec</literal> or <literal>soft-reboot</literal>. This signal is
      sent first, followed by <function>PrepareForShutdown()</function> (for backward compatibility).</para>
    </refsect2>
 
    <refsect2>
      <title>Properties</title>
 
      <para>Most properties simply reflect the configuration, see
      <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. This
      includes: <varname>NAutoVTs</varname>, <varname>KillOnlyUsers</varname>,
      <varname>KillExcludeUsers</varname>, <varname>KillUserProcesses</varname>, <varname>IdleAction</varname>,
      <varname>InhibitDelayMaxUSec</varname>,
      <varname>InhibitorsMax</varname>,
      <varname>UserStopDelayUSec</varname>,
      <varname>HandlePowerKey</varname>, <varname>HandleSuspendKey</varname>,
      <varname>HandleHibernateKey</varname>, <varname>HandleLidSwitch</varname>,
      <varname>HandleLidSwitchExternalPower</varname>, <varname>HandleLidSwitchDocked</varname>,
      <varname>IdleActionUSec</varname>, <varname>HoldoffTimeoutUSec</varname>,
      <varname>RemoveIPC</varname>, <varname>RuntimeDirectorySize</varname>,
      <varname>RuntimeDirectoryInodesMax</varname>, <varname>InhibitorsMax</varname>, and
      <varname>SessionsMax</varname>.
      </para>
 
      <para>The <varname>IdleHint</varname> 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.</para>
 
      <para><varname>IdleSinceHint</varname> and <varname>IdleSinceHintMonotonic</varname> encode the
      timestamps of the last change of the idle hint boolean, in <constant>CLOCK_REALTIME</constant> and
      <constant>CLOCK_MONOTONIC</constant> timestamps, respectively, in microseconds since the epoch.</para>
 
      <para>The <varname>BlockInhibited</varname>, <varname>BlockWeakInhibited</varname>, and
      <varname>DelayInhibited</varname> properties encode the currently active locks of the respective
      modes. They are colon separated lists of <literal>shutdown</literal>, <literal>sleep</literal>, and
      <literal>idle</literal> (see above).</para>
 
      <para><varname>NCurrentSessions</varname> and <varname>NCurrentInhibitors</varname> contain the number
      of currently registered sessions and inhibitors.</para>
 
      <para>The <varname>BootLoaderEntries</varname> 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
      <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>
      for more information.</para>
 
      <para>The <varname>PreparingForShutdown</varname> and <varname>PreparingForSleep</varname> boolean
      properties are true during the interval between the two <function>PrepareForShutdown()</function> and
      <function>PrepareForSleep()</function> signals respectively. The
      <varname>PreparingForShutdownWithMetadata</varname> property provides a list of key/value pair
      metadata fields. Currently it lists a <varname>preparing</varname> boolean that corresponds to the
      <varname>PreparingForShutdown</varname> property, and, if a shutdown is being prepared, it will also
      contain a <varname>type</varname> string which defines the type of shutdown. The type can be one of
      <literal>power-off</literal>, <literal>reboot</literal>, <literal>halt</literal>,
      <literal>kexec</literal> or <literal>soft-reboot</literal>. Note that these properties do not send out
      <function>PropertyChanged</function> signals.</para>
 
      <para>The <varname>RebootParameter</varname> property shows the value set with the
      <function>SetRebootParameter()</function> method described above.</para>
 
      <para><varname>ScheduledShutdown</varname> shows the value pair set with the
      <function>ScheduleShutdown()</function> method described above.</para>
 
      <para><varname>RebootToFirmwareSetup</varname>, <varname>RebootToBootLoaderMenu</varname>, and
      <varname>RebootToBootLoaderEntry</varname> are true when the resprective post-reboot operation was
      selected with <function>SetRebootToFirmwareSetup()</function>,
      <function>SetRebootToBootLoaderMenu()</function>, or
      <function>SetRebootToBootLoaderEntry()</function>.</para>
 
      <para>The <varname>WallMessage</varname> and <varname>EnableWallMessages</varname> properties reflect the
      shutdown reason and wall message enablement switch which can be set with the
      <function>SetWallMessage()</function> method described above.</para>
 
      <para><varname>Docked</varname> is true if the machine is connected to a dock.
      <varname>LidClosed</varname> is true when the lid (of a laptop) is closed.
      <varname>OnExternalPower</varname> is true when the machine is connected to an external power supply.
      </para>
    </refsect2>
 
    <refsect2>
      <title>Security</title>
 
      <para>A number of operations are protected via the polkit privilege
      system. <function>SetUserLinger()</function> requires the
      <interfacename>org.freedesktop.login1.set-user-linger</interfacename>
      privilege. <function>AttachDevice()</function> requires
      <interfacename>org.freedesktop.login1.attach-device</interfacename> and
      <function>FlushDevices()</function> requires
      <interfacename>org.freedesktop.login1.flush-devices</interfacename>. <function>PowerOff()</function>,
      <function>Reboot()</function>, <function>Halt()</function>, <function>Suspend()</function>,
      <function>Hibernate()</function> require
      <interfacename>org.freedesktop.login1.power-off</interfacename>,
      <interfacename>org.freedesktop.login1.power-off-multiple-sessions</interfacename>,
      <interfacename>org.freedesktop.login1.power-off-ignore-inhibit</interfacename>,
      <interfacename>org.freedesktop.login1.reboot</interfacename>,
      <interfacename>org.freedesktop.login1.reboot-multiple-sessions</interfacename>,
      <interfacename>org.freedesktop.login1.reboot-ignore-inhibit</interfacename>,
      <interfacename>org.freedesktop.login1.halt</interfacename>,
      <interfacename>org.freedesktop.login1.halt-multiple-sessions</interfacename>,
      <interfacename>org.freedesktop.login1.halt-ignore-inhibit</interfacename>,
      <interfacename>org.freedesktop.login1.suspend</interfacename>,
      <interfacename>org.freedesktop.login1.suspend-multiple-sessions</interfacename>,
      <interfacename>org.freedesktop.login1.suspend-ignore-inhibit</interfacename>,
      <interfacename>org.freedesktop.login1.hibernate</interfacename>,
      <interfacename>org.freedesktop.login1.hibernate-multiple-sessions</interfacename>,
      <interfacename>org.freedesktop.login1.hibernate-ignore-inhibit</interfacename>,
      respectively depending on whether there are other sessions around or active inhibits are present.
      <function>HybridSleep()</function> and <function>SuspendThenHibernate()</function>
      use the same privileges as <function>Hibernate()</function>. <function>Sleep()</function> uses
      the inhibits of the auto-selected sleep operation. <function>SetRebootParameter()</function> requires
      <interfacename>org.freedesktop.login1.set-reboot-parameter</interfacename>.</para>
 
      <para><function>SetRebootToFirmwareSetup()</function> requires
      <interfacename>org.freedesktop.login1.set-reboot-to-firmware-setup</interfacename>.
      <function>SetRebootToBootLoaderMenu()</function> requires
      <interfacename>org.freedesktop.login1.set-reboot-to-boot-loader-menu</interfacename>.
      <function>SetRebootToBootLoaderEntry()</function> requires
      <interfacename>org.freedesktop.login1.set-reboot-to-boot-loader-entry</interfacename>.
      </para>
 
      <para><function>ScheduleShutdown()</function> and <function>CancelScheduledShutdown()</function> require
      the same privileges (listed above) as the immediate poweroff/reboot/halt operations.</para>
 
      <para><function>Inhibit()</function> is protected via one of
      <interfacename>org.freedesktop.login1.inhibit-block-shutdown</interfacename>,
      <interfacename>org.freedesktop.login1.inhibit-delay-shutdown</interfacename>,
      <interfacename>org.freedesktop.login1.inhibit-block-sleep</interfacename>,
      <interfacename>org.freedesktop.login1.inhibit-delay-sleep</interfacename>,
      <interfacename>org.freedesktop.login1.inhibit-block-idle</interfacename>,
      <interfacename>org.freedesktop.login1.inhibit-handle-power-key</interfacename>,
      <interfacename>org.freedesktop.login1.inhibit-handle-suspend-key</interfacename>,
      <interfacename>org.freedesktop.login1.inhibit-handle-hibernate-key</interfacename>,
      <interfacename>org.freedesktop.login1.inhibit-handle-lid-switch</interfacename> depending on the lock
      type and mode taken.</para>
 
      <para>The <varname>interactive</varname> boolean parameters can be used to control whether polkit
      should interactively ask the user for authentication credentials if required.</para>
    </refsect2>
  </refsect1>
 
  <refsect1>
    <title>Seat Objects</title>
 
    <programlisting executable="systemd-logind" node="/org/freedesktop/login1/seat/seat0" interface="org.freedesktop.login1.Seat">
node /org/freedesktop/login1/seat/seat0 {
  interface org.freedesktop.login1.Seat {
    methods:
      Terminate();
      ActivateSession(in  s session_id);
      SwitchTo(in  u vtnr);
      SwitchToNext();
      SwitchToPrevious();
    properties:
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly s Id = '...';
      readonly (so) ActiveSession = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
      readonly b CanTTY = ...;
      readonly b CanGraphical = ...;
      @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
      readonly a(so) Sessions = [...];
      readonly b IdleHint = ...;
      readonly t IdleSinceHint = ...;
      readonly t IdleSinceHintMonotonic = ...;
  };
  interface org.freedesktop.DBus.Peer { ... };
  interface org.freedesktop.DBus.Introspectable { ... };
  interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
 
    <!--Autogenerated cross-references for systemd.directives, do not edit-->
 
    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.login1.Seat"/>
 
    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.login1.Seat"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="Terminate()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="ActivateSession()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SwitchTo()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SwitchToNext()"/>
 
    <variablelist class="dbus-method" generated="True" extra-ref="SwitchToPrevious()"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="Id"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="ActiveSession"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="CanTTY"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="CanGraphical"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="Sessions"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="IdleHint"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="IdleSinceHint"/>
 
    <variablelist class="dbus-property" generated="True" extra-ref="IdleSinceHintMonotonic"/>
 
    <!--End of Autogenerated section-->