diff options
Diffstat (limited to 'source4/lib/ldb/man')
| -rwxr-xr-x | source4/lib/ldb/man/build_manpages.sh | 11 | ||||
| -rw-r--r-- | source4/lib/ldb/man/man3/ldb.3 | 165 | ||||
| -rw-r--r-- | source4/lib/ldb/man/man3/ldb.yo | 133 |
3 files changed, 309 insertions, 0 deletions
diff --git a/source4/lib/ldb/man/build_manpages.sh b/source4/lib/ldb/man/build_manpages.sh new file mode 100755 index 0000000000..5e5e698ac4 --- /dev/null +++ b/source4/lib/ldb/man/build_manpages.sh @@ -0,0 +1,11 @@ +#!/bin/sh + +for f in man/man3/*.yo; do + base=`basename $f .yo`; + man=man/man3/$base.3; + + if test $f -nt $man; then + echo Creating $man from $f + yodl2man -o $man $f || rm -f $man + fi +done diff --git a/source4/lib/ldb/man/man3/ldb.3 b/source4/lib/ldb/man/man3/ldb.3 new file mode 100644 index 0000000000..d6e20035c6 --- /dev/null +++ b/source4/lib/ldb/man/man3/ldb.3 @@ -0,0 +1,165 @@ +.TH "ldb" "3" "May 2004" "" "" +.SH "NAME" +ldb \- A light-weight database library +.PP +.SH "SYNOPSIS" +.PP +\fB#include <ldb\&.h>\fP +.PP +.SH "DESCRIPTION" +.PP +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\&. +.PP +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\&. +.PP +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\&. +.PP +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\&. +.PP +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\&. +.PP +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\&. +.PP +.SH "INDEX" +.PP +.IP +.IP "\fBldbsearch(1)\fP" +command line ldb search utility +.IP +.IP "\fBldbedit(1)\fP" +edit all or part of a ldb databse using your +favourite editor +.IP +.IP "\fBldbedit(1)\fP" +edit all or part of a ldb databse using your +favourite editor +.IP +.IP "\fBldbadd(1)\fP" +add records to a ldb database using LDIF formatted input +.IP +.IP "\fBldbdel(1)\fP" +delete records from a ldb database +.IP +.IP "\fBldbmodify(1)\fP" +modify records in a ldb database using LDIF +formatted input +.IP +.IP "\fBldb_connect(3)\fP" +connect to a ldb backend +.IP +.IP "\fBldb_close(3)\fP" +close a connection to a ldb backend +.IP +.IP "\fBldb_search(3)\fP" +perform a database search +.IP +.IP "\fBldb_search_free(3)\fP" +free the results of a ldb_search +.IP +.IP "\fBldb_add(3)\fP" +add a record to the database +.IP +.IP "\fBldb_delete(3)\fP" +delete a record from the database +.IP +.IP "\fBldb_modify(3)\fP" +modify a record in the database +.IP +.IP "\fBldb_errstring(3)\fP" +retrieve extended error information from the +last operation +.IP +.IP "\fBldb_ldif_write(3)\fP" +write a LDIF formatted message +.IP +.IP "\fBldb_ldif_write_\fB3\fP\fP" +write a LDIF formatted message to a file +.IP +.IP "\fBldb_ldif_read(3)\fP" +read a LDIF formatted message +.IP +.IP "\fBldb_ldif_read_free(3)\fP" +free the result of a ldb_ldif_read() +.IP +.IP "\fBldb_ldif_read_\fB3\fP\fP" +read a LDIF message from a file +.IP +.IP "\fBldb_ldif_read_string(3)\fP" +read a LDIF message from a string +.IP +.IP "\fBldb_msg_find_element(3)\fP" +find an element in a ldb_message +.IP +.IP "\fBldb_val_equal_exact(3)\fP" +compare two ldb_val structures +.IP +.IP "\fBldb_msg_find_val(3)\fP" +find an element by value +.IP +.IP "\fBldb_msg_add_empty(3)\fP" +add an empty message element to a ldb_message +.IP +.IP "\fBldb_msg_add(3)\fP" +add a non-empty message element to a ldb_message +.IP +.IP "\fBldb_msg_element_compare(3)\fP" +compare two ldb_message_element structures +.IP +.IP "\fBldb_msg_find_int(3)\fP" +return an integer value from a ldb_message +.IP +.IP "\fBldb_msg_find_uint(3)\fP" +return an unsigned integer value from a ldb_message +.IP +.IP "\fBldb_msg_find_double(3)\fP" +return a double value from a ldb_message +.IP +.IP "\fBldb_msg_find_string(3)\fP" +return a string value from a ldb_message +.IP +.IP "\fBldb_set_alloc(3)\fP" +set the memory allocation function to be used by ldb +.IP +.IP "\fBldb_set_debug(3)\fP" +set a debug handler to be used by ldb +.IP +.IP "\fBldb_set_debug_stderr(3)\fP" +set a debug handler for stderr output +.IP +.PP +.SH "AUTHOR" +.PP +ldb was written by Andrew Tridgell +http://samba\&.org/~tridge/ +.PP +If you wish to report a problem or make a suggestion then please see +the http://ldb\&.samba\&.org/ web site for +current contact and maintainer information\&. +.PP +ldb is released under the GNU Lesser General Public License version 2 +or later\&. Please see the file COPYING for license details\&. +.PP diff --git a/source4/lib/ldb/man/man3/ldb.yo b/source4/lib/ldb/man/man3/ldb.yo new file mode 100644 index 0000000000..ce8a590fbc --- /dev/null +++ b/source4/lib/ldb/man/man3/ldb.yo @@ -0,0 +1,133 @@ +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_close(3))) close a connection to a ldb backend + +dit(bf(ldb_search(3))) perform a database search + +dit(bf(ldb_search_free(3))) free the results of a ldb_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. + |