.\" Copyright (c) 2004 Andrey Simonenko
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)$Id: ipa_st_sdb.8,v 1.2 2006/03/21 20:24:43 simon Exp $
.\"
.TH IPA_ST_SDB 8 "April 26, 2005"
.SH NAME
ipa_st_sdb\ \-\ IPA simple database module (statistics part)
.SH DESCRIPTION
\fBipa_st_sdb\fP is an IPA statistics module, this module is the statistics
part for the database module ipa_db_sdb(8), so it has the same features
as its database part.
.PP
Usually binary implementation of the \fBipa_st_sdb\fP module is saved in the
\fIipa_st_sdb.so\fP.
The name of the database is \fBsdb\fP.
.SH CONFIGURATION FILE FORMAT
Configuration for the module is integrated to the ipa.conf(5).
The configuration prefix of this module is \fBsdb\fP.
.PP
The \fBdb_dir\fP parameter allows to change default database directory
\fI/var/ipa_sdb\fP:
.PP
.nf
	sdb:db_dir = "/path/to/directory";
.fi
.PP
This parameter can be placed in \fBglobal\fP or \fBrule\fP section.
Since it can be placed in the \fBrule\fP section, then any rule can
have own base directory for its database files and directories.
.PP
Next parameters can be placed only in the null module's section:
.PP
.nf
	sdb: {
	    /* Parameters. */
	}
.fi
.PP
By default the module does not expect that some directory or a file
in the database is a symlink, but it is possible to allow or disallow
symlinks in the \fBallow_symlinks\fP parameter:
.PP
.nf
	allow_symlinks = <boolean>;
.fi
.PP
The default value of this parameter is ``no''.
.PP
By default each base directory for the database has special file,
which contains the version number of the database format and the module
checks version saved in this file.
To speedup a bit the module in case if there are many rules it is possible
to turn off database format version checking by the \fBcheck_version\fP
parameter:
.PP
.nf
	check_version = <boolean>;
.fi
.PP
The default value of this parameter is ``yes''.
It is recommended not to turn off database format version checking.
.PP
By default the module is very quiet and does not send any log messages
until any error occurs, if it is needed to see all messages from 
the module, then set the value of the \fBquiet\fP parameter to ``no'':
.PP
.nf
	quiet = <boolean>;
.fi
.PP
The default value of this parameter is ``yes''.
.PP
\fIExample:\fP
.PP
.nf
	st_mod "ipa_st_sdb.so";

	global {
	    /* ... */
	    st_list sdb;
	    sdb:db_dir = "/var/db/ipa_sdb";
	}

	rule 1 {
	    /* ... */
	}

	rule 2 {
	    /* ... */
	    sdb:db_dir = "/home/my/ipa_sdb";
	}
.fi
.PP
First rule inherits value of the \fBdb_dir\fP parameter from the
\fBglobal\fP section.
Second rule has own value for this parameter.
All dynamic rules will inherit the value of the \fBdb_dir\fP parameter
from the \fBglobal\fP section.
.SH SEE ALSO
ipa_sdb(5), ipa_db_sdb(8), ipa_sdb_dump(8)
.SH AUTHOR
Andrey\ Simonenko\ <simon@comsys.ntu-kpi.kiev.ua>
.SH BUGS
If you find any, please send email me.