docs/html/gsignond-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>gsignond API Reference Manual: General configuration</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
   8 <link rel="up" href="ch02.html" title="GSignond configuration">
   9 <link rel="prev" href="GSignondConfig.html" title="GSignondConfig">
  10 <link rel="next" href="gsignond-DBus-configuration.html" title="DBus 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="#gsignond-General-configuration.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#gsignond-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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="GSignondConfig.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="gsignond-DBus-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="gsignond-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="gsignond-General-configuration.top_of_page"></a>General configuration</span></h2>
  31 <p>General configuration — gSSO 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="gsignond-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="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL:CAPS" title="GSIGNOND_CONFIG_GENERAL">GSIGNOND_CONFIG_GENERAL</a></td>
  46 </tr>
  47 <tr>
  48 <td class="define_keyword">#define</td>
  49 <td class="function_name"><a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS" title="GSIGNOND_CONFIG_GENERAL_STORAGE_PATH">GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</a></td>
  50 </tr>
  51 <tr>
  52 <td class="define_keyword">#define</td>
  53 <td class="function_name"><a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS" title="GSIGNOND_CONFIG_GENERAL_EXTENSION">GSIGNOND_CONFIG_GENERAL_EXTENSION</a></td>
  54 </tr>
  55 <tr>
  56 <td class="define_keyword">#define</td>
  57 <td class="function_name"><a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_SECURE_DIR">GSIGNOND_CONFIG_GENERAL_SECURE_DIR</a></td>
  58 </tr>
  59 <tr>
  60 <td class="define_keyword">#define</td>
  61 <td class="function_name"><a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_PLUGIN_TIMEOUT">GSIGNOND_CONFIG_PLUGIN_TIMEOUT</a></td>
  62 </tr>
  63 <tr>
  64 <td class="define_keyword">#define</td>
  65 <td class="function_name"><a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-KEYCHAIN-SYSCTX:CAPS" title="GSIGNOND_CONFIG_GENERAL_KEYCHAIN_SYSCTX">GSIGNOND_CONFIG_GENERAL_KEYCHAIN_SYSCTX</a></td>
  66 </tr>
  67 </tbody>
  68 </table></div>
  69 </div>
  70 <div class="refsect1">
  71 <a name="gsignond-General-configuration.object-hierarchy"></a><h2>Object Hierarchy</h2>
  72 <pre class="screen">
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="gsignond-General-configuration.includes"></a><h2>Includes</h2>
  77 <pre class="synopsis">#include &lt;gsignond/gsignond-config.h&gt;
  78 </pre>
  79 </div>
  80 <div class="refsect1">
  81 <a name="gsignond-General-configuration.description"></a><h2>Description</h2>
  82 <p>General configuration keys are defined below. See <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> for how to use them.</p>
  83 </div>
  84 <div class="refsect1">
  85 <a name="gsignond-General-configuration.functions_details"></a><h2>Functions</h2>
  86 </div>
  87 <div class="refsect1">
  88 <a name="gsignond-General-configuration.other_details"></a><h2>Types and Values</h2>
  89 <div class="refsect2">
  90 <a name="GSIGNOND-CONFIG-GENERAL:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL</h3>
  91 <pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL                 "General"
  92 </pre>
  93 <p>A prefix for general keys. Should be used only when defining new keys.</p>
  94 </div>
  95 <hr>
  96 <div class="refsect2">
  97 <a name="GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</h3>
  98 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</pre>
  99 <p>Base path for <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> to operate in.</p>
 100 <p>Default value: "/var/db", can be overriden in debug
 101 builds by setting SSO_STORAGE_PATH environment variable.</p>
 102 </div>
 103 <hr>
 104 <div class="refsect2">
 105 <a name="GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_EXTENSION</h3>
 106 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_EXTENSION</pre>
 107 <p>The name of the gSSO extension to use. If not specified, the default
 108 implementation is used (see <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a>).</p>
 109 <p>Can be overriden in debug
 110 builds by setting SSO_EXTENSION environment variable.</p>
 111 </div>
 112 <hr>
 113 <div class="refsect2">
 114 <a name="GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_SECURE_DIR</h3>
 115 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_SECURE_DIR</pre>
 116 <p>Path provided by <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> for storing user-specific
 117 information, including secret and metadata databases.</p>
 118 <p>This is a run-time value and any value read from configuration file
 119 is overwritten.</p>
 120 <p>Value provided by the default implementation:
 121 <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS" title="GSIGNOND_CONFIG_GENERAL_STORAGE_PATH"><span class="type">GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</span></a> + "/gsignond." + <a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Utility-Functions.html#g-get-user-name"><code class="function">g_get_user_name()</code></a>.</p>
 122 </div>
 123 <hr>
 124 <div class="refsect2">
 125 <a name="GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS"></a><h3>GSIGNOND_CONFIG_PLUGIN_TIMEOUT</h3>
 126 <pre class="programlisting">#define             GSIGNOND_CONFIG_PLUGIN_TIMEOUT</pre>
 127 <p>A timeout in seconds, after which inactive plugin objects and processes are removed.
 128 If not set, the plugin objects will persist for possible reuse.</p>
 129 <p>Can be overriden in debug
 130 builds by setting SSO_PLUGIN_TIMEOUT environment variable.</p>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="GSIGNOND-CONFIG-GENERAL-KEYCHAIN-SYSCTX:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_KEYCHAIN_SYSCTX</h3>
 135 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_KEYCHAIN_SYSCTX</pre>
 136 <p>System security context of the keychain UI process
 137 (see <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a>).</p>
 138 <p>Default value can be defined through configure --enable-keychain flag (see</p>
 139 <a class="link" href="gsignond-building.html" title="Building and installing the gsignond daemon">Building gsignond</a>).
 140 </div>
 141 </div>
 142 </div>
 143 <div class="footer">
 144 <hr>
 145           Generated by GTK-Doc V1.20</div>
 146 </body>
 147 </html>