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>Tizen 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="Tizen 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="gdbus-org.tizen.Tlm.Login.html" title="org.tizen.Tlm.Login">
  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="gdbus-org.tizen.Tlm.Login.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-SESSION-CMD:CAPS" title="TLM_CONFIG_GENERAL_SESSION_CMD">TLM_CONFIG_GENERAL_SESSION_CMD</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-PATH:CAPS" title="TLM_CONFIG_GENERAL_SESSION_PATH">TLM_CONFIG_GENERAL_SESSION_PATH</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-DATA-DIRS:CAPS" title="TLM_CONFIG_GENERAL_DATA_DIRS">TLM_CONFIG_GENERAL_DATA_DIRS</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-AUTO-LOGIN:CAPS" title="TLM_CONFIG_GENERAL_AUTO_LOGIN">TLM_CONFIG_GENERAL_AUTO_LOGIN</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-PREPARE-DEFAULT:CAPS" title="TLM_CONFIG_GENERAL_PREPARE_DEFAULT">TLM_CONFIG_GENERAL_PREPARE_DEFAULT</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-PAM-SERVICE:CAPS" title="TLM_CONFIG_GENERAL_PAM_SERVICE">TLM_CONFIG_GENERAL_PAM_SERVICE</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-DEFAULT-PAM-SERVICE:CAPS" title="TLM_CONFIG_GENERAL_DEFAULT_PAM_SERVICE">TLM_CONFIG_GENERAL_DEFAULT_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-USER:CAPS" title="TLM_CONFIG_GENERAL_DEFAULT_USER">TLM_CONFIG_GENERAL_DEFAULT_USER</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-SETUP-TERMINAL:CAPS" title="TLM_CONFIG_GENERAL_SETUP_TERMINAL">TLM_CONFIG_GENERAL_SETUP_TERMINAL</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-TERMINATE-TIMEOUT:CAPS" title="TLM_CONFIG_GENERAL_TERMINATE_TIMEOUT">TLM_CONFIG_GENERAL_TERMINATE_TIMEOUT</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-X11-SESSION:CAPS" title="TLM_CONFIG_GENERAL_X11_SESSION">TLM_CONFIG_GENERAL_X11_SESSION</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-PAUSE-SESSION:CAPS" title="TLM_CONFIG_GENERAL_PAUSE_SESSION">TLM_CONFIG_GENERAL_PAUSE_SESSION</a></td>
  98 </tr>
  99 </tbody>
 100 </table></div>
 101 </div>
 102 <div class="refsect1">
 103 <a name="tlm-General-configuration.object-hierarchy"></a><h2>Object Hierarchy</h2>
 104 <pre class="screen">
 105 </pre>
 106 </div>
 107 <div class="refsect1">
 108 <a name="tlm-General-configuration.description"></a><h2>Description</h2>
 109 <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
 110 them.</p>
 111 </div>
 112 <div class="refsect1">
 113 <a name="tlm-General-configuration.functions_details"></a><h2>Functions</h2>
 114 </div>
 115 <div class="refsect1">
 116 <a name="tlm-General-configuration.other_details"></a><h2>Types and Values</h2>
 117 <div class="refsect2">
 118 <a name="TLM-CONFIG-GENERAL:CAPS"></a><h3>TLM_CONFIG_GENERAL</h3>
 119 <pre class="programlisting">#define TLM_CONFIG_GENERAL                  "General"
 120 </pre>
 121 <p>A prefix for general keys. Should be used only when defining new keys.</p>
 122 </div>
 123 <hr>
 124 <div class="refsect2">
 125 <a name="TLM-CONFIG-GENERAL-ACCOUNTS-PLUGIN:CAPS"></a><h3>TLM_CONFIG_GENERAL_ACCOUNTS_PLUGIN</h3>
 126 <pre class="programlisting">#define TLM_CONFIG_GENERAL_ACCOUNTS_PLUGIN  "ACCOUNTS_PLUGIN"
 127 </pre>
 128 <p>Accounts plugin (implementation of <a class="link" href="TlmAccountPlugin.html" title="TlmAccountPlugin"><span class="type">TlmAccountPlugin</span></a>) to use.
 129 Default value: "default". If Tlm has been configured with --enable-debug, the
 130 value can be overriden with TLM_ACCOUNT_PLUGIN environment variable.</p>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="TLM-CONFIG-GENERAL-SESSION-CMD:CAPS"></a><h3>TLM_CONFIG_GENERAL_SESSION_CMD</h3>
 135 <pre class="programlisting">#define TLM_CONFIG_GENERAL_SESSION_CMD      "SESSION_CMD"
 136 </pre>
 137 <p>Session command line: the command run after successfull login. If the value
 138 is not defined in the config file, user's shell from /etc/passwd is used,
 139 and if that is not defined, the fallback is "systemd --user"</p>
 140 </div>
 141 <hr>
 142 <div class="refsect2">
 143 <a name="TLM-CONFIG-GENERAL-SESSION-PATH:CAPS"></a><h3>TLM_CONFIG_GENERAL_SESSION_PATH</h3>
 144 <pre class="programlisting">#define TLM_CONFIG_GENERAL_SESSION_PATH     "SESSION_PATH"
 145 </pre>
 146 <p>Default value for PATH environment variable in user's session. If not set,
 147 "/usr/local/bin:/usr/bin:/bin" is used.</p>
 148 </div>
 149 <hr>
 150 <div class="refsect2">
 151 <a name="TLM-CONFIG-GENERAL-DATA-DIRS:CAPS"></a><h3>TLM_CONFIG_GENERAL_DATA_DIRS</h3>
 152 <pre class="programlisting">#define TLM_CONFIG_GENERAL_DATA_DIRS        "XDG_DATA_DIRS"
 153 </pre>
 154 <p>Default value for XDG_DATA_DIRS environment variable. If not set,
 155 "/usr/share:/usr/local/share" is used.</p>
 156 </div>
 157 <hr>
 158 <div class="refsect2">
 159 <a name="TLM-CONFIG-GENERAL-AUTO-LOGIN:CAPS"></a><h3>TLM_CONFIG_GENERAL_AUTO_LOGIN</h3>
 160 <pre class="programlisting">#define TLM_CONFIG_GENERAL_AUTO_LOGIN       "AUTO_LOGIN"
 161 </pre>
 162 <p>Autologin to default user : TRUE/FALSE. TRUE if value is not set</p>
 163 <p>Whether to automatically log in the default user on startup and when another
 164 user session has been terminated.</p>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="TLM-CONFIG-GENERAL-PREPARE-DEFAULT:CAPS"></a><h3>TLM_CONFIG_GENERAL_PREPARE_DEFAULT</h3>
 169 <pre class="programlisting">#define TLM_CONFIG_GENERAL_PREPARE_DEFAULT  "PREPARE_DEFAULT"
 170 </pre>
 171 <p>Prepare default user before auto-login: TRUE/FALSE (FALSE if value not set).</p>
 172 <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
 173 user's account before auto-login.</p>
 174 </div>
 175 <hr>
 176 <div class="refsect2">
 177 <a name="TLM-CONFIG-GENERAL-PAM-SERVICE:CAPS"></a><h3>TLM_CONFIG_GENERAL_PAM_SERVICE</h3>
 178 <pre class="programlisting">#define TLM_CONFIG_GENERAL_PAM_SERVICE      "PAM_SERVICE"
 179 </pre>
 180 <p>PAM service file to use for authentication and session setup. Default value: "tlm-login".</p>
 181 </div>
 182 <hr>
 183 <div class="refsect2">
 184 <a name="TLM-CONFIG-GENERAL-DEFAULT-PAM-SERVICE:CAPS"></a><h3>TLM_CONFIG_GENERAL_DEFAULT_PAM_SERVICE</h3>
 185 <pre class="programlisting">#define TLM_CONFIG_GENERAL_DEFAULT_PAM_SERVICE "DEFAULT_PAM_SERVICE"
 186 </pre>
 187 <p>PAM service file to use for default user authentication and session setup. Default value: "tlm-default-login".</p>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="TLM-CONFIG-GENERAL-DEFAULT-USER:CAPS"></a><h3>TLM_CONFIG_GENERAL_DEFAULT_USER</h3>
 192 <pre class="programlisting">#define TLM_CONFIG_GENERAL_DEFAULT_USER     "DEFAULT_USER"
 193 </pre>
 194 <p>Default username for autologin. Default value: "guest".</p>
 195 <p>The value can include: %S - seat number, %I - seat id string.</p>
 196 </div>
 197 <hr>
 198 <div class="refsect2">
 199 <a name="TLM-CONFIG-GENERAL-SETUP-TERMINAL:CAPS"></a><h3>TLM_CONFIG_GENERAL_SETUP_TERMINAL</h3>
 200 <pre class="programlisting">#define TLM_CONFIG_GENERAL_SETUP_TERMINAL   "SETUP_TERMINAL"
 201 </pre>
 202 <p>Setup terminal while creating session : TRUE/FALSE. (TRUE if not set).</p>
 203 <p>Whether to connect the standard input, output and error streams for a newly
 204 created session to the terminal device.</p>
 205 </div>
 206 <hr>
 207 <div class="refsect2">
 208 <a name="TLM-CONFIG-GENERAL-TERMINATE-TIMEOUT:CAPS"></a><h3>TLM_CONFIG_GENERAL_TERMINATE_TIMEOUT</h3>
 209 <pre class="programlisting">#define TLM_CONFIG_GENERAL_TERMINATE_TIMEOUT "TERMINATE_TIMEOUT"
 210 </pre>
 211 <p>Timeout for session termination in seconds. Default value: 10</p>
 212 <p>Specifies timeout between sending different termination signals in case
 213 the previous signal wasn't obeyed.</p>
 214 </div>
 215 <hr>
 216 <div class="refsect2">
 217 <a name="TLM-CONFIG-GENERAL-X11-SESSION:CAPS"></a><h3>TLM_CONFIG_GENERAL_X11_SESSION</h3>
 218 <pre class="programlisting">#define TLM_CONFIG_GENERAL_X11_SESSION      "X11_SESSION"
 219 </pre>
 220 <p>Use X11 style sessions. Default value: 0</p>
 221 <p>Switches session handling style to X11 sessions where display manager
 222 is terminated and Xserver restarted for each session.</p>
 223 </div>
 224 <hr>
 225 <div class="refsect2">
 226 <a name="TLM-CONFIG-GENERAL-PAUSE-SESSION:CAPS"></a><h3>TLM_CONFIG_GENERAL_PAUSE_SESSION</h3>
 227 <pre class="programlisting">#define TLM_CONFIG_GENERAL_PAUSE_SESSION    "PAUSE_SESSION"
 228 </pre>
 229 <p>Do not actually launch anything after creating session, let systemd
 230 handle it through PAM.</p>
 231 </div>
 232 </div>
 233 </div>
 234 <div class="footer">
 235 <hr>
 236           Generated by GTK-Doc V1.20</div>
 237 </body>
 238 </html>