From 4219ec1dece35452c3887b2013e636105fc44f33 Mon Sep 17 00:00:00 2001 From: Andrew Tridgell Date: Thu, 20 May 2004 13:20:30 +0000 Subject: r790: started working on some documentation (manual pages) for ldb (This used to be commit dcb9d1a897f7186824e997064902f3d50bad1887) --- source4/lib/ldb/man/build_manpages.sh | 11 +++ source4/lib/ldb/man/man3/ldb.3 | 165 ++++++++++++++++++++++++++++++++++ source4/lib/ldb/man/man3/ldb.yo | 133 +++++++++++++++++++++++++++ 3 files changed, 309 insertions(+) create mode 100755 source4/lib/ldb/man/build_manpages.sh create mode 100644 source4/lib/ldb/man/man3/ldb.3 create mode 100644 source4/lib/ldb/man/man3/ldb.yo (limited to 'source4/lib/ldb/man') 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 \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 ) + +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. + -- cgit From cfb25947f2fd45254b5fac0be6c15dd4e1c9cc84 Mon Sep 17 00:00:00 2001 From: Tim Potter Date: Mon, 7 Jun 2004 01:40:30 +0000 Subject: r1052: Remove autogenerated file. (This used to be commit 108efcc002c2eccfd1da30fff5c11aa67af09f9e) --- source4/lib/ldb/man/man3/ldb.3 | 165 ----------------------------------------- 1 file changed, 165 deletions(-) delete mode 100644 source4/lib/ldb/man/man3/ldb.3 (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/man3/ldb.3 b/source4/lib/ldb/man/man3/ldb.3 deleted file mode 100644 index d6e20035c6..0000000000 --- a/source4/lib/ldb/man/man3/ldb.3 +++ /dev/null @@ -1,165 +0,0 @@ -.TH "ldb" "3" "May 2004" "" "" -.SH "NAME" -ldb \- A light-weight database library -.PP -.SH "SYNOPSIS" -.PP -\fB#include \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 -- cgit From b1b14817eaa6e6579596d54166e17bc8d5605c01 Mon Sep 17 00:00:00 2001 From: Simo Sorce Date: Sun, 27 Feb 2005 11:35:47 +0000 Subject: r5585: LDB interfaces change: changes: - ldb_wrap disappears from code and become a private structure of db_wrap.c thanks to our move to talloc in ldb code, we do not need to expose it anymore - removal of ldb_close() function form the code thanks to our move to talloc in ldb code, we do not need it anymore use talloc_free() to close and free an ldb database - some minor updates to ldb modules code to cope with the change and fix some bugs I found out during the process (This used to be commit d58be9e74b786a11a57e89df36081d55730dfe0a) --- source4/lib/ldb/man/man3/ldb.yo | 2 -- 1 file changed, 2 deletions(-) (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/man3/ldb.yo b/source4/lib/ldb/man/man3/ldb.yo index ce8a590fbc..8d7a60ccf2 100644 --- a/source4/lib/ldb/man/man3/ldb.yo +++ b/source4/lib/ldb/man/man3/ldb.yo @@ -64,8 +64,6 @@ 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 -- cgit From 499f00b4d947b04ab9616a17d9e638caaec9e6f5 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Sat, 23 Apr 2005 04:30:58 +0000 Subject: r6442: Add mechanism for configuring ldb independantly of the rest of Samba using the autoconf tools. (This used to be commit a8de35ca27e307d1be6ebad517b7012a5de30567) --- source4/lib/ldb/man/build_manpages.sh | 11 ----------- 1 file changed, 11 deletions(-) delete mode 100755 source4/lib/ldb/man/build_manpages.sh (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/build_manpages.sh b/source4/lib/ldb/man/build_manpages.sh deleted file mode 100755 index 5e5e698ac4..0000000000 --- a/source4/lib/ldb/man/build_manpages.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/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 -- cgit From fe4d985b6f3d318d9b58a16677be3b4ae34fba15 Mon Sep 17 00:00:00 2001 From: Simo Sorce Date: Mon, 25 Apr 2005 12:46:18 +0000 Subject: r6470: Remove ldb_search_free() it is not needed anymore. Just use talloc_free() to release the memory after an ldb_search(). (This used to be commit 4f0948dab0aa5e8b6a4ce486f3668ca8dfae23db) --- source4/lib/ldb/man/man3/ldb.yo | 2 -- 1 file changed, 2 deletions(-) (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/man3/ldb.yo b/source4/lib/ldb/man/man3/ldb.yo index 8d7a60ccf2..c2c7e1b872 100644 --- a/source4/lib/ldb/man/man3/ldb.yo +++ b/source4/lib/ldb/man/man3/ldb.yo @@ -66,8 +66,6 @@ dit(bf(ldb_connect(3))) connect 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 -- cgit From dde05bc78735a111e814ab5ece9e79af4555153b Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Mon, 30 May 2005 15:11:10 +0000 Subject: r7113: Move manpages from docs repository to source repository (This used to be commit f16d346032b9052c9dcd6b15cf65dd62e6943cd3) --- source4/lib/ldb/man/man1/ldbadd.1.xml | 99 ++++++++++++++++++++++++ source4/lib/ldb/man/man1/ldbdel.1.xml | 97 ++++++++++++++++++++++++ source4/lib/ldb/man/man1/ldbedit.1.xml | 125 +++++++++++++++++++++++++++++++ source4/lib/ldb/man/man1/ldbmodify.1.xml | 87 +++++++++++++++++++++ source4/lib/ldb/man/man1/ldbrename.1.xml | 101 +++++++++++++++++++++++++ source4/lib/ldb/man/man1/ldbsearch.1.xml | 113 ++++++++++++++++++++++++++++ 6 files changed, 622 insertions(+) create mode 100644 source4/lib/ldb/man/man1/ldbadd.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbdel.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbedit.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbmodify.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbrename.1.xml create mode 100644 source4/lib/ldb/man/man1/ldbsearch.1.xml (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/man1/ldbadd.1.xml b/source4/lib/ldb/man/man1/ldbadd.1.xml new file mode 100644 index 0000000000..0b3122ab32 --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbadd.1.xml @@ -0,0 +1,99 @@ + + + + + + ldbadd + 1 + + + + + ldbadd + Command-line utility for adding records to an LDB + + + + + ldbadd + -h + -H LDB-URL + ldif-file1 + ldif-file2 + ... + + + + + DESCRIPTION + + ldbadd adds records to an ldb(7) database. It reads + the ldif(5) files specified on the command line and adds + the records from these files to the LDB database, which is specified + by the -H option or the LDB_URL environment variable. + + + If - is specified as a ldb file, the ldif input is read from + standard input. + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbadd was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbdel.1.xml b/source4/lib/ldb/man/man1/ldbdel.1.xml new file mode 100644 index 0000000000..2f98f9d427 --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbdel.1.xml @@ -0,0 +1,97 @@ + + + + + + ldbdel + 1 + + + + + ldbdel + Command-line program for deleting LDB records + + + + + ldbdel + -h + -H LDB-URL + dn + ... + + + + + DESCRIPTION + + ldbdel deletes records from an ldb(7) database. + It deletes the records identified by the dn's specified + on the command-line. + + ldbdel uses either the database that is specified with + the -H option or the database specified by the LDB_URL environment + variable. + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbadd, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbdel was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbedit.1.xml b/source4/lib/ldb/man/man1/ldbedit.1.xml new file mode 100644 index 0000000000..0b5c63a17a --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbedit.1.xml @@ -0,0 +1,125 @@ + + + + + + ldbedit + 1 + + + + + ldbedit + Edit LDB databases using your favorite editor + + + + + ldbedit + -h + -s base|one|sub + -b basedn + -a + -e editor + -H LDB-URL + expression + attributes + + + + + DESCRIPTION + + ldbedit is a utility that allows you to edit LDB files using + your favorite editor. ldbedit generates an LDIF file based on + your query, allows you to edit it and then merges it back + into the LDB database. + + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + -s one|sub|base + Search scope to use. One-level, subtree or base. + + + + -a + Edit all records. + + + + -e editor + Specify the editor that should be used (overrides + the VISUAL and EDITOR environment variables). + + + + -b basedn + Specify Base DN to use. + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + VISUAL and EDITOR + Environment variables used to determine what + editor to use. If VISUAL isn't set, EDITOR is used. + + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbedit was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbmodify.1.xml b/source4/lib/ldb/man/man1/ldbmodify.1.xml new file mode 100644 index 0000000000..e39f74fffa --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbmodify.1.xml @@ -0,0 +1,87 @@ + + + + + + ldbmodify + 1 + + + + + ldbmodify + Modify records in a LDB database + + + + + ldbmodify + -H LDB-URL + ldif-file + + + + + DESCRIPTION + + + ldbmodify changes, adds and deletes records in a LDB database. + The changes that should be made to the LDB database are read from + the specified LDIF-file. If - is specified as the filename, input is read from stdin. + + + For now, see ldapmodify(1) for details on the LDIF file format. + + + + + + OPTIONS + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbedit + + + + + AUTHOR + + &man.credits.samba; + + ldbmodify was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbrename.1.xml b/source4/lib/ldb/man/man1/ldbrename.1.xml new file mode 100644 index 0000000000..32456243af --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbrename.1.xml @@ -0,0 +1,101 @@ + + + + + + ldbrename + 1 + + + + + ldbrename + Edit LDB databases using your favorite editor + + + + + ldbrename + -h + -o options + olddn + newdb + + + + + DESCRIPTION + + ldbrename is a utility that allows you to rename trees in + an LDB database based by DN. This utility takes + two arguments: the original + DN name of the top element and the DN to change it to. + + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + -o options + Extra ldb options, such as + modules. + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbrename was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbsearch.1.xml b/source4/lib/ldb/man/man1/ldbsearch.1.xml new file mode 100644 index 0000000000..8361aa97ff --- /dev/null +++ b/source4/lib/ldb/man/man1/ldbsearch.1.xml @@ -0,0 +1,113 @@ + + + + + + ldbsearch + 1 + + + + + ldbsearch + Search for records in a LDB database + + + + + ldbsearch + -h + -s base|one|sub + -b basedn + -i + -H LDB-URL + expression + attributes + + + + + DESCRIPTION + + ldbsearch searches a LDB database for records matching the + specified expression (see the ldapsearch(1) manpage for + a description of the expression format). For each + record, the specified attributes are printed. + + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + -s one|sub|base + Search scope to use. One-level, subtree or base. + + + + -i + Read search expressions from stdin. + + + + -b basedn + Specify Base DN to use. + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbedit + + + + + AUTHOR + + &man.credits.samba; + + ldbsearch was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + -- cgit From 1863240bbc6dbd7b0b0832504a9c30573b44ddf6 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Mon, 30 May 2005 15:59:08 +0000 Subject: r7114: Convert ldb documentation to DocBook/XML (This used to be commit 470c6185fb815983aebffd313361ec0fac723fd0) --- source4/lib/ldb/man/man3/ldb.3.xml | 262 +++++++++++++++++++++++++++++++++++++ source4/lib/ldb/man/man3/ldb.yo | 129 ------------------ 2 files changed, 262 insertions(+), 129 deletions(-) create mode 100644 source4/lib/ldb/man/man3/ldb.3.xml delete mode 100644 source4/lib/ldb/man/man3/ldb.yo (limited to 'source4/lib/ldb/man') 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 @@ + + + + + + ldb + 3 + + + + ldb + The Samba Project + A light-weight database library + + + + #include <ldb.h> + + + + description + + +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. + + + + + TOOLS + + + + ldbsearch(1) + - command line ldb search utility + + + + ldbedit(1) + - edit all or part of a ldb database using your favourite editor + + + + ldbadd(1) + - add records to a ldb database using LDIF formatted input + + + + ldbdel(1) + - delete records from a ldb database + + + + ldbmodify(1) + - modify records in a ldb database using LDIF formatted input + + + + + + FUNCTIONS + + + + ldb_connect(3) + - connect to a ldb backend + + + + ldb_search(3) + - perform a database search + + + + ldb_add(3) + - add a record to the database + + + + ldb_delete(3) + - delete a record from the database + + + + ldb_modify(3) + - modify a record in the database + + + + ldb_errstring(3) + - retrieve extended error information from the last operation + + + + ldb_ldif_write(3) + - write a LDIF formatted message + + + + ldb_ldif_write_file(3) + - write a LDIF formatted message to a file + + + + ldb_ldif_read(3) + - read a LDIF formatted message + + + + ldb_ldif_read_free(3) + - free the result of a ldb_ldif_read() + + + + ldb_ldif_read_file(3) + - read a LDIF message from a file + + + + ldb_ldif_read_string(3) + - read a LDIF message from a string + + + + ldb_msg_find_element(3) + - find an element in a ldb_message + + + + ldb_val_equal_exact(3) + - compare two ldb_val structures + + + + ldb_msg_find_val(3) + - find an element by value + + + + ldb_msg_add_empty(3) + - add an empty message element to a ldb_message + + + + + ldb_msg_add(3) + - add a non-empty message element to a ldb_message + + + + + ldb_msg_element_compare(3) + - compare two ldb_message_element structures + + + + + ldb_msg_find_int(3) + - return an integer value from a ldb_message + + + + + ldb_msg_find_uint(3) + - return an unsigned integer value from a ldb_message + + + + + ldb_msg_find_double(3) + - return a double value from a ldb_message + + + + + ldb_msg_find_string(3) + - return a string value from a ldb_message + + + + + ldb_set_alloc(3) + - set the memory allocation function to be used by ldb + + + + + ldb_set_debug(3) + - set a debug handler to be used by ldb + + + + + ldb_set_debug_stderr(3) + - set a debug handler for stderr output + + + + + + description + + + ldb was written by + Andrew Tridgell. + + + +If you wish to report a problem or make a suggestion then please see +the 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. + + + 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 ) - -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. - -- cgit From 65cc3f5d5cb6e2b816e6d730960c2141ed0eecd6 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Mon, 27 Jun 2005 22:07:28 +0000 Subject: r7958: More debian packaging updates; packages build now with a few minor issues. Move ldb manpages one level higher - there is no longer a need to have subdirectories. (This used to be commit e8e3524b2394f4107230715ea38fb619332e0251) --- source4/lib/ldb/man/ldb.3.xml | 262 +++++++++++++++++++++++++++++++ source4/lib/ldb/man/ldbadd.1.xml | 99 ++++++++++++ source4/lib/ldb/man/ldbdel.1.xml | 97 ++++++++++++ source4/lib/ldb/man/ldbedit.1.xml | 125 +++++++++++++++ source4/lib/ldb/man/ldbmodify.1.xml | 87 ++++++++++ source4/lib/ldb/man/ldbrename.1.xml | 101 ++++++++++++ source4/lib/ldb/man/ldbsearch.1.xml | 113 +++++++++++++ source4/lib/ldb/man/man1/ldbadd.1.xml | 99 ------------ source4/lib/ldb/man/man1/ldbdel.1.xml | 97 ------------ source4/lib/ldb/man/man1/ldbedit.1.xml | 125 --------------- source4/lib/ldb/man/man1/ldbmodify.1.xml | 87 ---------- source4/lib/ldb/man/man1/ldbrename.1.xml | 101 ------------ source4/lib/ldb/man/man1/ldbsearch.1.xml | 113 ------------- source4/lib/ldb/man/man3/ldb.3.xml | 262 ------------------------------- 14 files changed, 884 insertions(+), 884 deletions(-) create mode 100644 source4/lib/ldb/man/ldb.3.xml create mode 100644 source4/lib/ldb/man/ldbadd.1.xml create mode 100644 source4/lib/ldb/man/ldbdel.1.xml create mode 100644 source4/lib/ldb/man/ldbedit.1.xml create mode 100644 source4/lib/ldb/man/ldbmodify.1.xml create mode 100644 source4/lib/ldb/man/ldbrename.1.xml create mode 100644 source4/lib/ldb/man/ldbsearch.1.xml delete mode 100644 source4/lib/ldb/man/man1/ldbadd.1.xml delete mode 100644 source4/lib/ldb/man/man1/ldbdel.1.xml delete mode 100644 source4/lib/ldb/man/man1/ldbedit.1.xml delete mode 100644 source4/lib/ldb/man/man1/ldbmodify.1.xml delete mode 100644 source4/lib/ldb/man/man1/ldbrename.1.xml delete mode 100644 source4/lib/ldb/man/man1/ldbsearch.1.xml delete mode 100644 source4/lib/ldb/man/man3/ldb.3.xml (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/ldb.3.xml b/source4/lib/ldb/man/ldb.3.xml new file mode 100644 index 0000000000..d9ed135f20 --- /dev/null +++ b/source4/lib/ldb/man/ldb.3.xml @@ -0,0 +1,262 @@ + + + + + + ldb + 3 + + + + ldb + The Samba Project + A light-weight database library + + + + #include <ldb.h> + + + + description + + +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. + + + + + TOOLS + + + + ldbsearch(1) + - command line ldb search utility + + + + ldbedit(1) + - edit all or part of a ldb database using your favourite editor + + + + ldbadd(1) + - add records to a ldb database using LDIF formatted input + + + + ldbdel(1) + - delete records from a ldb database + + + + ldbmodify(1) + - modify records in a ldb database using LDIF formatted input + + + + + + FUNCTIONS + + + + ldb_connect(3) + - connect to a ldb backend + + + + ldb_search(3) + - perform a database search + + + + ldb_add(3) + - add a record to the database + + + + ldb_delete(3) + - delete a record from the database + + + + ldb_modify(3) + - modify a record in the database + + + + ldb_errstring(3) + - retrieve extended error information from the last operation + + + + ldb_ldif_write(3) + - write a LDIF formatted message + + + + ldb_ldif_write_file(3) + - write a LDIF formatted message to a file + + + + ldb_ldif_read(3) + - read a LDIF formatted message + + + + ldb_ldif_read_free(3) + - free the result of a ldb_ldif_read() + + + + ldb_ldif_read_file(3) + - read a LDIF message from a file + + + + ldb_ldif_read_string(3) + - read a LDIF message from a string + + + + ldb_msg_find_element(3) + - find an element in a ldb_message + + + + ldb_val_equal_exact(3) + - compare two ldb_val structures + + + + ldb_msg_find_val(3) + - find an element by value + + + + ldb_msg_add_empty(3) + - add an empty message element to a ldb_message + + + + + ldb_msg_add(3) + - add a non-empty message element to a ldb_message + + + + + ldb_msg_element_compare(3) + - compare two ldb_message_element structures + + + + + ldb_msg_find_int(3) + - return an integer value from a ldb_message + + + + + ldb_msg_find_uint(3) + - return an unsigned integer value from a ldb_message + + + + + ldb_msg_find_double(3) + - return a double value from a ldb_message + + + + + ldb_msg_find_string(3) + - return a string value from a ldb_message + + + + + ldb_set_alloc(3) + - set the memory allocation function to be used by ldb + + + + + ldb_set_debug(3) + - set a debug handler to be used by ldb + + + + + ldb_set_debug_stderr(3) + - set a debug handler for stderr output + + + + + + description + + + ldb was written by + Andrew Tridgell. + + + +If you wish to report a problem or make a suggestion then please see +the 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. + + + diff --git a/source4/lib/ldb/man/ldbadd.1.xml b/source4/lib/ldb/man/ldbadd.1.xml new file mode 100644 index 0000000000..0b3122ab32 --- /dev/null +++ b/source4/lib/ldb/man/ldbadd.1.xml @@ -0,0 +1,99 @@ + + + + + + ldbadd + 1 + + + + + ldbadd + Command-line utility for adding records to an LDB + + + + + ldbadd + -h + -H LDB-URL + ldif-file1 + ldif-file2 + ... + + + + + DESCRIPTION + + ldbadd adds records to an ldb(7) database. It reads + the ldif(5) files specified on the command line and adds + the records from these files to the LDB database, which is specified + by the -H option or the LDB_URL environment variable. + + + If - is specified as a ldb file, the ldif input is read from + standard input. + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbadd was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/ldbdel.1.xml b/source4/lib/ldb/man/ldbdel.1.xml new file mode 100644 index 0000000000..2f98f9d427 --- /dev/null +++ b/source4/lib/ldb/man/ldbdel.1.xml @@ -0,0 +1,97 @@ + + + + + + ldbdel + 1 + + + + + ldbdel + Command-line program for deleting LDB records + + + + + ldbdel + -h + -H LDB-URL + dn + ... + + + + + DESCRIPTION + + ldbdel deletes records from an ldb(7) database. + It deletes the records identified by the dn's specified + on the command-line. + + ldbdel uses either the database that is specified with + the -H option or the database specified by the LDB_URL environment + variable. + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbadd, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbdel was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/ldbedit.1.xml b/source4/lib/ldb/man/ldbedit.1.xml new file mode 100644 index 0000000000..0b5c63a17a --- /dev/null +++ b/source4/lib/ldb/man/ldbedit.1.xml @@ -0,0 +1,125 @@ + + + + + + ldbedit + 1 + + + + + ldbedit + Edit LDB databases using your favorite editor + + + + + ldbedit + -h + -s base|one|sub + -b basedn + -a + -e editor + -H LDB-URL + expression + attributes + + + + + DESCRIPTION + + ldbedit is a utility that allows you to edit LDB files using + your favorite editor. ldbedit generates an LDIF file based on + your query, allows you to edit it and then merges it back + into the LDB database. + + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + -s one|sub|base + Search scope to use. One-level, subtree or base. + + + + -a + Edit all records. + + + + -e editor + Specify the editor that should be used (overrides + the VISUAL and EDITOR environment variables). + + + + -b basedn + Specify Base DN to use. + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + VISUAL and EDITOR + Environment variables used to determine what + editor to use. If VISUAL isn't set, EDITOR is used. + + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbedit was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/ldbmodify.1.xml b/source4/lib/ldb/man/ldbmodify.1.xml new file mode 100644 index 0000000000..e39f74fffa --- /dev/null +++ b/source4/lib/ldb/man/ldbmodify.1.xml @@ -0,0 +1,87 @@ + + + + + + ldbmodify + 1 + + + + + ldbmodify + Modify records in a LDB database + + + + + ldbmodify + -H LDB-URL + ldif-file + + + + + DESCRIPTION + + + ldbmodify changes, adds and deletes records in a LDB database. + The changes that should be made to the LDB database are read from + the specified LDIF-file. If - is specified as the filename, input is read from stdin. + + + For now, see ldapmodify(1) for details on the LDIF file format. + + + + + + OPTIONS + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbedit + + + + + AUTHOR + + &man.credits.samba; + + ldbmodify was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/ldbrename.1.xml b/source4/lib/ldb/man/ldbrename.1.xml new file mode 100644 index 0000000000..32456243af --- /dev/null +++ b/source4/lib/ldb/man/ldbrename.1.xml @@ -0,0 +1,101 @@ + + + + + + ldbrename + 1 + + + + + ldbrename + Edit LDB databases using your favorite editor + + + + + ldbrename + -h + -o options + olddn + newdb + + + + + DESCRIPTION + + ldbrename is a utility that allows you to rename trees in + an LDB database based by DN. This utility takes + two arguments: the original + DN name of the top element and the DN to change it to. + + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + -o options + Extra ldb options, such as + modules. + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + &man.credits.samba; + + ldbrename was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/ldbsearch.1.xml b/source4/lib/ldb/man/ldbsearch.1.xml new file mode 100644 index 0000000000..8361aa97ff --- /dev/null +++ b/source4/lib/ldb/man/ldbsearch.1.xml @@ -0,0 +1,113 @@ + + + + + + ldbsearch + 1 + + + + + ldbsearch + Search for records in a LDB database + + + + + ldbsearch + -h + -s base|one|sub + -b basedn + -i + -H LDB-URL + expression + attributes + + + + + DESCRIPTION + + ldbsearch searches a LDB database for records matching the + specified expression (see the ldapsearch(1) manpage for + a description of the expression format). For each + record, the specified attributes are printed. + + + + + + + OPTIONS + + + + -h + + Show list of available options. + + + + -H <ldb-url> + + LDB URL to connect to. See ldb(7) for details. + + + + + -s one|sub|base + Search scope to use. One-level, subtree or base. + + + + -i + Read search expressions from stdin. + + + + -b basedn + Specify Base DN to use. + + + + + + + + ENVIRONMENT + + + LDB_URL + LDB URL to connect to (can be overrided by using the + -H command-line option.) + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbedit + + + + + AUTHOR + + &man.credits.samba; + + ldbsearch was written by Andrew Tridgell. + + This manpage was written by Jelmer Vernooij. + + + + diff --git a/source4/lib/ldb/man/man1/ldbadd.1.xml b/source4/lib/ldb/man/man1/ldbadd.1.xml deleted file mode 100644 index 0b3122ab32..0000000000 --- a/source4/lib/ldb/man/man1/ldbadd.1.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - ldbadd - 1 - - - - - ldbadd - Command-line utility for adding records to an LDB - - - - - ldbadd - -h - -H LDB-URL - ldif-file1 - ldif-file2 - ... - - - - - DESCRIPTION - - ldbadd adds records to an ldb(7) database. It reads - the ldif(5) files specified on the command line and adds - the records from these files to the LDB database, which is specified - by the -H option or the LDB_URL environment variable. - - - If - is specified as a ldb file, the ldif input is read from - standard input. - - - - - - OPTIONS - - - - -h - - Show list of available options. - - - - -H <ldb-url> - - LDB URL to connect to. See ldb(7) for details. - - - - - - - - - ENVIRONMENT - - - LDB_URL - LDB URL to connect to (can be overrided by using the - -H command-line option.) - - - - - - - VERSION - - This man page is correct for version 4.0 of the Samba suite. - - - - SEE ALSO - - ldb(7), ldbmodify, ldbdel, ldif(5) - - - - - AUTHOR - - &man.credits.samba; - - ldbadd was written by Andrew Tridgell. - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/source4/lib/ldb/man/man1/ldbdel.1.xml b/source4/lib/ldb/man/man1/ldbdel.1.xml deleted file mode 100644 index 2f98f9d427..0000000000 --- a/source4/lib/ldb/man/man1/ldbdel.1.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - ldbdel - 1 - - - - - ldbdel - Command-line program for deleting LDB records - - - - - ldbdel - -h - -H LDB-URL - dn - ... - - - - - DESCRIPTION - - ldbdel deletes records from an ldb(7) database. - It deletes the records identified by the dn's specified - on the command-line. - - ldbdel uses either the database that is specified with - the -H option or the database specified by the LDB_URL environment - variable. - - - - - - OPTIONS - - - - -h - - Show list of available options. - - - - -H <ldb-url> - - LDB URL to connect to. See ldb(7) for details. - - - - - - - - - ENVIRONMENT - - - LDB_URL - LDB URL to connect to (can be overrided by using the - -H command-line option.) - - - - - - - VERSION - - This man page is correct for version 4.0 of the Samba suite. - - - - SEE ALSO - - ldb(7), ldbmodify, ldbadd, ldif(5) - - - - - AUTHOR - - &man.credits.samba; - - ldbdel was written by Andrew Tridgell. - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/source4/lib/ldb/man/man1/ldbedit.1.xml b/source4/lib/ldb/man/man1/ldbedit.1.xml deleted file mode 100644 index 0b5c63a17a..0000000000 --- a/source4/lib/ldb/man/man1/ldbedit.1.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - ldbedit - 1 - - - - - ldbedit - Edit LDB databases using your favorite editor - - - - - ldbedit - -h - -s base|one|sub - -b basedn - -a - -e editor - -H LDB-URL - expression - attributes - - - - - DESCRIPTION - - ldbedit is a utility that allows you to edit LDB files using - your favorite editor. ldbedit generates an LDIF file based on - your query, allows you to edit it and then merges it back - into the LDB database. - - - - - - - OPTIONS - - - - -h - - Show list of available options. - - - - -H <ldb-url> - - LDB URL to connect to. See ldb(7) for details. - - - - - -s one|sub|base - Search scope to use. One-level, subtree or base. - - - - -a - Edit all records. - - - - -e editor - Specify the editor that should be used (overrides - the VISUAL and EDITOR environment variables). - - - - -b basedn - Specify Base DN to use. - - - - - - - - ENVIRONMENT - - - LDB_URL - LDB URL to connect to (can be overrided by using the - -H command-line option.) - - VISUAL and EDITOR - Environment variables used to determine what - editor to use. If VISUAL isn't set, EDITOR is used. - - - - - - - - VERSION - - This man page is correct for version 4.0 of the Samba suite. - - - - SEE ALSO - - ldb(7), ldbmodify, ldbdel, ldif(5) - - - - - AUTHOR - - &man.credits.samba; - - ldbedit was written by Andrew Tridgell. - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/source4/lib/ldb/man/man1/ldbmodify.1.xml b/source4/lib/ldb/man/man1/ldbmodify.1.xml deleted file mode 100644 index e39f74fffa..0000000000 --- a/source4/lib/ldb/man/man1/ldbmodify.1.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - ldbmodify - 1 - - - - - ldbmodify - Modify records in a LDB database - - - - - ldbmodify - -H LDB-URL - ldif-file - - - - - DESCRIPTION - - - ldbmodify changes, adds and deletes records in a LDB database. - The changes that should be made to the LDB database are read from - the specified LDIF-file. If - is specified as the filename, input is read from stdin. - - - For now, see ldapmodify(1) for details on the LDIF file format. - - - - - - OPTIONS - - - - -H <ldb-url> - - LDB URL to connect to. See ldb(7) for details. - - - - - - - ENVIRONMENT - - - LDB_URL - LDB URL to connect to (can be overrided by using the - -H command-line option.) - - - - - - - VERSION - - This man page is correct for version 4.0 of the Samba suite. - - - - SEE ALSO - - ldb(7), ldbedit - - - - - AUTHOR - - &man.credits.samba; - - ldbmodify was written by Andrew Tridgell. - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/source4/lib/ldb/man/man1/ldbrename.1.xml b/source4/lib/ldb/man/man1/ldbrename.1.xml deleted file mode 100644 index 32456243af..0000000000 --- a/source4/lib/ldb/man/man1/ldbrename.1.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - ldbrename - 1 - - - - - ldbrename - Edit LDB databases using your favorite editor - - - - - ldbrename - -h - -o options - olddn - newdb - - - - - DESCRIPTION - - ldbrename is a utility that allows you to rename trees in - an LDB database based by DN. This utility takes - two arguments: the original - DN name of the top element and the DN to change it to. - - - - - - - OPTIONS - - - - -h - - Show list of available options. - - - - -H <ldb-url> - - LDB URL to connect to. See ldb(7) for details. - - - - - -o options - Extra ldb options, such as - modules. - - - - - - - - ENVIRONMENT - - - LDB_URL - LDB URL to connect to (can be overrided by using the - -H command-line option.) - - - - - - - VERSION - - This man page is correct for version 4.0 of the Samba suite. - - - - SEE ALSO - - ldb(7), ldbmodify, ldbdel, ldif(5) - - - - - AUTHOR - - &man.credits.samba; - - ldbrename was written by Andrew Tridgell. - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/source4/lib/ldb/man/man1/ldbsearch.1.xml b/source4/lib/ldb/man/man1/ldbsearch.1.xml deleted file mode 100644 index 8361aa97ff..0000000000 --- a/source4/lib/ldb/man/man1/ldbsearch.1.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - ldbsearch - 1 - - - - - ldbsearch - Search for records in a LDB database - - - - - ldbsearch - -h - -s base|one|sub - -b basedn - -i - -H LDB-URL - expression - attributes - - - - - DESCRIPTION - - ldbsearch searches a LDB database for records matching the - specified expression (see the ldapsearch(1) manpage for - a description of the expression format). For each - record, the specified attributes are printed. - - - - - - - OPTIONS - - - - -h - - Show list of available options. - - - - -H <ldb-url> - - LDB URL to connect to. See ldb(7) for details. - - - - - -s one|sub|base - Search scope to use. One-level, subtree or base. - - - - -i - Read search expressions from stdin. - - - - -b basedn - Specify Base DN to use. - - - - - - - - ENVIRONMENT - - - LDB_URL - LDB URL to connect to (can be overrided by using the - -H command-line option.) - - - - - - - VERSION - - This man page is correct for version 4.0 of the Samba suite. - - - - SEE ALSO - - ldb(7), ldbedit - - - - - AUTHOR - - &man.credits.samba; - - ldbsearch was written by Andrew Tridgell. - - This manpage was written by Jelmer Vernooij. - - - - diff --git a/source4/lib/ldb/man/man3/ldb.3.xml b/source4/lib/ldb/man/man3/ldb.3.xml deleted file mode 100644 index d9ed135f20..0000000000 --- a/source4/lib/ldb/man/man3/ldb.3.xml +++ /dev/null @@ -1,262 +0,0 @@ - - - - - - ldb - 3 - - - - ldb - The Samba Project - A light-weight database library - - - - #include <ldb.h> - - - - description - - -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. - - - - - TOOLS - - - - ldbsearch(1) - - command line ldb search utility - - - - ldbedit(1) - - edit all or part of a ldb database using your favourite editor - - - - ldbadd(1) - - add records to a ldb database using LDIF formatted input - - - - ldbdel(1) - - delete records from a ldb database - - - - ldbmodify(1) - - modify records in a ldb database using LDIF formatted input - - - - - - FUNCTIONS - - - - ldb_connect(3) - - connect to a ldb backend - - - - ldb_search(3) - - perform a database search - - - - ldb_add(3) - - add a record to the database - - - - ldb_delete(3) - - delete a record from the database - - - - ldb_modify(3) - - modify a record in the database - - - - ldb_errstring(3) - - retrieve extended error information from the last operation - - - - ldb_ldif_write(3) - - write a LDIF formatted message - - - - ldb_ldif_write_file(3) - - write a LDIF formatted message to a file - - - - ldb_ldif_read(3) - - read a LDIF formatted message - - - - ldb_ldif_read_free(3) - - free the result of a ldb_ldif_read() - - - - ldb_ldif_read_file(3) - - read a LDIF message from a file - - - - ldb_ldif_read_string(3) - - read a LDIF message from a string - - - - ldb_msg_find_element(3) - - find an element in a ldb_message - - - - ldb_val_equal_exact(3) - - compare two ldb_val structures - - - - ldb_msg_find_val(3) - - find an element by value - - - - ldb_msg_add_empty(3) - - add an empty message element to a ldb_message - - - - - ldb_msg_add(3) - - add a non-empty message element to a ldb_message - - - - - ldb_msg_element_compare(3) - - compare two ldb_message_element structures - - - - - ldb_msg_find_int(3) - - return an integer value from a ldb_message - - - - - ldb_msg_find_uint(3) - - return an unsigned integer value from a ldb_message - - - - - ldb_msg_find_double(3) - - return a double value from a ldb_message - - - - - ldb_msg_find_string(3) - - return a string value from a ldb_message - - - - - ldb_set_alloc(3) - - set the memory allocation function to be used by ldb - - - - - ldb_set_debug(3) - - set a debug handler to be used by ldb - - - - - ldb_set_debug_stderr(3) - - set a debug handler for stderr output - - - - - - description - - - ldb was written by - Andrew Tridgell. - - - -If you wish to report a problem or make a suggestion then please see -the 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. - - - -- cgit From d0f46637713cb54b44fb8e371a54412146f05406 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Tue, 13 Dec 2005 16:48:37 +0000 Subject: r12209: Fix some issues with XML entities. (This used to be commit 754e51b19d2d1fd6be8e01d62b6ec892688f934c) --- source4/lib/ldb/man/ldb.3.xml | 2 +- source4/lib/ldb/man/ldbadd.1.xml | 10 ++++++++-- source4/lib/ldb/man/ldbdel.1.xml | 10 +++++++++- source4/lib/ldb/man/ldbedit.1.xml | 10 ++++++++-- source4/lib/ldb/man/ldbmodify.1.xml | 10 ++++++++-- source4/lib/ldb/man/ldbrename.1.xml | 10 ++++++++-- source4/lib/ldb/man/ldbsearch.1.xml | 10 ++++++++-- 7 files changed, 50 insertions(+), 12 deletions(-) (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/ldb.3.xml b/source4/lib/ldb/man/ldb.3.xml index d9ed135f20..d6223b0743 100644 --- a/source4/lib/ldb/man/ldb.3.xml +++ b/source4/lib/ldb/man/ldb.3.xml @@ -241,7 +241,7 @@ ldb_search(3) manual pages. - description + DESCRIPTION ldb was written by diff --git a/source4/lib/ldb/man/ldbadd.1.xml b/source4/lib/ldb/man/ldbadd.1.xml index 0b3122ab32..11ed847b75 100644 --- a/source4/lib/ldb/man/ldbadd.1.xml +++ b/source4/lib/ldb/man/ldbadd.1.xml @@ -88,9 +88,15 @@ AUTHOR - &man.credits.samba; + ldb was written by + Andrew Tridgell. + - ldbadd was written by Andrew Tridgell. + +If you wish to report a problem or make a suggestion then please see +the web site for +current contact and maintainer information. + This manpage was written by Jelmer Vernooij. diff --git a/source4/lib/ldb/man/ldbdel.1.xml b/source4/lib/ldb/man/ldbdel.1.xml index 2f98f9d427..51ae18e685 100644 --- a/source4/lib/ldb/man/ldbdel.1.xml +++ b/source4/lib/ldb/man/ldbdel.1.xml @@ -86,7 +86,15 @@ AUTHOR - &man.credits.samba; + ldb was written by + Andrew Tridgell. + + + +If you wish to report a problem or make a suggestion then please see +the web site for +current contact and maintainer information. + ldbdel was written by Andrew Tridgell. diff --git a/source4/lib/ldb/man/ldbedit.1.xml b/source4/lib/ldb/man/ldbedit.1.xml index 0b5c63a17a..e2b2fd053f 100644 --- a/source4/lib/ldb/man/ldbedit.1.xml +++ b/source4/lib/ldb/man/ldbedit.1.xml @@ -114,9 +114,15 @@ AUTHOR - &man.credits.samba; + ldb was written by + Andrew Tridgell. + - ldbedit was written by Andrew Tridgell. + +If you wish to report a problem or make a suggestion then please see +the web site for +current contact and maintainer information. + This manpage was written by Jelmer Vernooij. diff --git a/source4/lib/ldb/man/ldbmodify.1.xml b/source4/lib/ldb/man/ldbmodify.1.xml index e39f74fffa..e936746ed7 100644 --- a/source4/lib/ldb/man/ldbmodify.1.xml +++ b/source4/lib/ldb/man/ldbmodify.1.xml @@ -76,9 +76,15 @@ AUTHOR - &man.credits.samba; + ldb was written by + Andrew Tridgell. + - ldbmodify was written by Andrew Tridgell. + +If you wish to report a problem or make a suggestion then please see +the web site for +current contact and maintainer information. + This manpage was written by Jelmer Vernooij. diff --git a/source4/lib/ldb/man/ldbrename.1.xml b/source4/lib/ldb/man/ldbrename.1.xml index 32456243af..b0480ca366 100644 --- a/source4/lib/ldb/man/ldbrename.1.xml +++ b/source4/lib/ldb/man/ldbrename.1.xml @@ -90,9 +90,15 @@ AUTHOR - &man.credits.samba; + ldb was written by + Andrew Tridgell. + - ldbrename was written by Andrew Tridgell. + +If you wish to report a problem or make a suggestion then please see +the web site for +current contact and maintainer information. + This manpage was written by Jelmer Vernooij. diff --git a/source4/lib/ldb/man/ldbsearch.1.xml b/source4/lib/ldb/man/ldbsearch.1.xml index 8361aa97ff..f940526a72 100644 --- a/source4/lib/ldb/man/ldbsearch.1.xml +++ b/source4/lib/ldb/man/ldbsearch.1.xml @@ -102,9 +102,15 @@ AUTHOR - &man.credits.samba; + ldb was written by + Andrew Tridgell. + - ldbsearch was written by Andrew Tridgell. + +If you wish to report a problem or make a suggestion then please see +the web site for +current contact and maintainer information. + This manpage was written by Jelmer Vernooij. -- cgit From 4bbb73894c7e30a33cda97480e42aadb6fa56c92 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Fri, 23 Dec 2005 12:28:26 +0000 Subject: r12445: Fix header in manpage, make script executable (This used to be commit 7ca00cd918760dccc51e56234126ead8535a22ef) --- source4/lib/ldb/man/ldb.3.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/ldb.3.xml b/source4/lib/ldb/man/ldb.3.xml index d6223b0743..bf306d787c 100644 --- a/source4/lib/ldb/man/ldb.3.xml +++ b/source4/lib/ldb/man/ldb.3.xml @@ -241,7 +241,7 @@ ldb_search(3) manual pages. - DESCRIPTION + Author ldb was written by -- cgit From a6d0d564597ea793e0a145ff39fafd6a0dfd6c0f Mon Sep 17 00:00:00 2001 From: Simo Sorce Date: Fri, 30 Dec 2005 11:56:52 +0000 Subject: r12605: docs patch from Brad Hards (This used to be commit 874f16e055ec30bf2ee52a33464b4810a8f8cd89) --- source4/lib/ldb/man/ldbedit.1.xml | 231 +++++++++++++++++++++++++------------- 1 file changed, 150 insertions(+), 81 deletions(-) (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/ldbedit.1.xml b/source4/lib/ldb/man/ldbedit.1.xml index e2b2fd053f..3cfcce89f1 100644 --- a/source4/lib/ldb/man/ldbedit.1.xml +++ b/source4/lib/ldb/man/ldbedit.1.xml @@ -2,130 +2,199 @@ - + ldbedit 1 - + - + ldbedit - Edit LDB databases using your favorite editor - + Edit LDB databases using your preferred editor + - + - ldbedit - -h - -s base|one|sub - -b basedn - -a - -e editor - -H LDB-URL - expression - attributes + ldbedit + -? + --usage + -s base|one|sub + -b basedn + -a + -e editor + -H LDB-URL + expression + attributes DESCRIPTION - ldbedit is a utility that allows you to edit LDB files using - your favorite editor. ldbedit generates an LDIF file based on - your query, allows you to edit it and then merges it back - into the LDB database. + ldbedit is a utility that allows you to edit LDB entries (in + tdb files, sqlite files or LDAP servers) using your preferred editor. + ldbedit generates an LDIF file based on your query, allows you to edit + the LDIF, and then merges that LDIF back into the LDB backend. - + OPTIONS - + - - -h - - Show list of available options. - - - - -H <ldb-url> - - LDB URL to connect to. See ldb(7) for details. - - - - - -s one|sub|base - Search scope to use. One-level, subtree or base. - - - - -a - Edit all records. - - - - -e editor - Specify the editor that should be used (overrides - the VISUAL and EDITOR environment variables). - - - - -b basedn - Specify Base DN to use. - + + -? + --help + + + Show list of available options, and a phrase describing what that option + does. + + + + + + --usage + + + Show list of available options. This is similar to the help option, + however it does not provide any description, and is hence shorter. + + + + + + -H <ldb-url> + + + LDB URL to connect to. For a tdb database, + this will be of the form + tdb://filename. + For a LDAP connection over unix domain + sockets, this will be of the form + ldapi://socket. For + a (potentially remote) LDAP connection over + TCP, this will be of the form + ldap://hostname. For + an SQLite database, this will be of the form + sqlite://filename. + + + + + + -s one|sub|base + Search scope to use. One-level, subtree or base. + + + + -a + -all + + Edit all records. This allows you to + apply the same change to a number of records + at once. You probably want to combine this + with an expression of the form + "objectclass=*". + + + + + + -e editor + --editor editor + + Specify the editor that should be used (overrides + the VISUAL and EDITOR environment + variables). If this option is not used, and + neither VISUAL nor EDITOR environment variables + are set, then the vi editor will be used. + + + + + + -b basedn + Specify Base Distinguished Name to use. + + + + -v + --verbose + + Make ldbedit more verbose about the + operations that are being performed. Without + this option, ldbedit will only provide a + summary change line. + + + - + - + ENVIRONMENT - LDB_URL - LDB URL to connect to (can be overrided by using the - -H command-line option.) - - VISUAL and EDITOR - Environment variables used to determine what - editor to use. If VISUAL isn't set, EDITOR is used. - - + + LDB_URL + + LDB URL to connect to. This can be + overridden by using the -H command-line option.) + + + + + VISUAL and EDITOR + + + Environment variables used to determine what + editor to use. VISUAL takes precedence over + EDITOR, and both are overridden by the + -e command-line option. + + + - + - + VERSION - + This man page is correct for version 4.0 of the Samba suite. - + - + SEE ALSO + + ldb(7), ldbmodify(1), ldbdel(1), ldif(5), vi(1) - ldb(7), ldbmodify, ldbdel, ldif(5) + - - - + AUTHOR - ldb was written by - Andrew Tridgell. + + ldb was written by + Andrew Tridgell. -If you wish to report a problem or make a suggestion then please see -the web site for -current contact and maintainer information. + If you wish to report a problem or make a suggestion then please see + the web site for + current contact and maintainer information. - This manpage was written by Jelmer Vernooij. + + This manpage was written by Jelmer Vernooij and updated + by Brad Hards. + - + -- cgit From 224bcda06125b9bed40c365af9b9700afa27eb33 Mon Sep 17 00:00:00 2001 From: Stefan Metzmacher Date: Wed, 11 Jan 2006 16:00:27 +0000 Subject: r12845: fix some typos metze (This used to be commit 5d0ae1d2aef3fc7ddb4cb9269bb028beeaee6dfb) --- source4/lib/ldb/man/ldbsearch.1.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/ldbsearch.1.xml b/source4/lib/ldb/man/ldbsearch.1.xml index f940526a72..f287f3c263 100644 --- a/source4/lib/ldb/man/ldbsearch.1.xml +++ b/source4/lib/ldb/man/ldbsearch.1.xml @@ -95,7 +95,7 @@ SEE ALSO - ldb(7), ldbedit + ldb(7), ldbedit(1) -- cgit From 83e420f93acdc0b3e36d2e748bdc5e28bd8bb089 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Mon, 23 Jan 2006 04:13:06 +0000 Subject: r13074: Add oLschema2ldif manpage (This used to be commit 3e3a0c96cdb631798cf2192d0b441d29b33428c0) --- source4/lib/ldb/man/oLschema2ldif.1.xml | 79 +++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 source4/lib/ldb/man/oLschema2ldif.1.xml (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/oLschema2ldif.1.xml b/source4/lib/ldb/man/oLschema2ldif.1.xml new file mode 100644 index 0000000000..b499da574e --- /dev/null +++ b/source4/lib/ldb/man/oLschema2ldif.1.xml @@ -0,0 +1,79 @@ + + + + + + oLschema2ldif + 1 + + + + + oLschema2ldif + Converts LDAP schema's to LDB-compatible LDIF + + + + + oLschema2ldif + -I INPUT-FILE + -O OUTPUT-FILE + + + + + DESCRIPTION + + oLschema2ldif is a simple tool that converts standard OpenLDAP schema files to a LDIF format that is understood by LDB. + + + + + OPTIONS + + + + -I input-file + OpenLDAP schema to read. If none are specified, +the schema file will be read from standard input. + + + + + -O output-file + File to write ldif version of schema to. + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + ldb was written by + Andrew Tridgell. + oLschema2ldif was written by Simo Sorce. + + + +If you wish to report a problem or make a suggestion then please see +the web site for +current contact and maintainer information. + + + + + -- cgit From 7de75a991bda653497a0989de93608310b55894a Mon Sep 17 00:00:00 2001 From: Andrew Bartlett Date: Thu, 17 Aug 2006 08:31:19 +0000 Subject: r17580: Add a new tools to convert back from AD-like schema to OpenLDAP. Add attribute syntax mapping to the existing OpenLDAP -> AD tool. Andrew Bartlett (This used to be commit ba1c652bae700a82acde166e70035d61c320e233) --- source4/lib/ldb/man/ad2oLschema.1.xml | 87 +++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 source4/lib/ldb/man/ad2oLschema.1.xml (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/ad2oLschema.1.xml b/source4/lib/ldb/man/ad2oLschema.1.xml new file mode 100644 index 0000000000..a4e304f15f --- /dev/null +++ b/source4/lib/ldb/man/ad2oLschema.1.xml @@ -0,0 +1,87 @@ + + + + + + ad2oLschema + 1 + + + + + ad2oLschema + Converts AC-like LDAP schemas to OpenLDAP + compatible schema files + + + + + ad2oLschema + -I INPUT-FILE + -O OUTPUT-FILE + + + + + DESCRIPTION + + ad2oLschema is a simple tool that converts AD-like LDIF + schema files into OpenLDAP schema files. + + + + + OPTIONS + + + + -H url + URL to an LDB or LDAP server with an AD schema to read. + + + + -I input-file AD schema + to read. If neither this nor -H is specified, the + schema file will be read from standard input. + + + + + -O output-file + File to write OpenLDAP version of schema to. + + + + + + + VERSION + + This man page is correct for version 4.0 of the Samba suite. + + + + SEE ALSO + + ldb(7), ldbmodify, ldbdel, ldif(5) + + + + + AUTHOR + + ldb was written by + Andrew Tridgell. + ad2oLschema was written by Andrew Bartlett. + + + +If you wish to report a problem or make a suggestion then please see +the web site for +current contact and maintainer information. + + + + + -- cgit From f1da198449fece2e6d586859f35e1a2f1832336f Mon Sep 17 00:00:00 2001 From: Andrew Tridgell Date: Wed, 23 Aug 2006 01:44:22 +0000 Subject: r17732: after some help from Jelmer, changed builddocs.sh not to rely on either an internet connection, or a list of xsl paths (This used to be commit 7f3c699d0f8fc0e75b351bc851dbb9ffdc3617c4) --- source4/lib/ldb/man/ad2oLschema.1.xml | 2 +- source4/lib/ldb/man/ldb.3.xml | 2 +- source4/lib/ldb/man/ldbadd.1.xml | 2 +- source4/lib/ldb/man/ldbdel.1.xml | 2 +- source4/lib/ldb/man/ldbedit.1.xml | 2 +- source4/lib/ldb/man/ldbmodify.1.xml | 2 +- source4/lib/ldb/man/ldbrename.1.xml | 2 +- source4/lib/ldb/man/ldbsearch.1.xml | 2 +- source4/lib/ldb/man/oLschema2ldif.1.xml | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/ad2oLschema.1.xml b/source4/lib/ldb/man/ad2oLschema.1.xml index a4e304f15f..6ae8996477 100644 --- a/source4/lib/ldb/man/ad2oLschema.1.xml +++ b/source4/lib/ldb/man/ad2oLschema.1.xml @@ -1,5 +1,5 @@ - + diff --git a/source4/lib/ldb/man/ldb.3.xml b/source4/lib/ldb/man/ldb.3.xml index bf306d787c..6a3a789034 100644 --- a/source4/lib/ldb/man/ldb.3.xml +++ b/source4/lib/ldb/man/ldb.3.xml @@ -1,5 +1,5 @@ - + diff --git a/source4/lib/ldb/man/ldbadd.1.xml b/source4/lib/ldb/man/ldbadd.1.xml index 11ed847b75..7ad0f835d0 100644 --- a/source4/lib/ldb/man/ldbadd.1.xml +++ b/source4/lib/ldb/man/ldbadd.1.xml @@ -1,5 +1,5 @@ - + diff --git a/source4/lib/ldb/man/ldbdel.1.xml b/source4/lib/ldb/man/ldbdel.1.xml index 51ae18e685..7dfc7366f6 100644 --- a/source4/lib/ldb/man/ldbdel.1.xml +++ b/source4/lib/ldb/man/ldbdel.1.xml @@ -1,5 +1,5 @@ - + diff --git a/source4/lib/ldb/man/ldbedit.1.xml b/source4/lib/ldb/man/ldbedit.1.xml index 3cfcce89f1..15c69b1b25 100644 --- a/source4/lib/ldb/man/ldbedit.1.xml +++ b/source4/lib/ldb/man/ldbedit.1.xml @@ -1,5 +1,5 @@ - + diff --git a/source4/lib/ldb/man/ldbmodify.1.xml b/source4/lib/ldb/man/ldbmodify.1.xml index e936746ed7..bc19647785 100644 --- a/source4/lib/ldb/man/ldbmodify.1.xml +++ b/source4/lib/ldb/man/ldbmodify.1.xml @@ -1,5 +1,5 @@ - + diff --git a/source4/lib/ldb/man/ldbrename.1.xml b/source4/lib/ldb/man/ldbrename.1.xml index b0480ca366..391ec84ccc 100644 --- a/source4/lib/ldb/man/ldbrename.1.xml +++ b/source4/lib/ldb/man/ldbrename.1.xml @@ -1,5 +1,5 @@ - + diff --git a/source4/lib/ldb/man/ldbsearch.1.xml b/source4/lib/ldb/man/ldbsearch.1.xml index f287f3c263..ed3749b920 100644 --- a/source4/lib/ldb/man/ldbsearch.1.xml +++ b/source4/lib/ldb/man/ldbsearch.1.xml @@ -1,5 +1,5 @@ - + diff --git a/source4/lib/ldb/man/oLschema2ldif.1.xml b/source4/lib/ldb/man/oLschema2ldif.1.xml index b499da574e..b1e681be4e 100644 --- a/source4/lib/ldb/man/oLschema2ldif.1.xml +++ b/source4/lib/ldb/man/oLschema2ldif.1.xml @@ -1,5 +1,5 @@ - + -- cgit From 7218b3b878fe74b8bd739443a38cb2409d332e20 Mon Sep 17 00:00:00 2001 From: James Peach Date: Mon, 6 Nov 2006 19:38:27 +0000 Subject: r19578: Fix trivial typ0. (This used to be commit 664b4a84b60d4f8dddfe06e0619b882b322108ec) --- source4/lib/ldb/man/ldb.3.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'source4/lib/ldb/man') diff --git a/source4/lib/ldb/man/ldb.3.xml b/source4/lib/ldb/man/ldb.3.xml index 6a3a789034..19d9a89e10 100644 --- a/source4/lib/ldb/man/ldb.3.xml +++ b/source4/lib/ldb/man/ldb.3.xml @@ -37,7 +37,7 @@ architecture. -It a taxonomy of databases ldb would sit half way between key/value +In 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 -- cgit