docs/html/tlm-General-configuration.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: General configuration</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="TlmConfig.html" title="TlmConfig">
  10 <link rel="next" href="tlm-Seat-configuration.html" title="Seat configuration">
  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">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#tlm-General-configuration.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#tlm-General-configuration.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="TlmConfig.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="tlm-Seat-configuration.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="tlm-General-configuration"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="tlm-General-configuration.top_of_page"></a>General configuration</span></h2>
  31 <p>General configuration — tlm general configuration keys</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="tlm-General-configuration.other"></a><h2>Types and Values</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="name">
  40 <col class="description">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="define_keyword">#define</td>
  45 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL:CAPS" title="TLM_CONFIG_GENERAL">TLM_CONFIG_GENERAL</a></td>
  46 </tr>
  47 <tr>
  48 <td class="define_keyword">#define</td>
  49 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-ACCOUNTS-PLUGIN:CAPS" title="TLM_CONFIG_GENERAL_ACCOUNTS_PLUGIN">TLM_CONFIG_GENERAL_ACCOUNTS_PLUGIN</a></td>
  50 </tr>
  51 <tr>
  52 <td class="define_keyword">#define</td>
  53 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-NSEATS:CAPS" title="TLM_CONFIG_GENERAL_NSEATS">TLM_CONFIG_GENERAL_NSEATS</a></td>
  54 </tr>
  55 <tr>
  56 <td class="define_keyword">#define</td>
  57 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-SESSION-CMD:CAPS" title="TLM_CONFIG_GENERAL_SESSION_CMD">TLM_CONFIG_GENERAL_SESSION_CMD</a></td>
  58 </tr>
  59 <tr>
  60 <td class="define_keyword">#define</td>
  61 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-SESSION-PATH:CAPS" title="TLM_CONFIG_GENERAL_SESSION_PATH">TLM_CONFIG_GENERAL_SESSION_PATH</a></td>
  62 </tr>
  63 <tr>
  64 <td class="define_keyword">#define</td>
  65 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-DATA-DIRS:CAPS" title="TLM_CONFIG_GENERAL_DATA_DIRS">TLM_CONFIG_GENERAL_DATA_DIRS</a></td>
  66 </tr>
  67 <tr>
  68 <td class="define_keyword">#define</td>
  69 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-AUTO-LOGIN:CAPS" title="TLM_CONFIG_GENERAL_AUTO_LOGIN">TLM_CONFIG_GENERAL_AUTO_LOGIN</a></td>
  70 </tr>
  71 <tr>
  72 <td class="define_keyword">#define</td>
  73 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-PREPARE-DEFAULT:CAPS" title="TLM_CONFIG_GENERAL_PREPARE_DEFAULT">TLM_CONFIG_GENERAL_PREPARE_DEFAULT</a></td>
  74 </tr>
  75 <tr>
  76 <td class="define_keyword">#define</td>
  77 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-PAM-SERVICE:CAPS" title="TLM_CONFIG_GENERAL_PAM_SERVICE">TLM_CONFIG_GENERAL_PAM_SERVICE</a></td>
  78 </tr>
  79 <tr>
  80 <td class="define_keyword">#define</td>
  81 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-DEFAULT-PAM-SERVICE:CAPS" title="TLM_CONFIG_GENERAL_DEFAULT_PAM_SERVICE">TLM_CONFIG_GENERAL_DEFAULT_PAM_SERVICE</a></td>
  82 </tr>
  83 <tr>
  84 <td class="define_keyword">#define</td>
  85 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-DEFAULT-USER:CAPS" title="TLM_CONFIG_GENERAL_DEFAULT_USER">TLM_CONFIG_GENERAL_DEFAULT_USER</a></td>
  86 </tr>
  87 <tr>
  88 <td class="define_keyword">#define</td>
  89 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-SETUP-TERMINAL:CAPS" title="TLM_CONFIG_GENERAL_SETUP_TERMINAL">TLM_CONFIG_GENERAL_SETUP_TERMINAL</a></td>
  90 </tr>
  91 <tr>
  92 <td class="define_keyword">#define</td>
  93 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-SETUP-RUNTIME-DIR:CAPS" title="TLM_CONFIG_GENERAL_SETUP_RUNTIME_DIR">TLM_CONFIG_GENERAL_SETUP_RUNTIME_DIR</a></td>
  94 </tr>
  95 <tr>
  96 <td class="define_keyword">#define</td>
  97 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-RUNTIME-MODE:CAPS" title="TLM_CONFIG_GENERAL_RUNTIME_MODE">TLM_CONFIG_GENERAL_RUNTIME_MODE</a></td>
  98 </tr>
  99 <tr>
 100 <td class="define_keyword">#define</td>
 101 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-TERMINATE-TIMEOUT:CAPS" title="TLM_CONFIG_GENERAL_TERMINATE_TIMEOUT">TLM_CONFIG_GENERAL_TERMINATE_TIMEOUT</a></td>
 102 </tr>
 103 <tr>
 104 <td class="define_keyword">#define</td>
 105 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-X11-SESSION:CAPS" title="TLM_CONFIG_GENERAL_X11_SESSION">TLM_CONFIG_GENERAL_X11_SESSION</a></td>
 106 </tr>
 107 <tr>
 108 <td class="define_keyword">#define</td>
 109 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-PAUSE-SESSION:CAPS" title="TLM_CONFIG_GENERAL_PAUSE_SESSION">TLM_CONFIG_GENERAL_PAUSE_SESSION</a></td>
 110 </tr>
 111 <tr>
 112 <td class="define_keyword">#define</td>
 113 <td class="function_name"><a class="link" href="tlm-General-configuration.html#TLM-CONFIG-GENERAL-SESSION-TYPE:CAPS" title="TLM_CONFIG_GENERAL_SESSION_TYPE">TLM_CONFIG_GENERAL_SESSION_TYPE</a></td>
 114 </tr>
 115 </tbody>
 116 </table></div>
 117 </div>
 118 <div class="refsect1">
 119 <a name="tlm-General-configuration.object-hierarchy"></a><h2>Object Hierarchy</h2>
 120 <pre class="screen">
 121 </pre>
 122 </div>
 123 <div class="refsect1">
 124 <a name="tlm-General-configuration.description"></a><h2>Description</h2>
 125 <p>General configuration keys are defined below. See <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> for how to use
 126 them.</p>
 127 </div>
 128 <div class="refsect1">
 129 <a name="tlm-General-configuration.functions_details"></a><h2>Functions</h2>
 130 </div>
 131 <div class="refsect1">
 132 <a name="tlm-General-configuration.other_details"></a><h2>Types and Values</h2>
 133 <div class="refsect2">
 134 <a name="TLM-CONFIG-GENERAL:CAPS"></a><h3>TLM_CONFIG_GENERAL</h3>
 135 <pre class="programlisting">#define TLM_CONFIG_GENERAL                  "General"
 136 </pre>
 137 <p>A prefix for general keys. Should be used only when defining new keys.</p>
 138 </div>
 139 <hr>
 140 <div class="refsect2">
 141 <a name="TLM-CONFIG-GENERAL-ACCOUNTS-PLUGIN:CAPS"></a><h3>TLM_CONFIG_GENERAL_ACCOUNTS_PLUGIN</h3>
 142 <pre class="programlisting">#define TLM_CONFIG_GENERAL_ACCOUNTS_PLUGIN  "ACCOUNTS_PLUGIN"
 143 </pre>
 144 <p>Accounts plugin (implementation of <a class="link" href="TlmAccountPlugin.html" title="TlmAccountPlugin"><span class="type">TlmAccountPlugin</span></a>) to use.
 145 Default value: "default". If Tlm has been configured with --enable-debug, the
 146 value can be overriden with TLM_ACCOUNT_PLUGIN environment variable.</p>
 147 </div>
 148 <hr>
 149 <div class="refsect2">
 150 <a name="TLM-CONFIG-GENERAL-NSEATS:CAPS"></a><h3>TLM_CONFIG_GENERAL_NSEATS</h3>
 151 <pre class="programlisting">#define TLM_CONFIG_GENERAL_NSEATS           "NSEATS"
 152 </pre>
 153 <p>Number of seats, instead seat information from systemd.</p>
 154 </div>
 155 <hr>
 156 <div class="refsect2">
 157 <a name="TLM-CONFIG-GENERAL-SESSION-CMD:CAPS"></a><h3>TLM_CONFIG_GENERAL_SESSION_CMD</h3>
 158 <pre class="programlisting">#define TLM_CONFIG_GENERAL_SESSION_CMD      "SESSION_CMD"
 159 </pre>
 160 <p>Session command line: the command run after successfull login. If the value
 161 is not defined in the config file, user's shell from /etc/passwd is used,
 162 and if that is not defined, the fallback is "systemd --user"</p>
 163 </div>
 164 <hr>
 165 <div class="refsect2">
 166 <a name="TLM-CONFIG-GENERAL-SESSION-PATH:CAPS"></a><h3>TLM_CONFIG_GENERAL_SESSION_PATH</h3>
 167 <pre class="programlisting">#define TLM_CONFIG_GENERAL_SESSION_PATH     "SESSION_PATH"
 168 </pre>
 169 <p>Default value for PATH environment variable in user's session. If not set,
 170 "/usr/local/bin:/usr/bin:/bin" is used.</p>
 171 </div>
 172 <hr>
 173 <div class="refsect2">
 174 <a name="TLM-CONFIG-GENERAL-DATA-DIRS:CAPS"></a><h3>TLM_CONFIG_GENERAL_DATA_DIRS</h3>
 175 <pre class="programlisting">#define TLM_CONFIG_GENERAL_DATA_DIRS        "XDG_DATA_DIRS"
 176 </pre>
 177 <p>Default value for XDG_DATA_DIRS environment variable. If not set,
 178 "/usr/share:/usr/local/share" is used.</p>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="TLM-CONFIG-GENERAL-AUTO-LOGIN:CAPS"></a><h3>TLM_CONFIG_GENERAL_AUTO_LOGIN</h3>
 183 <pre class="programlisting">#define TLM_CONFIG_GENERAL_AUTO_LOGIN       "AUTO_LOGIN"
 184 </pre>
 185 <p>Autologin to default user : TRUE/FALSE. TRUE if value is not set</p>
 186 <p>Whether to automatically log in the default user on startup and when another
 187 user session has been terminated.</p>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="TLM-CONFIG-GENERAL-PREPARE-DEFAULT:CAPS"></a><h3>TLM_CONFIG_GENERAL_PREPARE_DEFAULT</h3>
 192 <pre class="programlisting">#define TLM_CONFIG_GENERAL_PREPARE_DEFAULT  "PREPARE_DEFAULT"
 193 </pre>
 194 <p>Prepare default user before auto-login: TRUE/FALSE (FALSE if value not set).</p>
 195 <p>If set to TRUE, methods of <a class="link" href="TlmAccountPlugin.html" title="TlmAccountPlugin"><span class="type">TlmAccountPlugin</span></a> are used to set up the default
 196 user's account before auto-login.</p>
 197 </div>
 198 <hr>
 199 <div class="refsect2">
 200 <a name="TLM-CONFIG-GENERAL-PAM-SERVICE:CAPS"></a><h3>TLM_CONFIG_GENERAL_PAM_SERVICE</h3>
 201 <pre class="programlisting">#define TLM_CONFIG_GENERAL_PAM_SERVICE      "PAM_SERVICE"
 202 </pre>
 203 <p>PAM service file to use for authentication and session setup. Default value: "tlm-login".</p>
 204 </div>
 205 <hr>
 206 <div class="refsect2">
 207 <a name="TLM-CONFIG-GENERAL-DEFAULT-PAM-SERVICE:CAPS"></a><h3>TLM_CONFIG_GENERAL_DEFAULT_PAM_SERVICE</h3>
 208 <pre class="programlisting">#define TLM_CONFIG_GENERAL_DEFAULT_PAM_SERVICE "DEFAULT_PAM_SERVICE"
 209 </pre>
 210 <p>PAM service file to use for default user authentication and session setup. Default value: "tlm-default-login".</p>
 211 </div>
 212 <hr>
 213 <div class="refsect2">
 214 <a name="TLM-CONFIG-GENERAL-DEFAULT-USER:CAPS"></a><h3>TLM_CONFIG_GENERAL_DEFAULT_USER</h3>
 215 <pre class="programlisting">#define TLM_CONFIG_GENERAL_DEFAULT_USER     "DEFAULT_USER"
 216 </pre>
 217 <p>Default username for autologin. Default value: "guest".</p>
 218 <p>The value can include: %S - seat number, %I - seat id string.</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="TLM-CONFIG-GENERAL-SETUP-TERMINAL:CAPS"></a><h3>TLM_CONFIG_GENERAL_SETUP_TERMINAL</h3>
 223 <pre class="programlisting">#define TLM_CONFIG_GENERAL_SETUP_TERMINAL   "SETUP_TERMINAL"
 224 </pre>
 225 <p>Setup terminal while creating session : TRUE/FALSE. (TRUE if not set).</p>
 226 <p>Whether to connect the standard input, output and error streams for a newly
 227 created session to the terminal device.</p>
 228 </div>
 229 <hr>
 230 <div class="refsect2">
 231 <a name="TLM-CONFIG-GENERAL-SETUP-RUNTIME-DIR:CAPS"></a><h3>TLM_CONFIG_GENERAL_SETUP_RUNTIME_DIR</h3>
 232 <pre class="programlisting">#define TLM_CONFIG_GENERAL_SETUP_RUNTIME_DIR "SETUP_RUNTIME_DIR"
 233 </pre>
 234 <p>Setup XDG_RUNTIME_DIR for the user.</p>
 235 </div>
 236 <hr>
 237 <div class="refsect2">
 238 <a name="TLM-CONFIG-GENERAL-RUNTIME-MODE:CAPS"></a><h3>TLM_CONFIG_GENERAL_RUNTIME_MODE</h3>
 239 <pre class="programlisting">#define TLM_CONFIG_GENERAL_RUNTIME_MODE     "RUNTIME_MODE"
 240 </pre>
 241 <p>Access mode for the XDG_RUNTIME_DIR.</p>
 242 </div>
 243 <hr>
 244 <div class="refsect2">
 245 <a name="TLM-CONFIG-GENERAL-TERMINATE-TIMEOUT:CAPS"></a><h3>TLM_CONFIG_GENERAL_TERMINATE_TIMEOUT</h3>
 246 <pre class="programlisting">#define TLM_CONFIG_GENERAL_TERMINATE_TIMEOUT "TERMINATE_TIMEOUT"
 247 </pre>
 248 <p>Timeout for session termination in seconds. Default value: 10</p>
 249 <p>Specifies timeout between sending different termination signals in case
 250 the previous signal wasn't obeyed.</p>
 251 </div>
 252 <hr>
 253 <div class="refsect2">
 254 <a name="TLM-CONFIG-GENERAL-X11-SESSION:CAPS"></a><h3>TLM_CONFIG_GENERAL_X11_SESSION</h3>
 255 <pre class="programlisting">#define TLM_CONFIG_GENERAL_X11_SESSION      "X11_SESSION"
 256 </pre>
 257 <p>Use X11 style sessions. Default value: 0</p>
 258 <p>Switches session handling style to X11 sessions where display manager
 259 is terminated and Xserver restarted for each session.</p>
 260 </div>
 261 <hr>
 262 <div class="refsect2">
 263 <a name="TLM-CONFIG-GENERAL-PAUSE-SESSION:CAPS"></a><h3>TLM_CONFIG_GENERAL_PAUSE_SESSION</h3>
 264 <pre class="programlisting">#define TLM_CONFIG_GENERAL_PAUSE_SESSION    "PAUSE_SESSION"
 265 </pre>
 266 <p>Do not actually launch anything after creating session, let systemd
 267 handle it through PAM.</p>
 268 </div>
 269 <hr>
 270 <div class="refsect2">
 271 <a name="TLM-CONFIG-GENERAL-SESSION-TYPE:CAPS"></a><h3>TLM_CONFIG_GENERAL_SESSION_TYPE</h3>
 272 <pre class="programlisting">#define TLM_CONFIG_GENERAL_SESSION_TYPE     "SESSION_TYPE"
 273 </pre>
 274 <p>Specify session type, one of "unspecified", "tty", "x11", "wayland" or
 275 "mir".</p>
 276 </div>
 277 </div>
 278 </div>
 279 <div class="footer">
 280 <hr>
 281           Generated by GTK-Doc V1.20</div>
 282 </body>
 283 </html>