diff options
Diffstat (limited to 'docs/html/gsignond-General-configuration.html')
| -rw-r--r-- | docs/html/gsignond-General-configuration.html | 161 |
1 files changed, 161 insertions, 0 deletions
diff --git a/docs/html/gsignond-General-configuration.html b/docs/html/gsignond-General-configuration.html new file mode 100644 index 0000000..90875dd --- /dev/null +++ b/docs/html/gsignond-General-configuration.html @@ -0,0 +1,161 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>General configuration</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="gsignond API Reference Manual"> +<link rel="up" href="ch02.html" title="GSignond configuration"> +<link rel="prev" href="GSignondConfig.html" title="GSignondConfig"> +<link rel="next" href="gsignond-Database-configuration.html" title="Database configuration"> +<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left"> +<a href="#" class="shortcut">Top</a> + | + <a href="#gsignond-General-configuration.description" class="shortcut">Description</a> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GSignondConfig.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gsignond-Database-configuration.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gsignond-General-configuration"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gsignond-General-configuration.top_of_page"></a>General configuration</span></h2> +<p>General configuration — gSSO general configuration keys</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gsignond-General-configuration.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> +#include <gsignond/gsignond-config.h> + +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL:CAPS" title="GSIGNOND_CONFIG_GENERAL">GSIGNOND_CONFIG_GENERAL</a> +#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> +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS" title="GSIGNOND_CONFIG_GENERAL_EXTENSION">GSIGNOND_CONFIG_GENERAL_EXTENSION</a> +#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> +#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> +#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> +#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> +#define <a class="link" href="gsignond-General-configuration.html#GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS" title="GSIGNOND_CONFIG_PLUGIN_TIMEOUT">GSIGNOND_CONFIG_PLUGIN_TIMEOUT</a> +</pre> +</div> +<div class="refsect1"> +<a name="gsignond-General-configuration.description"></a><h2>Description</h2> +<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> +</div> +<div class="refsect1"> +<a name="gsignond-General-configuration.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL "General" +</pre> +<p> +A prefix for general keys. Should be used only when defining new keys. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-BIN-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_BIN_DIR</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_BIN_DIR</pre> +<p> +The path where gSSO is looking for the gsignond-plugind binary when it needs +to start a plugin process. Can be used for finding other supplementary binaries in +the future. +</p> +<p> +Default value: $(bindir), can be overriden in debug +builds by setting SSO_BIN_DIR environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-EXTENSION:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_EXTENSION</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_EXTENSION</pre> +<p> +The name of the gSSO extension to use. If not specified, the default +implementation is used (see <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a>). +</p> +<p> +Can be overriden in debug +builds by setting SSO_EXTENSION environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-EXTENSIONS-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_EXTENSIONS_DIR</pre> +<p> +The path where gSSO is looking for available extension modules. +</p> +<p> +Default value: $(pkglibdir)/extensions, can be overriden in debug +builds by setting SSO_EXTENSIONS_DIR environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-PLUGINS-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_PLUGINS_DIR</pre> +<p> +The path where gSSO is looking for available plugins. +</p> +<p> +Default value: $(pkglibdir)/plugins, can be overriden in debug +builds by setting SSO_PLUGINS_DIR environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-SECURE-DIR:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_SECURE_DIR</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_SECURE_DIR</pre> +<p> +Path provided by <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> for storing user-specific +information, including secret and metadata databases. +</p> +<p> +Value provided by the default implementation: +<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> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-GENERAL-STORAGE-PATH:CAPS"></a><h3>GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_GENERAL_STORAGE_PATH</pre> +<p> +Base path for <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> to operate in. +</p> +<p> +Default value: "/var/db", can be overriden in debug +builds by setting SSO_STORAGE_PATH environment variable. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GSIGNOND-CONFIG-PLUGIN-TIMEOUT:CAPS"></a><h3>GSIGNOND_CONFIG_PLUGIN_TIMEOUT</h3> +<pre class="programlisting">#define GSIGNOND_CONFIG_PLUGIN_TIMEOUT</pre> +<p> +A timeout in seconds, after which inactive plugin objects and processes are removed. +If not set, the plugin objects will persist for possible reuse. +</p> +<p> +Can be overriden in debug +builds by setting SSO_PLUGIN_TIMEOUT environment variable. +</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19.1</div> +</body> +</html>
\ No newline at end of file |