Move existing samba4 documentation to Samba-docs trunk
[Samba.git] / docs / manpages-4 / ldb.7.xml
blobaae16806f045438cef2f9283a048d37a4ebc300a
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="ldb.7">
5 <refmeta>
6         <refentrytitle>ldb</refentrytitle>
7         <manvolnum>7</manvolnum>
8 </refmeta>
11 <refnamediv>
12         <refname>ldb</refname>
13         <refpurpose>Lightweight DataBase</refpurpose>
14 </refnamediv>
16 <refsect1>
17         <title>DESCRIPTION</title>
19         <para>Ldb is a library providing simple LDAP-like database system that 
20                 can use either tdb or LDAP as its backend. It's internal API is similar to 
21         that of LDAP.</para>
23         <para>ldb is used heavily in Samba 4. It's aim is to provide a LDAP-like 
24                 database system at all times, even when no LDAP server is available.
25         </para>
26 </refsect1>
28 <refsect1>
29         <title>LDB URLS</title>
31         <para>FIXME</para>
33 </refsect1>
35 <refsect1>
36         <title>FUNCTIONS</title>
38         <variablelist>
39                 <varlistentry><term>ldb_connect(2)</term>
40                         <listitem><para>
41                                         Connect to an LDAP server or local LDB database stored in TDB.
42                         </para></listitem>
43                 </varlistentry>
44                 <varlistentry><term>ldb_close(2)</term>
45                         <listitem><para>
46                                         Close connection to the server.
47                         </para></listitem>
48                 </varlistentry>
49                 <varlistentry><term>ldb_search(2)</term>
50                         <listitem><para>
51                                         Search for specified attributes of records that match a LDAP-like search string.
52                         </para></listitem>
53                 </varlistentry>
54                 <varlistentry><term>ldb_search_free(2)</term>
55                         <listitem><para>
56                                         Free search results.
57                         </para></listitem>
58                 </varlistentry>
59                 <varlistentry><term>ldb_add(2)</term>
60                         <listitem><para>
61                                         Add records.
62                         </para></listitem>
63                 </varlistentry>
64                 <varlistentry><term>ldb_modify(2)</term>
65                         <listitem><para>
66                                         Modify records.
67                         </para></listitem>
68                 </varlistentry>
69                 <varlistentry><term>ldb_delete(2)</term>
70                         <listitem><para>
71                                         Delete records.
72                         </para></listitem>
73                 </varlistentry>
74                 <varlistentry><term>ldb_errstring(2)</term>
75                         <listitem><para>
76                                         Return extended error information from last call.
77                         </para></listitem>
78                 </varlistentry>
79                 <varlistentry><term>ldb_casefold(2)</term>
80                         <listitem><para>
81                                         Casefold a string.
82                         </para></listitem>
83                 </varlistentry>
84                 <!-- FIXME -->
85         </variablelist>
86 </refsect1>
88 <refsect1>
89         <title>PERFORMANCE</title>
91         <para>FIXME</para>
92 </refsect1>
94 <refsect1>
95         <title>COMPATIBILITY WITH LDAP</title>
96         <para>FIXME</para>
97 </refsect1>
99 <refsect1>
100         <title>SEE ALSO</title>
102         <para>ldap</para>
103 </refsect1>
105 <refsect1>
106         <title>VERSION</title>
108         <para>This man page is correct for version 4.0 of the Samba suite.</para>
109 </refsect1>
111 <refsect1>
112         <title>AUTHOR</title>
114         <para>ldb was written by Andrew Tridgell. </para>
116         <para>This manpage was written by Jelmer Vernooij. </para>
117         
118 </refsect1>
120 </refentry>