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>General configuration</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.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-Database-configuration.html" title="Database configuration">
  11 <meta name="generator" content="GTK-Doc V1.19.1 (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">
  17 <a href="#" class="shortcut">Top</a>
  18                    |
  19                   <a href="#gsignond-General-configuration.description" class="shortcut">Description</a>
  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-Database-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 valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsynopsisdiv">
  36 <a name="gsignond-General-configuration.synopsis"></a><h2>Synopsis</h2>
  37 <pre class="synopsis">
  38 #include &lt;gsignond/gsignond-config.h&gt;
  39
  40 #define             <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL:CAPS" title="GSIGNOND_CONFIG_GENERAL">GSIGNOND_CONFIG_GENERAL</a>
  41 #define             <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-BIN-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_BIN_DIR">GSIGNOND_CONFIG_GENERAL_BIN_DIR</a>
  42 #define             <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS" title="GSIGNOND_CONFIG_GENERAL_EXTENSION">GSIGNOND_CONFIG_GENERAL_EXTENSION</a>
  43 #define             <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSIONS-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR">GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR</a>
  44 #define             <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-PLUGINS-DIR:CAPS" title="GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR">GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR</a>
  45 #define             <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>
  46 #define             <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>
  47 #define             <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_PLUGIN_TIMEOUT">GSIGNOND_CONFIG_PLUGIN_TIMEOUT</a>
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="gsignond-General-configuration.description"></a><h2>Description</h2>
  52 <p>
  53 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.
  54 </p>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gsignond-General-configuration.details"></a><h2>Details</h2>
  58 <div class="refsect2">
  59 <a name="GSIGNOND-CONFIG-GENERAL:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL</h3>
  60 <pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL                 "General"
  61 </pre>
  62 <p>
  63 A prefix for general keys. Should be used only when defining new keys.
  64 </p>
  65 </div>
  66 <hr>
  67 <div class="refsect2">
  68 <a name="GSIGNOND-CONFIG-GENERAL-BIN-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_BIN_DIR</h3>
  69 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_BIN_DIR</pre>
  70 <p>
  71 The path where gSSO is looking for the gsignond-plugind binary when it needs
  72 to start a plugin process. Can be used for finding other supplementary binaries in
  73 the future.
  74 </p>
  75 <p>
  76 Default value: $(bindir), can be overriden in debug
  77 builds by setting SSO_BIN_DIR environment variable.
  78 </p>
  79 </div>
  80 <hr>
  81 <div class="refsect2">
  82 <a name="GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_EXTENSION</h3>
  83 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_EXTENSION</pre>
  84 <p>
  85 The name of the gSSO extension to use. If not specified, the default
  86 implementation is used (see <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a>).
  87 </p>
  88 <p>
  89 Can be overriden in debug
  90 builds by setting SSO_EXTENSION environment variable.
  91 </p>
  92 </div>
  93 <hr>
  94 <div class="refsect2">
  95 <a name="GSIGNOND-CONFIG-GENERAL-EXTENSIONS-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR</h3>
  96 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR</pre>
  97 <p>
  98 The path where gSSO is looking for available extension modules.
  99 </p>
 100 <p>
 101 Default value: $(pkglibdir)/extensions, can be overriden in debug
 102 builds by setting SSO_EXTENSIONS_DIR environment variable.
 103 </p>
 104 </div>
 105 <hr>
 106 <div class="refsect2">
 107 <a name="GSIGNOND-CONFIG-GENERAL-PLUGINS-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR</h3>
 108 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR</pre>
 109 <p>
 110 The path where gSSO is looking for available plugins.
 111 </p>
 112 <p>
 113 Default value: $(pkglibdir)/plugins, can be overriden in debug
 114 builds by setting SSO_PLUGINS_DIR environment variable.
 115 </p>
 116 </div>
 117 <hr>
 118 <div class="refsect2">
 119 <a name="GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_SECURE_DIR</h3>
 120 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_SECURE_DIR</pre>
 121 <p>
 122 Path provided by <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> for storing user-specific
 123 information, including secret and metadata databases.
 124 </p>
 125 <p>
 126 Value provided by the default implementation:
 127 <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>.
 128 </p>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</h3>
 133 <pre class="programlisting">#define             GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</pre>
 134 <p>
 135 Base path for <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> to operate in.
 136 </p>
 137 <p>
 138 Default value: "/var/db", can be overriden in debug
 139 builds by setting SSO_STORAGE_PATH environment variable.
 140 </p>
 141 </div>
 142 <hr>
 143 <div class="refsect2">
 144 <a name="GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS"></a><h3>GSIGNOND_CONFIG_PLUGIN_TIMEOUT</h3>
 145 <pre class="programlisting">#define             GSIGNOND_CONFIG_PLUGIN_TIMEOUT</pre>
 146 <p>
 147 A timeout in seconds, after which inactive plugin objects and processes are removed.
 148 If not set, the plugin objects will persist for possible reuse.
 149 </p>
 150 <p>
 151 Can be overriden in debug
 152 builds by setting SSO_PLUGIN_TIMEOUT environment variable.
 153 </p>
 154 </div>
 155 </div>
 156 </div>
 157 <div class="footer">
 158 <hr>
 159           Generated by GTK-Doc V1.19.1</div>
 160 </body>
 161 </html>