docs/html/tlm-intro.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>Tiny Login Manager Reference Manual: Introduction</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="Tiny Login Manager Reference Manual">
   8 <link rel="up" href="ch01.html" title="Introduction">
   9 <link rel="prev" href="ch01.html" title="Introduction">
  10 <link rel="next" href="TlmConfig.html" title="TlmConfig">
  11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts"></td>
  17 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  19 <td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  20 <td><a accesskey="n" href="TlmConfig.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  21 </tr></table>
  22 <div class="refentry">
  23 <a name="tlm-intro"></a><div class="titlepage"></div>
  24 <div class="refsect1">
  25 <a name="id-1.2.2.2"></a><h2>What is TLM?</h2>
  26 <p>
  27         TLM is a daemon that handles user logins in a multi-user, multi-seat system by
  28         authenticating the users through PAM, and setting up, launching, and tracking user
  29         sessions.
  30     </p>
  31 <p>
  32         TLM daemon itself does not include any UI for interacting with
  33         the users; any such interaction is handled through TLM's authentication plugin system (see
  34             <a class="link" href="TlmAuthPlugin.html" title="TlmAuthPlugin">TlmAuthPlugin</a>).
  35         TLM can be configured to log-in a default ("guest") user when no other
  36         user is logged in at a specific seat.
  37     </p>
  38 <p>
  39         TLM also exports a <a class="link" href="gdbus-org.O1.Tlm.Login.html" title="org.O1.Tlm.Login">D-Bus API</a>, that can be used to log in, log out and
  40         switch users on a seat.
  41     </p>
  42 <p>
  43         Under examples, tlm-ui demonstrates the usage of tlm daemon's dbus
  44         interface for login, logout and switch user functionality. Login
  45         object with root access is exported at TLM_DBUS_ROOT_SOCKET_ADDRESS
  46         which can be used to login, logout and switch any user.
  47         TLM_DBUS_ROOT_SOCKET_ADDRESS can be fetched as a variable from package
  48         configuration file tlm.pc.
  49         Besides whenever a user is logged in, a dbus login object is also
  50         exported which can be used for 'logout-user' and 'switch-user'
  51         functionalities by that user. The dbus object can be accessed at
  52         TLM_DBUS_SOCKET_PATH/&lt;seat_id-uid&gt; by the user (uid) who is logged
  53         in at the seat (seat_id).
  54     </p>
  55 </div>
  56 <div class="refsect1">
  57 <a name="id-1.2.2.3"></a><h2>Plugin development</h2>
  58 <p>
  59           Plugins should be named "libtlm-plugin-&lt;plugin_name&gt;.so" and
  60           they should contain a
  61           "tlm_&lt;plugin_type&gt;_plugin_&lt;plugin_name&gt;_get_type"
  62           symbol that is a function that returns a #GType of the plugin object.
  63           plugin_type is "auth" for authentication plugins and "account" for
  64           account plugins.
  65       </p>
  66 <p>
  67           If Tlm has been configured with --enable-debug, plugin directory can
  68           be overriden with TLM_PLUGINS_DIR environment variable.
  69       </p>
  70 </div>
  71 </div>
  72 <div class="footer">
  73 <hr>
  74           Generated by GTK-Doc V1.20</div>
  75 </body>
  76 </html>