summaryrefslogtreecommitdiff
path: root/docs/manpages-4/ldb.7.xml
blob: aae16806f045438cef2f9283a048d37a4ebc300a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="ldb.7">

<refmeta>
	<refentrytitle>ldb</refentrytitle>
	<manvolnum>7</manvolnum>
</refmeta>


<refnamediv>
	<refname>ldb</refname>
	<refpurpose>Lightweight DataBase</refpurpose>
</refnamediv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>Ldb is a library providing simple LDAP-like database system that 
		can use either tdb or LDAP as its backend. It's internal API is similar to 
	that of LDAP.</para>

	<para>ldb is used heavily in Samba 4. It's aim is to provide a LDAP-like 
		database system at all times, even when no LDAP server is available.
	</para>
</refsect1>

<refsect1>
	<title>LDB URLS</title>

	<para>FIXME</para>

</refsect1>

<refsect1>
	<title>FUNCTIONS</title>

	<variablelist>
		<varlistentry><term>ldb_connect(2)</term>
			<listitem><para>
					Connect to an LDAP server or local LDB database stored in TDB.
			</para></listitem>
		</varlistentry>
		<varlistentry><term>ldb_close(2)</term>
			<listitem><para>
					Close connection to the server.
			</para></listitem>
		</varlistentry>
		<varlistentry><term>ldb_search(2)</term>
			<listitem><para>
					Search for specified attributes of records that match a LDAP-like search string.
			</para></listitem>
		</varlistentry>
		<varlistentry><term>ldb_search_free(2)</term>
			<listitem><para>
					Free search results.
			</para></listitem>
		</varlistentry>
		<varlistentry><term>ldb_add(2)</term>
			<listitem><para>
					Add records.
			</para></listitem>
		</varlistentry>
		<varlistentry><term>ldb_modify(2)</term>
			<listitem><para>
					Modify records.
			</para></listitem>
		</varlistentry>
		<varlistentry><term>ldb_delete(2)</term>
			<listitem><para>
					Delete records.
			</para></listitem>
		</varlistentry>
		<varlistentry><term>ldb_errstring(2)</term>
			<listitem><para>
					Return extended error information from last call.
			</para></listitem>
		</varlistentry>
		<varlistentry><term>ldb_casefold(2)</term>
			<listitem><para>
					Casefold a string.
			</para></listitem>
		</varlistentry>
		<!-- FIXME -->
	</variablelist>
</refsect1>

<refsect1>
	<title>PERFORMANCE</title>

	<para>FIXME</para>
</refsect1>

<refsect1>
	<title>COMPATIBILITY WITH LDAP</title>
	<para>FIXME</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>

	<para>ldap</para>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 4.0 of the Samba suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>ldb was written by Andrew Tridgell. </para>

	<para>This manpage was written by Jelmer Vernooij. </para>
	
</refsect1>

</refentry>