r7114: Convert ldb documentation to DocBook/XML

(This used to be commit 470c6185fb815983aebffd313361ec0fac723fd0)

4 files changed, 273 insertions, 135 deletions

diff --git a/source4/lib/ldb/Makefile.in b/source4/lib/ldb/Makefile.in
index e7bde04658..4d93edb884 100644
--- a/source4/lib/ldb/Makefile.in
+++ b/source4/lib/ldb/Makefile.in
@@ -1,6 +1,6 @@
 CC = @CC@
 GCOV = @GCOV@
-YODL2MAN = @YODL2MAN@
+XSLTPROC = @XSLTPROC@
 prefix = @prefix@
 exec_prefix = @exec_prefix@
 includedir = @includedir@
@@ -90,11 +90,16 @@ bin/ldbtest: tools/ldbtest.o $(LIBS)
 
 .SUFFIXES: .1 .2 .3 .yo
 
-.yo.3: 
-	echo Creating $@ from $<
-	-$(YODL2MAN) -o $@ `dirname $<`/`basename $< .yo` || rm -f $@
+%.3: %.3.xml
+	test -z "$(XSLTPROC)" || $(XSLTPROC) -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
 
-manpages: $(patsubst %.yo,%.3,$(wildcard man/man3/*.yo))
+%.1: %.1.xml
+	test -z "$(XSLTPROC)" || $(XSLTPROC) -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+%.html: %.xml
+	test -z "$(XSLTPROC)" || $(XSLTPROC) -o $@ http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $<
+
+manpages: $(patsubst %.xml,%,$(wildcard man/*/*.xml))
 
 clean:
 	rm -f */*.o *.gcov */*.gc?? *~ */*~ $(BINS) $(TDB_OBJ) $(TALLOC_OBJ) $(LDB_LIB) man/man?/*.[13]
diff --git a/source4/lib/ldb/configure.in b/source4/lib/ldb/configure.in
index a04ae00690..aec149360b 100644
--- a/source4/lib/ldb/configure.in
+++ b/source4/lib/ldb/configure.in
@@ -19,7 +19,7 @@ AC_ARG_ENABLE(gcov,
 AC_SUBST(WITH_GCOV)
 AC_PROG_CC
 AC_FUNC_MMAP
-AC_PATH_PROG(YODL2MAN,yodl2man)
+AC_PATH_PROG(XSLTPROC,xsltproc)
 AC_PATH_PROG(GCOV,gcov)
 AC_CHECK_HEADERS(stdint.h)
 AC_CONFIG_HEADER(include/config.h)
diff --git a/source4/lib/ldb/man/man3/ldb.3.xml b/source4/lib/ldb/man/man3/ldb.3.xml
new file mode 100644
index 0000000000..d9ed135f20
--- /dev/null
+++ b/source4/lib/ldb/man/man3/ldb.3.xml
@@ -0,0 +1,262 @@
+<?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.3">
+
+<refmeta>
+	<refentrytitle>ldb</refentrytitle>
+	<manvolnum>3</manvolnum>
+</refmeta>
+
+<refnamediv>
+	<refname>ldb</refname>
+	<refclass>The Samba Project</refclass>
+	<refpurpose>A light-weight database library</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<synopsis>#include &lt;ldb.h&gt;</synopsis>
+</refsynopsisdiv>
+
+<refsect1>
+	<title>description</title>
+
+	<para>
+ldb is a light weight embedded database library and API. With a
+programming interface that is very similar to LDAP, ldb can store its
+data either in a tdb(3) database or in a real LDAP database.
+	</para>
+
+	<para>
+When used with the tdb backend ldb does not require any database
+daemon. Instead, ldb function calls are processed immediately by the
+ldb library, which does IO directly on the database, while allowing
+multiple readers/writers using operating system byte range locks. This
+leads to an API with very low overheads, often resulting in speeds of
+more than 10x what can be achieved with a more traditional LDAP
+architecture.
+	</para>
+
+	<para>
+It a taxonomy of databases ldb would sit half way between key/value
+pair databases (such as berkley db or tdb) and a full LDAP
+database. With a structured attribute oriented API like LDAP and good
+indexing capabilities, ldb can be used for quite sophisticated
+applications that need a light weight database, without the
+administrative overhead of a full LDAP installation.
+	</para>
+
+	<para>
+Included with ldb are a number of useful command line tools for
+manipulating a ldb database. These tools are similar in style to the
+equivalent ldap command line tools.
+	</para>
+
+	<para>
+In its default mode of operation with a tdb backend, ldb can also be
+seen as a "schema-less LDAP". By default ldb does not require a
+schema, which greatly reduces the complexity of getting started with
+ldb databases. As the complexity of you application grows you can take
+advantage of some of the optional schema-like attributes that ldb
+offers, or you can migrate to using the full LDAP api while keeping
+your exiting ldb code.
+	</para>
+
+	<para>
+If you are new to ldb, then I suggest starting with the manual pages
+for ldbsearch(1) and ldbedit(1), and experimenting with a local
+database. Then I suggest you look at the ldb_connect(3) and
+ldb_search(3) manual pages.
+	</para>
+</refsect1>
+
+<refsect1>
+	<title>TOOLS</title>
+
+	<itemizedlist>
+		<listitem><para>
+			<application>ldbsearch(1)</application>
+			  - command line ldb search utility
+		</para></listitem>
+
+		<listitem><para>
+			<application>ldbedit(1)</application>
+			 - edit all or part of a ldb database using your favourite editor
+		</para></listitem>
+
+		<listitem><para>
+			<application>ldbadd(1)</application>
+			 - add records to a ldb database using LDIF formatted input
+		</para></listitem>
+
+		<listitem><para>
+			<application>ldbdel(1)</application>
+			 - delete records from a ldb database
+		</para></listitem>
+
+		<listitem><para>
+			<application>ldbmodify(1)</application>
+			 - modify records in a ldb database using LDIF formatted input
+		</para></listitem>
+	</itemizedlist>
+</refsect1>
+
+<refsect1>
+	<title>FUNCTIONS</title>
+
+	<itemizedlist>
+		<listitem><para>
+			<function>ldb_connect(3)</function>
+			 - connect to a ldb backend
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_search(3)</function>
+			 - perform a database search
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_add(3)</function>
+			 - add a record to the database
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_delete(3)</function>
+			 - delete a record from the database
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_modify(3)</function>
+			 - modify a record in the database
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_errstring(3)</function>
+			 - retrieve extended error information from the last operation
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_ldif_write(3)</function>
+			 - write a LDIF formatted message
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_ldif_write_file(3)</function>
+			 - write a LDIF formatted message to a file
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_ldif_read(3)</function>
+			 - read a LDIF formatted message
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_ldif_read_free(3)</function>
+			 - free the result of a ldb_ldif_read()
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_ldif_read_file(3)</function>
+			 - read a LDIF message from a file
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_ldif_read_string(3)</function>
+			 - read a LDIF message from a string
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_msg_find_element(3)</function>
+			 - find an element in a ldb_message
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_val_equal_exact(3)</function>
+			 - compare two ldb_val structures
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_msg_find_val(3)</function>
+			 - find an element by value
+		</para></listitem>
+
+		<listitem><para>
+			<function>ldb_msg_add_empty(3)</function>
+			 - add an empty message element to a ldb_message
+		</para></listitem>
+
+
+		<listitem><para>
+			<function>ldb_msg_add(3)</function>
+			 - add a non-empty message element to a ldb_message
+		</para></listitem>
+
+
+		<listitem><para>
+			<function>ldb_msg_element_compare(3)</function>
+			 - compare two ldb_message_element structures
+		</para></listitem>
+
+
+		<listitem><para>
+			<function>ldb_msg_find_int(3)</function>
+			 - return an integer value from a ldb_message
+		</para></listitem>
+
+
+		<listitem><para>
+			<function>ldb_msg_find_uint(3)</function>
+			 - return an unsigned integer value from a ldb_message
+		</para></listitem>
+
+
+		<listitem><para>
+			<function>ldb_msg_find_double(3)</function>
+			 - return a double value from a ldb_message
+		</para></listitem>
+
+
+		<listitem><para>
+			<function>ldb_msg_find_string(3)</function>
+			 - return a string value from a ldb_message
+		</para></listitem>
+
+
+		<listitem><para>
+			<function>ldb_set_alloc(3)</function>
+			 - set the memory allocation function to be used by ldb
+		</para></listitem>
+
+
+		<listitem><para>
+			<function>ldb_set_debug(3)</function>
+			 - set a debug handler to be used by ldb
+		</para></listitem>
+
+
+		<listitem><para>
+			<function>ldb_set_debug_stderr(3)</function>
+			 - set a debug handler for stderr output
+		</para></listitem>
+	</itemizedlist>
+</refsect1>
+
+<refsect1>
+	<title>description</title>
+
+	<para>
+		ldb was written by 
+		 <ulink url="http://samba.org/~tridge/">Andrew Tridgell</ulink>.
+	</para>
+
+	<para>
+If you wish to report a problem or make a suggestion then please see
+the <ulink url="http://ldb.samba.org/"/> web site for
+current contact and maintainer information.
+	</para>
+
+	<para>
+ldb is released under the GNU Lesser General Public License version 2
+or later. Please see the file COPYING for license details.
+	</para>
+</refsect1>
+</refentry>
diff --git a/source4/lib/ldb/man/man3/ldb.yo b/source4/lib/ldb/man/man3/ldb.yo
deleted file mode 100644
index c2c7e1b872..0000000000
--- a/source4/lib/ldb/man/man3/ldb.yo
+++ /dev/null
@@ -1,129 +0,0 @@
-manpage(ldb)(3)(May 2004)()()
-manpagename(ldb)(A light-weight database library)
-
-manpagesynopsis()
-
-	bf(#include <ldb.h>)
-
-manpagedescription()
-
-ldb is a light weight embedded database library and API. With a
-programming interface that is very similar to LDAP, ldb can store its
-data either in a tdb(3) database or in a real LDAP database.
-
-When used with the tdb backend ldb does not require any database
-daemon. Instead, ldb function calls are processed immediately by the
-ldb library, which does IO directly on the database, while allowing
-multiple readers/writers using operating system byte range locks. This
-leads to an API with very low overheads, often resulting in speeds of
-more than 10x what can be achieved with a more traditional LDAP
-architecture.
-
-It a taxonomy of databases ldb would sit half way between key/value
-pair databases (such as berkley db or tdb) and a full LDAP
-database. With a structured attribute oriented API like LDAP and good
-indexing capabilities, ldb can be used for quite sophisticated
-applications that need a light weight database, without the
-administrative overhead of a full LDAP installation.
-
-Included with ldb are a number of useful command line tools for
-manipulating a ldb database. These tools are similar in style to the
-equivalent ldap command line tools.
-
-In its default mode of operation with a tdb backend, ldb can also be
-seen as a "schema-less LDAP". By default ldb does not require a
-schema, which greatly reduces the complexity of getting started with
-ldb databases. As the complexity of you application grows you can take
-advantage of some of the optional schema-like attributes that ldb
-offers, or you can migrate to using the full LDAP api while keeping
-your exiting ldb code.
-
-If you are new to ldb, then I suggest starting with the manual pages
-for ldbsearch(1) and ldbedit(1), and experimenting with a local
-database. Then I suggest you look at the ldb_connect(3) and
-ldb_search(3) manual pages.
-
-manpagesection(INDEX)
-
-startdit()
-
-dit(bf(ldbsearch(1))) command line ldb search utility
-
-dit(bf(ldbedit(1))) edit all or part of a ldb databse using your
-favourite editor
-
-dit(bf(ldbedit(1))) edit all or part of a ldb databse using your
-favourite editor
-
-dit(bf(ldbadd(1))) add records to a ldb database using LDIF formatted input
-
-dit(bf(ldbdel(1))) delete records from a ldb database
-
-dit(bf(ldbmodify(1))) modify records in a ldb database using LDIF
-formatted input
-
-dit(bf(ldb_connect(3))) connect to a ldb backend
-
-dit(bf(ldb_search(3))) perform a database search
-
-dit(bf(ldb_add(3))) add a record to the database
-
-dit(bf(ldb_delete(3))) delete a record from the database
-
-dit(bf(ldb_modify(3))) modify a record in the database
-
-dit(bf(ldb_errstring(3))) retrieve extended error information from the
-last operation
-
-dit(bf(ldb_ldif_write(3))) write a LDIF formatted message
-
-dit(bf(ldb_ldif_write_file(3))) write a LDIF formatted message to a file
-
-dit(bf(ldb_ldif_read(3))) read a LDIF formatted message
-
-dit(bf(ldb_ldif_read_free(3))) free the result of a ldb_ldif_read()
-
-dit(bf(ldb_ldif_read_file(3))) read a LDIF message from a file
-
-dit(bf(ldb_ldif_read_string(3))) read a LDIF message from a string
-
-dit(bf(ldb_msg_find_element(3))) find an element in a ldb_message
-
-dit(bf(ldb_val_equal_exact(3))) compare two ldb_val structures
-
-dit(bf(ldb_msg_find_val(3))) find an element by value
-
-dit(bf(ldb_msg_add_empty(3))) add an empty message element to a ldb_message
-
-dit(bf(ldb_msg_add(3))) add a non-empty message element to a ldb_message
-
-dit(bf(ldb_msg_element_compare(3))) compare two ldb_message_element structures
-
-dit(bf(ldb_msg_find_int(3))) return an integer value from a ldb_message
-
-dit(bf(ldb_msg_find_uint(3))) return an unsigned integer value from a ldb_message
-
-dit(bf(ldb_msg_find_double(3))) return a double value from a ldb_message
-
-dit(bf(ldb_msg_find_string(3))) return a string value from a ldb_message
-
-dit(bf(ldb_set_alloc(3))) set the memory allocation function to be used by ldb
-
-dit(bf(ldb_set_debug(3))) set a debug handler to be used by ldb
-
-dit(bf(ldb_set_debug_stderr(3))) set a debug handler for stderr output
-
-enddit()
-
-manpageauthor()
-
-ldb was written by Andrew Tridgell
-url(http://samba.org/~tridge/)(http://samba.org/~tridge/)
-
-If you wish to report a problem or make a suggestion then please see
-the url(http://ldb.samba.org/)(http://ldb.samba.org/) web site for
-current contact and maintainer information.
-
-ldb is released under the GNU Lesser General Public License version 2
-or later. Please see the file COPYING for license details.
-