summaryrefslogtreecommitdiff
path: root/lib/tdb/docs
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2011-01-13 17:30:52 +0100
committerAndreas Schneider <asn@samba.org>2011-01-19 11:26:34 +0100
commitb42afa0edf375c944d39a888f4db422e8d2b13cf (patch)
treec851413d3e32f68e90c3cbce44240f2ca0b974b5 /lib/tdb/docs
parent7f87d58900c2adf4d79f4dc7859a96f1d00d819b (diff)
downloadsamba-b42afa0edf375c944d39a888f4db422e8d2b13cf.tar.gz
samba-b42afa0edf375c944d39a888f4db422e8d2b13cf.tar.bz2
samba-b42afa0edf375c944d39a888f4db422e8d2b13cf.zip
tdb: Added doxygen documentation.
Autobuild-User: Andreas Schneider <asn@samba.org> Autobuild-Date: Wed Jan 19 11:26:34 CET 2011 on sn-devel-104
Diffstat (limited to 'lib/tdb/docs')
-rw-r--r--lib/tdb/docs/mainpage.dox61
1 files changed, 61 insertions, 0 deletions
diff --git a/lib/tdb/docs/mainpage.dox b/lib/tdb/docs/mainpage.dox
new file mode 100644
index 0000000000..d130769356
--- /dev/null
+++ b/lib/tdb/docs/mainpage.dox
@@ -0,0 +1,61 @@
+/**
+
+@mainpage
+
+This is a simple database API. It was inspired by the realisation that in Samba
+we have several ad-hoc bits of code that essentially implement small databases
+for sharing structures between parts of Samba.
+
+The interface is based on gdbm. gdbm couldn't be use as we needed to be able to
+have multiple writers to the databases at one time.
+
+@section tdb_download Download
+
+You can download the latest releases of tdb from the
+<a href="http://samba.org/ftp/tdb">tdb directory</a> on the samba public source
+archive.
+
+You can download the latest code either via git or rsync.
+
+To fetch via git see the following guide:
+
+<a href="http://wiki.samba.org/index.php/Using_Git_for_Samba_Development">Using Git for Samba Development</a>
+Once you have cloned the tree switch to the master branch and cd into the source/lib/tdb directory.
+
+To fetch via rsync use these commands:
+
+<pre>
+ rsync -Pavz samba.org::ftp/unpacked/standalone_projects/lib/tdb .
+ rsync -Pavz samba.org::ftp/unpacked/standalone_projects/lib/replace .
+</pre>
+
+and build in tdb. It will find the replace library in the directory above
+automatically.
+
+@section tdb_bugs Discussion and bug reports
+
+tdb does not currently have its own mailing list or bug tracking system. For now,
+please use the
+<a href="https://lists.samba.org/mailman/listinfo/samba-technical">samba-technical</a>
+mailing list, and the <a href="http://bugzilla.samba.org/">Samba bugzilla</a> bug
+tracking system.
+
+
+@section tdb_compilation Compilation
+
+add HAVE_MMAP=1 to use mmap instead of read/write
+add NOLOCK=1 to disable locking code
+
+@section tdb_testing Testing
+
+Compile tdbtest.c and link with gdbm for testing. tdbtest will perform
+identical operations via tdb and gdbm then make sure the result is the
+same
+
+Also included is tdbtool, which allows simple database manipulation
+on the commandline.
+
+tdbtest and tdbtool are not built as part of Samba, but are included
+for completeness.
+
+*/